PDFix Template

—

Table of Contents

• General Settings
• Threshold Values
• Regular Expressions
• Functions

General Settings

General template settings

Example:

{
  "template": {
    "settings": {
      "retain_pdfua": true,
      "page_tag": "NonStruct",
      "substructure_form_XObject": true
    }
  }
}

Threshold Values

—

Example:

{
  "template": {
    "pagemap": [
      {
        "rect_image_similarity": 0.7,
        "preflight_columns": 1,
        "background_color_blue": 255
      }
    ]
  }
}

Regular Expressions

—

Example:

{
  "template": {
    "pagemap_regex": [
      {
        "regex_roman_numbering": "^[\\[\\(]?M{0,4}(CM|CD|D?C{0,3})(XC|XL|L?X{0,3})(IX|IV|V?I{0,3})[\\)\\]\\.]?$",
        "regex_chart_caption": "((^chart)|(^map))"
      }
    ]
  }
}

Functions

form_object_process

The test is triggered when the page form object is parsed.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

path_object_process

The test is triggered when the page path object is parsed.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

object_update

The test is triggered when the page image object is tested.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

image_object_process

The test is triggered when the page image object is parsed.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

line_update

Updates a line element after detecting horizontal and vertical lines.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

rect_update

Updates a rectangle element after detecting rectangles.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

word_update

Updates a word element after detecting words.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

word_spacing

Detects the spacing between two words.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

text_line_add_word

The test is triggered when forming text lines from words.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

text_line_update

Updates a text line element after detecting text lines.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

text_line_split_filling

Splits a text line based on filling.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

text_line_neighbours

Test if two neighbours text lines can form a paragraph.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

text_update

Updates the text element after detecting paragraphs.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

element_create

Create user-defined elements.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

element_update

Updates an element after detecting basic elements.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

table_recognize

The test is triggered during the table recognition process for detecting columns and rows. This test can be called multiple times!

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

caption_join

Finds the element for text that has been marked as a caption.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

table_update

Updates a table after the whole process od table detection is done.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

table_detect_header

Defines the rules for detecting table headers and tests whether the text is a header in a table.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

table_split

Updates the table after the entire table detection process is completed.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

single_instance_detect

Detects handles for elements that require a single occurrence only.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

alt_update

Sets an alternate description for the element. The alternate description is established in a specific order. To skip a step, set the default value to false for that step.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

actual_text_update

Sets the actual text for the element. The actual text is established in a specific order. To skip a step, set the default value to false for that step.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

artifact_update

Marks an element as an artifact.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

reading_order_detect

Detect reading order options

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

label_update

Update elements marked as labels to include them as part of the list.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

list_update

Tests if a list is correct.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

tag_list

Handles the process of tagging lists.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

tag_image

Handles the process of tagging images. For repurposing and accessibility purposes, a Figure element should have either an Alt entry or an ActualText entry in its structure element dictionary. If both are absent, the default behavior is to tag the Figure with an empty alt attribute.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

tag_table

Handles the process of tagging tables. For repurposing and accessibility purposes, a table should have headers. If no headers are detected, the default behavior is to leave the table without any <th> elements.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

tag_annot

Handles the process of tagging annotations.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

tag_update

Updates the tag after it has been created..

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

annot_update

Updates the annotation tag after it has been created.

keys and values:

• “disable” : false
• “statement” : “$if”
• “query” :
  • “param” : [[“pds_form“]]
• “flag” : “”

Schema

statement

The if statement type of the query. According to the statement the query evaluation stops upon pass or not.

• values:
  • ['$if', '$elif', '$else']
• defaule value: $if

keys and values:

• “$if”
• “$elif”
• “$else”

$if

Can by used in all functions. General logic of IF statement.

• type: statement

$elif

Can by used in all functions. General logic of ELSE IF statement.

• type: statement

$else

Can by used in all functions. General logic of ELSE statement.

• type: statement

query

The query defines thresholds and operations for a pagemap detection.

• type: query

keys and values:

