|
If no Role Map is specified for the document, any tags that do not match a standard structure type will be treated as paragraphs.
|
|
If name is not set to Document within the PDF Tag Control Stream, or the required name is not mapped to the Document role in the Role Map Stream, PTC ALD will create its own default Document element.
|
|
If the text content of a frame is set to repeat, the structure will automatically be terminated once the frame’s content is printed.
|
Parameter
|
Description
|
name
|
Required
The name of the Structure Element instance in the control stream. This option is used to delineate tag definitions with the control stream.
The value of this parameter can be a name defined in the in the document’s PDF Role Map, or one of the predefined structure types.
|
Parameter
|
Description
|
type
|
Optional
The type of artifact that this property list describes:
• Pagination
• Layout
• Page
• Background (PDF1.7)
|
subtype
|
Optional (PDF 1.7)
The subtype of the artifact. This entry applies only when the type entry has a value of Pagination.
Valid values are:
• Header
• Footer
• Watermark
|
bbox
|
Optional
This entry only applies when the type entry has a value of Background.
The value for this entry is a comma delimited list of four numbers in default user space units. The numbers provide the coordinates of the left, bottom, right, and top edges, respectively, of the artifact’s bounding box.
A bounding box is the rectangle that completely encloses its visible extent.
|
attached
|
Optional
This entry only applies for pagination and full page background artifacts.
The value for this entry is a comma delimited list of name objects containing one to four of the locations Top, Bottom, Left, and Right. The locations specify the edges of the page, if any, to which the artifact is logically attached.
|
Parameter
|
Description
|
lang
|
Optional (PDF 1.4)
The language identifier specifying the natural language for all text in the structure element, except where overridden by language specifications for nested structure elements.
The value must be a two character ISO 639 language code, for example EN, DE, JA. It may optionally be followed by a hyphen character and a two character ISO 3166 country code, for example EN-US, EN-GB.
|
actualText
|
Optional (PDF 1.4)
Text that is an exact replacement for the structure element and its children.
|
altText
|
Optional
An alternate description of the structure element and its children in human readable form.
|
expandedtext
|
Optional (PDF 1.5)
The expanded form of an abbreviation.
|
title
|
Optional
A text string in human readable form that represents the title of the structure element.
This parameter is not valid for Inline Level Structural Element Roles (ILSEs) Span, Quote, Note, Reference, BibEntry, Code, RB, RT, RP, WT, and WP.
Refer to Support for Tagged PDF Output in this topic for descriptions of supported ILSEs.
|
colSpan
|
Optional
The number of columns in the enclosing table that are spanned by the cell.
This parameter is only valid for the Block Level Structural Element Roles (BLSEs) TD and TH.
Refer to Support for Tagged PDF Output in this topic for descriptions of supported BLSEs.
|
rowSpan
|
Optional
The number of rows in the enclosing table that are spanned by the cell.
This parameter is only valid for the Block Level Structural Element Roles (BLSEs) TD and TH.
|
inline
|
Optional
The value of this parameter can be 0 or 1.
• 0 (default) - elements are written as Structure Elements
• 1 - elements are written inline
This parameter is only valid for the Inline Level Structural Element Roles (ILSEs) Span, Quote, Note, Reference, BibEntry, and Code.
|
Parameter
|
Description
|
Artifact
|
Objects that are not typically part of the desired content but information rated in the course of producing the output document, e.g. headers and footers, watermarks, etc.
Information contained within an Artifact will not appear in a document’s logical structure.
|
Parameter
|
Description
|
Document
|
A complete document. This is the root element of any structure tree containing multiple parts or multiple articles.
|
Part
|
A large scale division of a document
This type of element is appropriate for grouping articles or sections.
|
Art
|
(Article) A relatively self-contained body of text constituting a single narrative or exposition
Articles should not contain other articles as constituent elements.
|
Sect
|
(Section) A container for grouping related content elements
For example, a section might contain a heading, several introductory paragraphs, and two or more other child sections nested within it as subsections.
|
Div
|
(Division) A generic block-level element or group of elements
|
BlockQuote
|
(Block quotation) A portion of text consisting of one of more paragraphs attributed to someone other than the author of the surrounding text
|
Caption
|
A brief portion of text describing a table or figure
|
TOC
|
Table of contents
|
TOC1
|
Table of contents item
|
Index
|
Index
|
NonStruct
|
(Non-structural element) A grouping element having no inherent structural significance
It is used solely for grouping purposes.
|
Private
|
A grouping element containing private content belonging to the application producing it
|
Parameter
|
Description
|
P
|
Paragraph
|
H
|
Heading
|
H1–H6
|
Headings with specific levels, up to 6
|
L
|
List
|
LI
|
List item
|
Lbl
|
Label for a list item, e.g. number and punctuation
|
LBody
|
List body, i.e. the descriptive content of a list item
|
Table
|
Table
|
THead
|
Table header row group
|
TBody
|
Table body row group
|
TFoot
|
Table footer row group
|
TR
|
Table row
|
TD
|
Table data / cell
|
TH
|
Table header cell
|
Parameter
|
Description
|
Span
|
A generic inline portion of text having no particular inherent characteristics
|
Quote
|
(Quotation) An inline portion of text attributed to someone other than the author of the surrounding text
|
Note
|
An item of explanatory text, such as a footnote or an endnote, that is referred to from within the body of the document
|
Reference
|
A citation to content elsewhere in the document
|
BibEntry
|
(Bibliography entry) A reference identifying the external source of some cited content
|
Code
|
A fragment of computer program text
|
Link
|
An association between a portion of the ILSE’s content and a corresponding link annotation or annotations
|
Annot
|
(Annotation) An association between a portion of the ILSE’s content and a corresponding PDF annotation
|
Ruby
|
A sidenote (annotation) written in smaller text size and placed adjacent to the base text to which it refers
|
RB
|
(Ruby base text) The full size text to which the ruby annotation is applied
|
RT
|
(Ruby annotation text) The smaller size text that is placed adjacent to the ruby base text
|
RP
|
(Ruby punctuation) Punctuation surrounding the ruby annotation
|
Warichu
|
A comment or annotation in a smaller text size that is formatted onto two smaller lines within the height of the containing text line and placed following (inline) the base text to which it refers
|
WT
|
(Warichu text) The smaller size text of a warichu comment that is formatted in two lines and placed between surrounding WP elements
|
WP
|
(Warichu punctuation) The punctuation that surrounds the WT text
|
Parameter
|
Description
|
Figure
|
An item of graphical content
|
Formula
|
A mathematical formula
|
Form
|
A widget annotation representing an interactive form field
|