Element Properties
This section contains properties than can be edited for the rules. You can edit the
rule properties matched in the PDF document.
- Class Type
- Specifies the class type of the element. Depending on the element type, the information under this field is auto-filled.
- This element property can be used under the following rules: Document, Header, Footer, Paragraph, Heading, Link, Block Lines, Block Paragraphs, Reference, Figure, Artifact, Region, Repeating Group, Condition, Anchor, Macro, Set Variable, Section, Table, Table Row, Table Data, Table Column Header, Table Row Header, Block List, Block End Note List, List, List Item, List Item Body, Label, Note, Note List, Exit Repeating Group, Action, Log Entry.
- Name
- Use this field to add a name for a rule.
- This element property can be used under the following rules: Document, Header, Footer, Paragraph, Heading, Link, Block Lines, Block Paragraphs, Reference, Figure, Artifact, Region, Repeating Group, Condition, Anchor, Macro, Set Variable, Section, Table, Table Row, Table Data, Table Column Header, Table Row Header, Block List, Block End Note List, List, List Item, List Item Body, Label, Note, Note List, Exit Repeating Group, Action, Log Entry.
- Description
- Use this field to add a description for an element.
- This element property can be used under the following rules: Document, Header, Footer, Paragraph, Heading, Link, Block Lines, Block Paragraphs, Reference, Figure, Artifact, Region, Repeating Group, Condition, Anchor, Macro, Set Variable, Section, Table, Table Row, Table Data, Table Column Header, Table Row Header, Block List, Block End Note List, List, List Item, List Item Body, Label, Note, Note List, Exit Repeating Group, Action, Log Entry.
- Meta Title
- Use this field to add the meta title of the document. The Meta Title field is mandatory for the document to be PDF/UA compliant.
- This element property can be used under the Document rule.
- Author
- Use this field to add the name of the document creator.
- This element property can be used under the Document rule.
- Rotate Exported PDF
- Use this field to set the rotation for the exported PDF. Select Disabled so that your PDF pages are not rotated in Accessibility Designer nor in the exported PDF. Select Auto Rotation to enable the rotation in Accessibility Designer without enabling the rotation in the exported PDF. Select Preserve Rotation to enable the rotation in both Accessibility Designer and exported PDF. The auto rotation is done per page and the text is rotated so that text is oriented horizontally from left to right.
- This element property can be used under the Document rule.
- Language
- Use this field to set the language for an element that differs from other elements.
- This element property can be used under the following rules: Document, Paragraph, Heading, Link, Reference, Figure, Section, Table, Table Row, Table Data, Table Column Header, Table Row Header, Label, Note.
- You can also set the language as a variable by following these steps:
- Go to the RULES panel on the left side of the screen.
- Select a rule.
- Right-click the rule and select Set Variable.
- In the Set Variable panel enter a name for the variable, select String for Type and enter any IETF BCP 47 language tag, such as: "en" for English or "es" for Spanish.
- Click ADD.
- The new language variable is now displayed at the bottom of the language list in the
Rules properties section on the right of the screen. You can easily identify the new language variable
because it contains the "$" character in front of the name.
- Setting Position and Size Coordinates
- Use these input fields to manually set the X, Y, Width or Height Coordinates.
- X is used by the rule logic for the matching items and by the rule graphic box. The Export As value defines how the X value is used in the control file.
- Y is used by the rule logic for the matching items and by the rule graphic box. The Export As value defines how the Y value is used in the control file.
- Width is used by the rule logic for the matching items and by the rule graphic box. The Export As value defines how the Width value is used in the control file.
- Height is used by the rule logic for the matching items and by the rule graphic box. The Export As value defines how the Height value is used in the control file.
-
See Positioning Rules Graphic in the Workspace Area for more information.
- This element property can be used under the following rules: Paragraph, Heading, Link, Block Lines, Block Paragraphs, Reference, Figure, Artifact, Region, Repeating Group, Section, Table, Table Row, Table Data, Table Column Header, Table Row Header, Block List, Block End Note List, List, List Item, List Item Body, Label, Note, Note List. Apart from the listed rules, X and Y can also be used under these rules: Anchor and Macro.
- Use the Export As options to export position and size coordinates into the control file.
- Note:
- The options for Export As for each coordinate are listed as created into the XML control file.
- If you enabled the Set as default the last "Export As" values when creating new rules property as a rule preference when you edited your templates, each newly created rule will have the Export As values for X, Y, Width, Height copied from the most recent rule created with this setting enabled.
- Alternative Text
- Use this field to add an alternative text for all the rules mentioned below.
- This element property can be used under the following rules: Paragraph, Heading, Link, Reference, Figure, Label, Note, Table Data, Row Header, Column Header.
- Title
- Use this field to add a title for structure elements in the PDF document.
- This element property can be used under the following rules: Document, Paragraph, Heading, Link, Block Lines, Block Paragraphs, Reference, Figure, Section, Table, Table Row, Table Data, Table Column Header, Table Row Header, List, List Item, List Item Body, Label, Note, Note List.
- Summary
- Use this field to add a summary in the PDF document.
- This element property can be used under the Table rule.
- Use metadata as alternative text
- Check this option if you want to use the metadata from the PDF as alternative text
for the image.
Note: This option is valid only for image type elements.
- Text
- When the TextType is set to Fixed, this value matches a fixed text within the defined rule region or area.
- This element property can be used under the following rules: Paragraph, Heading, Link, Reference, Artifact, Table Data, Table Column Header, Table Row Header, Label, Note.
- Text Type
- Defines the method of matching text for a rule. You can select either Fixed or Regular Expression.
- Fixed: To identify a fixed text value.
- Regular Expression: To match a pattern to a given text.
The default regular expression option is .* that matches against any sequence of characters:
All regular expression options are available in the tool. For example, you can use the Regex option [...] to select a range of characters by specifying the first and last characters in the range.
When you specify the range [D-L]:
The text that matches this range is displayed as a matched element when you validate the PDF:
- Recognize inline links
- Use this option to automatically detect the links within the paragraph, list items,
table data or header elements. You can use regular expressions to identify different
types of links.
- Https Regex
- Explicit Regex
- Email Regex
- Phone Regex
- This element property can be used under the following rules: Action, RepeatingGroup, Section, Region, Table, TableRow, List, ListItem, ListItemBody, EndNoteList, Document, Paragraph, Heading, Table Data, Table Column Header, Table Row Header, Note List.
- Suppress if empty
- Enable this option to not tag any empty elements when your rules are processed.
- This element property can be used under the following rules: Paragraph, Heading, Link, Reference, Section, List, List Item, List Item Body, Label, Note, Note List.
- [Join match ID]
- Creates a single matched element output.
- The two rules are joined by an ID that you set up in Join match ID, within the Properties and Macros sections:
Note: For example: this option can be used for a Table element that is continued from one page to another.Once you mark the first Table element and set up the ID, you need to match the second Table element with the same ID. This can be done by manually writing or choosing it from the drop-down.
- The Join match ID field also allows you to set up a variable value. Once the variable
is added in RULES, it shows in the Join match ID section of the element, from where you can select it:
- This element property can be used under the following rules: Paragraph, Table, Table Row, List, List Item.
-
For more information, see: Setting Variables.
- Reference page
- Indicates the page where the originating rule was defined.
- This element property can be used under the following rules: Paragraph, Heading, Link, Block Lines, Block Paragraphs, Reference, Figure, Artifact, Region, Repeating Group, Condition, Anchor, Macro, Section, Table, Table Row, Table Data, Table Column Header, Table Row Header, Block List, Block End Note List, List, List Item, List Item Body, Label, Note, Note List.
- Font name
- Specifies the font name by defining the visual identity of the content.
- This element property can be used only under unmarked text.
- Font style
- Defines the visual appearance of the text by applying stylistic variations.
- This element property can be used only under unmarked text.
- Condition Result
- Condition Result element property is read only. It is set to True or False depending on the branch type.
- This element property can be used under the Action rule.
- Row Span
- Defines the number of rows on which the Table cell spans.
- This element property can be used under the following rules: Table Data, Table Column Header, Table Row Header.
- Column Span
- Defines the number of columns on which the Table cell spans.
- This element property can be used under the following rules: Table Data, Table Column Header, Table Row Header.
- Page Break
- Defines a row part of a table that spans over multiple pages.
- This element property can be used under the Table Row rule.
- Read Header
- For a table that spans on multiple pages, if a row is present on the next page, this property defines if the row is processed.
- This element property can be used under the Table Row rule.
- Adjust Cell Cursor
- Defines how the cursor is changed when a table cell is processed.
- This element property can be used under the Table rule.
- Variable Name
- Defines the name of a variable.
- This element property can be used under the Set Variable rule.
- Variable Type
- Defines the type of a variable.
- This element property can be used under the Set Variable rule.
- Variable Value
- Defines the value of a variable.
- This element property can be used under the Set Variable rule.
- Macro Name
- Defines the name of the macro definition used for a particular macro rule.
- This element property can be used under the Macro rule.
- Expression
- Represents a summary read-only description of the condition expression.
- This element property can be used under the Condition rule.
- Artifact Type
- Defines the type of content to be artifacted: text, image, or any.
- This element property can be used under the Artifact rule.
- Image Type
- Defines the type of supported image: raster, vectorial, or any.
- This element property can be used under the Figure rule.
- Support Image Text
- If the value is set, text images are supported and matched.
- This element property can be used under the Figure rule.
- Use Metadata as Alt Text
- Select this option to use the metadata from the PDF as alternative text for the image.
- This element property can be used under the Figure rule.
- Small Text
- Mark the superscript from the selected area as reference.
- This element property can be used under the Reference rule.
- Heading Level
- Defines different heading levels.
- This element property can be used under the Heading rule.
- URI
- Defines a text that represents a URL link.
- This element property can be used under the Link rule.
- Line Height
- Splits the entire text into blocks that resemble lists.
- This element property can be used under the Block List, Block Paragraphs, and Block End Note List rules.
- List Item Regex
- This regex value is used to check if a new list item begins.
- This element property can be used under the Block Paragraphs and Block End Note List rules.
- Note Regex
- This regex value marks or tags the note part of a list item.
- This element property can be used under the Block Paragraphs and Block End Note List rules.
- Label Regex
- This value marks or tags the label part of a list item.
- This element property can be used under the Block Paragraphs and Block End Note List rules.
- Single Line Regex
- This regex value checks if a line should be processed as a single tagged item.
- This element property can be used under the Block Paragraphs rule.
- Single Line Contains
- Fixed value text that checks if a line should be processed as a single tagged item.
- This element property can be used under the Block End Note List rule.
- Version
- Defines a value used as the control file version.
- This element property can be used under the Document rule.
- Export
- If the value is set, the logging rule is also exported in the control file.
- This element property can be used under the Log Entry rule.
- Log Entry
- Text used for logging into the console for debugging purposes.
- This element property can be used under the Log Entry rule.
- Whitespace Recognition
- Defines the space width in a PDF. Select either Revision 1 or Revision 2 according to your needs.
- This element property can be used under the Document rule.
- Actual Text
- Specifies the intended reading content for screen readers. It improves accessibility by ensuring screen readers interpret and read the text correctly, regardless of how it appears visually in the PDF.
- Use this field to add an actual text for all the rules mentioned below.
- You can enter any custom text that you want.
- You can use variables values: specified with a "$" character in front (example: $myVariable).
- This element property can be used under the following rules: Paragraph, Heading, Note, Label, Reference, Link, Table Data, Row Header, Column Header.
- Inline Actual Text
- This property allows you to insert a short, accessible replacement text within the content of a tagged PDF element. It overrides the visible text for accessibility purposes ensuring better understanding. Once you enable this option, you will be able to use these options:
- Matching regex that refers to a regular expression pattern that is used to identify specific text elements within the content.
- Text to replace that specifies the replacement text that will be used when a matching regular expression pattern is found.
- New actual text that defines the replacement text that is assigned as the updated text for a tagged element.
- Bookmarks from headings
- Specifies the option of generating PDF bookmarks automatically based on the document's heading structure. It helps you navigate the exported PDF efficiently using a hierarchical outline.
- To see the bookmarks created from the headings in an exported PDF, first insert a Heading rule on a specific location, then select your Heading Level. This operation indicates the rank of importance of a heading within a document's structure.