• “param” params:

  • “pds_object_params”

    • A parameter that represents PdsObject. The value starts with the character $, followed by a number (e.g., $0_width). The number represents the index of the parameter in the param array.

  • “pde_element_params”

    • A parameter that represents PdeElement. The value starts with the character $, followed by a number (e.g., $0_width). The number represents the index of the parameter in the param array.

  • “pds_struct_elem_params”

    • A parameter that represents PdsStructElem. The value starts with the character $, followed by a number (e.g., $0_width). The number represents the index of the parameter in the param array.

  • “pdf_annot_params”

    • A parameter that represents PdfAnnots. The value starts with the character $, followed by a number (e.g., $0_width). The number represents the index of the parameter in the param array.

  • “pdf_rect”

  • “pdf_rgb”

  • “int”

    • Parameter that represents integer.

  • “bool”

    • Parameter that represents boolean value.

  • “float”

    • Parameter that represents floating value.

  • “string”

    • Parameter that represents string value.

• “var” params:

  • “arithmetic_operator”

  • “0_value”

• “logical_operators“

param

Define the number and type of input parameters.

• type: query_param

keys and values:

• “pds_object_params“
• “pde_element_params“
• “pds_struct_elem_params“
• “pdf_annot_params“
• “pdf_rect“
• “pdf_rgb“
• “int“
• “bool“
• “float“
• “string“

int

Parameter that represents integer.

• type: int

bool

Parameter that represents boolean value.

• type: bool

float

Parameter that represents floating value.

• type: float

string

Parameter that represents string value.

• type: string

var

User defined variables. Use scheme:arithmetic_operators to define variables

• type: var

keys and values:

• “arithmetic_operator“
• “0_value”

logical_operators

Available logical operators.

• type: string
• values:
  • ['$and', '$or', '$not']

keys and values:

• “$and” params:

  • “$and”

  • “$or”

  • “$not”

  • “condition”

• “$or” params:

  • “$and”

  • “$or”

  • “$not”

  • “condition”

• “$not” params:

  • “$and”

  • “$or”

  • “$not”

  • “condition”

$and

Logical AND.

• type: logical_operator

keys and values:

• “$and”
• “$or”
• “$not”
• “condition“

$or

Logical OR.

• type: logical_operator

keys and values:

• “$and”
• “$or”
• “$not”
• “condition“

$not

Logical NOT.

• type: logical_operator

keys and values:

• “$and”
• “$or”
• “$not”
• “condition“

comparison_operators

Available comparison operators.

• type: string
• values:
  • ['$eq', '$ne', '$lt', '$lte', '$gt', '$gte', '$regex', '$in', '$nin']

keys and values:

• “$eq”
• “$ne”
• “$lt”
• “$lte”
• “$gt”
• “$gte”
• “$regex”
• “$in”
• “$nin”

$eq

Equality comparison operator.

• type: comparison_operator
• types: [“int“, “float“, “string“]

$ne

Nequality comparator operator.

• type: comparison_operator
• types: [“int“, “float“, “string“]

$lt

Less than comparison operator.

• type: comparison_operator
• types: [“int“, “float“]

$lte

Less than or equals operator.

• type: comparison_operator
• types: [“int“, “float“]

$gt

Greater than operator.

• type: comparison_operator
• types: [“int“, “float“]

$gte

Greater than or equals operator.

• type: comparison_operator
• types: [“int“, “float“]

$regex

Regular expression predicate.

• type: comparison_operator
• types: [“string“]

$in

Contain value operator.

• type: comparison_operator
• types: []

$nin

Not contain value operator.

• type: comparison_operator
• types: []

arithmetic_operators

Available arithmetic_operators.

• type: string
• values:
  • ['$sum', '$diff', '$abs', '$mul', '$div', '$min', '$max', '$mod']

keys and values:

• “$sum” params:

  • “arithmetic_operator”

  • “[0]”

  • “[1]”

• “$diff” params:

  • “arithmetic_operator”

  • “[0]”

  • “[1]”

