[Raku PDF Project] / [PDF-Class Module]
an entry in the StructTree See also PDF::StructTreeRoot
(Optional) The type of PDF object that this dictionary describes; if present, shall be StructElem for a structure element.
(Required) The structure type, a name object identifying the nature of the structure element and its role within the document, such as a chapter, paragraph, or footnote
(Optional) The element identifier, a byte string designating this structure element. The string shall be unique among all elements in the document’s structure hierarchy. The IDTree entry in the structure tree root defines the correspondence between element identifiers and the structure elements they denote.
Optional; PDF 2.0) An array containing zero, one or more indirect references to structure elements. A Ref identifies the structure element or elements to which the item of content, contained within this structure element, refers (e.g. footnotes, endnotes, sidebars, etc.).
(Optional; shall be an indirect reference) A page object representing a page on which some or all of the content items designated by the K entry shall be rendered.
(Required; shall be an indirect reference) The structure element that is the immediate parent of this one in the structure hierarchy.
(Optional) The children of this structure element. The value of this entry may be one of the following objects or an array consisting of one or more of the following objects:
(Optional) A single attribute object or array of attribute objects associated with this structure element. Each attribute object shall be either a dictionary or a stream. If the value of this entry is an array, each attribute object in the array may be followed by an integer representing its revision number.
(Optional) An attribute class name or array of class names associated with this structure element. If the value of this entry is an array, each class name in the array may be followed by an integer representing its revision number.
(Optional) The current revision number of this structure element. The value shall be a non-negative integer. Default value: 0.
(Optional) The title of the structure element, a text string representing it in human-readable form. The title should characterize the specific structure element, such as ‘Chapter 1’, rather than merely a generic element type, such as ‘Chapter’.
(Optional; PDF 1.4) A language identifier specifying the natural language for all text in the structure element except where overridden by language specifications for nested structure elements or marked content. If this entry is absent, the language (if any) specified in the document catalogue applies.
(Optional) An alternate description of the structure element and its children in human-readable form, which is useful when extracting the document’s contents in support of accessibility to users with.
(Optional; PDF 1.5) The expanded form of an abbreviation.
(Optional; PDF 1.4) Text that is an exact replacement for the structure element and its children. This replacement text (which should apply to as small a piece of content as possible) is useful when extracting the document’s contents in support of accessibility to users with disabilities or for other purposes
(Optional; PDF 2.0) An array of one or more file specification dictionaries (7.11.3, “File specification dictionaries”) which denote the associated files for the entire structure tree.
Optional; PDF 2.0) An indirect reference to a namespace dictionary defining the namespace this element belongs to
(Optional; PDF 2.0) Property for a structure element that indicates the phonetic alphabet used by a Phoneme property. Applies to the structure element and its children, except where overridden by a child structure element.
(Optional; PDF 2.0) Property for a structure element that may be used as pronunciation hint. It is an exact replacement for content enclosed by the structure element and its children.