Block Paragraphs

Specifies the rule used to mark paragraphs and lists located in a bounding box defined by the X, Y, Width, Height properties.

Built-in Macro Name: #ReadParagraphBlocks

All the lines in the region or the box are processed one by one and added to a paragraph or a list. When the distance between two lines is greater than the Line Height property, then it marks the end of a paragraph or a list. The distance between two lines is defined as the distance between the top Y position of the lines. The Line Height property is used to split the entire text into blocks that resemble into separate paragraphs or lists. You can set your Export as values to: Fixed, Next Image X Position, Cursor X. You can also select a previously added variable.

Note: You cannot set your export options to Absent or Relative for Width and Height.

For advancing to the next line Y position in the text, the getNextLineInRegion and getLineBeforeCursorInRegion operators are used. A List element contains a set of ListItem elements and starts with the first ListItem element encountered after the end of a paragraph or a list.

List items and paragraphs can span multiple lines with the exception that if a line contains the string . . . it is processed as a single line item.

List Items

A matched List Item element is split into a Label and a ListItemBody element.

Condition for matching new list items or the start of a ListItem element:

Line starting with a bullet • that corresponds to the Unicode character U+2022 (Regex = \x{2022}.*).
The bullet is matched as a Label element and the rest of the line is matched as a ListItemBody element.
Line starts with one or two digits continuing with a period and a space (Regex = ^\d{1,2}\. .*).
The start digits and period are matched as a Label element and the rest of the line is matched as a ListItemBody element.
Line starts with one or two digits then followed by a ) and a space (Regex = ^\d{1,2}\) .*)
The start digits and ) are matched as a Label element and the rest of the line is matched as a ListItemBody element.

A List Item element ends when at least one of the following is true:

  • The new line falls outside of the rule bounding box.
  • The end of a list is encountered.
  • The start of a new List Item element is encountered.
    List Item Regex
    This regex value is used to check if a new list item begins.
    Note Regex
    This regex value is used to mark or tag the note part of a list item.
    Label Regex
    This value is used to mark or tag the label part of a list item.
    Single Line Regex
    This regex value is used to check if a line should be processed as a single tagged item.

Paragraphs

If the line being processed in the defined region is not recognized as start or part of a List Item element, then it is processed as part of a Paragraph element. If the distance between the new line processed and the the previous line is greater than the Line Height property, then a new paragraph is started.

Parent topic: Built-in Macro Rules