• “$abs” params:

  • “arithmetic_operator”

  • “[0]”

• “$mul” params:

  • “arithmetic_operator”

  • “[0]”

  • “[1]”

• “$div” params:

  • “arithmetic_operator”

  • “[0]”

  • “[1]”

• “$min” params:

  • “arithmetic_operator”

  • “[0]”

  • “[1]”

• “$max” params:

  • “arithmetic_operator”

  • “[0]”

  • “[1]”

• “$mod” params:

  • “arithmetic_operator”

  • “[0]”

  • “[1]”

$sum

Sum of two numbers.

• type: arithmetic_operator
• types: [“int“, “float“]

keys and values:

• “arithmetic_operator“
• “[0]”
• “[1]”

$diff

Difference of two numbers.

• type: arithmetic_operator
• types: [“int“, “float“]

keys and values:

• “arithmetic_operator“
• “[0]”
• “[1]”

$abs

Absolute value of a single number.

• type: arithmetic_operator
• types: [“int“, “float“]

keys and values:

• “arithmetic_operator“
• “[0]”

$mul

Multiply two numbers.

• type: arithmetic_operator
• types: [“int“, “float“]

keys and values:

• “arithmetic_operator“
• “[0]”
• “[1]”

$div

division two numbers.

• type: arithmetic_operator
• types: [“int“, “float“]

keys and values:

• “arithmetic_operator“
• “[0]”
• “[1]”

$min

Get minimal value from any number of values.

• type: arithmetic_operator
• types: [“int“, “float“]

keys and values:

• “arithmetic_operator“
• “[0]”
• “[1]”

$max

Get maximal value from any number of values.

• type: arithmetic_operator
• types: [“int“, “float“]

keys and values:

• “arithmetic_operator“
• “[0]”
• “[1]”

$mod

Get the modulus from a division of values.

• type: arithmetic_operator
• types: [“int“, “int“]

keys and values:

• “arithmetic_operator“
• “[0]”
• “[1]”

pds_object_params

List of all pds_object types, can be used as parameter in QUERY->PARAM.

keys and values:

• “pds_text” params:

  • “width”

  • “height”

  • “left”

  • “right”

  • “top”

  • “bottom”

  • “bbox”

  • “fill_color”

  • “stroke_color”

  • “artifact”

  • “mcid”

  • “font_size”

  • “font_name”

  • “text”

• “pds_path“

• “pds_image“

• “pds_shading“

• “pds_form” params:

  • “width”

  • “height”

  • “left”

  • “right”

  • “top”

  • “bottom”

  • “bbox”

  • “children_num”

  • “artifact”

  • “mcid”

• “pds_object” params:

  • “type”

    • Type of PdsObject.

  • “width”

  • “height”

  • “left”

  • “right”

  • “top”

  • “bottom”

  • “bbox”

  • “fill_color”

  • “stroke_color”

  • “children_num”

  • “artifact”

  • “mcid”

  • “font_size”

  • “font_name”

  • “text”

pds_text

Text page object

keys and values:

• “width“
• “height“
• “left“
• “right“
• “top“
• “bottom“
• “bbox“
• “fill_color“
• “stroke_color“
• “artifact“
• “mcid“
• “font_size“
• “font_name“
• “text“

pds_struct_elem_params

List of all pds_tag types, can be used as parameter in QUERY->PARAM.

keys and values:

• “pds_struct_elem” params:

  • “type”

    • Type of PdsTag.

  • “width”

  • “height”

  • “left”

  • “right”

  • “top”

  • “bottom”

  • “bbox”

  • “tag_type”

  • “parent_tag_type”

  • “id”

  • “title”

  • “lang”

  • “alt”

  • “actual_text”

  • “text”

  • “expansion”

  • “children_num”

  • “fill_color”

  • “stroke_color”

  • “font_size”

  • “font_name”

  • “has_content”

pdf_annot_params

List of all pdf_annot types, can be used as parameter in QUERY->PARAM.

keys and values:

