natural-pdf 0.1.8__py3-none-any.whl → 0.1.10__py3-none-any.whl

docs/text-analysis/index.md

@@ -1,105 +0,0 @@
-# Text Analysis
-
-Analyzing the properties of text elements, such as their font, size, style, and color, can be crucial for understanding document structure and extracting specific information. Natural PDF provides tools to access and analyze these properties.
-
-## Introduction
-
-Beyond just the sequence of characters, the *style* of text carries significant meaning. Headings are often larger and bolder, important terms might be italicized, and different sections might use distinct fonts. This page covers how to access and utilize this stylistic information.
-
-## Accessing Font Information
-
-Every `TextElement` (representing characters or words) holds information about its font properties.
-
-```python
-from natural_pdf import PDF
-
-# Load the PDF
-pdf = PDF("https://github.com/jsoma/natural-pdf/raw/refs/heads/main/pdfs/01-practice.pdf")
-
-# Select the first page
-page = pdf.pages[0]
-```
-
-```python
-# Find the first word element
-word = page.find('word') 
-
-print(f"Text:", word.text)
-print(f"Font Name:", word.fontname) # Font reference (e.g., F1) or name
-print(f"Size:", word.size)
-print(f"Color:", word.color) # Non-stroking color
-print(f"Is Bold:", word.bold)
-print(f"Is Italic:", word.italic)
-```
-
-- `fontname`: Often an internal reference (like 'F1', 'F2') or a basic name.
-- `size`: Font size in points.
-- `color`: The non-stroking color, typically a tuple representing RGB or Grayscale values (e.g., `(0.0, 0.0, 0.0)` for black).
-- `bold`, `italic`: Boolean flags indicating if the font style is bold or italic (heuristically determined based on font name conventions).
-
-## Working with Text Styles
-
-You can directly select text based on its style using pseudo-classes in selectors:
-
-```python
-# Find all bold text elements
-bold_text = page.find_all('text:bold')
-
-# Find all italic text elements
-italic_text = page.find_all('text:italic')
-
-# Find text that is both bold and larger than 12pt
-bold_headings = page.find_all('text:bold[size>=12]')
-
-print(f"Found {len(bold_text)} bold elements.")
-print(f"Found {len(italic_text)} italic elements.")
-print(f"Found {len(bold_headings)} bold headings.")
-```
-
-## Analyzing Fonts on a Page
-
-You can use `analyze_text_styles` to assign labels to text based on font sizes, bold/italic and font names.
-
-```python
-page.analyze_text_styles()
-page.text_style_labels
-```
-
-One they're assigned, you can filter based on `style_label` instead of going bit-by-bit.
-
-```python
-page.find_all('text[style_label="10.0pt Bold Helvetica"]')
-```
-
-## Visualizing Text Properties
-
-Use highlighting to visually inspect text properties. Grouping by attributes like `fontname` or `size` can be very insightful. In the example below we go right to grouping by the `style_label`, which combines font name, size and variant.
-
-```python
-page.find_all('text').highlight(group_by='style_label', replace=True).to_image(width=700)
-```
-
-This allows you to quickly see patterns in font usage across the page layout. 
-
-## Weird font names
-
-Oftentimes font names aren't what you're used to – Arial, Helvetica, etc – the PDF has given them weird, weird names. Relax, it's okay, they're normal fonts.
-
-```python
-from natural_pdf import PDF
-
-# Load the PDF
-pdf = PDF("https://github.com/jsoma/natural-pdf/raw/refs/heads/main/pdfs/Atlanta_Public_Schools_GA_sample.pdf")
-
-# Select the first page
-page = pdf.pages[0]
-page.to_image(width=700)
-```
-
-Look!
-
-```python
-page.find_all('text')[0].fontname
-```
-
-The part before the `+` is the variant – bold, italic, etc – while the part after it is the "real" font name.