• “pdf_annot” params:

  • “type”

    • Type of PdfAnnot.

  • “width”

  • “height”

  • “left”

  • “right”

  • “top”

  • “bottom”

  • “bbox”

  • “annot_type”

  • “font_size”

  • “font_name”

  • “contents”

  • “annot_flag”

pde_element_params

List of all pde_element types, can be used as parameter in QUERY->PARAM.

keys and values:

• “pde_text” params:

  • “width”

  • “height”

  • “left”

  • “right”

  • “top”

  • “bottom”

  • “bbox”

  • “label”

  • “fill_color”

  • “stroke_color”

  • “alt”

  • “actual_text”

  • “font_size”

  • “font_name”

  • “text”

  • “angle”

  • “heading”

• “pde_text_line“

• “pde_word“

• “pde_text_run“

• “pde_image” params:

  • “width”

  • “height”

  • “left”

  • “right”

  • “top”

  • “bottom”

  • “bbox”

  • “label”

  • “fill_color”

  • “stroke_color”

  • “alt”

  • “actual_text”

  • “children_num”

• “pde_container“

• “pde_list“

• “pde_rect“

• “pde_cell” params:

  • “width”

  • “height”

  • “left”

  • “right”

  • “top”

  • “bottom”

  • “bbox”

  • “cell_column”

  • “cell_row”

• “pde_toc“

• “pde_header“

• “pde_footer“

• “pde_line” params:

  • “width”

  • “height”

  • “left”

  • “right”

  • “top”

  • “bottom”

  • “bbox”

  • “label”

  • “fill_color”

  • “stroke_color”

  • “alt”

  • “actual_text”

• “pde_form_field“

• “pde_annot“

• “pde_table” params:

  • “width”

  • “height”

  • “left”

  • “right”

  • “top”

  • “bottom”

  • “bbox”

  • “label”

  • “fill_color”

  • “stroke_color”

  • “alt”

  • “actual_text”

  • “row_num”

  • “col_num”

  • “header”

  • “table_type”

  • “isolated_num”

    • Number of isolated elements in the table.

• “pde_element” params:

  • “type”

    • Type of PdeElement.

  • “width”

  • “height”

  • “left”

  • “right”

  • “top”

  • “bottom”

  • “bbox”

  • “label”

  • “fill_color”

  • “stroke_color”

  • “angle”

  • “alt”

  • “actual_text”

  • “flag”

general_vars

General variables can be used without parameters. It represents general state during the processing. It contains information about the current page and the document and can be used in any query.

• type: string

keys and values:

• “$page_num”
• “$page_width”
• “$page_height”
• “$page_rotation”
• “$doc_num_pages”
• “$doc_lang”
• “$doc_title”

$page_num

Page number.

• type: int

$page_width

Page cropbox width.

• type: float

$page_height

Page cropbox height.

• type: float

$page_rotation

Page rotation.

• type: int
• values:
  • [0, 90, 180, 270]

$doc_num_pages

Document number of pages.

• type: int

$doc_lang

Document language.

• type: string

$doc_title

Document title.

• type: string

values

General values used in JSON default template.

keys and values:

• “actual_text“

• “alt“

• “lang“

• “id“

• “expansion“

• “has_content“

• “tag_type“

• “parent_tag_type“

• “annot_type“

• “contents“

• “annot_flag“

• “title“

• “angle“

• “bbox” params:

  • “left”

  • “bottom”

  • “right”

  • “top”

• “cell_column“

• “cell_row“

• “col_num“

• “children_num“

• “artifact“

• “mcid“

• “fill_color” params:

  • “red”

  • “green”

  • “blue”

• “stroke_color” params:

  • “red”

  • “green”

  • “blue”

• “flag“

• “font_name“

• “font_size“

• “red“

• “green“

• “blue“

• “header“

• “heading“

• “width“

• “height“

• “label“

• “left“

• “right“

• “top“

• “bottom“

• “pdf_rect” params:

  • “left”

  • “bottom”

  • “right”

  • “top”

• “pdf_rgb” params:

  • “red”

  • “green”

  • “blue”

• “reflow“

• “row_num“

• “table_type“

• “tag“

• “text“

• “text_flag“

• “text_line_flag“

• “type“

• “word_flag“

actual_text

Actual text.

• type: string

alt

Alternate description typically used for Figure tags.

• type: string

lang

The language identifier of the document or tag.

• type: string

id

The unique identifier of the tag.

• type: string

expansion

The expanded form of an abbreviation.

• type: string

has_content

A value identifying whether the object or tag has associated page content.

• type: bool
• values:
  • ['true', 'false']

tag_type

Tag type defined by a string or regular expression. Use .* to match all tags.

• type: string
• values:
  • ['Annot', 'Art', 'Artifact', 'Aside', 'BibEntry', 'BlockQuote', 'Caption', 'Code', 'Div', 'Document', 'DocumentFragment', 'Em', 'FENote', 'Figure', 'Form', 'Formula', 'H', 'H1', 'H2', 'H3', 'H4', 'H5', 'H6', 'Index', 'L', 'Lbl', 'LBody', 'LI', 'Link', 'NonStruct', 'Note', 'P', 'Part', 'Private', 'Quote', 'RB', 'Reference', 'RP', 'RT', 'Ruby', 'Sect', 'Span', 'Strong', 'Sub', 'Table', 'TBody', 'TD', 'TFoot', 'TH', 'THead', 'Title', 'TOC', 'TOCI', 'TR', 'Warichu', 'WP', 'WT']

annot_type

Annotation type defined by a string or regular expression. Use .* to match all annotations.

• type: string
• values:
  • ['Text', 'Link', 'FreeText', 'Line', 'Square', 'Circle', 'Polygon', 'PolyLine', 'Highlight', 'Underline', 'Squiggly', 'StrikeOut', 'Stamp', 'Caret', 'Ink', 'Popup', 'FileAttachment', 'Sound', 'Movie', 'Widget', 'Screen', 'PrinterMark', 'TrapNet', 'Watermark', '3D', 'Redact', 'Projection', 'RichMedia']

contents

A string value specifying the annotation contents.

• type: string

annot_flag

A comma-delimited string value specifying the annotation flags.

• type: string
• values:
  • ['invisible', 'hidden', 'print', 'no_zoom', 'no_rotate', 'no_view', 'read_only', 'locked', 'toggle', 'contents']

title

Title.

• type: string

angle

Angle.

• type: float

bbox

Parameter that represents the bounding box of an object, formatted as an array: [left, bottom, right, top].

• type: bbox

keys and values:

• “left“
• “bottom“
• “right“
• “top“

cell_column

The column number of the cell in the table.

• type: int

cell_row

The row number of the cell in the table.

• type: int

col_num

Number of columns in the table.

• type: int

children_num

Number of associated child page objects.

• type: int

artifact

True if object has content mark Artifact, false otherwise.

• type: bool
• values:
  • ['true', 'false']

mcid

MCID content mark number is exists, -1 otherwise.

• type: int

fill_color

The fill color of an object.

• type: rgb

keys and values:

• “red“
• “green“
• “blue“

stroke_color

The stroke color of an object.

• type: rgb

keys and values:

• “red“
• “green“
• “blue“

flag

The flag value defines a specific property for an object, which is essential for further processing.

• type: string
• values:
  • ['no_join', 'no_split', 'artifact', 'header', 'footer', 'splitter', 'no_table', 'table']

font_name

The name of the font used in the text object.

• type: string

font_size

The size of the font used in the text object.

• type: float

red

The red component of an RGB color.

• type: int

green

The green component of an RGB color.

• type: int

blue

The blue component of an RGB color.

• type: int

header

Marks the object as a table header.

• type: bool
• values:
  • ['true', 'false']

heading

Sets the text heading style.

• type: string
• values:
  • ['normal', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'h7', 'h8', 'note', 'title']

width

The object’s width dimension.

• type: float

height

The object’s height dimension.

• type: float

label

Marks the element as a list label.

• type: string
• values:
  • ['', 'label', 'li_1', 'li_2', 'li_3', 'li_4', 'label_no']

left

The left coordinate of the object.

• type: float

right

The left coordinate of the object.

• type: float

top

The top coordinate of the object.

• type: float

bottom

The bottom coordinate of the object.

• type: float

pdf_rect

Parameter that represents the bounding box of an object, formatted as an array: [left, bottom, right, top].

• type: rec

keys and values:

• “left“
• “bottom“
• “right“
• “top“

pdf_rgb

Parameter that represents the RGB color of an object, formatted as an array: [red, green, blue].

• type: rgb

keys and values:

• “red“
• “green“
• “blue“

reflow

Text reflow. If set to false, each line is treated as a new line.

• type: bool
• values:
  • ['true', 'false']

row_num

The number of rows in the table.

• type: int

table_type

The table type represented as a value from the PdfTableType enum.

• type: string
• values:
  • ['graphic', 'isolated', 'row', 'col', 'form']

tag

The tag name to be used.

• type: string

text

The text to be used as a value.

• type: string

text_flag

The flag to be used for the text element, specifying a value similar to the regex flags.

• type: string
• values:
  • ['table_caption', 'image_caption', 'chart_caption', 'note_caption', 'filling', 'uppercase']

text_line_flag

The flag to be used for the text line element, specifying a value similar to the regex flags.

• type: string
• values:
  • ['hyphen', 'new_line', 'indent', 'terminal', 'drop_cap', 'filling', 'uppercase']

type

Marks the object or element with a type, aiding in the recognition of the correct element type.

• type: string
• values:
  • ['pds_object', 'pds_text', 'pds_path', 'pds_image', 'pds_shading', 'pds_form', 'pde_element', 'pde_text', 'pde_text_line', 'pde_word', 'pde_text_run', 'pde_image', 'pde_container', 'pde_list', 'pde_line', 'pde_rect', 'pde_table', 'pde_cell', 'pde_toc', 'pde_header', 'pde_footer', 'pde_form_field', 'pde_annot']

word_flag

The flag to be used for the word element, specifying a value similar to the regex flags.

• type: string
• values:
  • ['hyphen', 'bullet', 'colon', 'number', 'subscript', 'superscript', 'terminal', 'capital', 'image', 'decimal_num', 'roman_num', 'letter_num', 'page_num', 'filling', 'uppercase', 'comma', 'no_unicode']

suffix

Container holding all unique suffixes used for naming in JSON default template

keys and values:

condition

Conditions types used in the query

keys and values:

• “condition_value“

• “comparison” params:

  • “$eq”

• “comparison_array” params:

  • “$gt”

  • “$lt”

condition_value

{0_width : 100}

comparison

{0_width : {$lt : 100}

keys and values:

• “$eq”

comparison_array

{0_width : [{$lt : 100}, {$gt : 100}, …]}

keys and values:

• “$gt”
• “$lt”

keywords

Container holding all unique keywords used in JSON default template

keys and values:

• “general“
• “template“
• “query“
• “param“
• “statement“
• “disable“
• “purpose“

general

Holding general data like: version, date, id, SDK version, …

template

Holding all functions.

query

Can be used in all functions. Each QUERY must have child PARAM, which holding array of parameters to specified query objects.

param

Child of the QUERY. Each QUERY must include a PARAM that specifies the object types used for evaluation.

• type: array_param

statement

The if statement should be used in function nodes. Based on the statement, the query evaluation stops upon pass or fail. If the if statement is not present, the condition is considered disabled.

• type: string
• values:
  • ['$if', '$elif', '$else']

disable

Can by used in all main functions nodes. If value is true, node is not executed. Default value is false

• type: bool
• values:
  • ['true', 'false']

purpose

Describes the user-defined purpose or description of the QUERY.

• type: string

insert

Values to be added as the default for the node.

keys and values:

• “elements_add_value“