THotPDF.AddStructureElement a pomocné funkcie pre Tagged PDF

Táto stránka dokumentuje aktuálne pomocné funkcie THotPDF pre Tagged PDF a stromy štruktúry PDF/UA. Identifikátory kódu zodpovedajú verejným deklaráciám

Aktuálne rozhranie Delphi

function AddStructureElement(const Role: AnsiString; Parent: THPDFDictionaryObject;
  PageIndex: Integer = -1; MCID: Integer = -1): THPDFDictionaryObject; overload;
function AddStructureElement(const Role: AnsiString; Parent: THPDFDictionaryObject;
  PageIndex: Integer; MCID: Integer;
  const AltText: AnsiString; const ActualText: AnsiString): THPDFDictionaryObject; overload;
function AddStructureElement(const Role: AnsiString; Parent: THPDFDictionaryObject;
  PageIndex: Integer; MCID: Integer;
  const AltText: AnsiString; const ActualText: AnsiString;
  const IDStr: AnsiString): THPDFDictionaryObject; overload;
function AddStructureElement(T: THPDFStandardStructureType; Parent: THPDFDictionaryObject;
  PageIndex: Integer = -1; MCID: Integer = -1): THPDFDictionaryObject; overload;

procedure SetStructureElementLanguage(Elem: THPDFDictionaryObject; const Lang: AnsiString);
procedure SetStructureElementExpansionText(Elem: THPDFDictionaryObject; const ExpansionText: AnsiString);
procedure SetStructureElementTitle(Elem: THPDFDictionaryObject; const Title: AnsiString);
procedure AddStructRoleMap(const SourceRole: AnsiString; const TargetRole: AnsiString);

function BeginTaggedContent(const Role: AnsiString; Parent: THPDFDictionaryObject;
  const Lang: AnsiString = ''; const Alt: AnsiString = '';
  const ActualText: AnsiString = ''; const ExpansionText: AnsiString = ''): THPDFDictionaryObject;
procedure EndTaggedContent;

function EmitTaggedHeading(Level: Integer; Parent: THPDFDictionaryObject; X, Y: Single; const Text: WideString): THPDFDictionaryObject;
function BeginTaggedList(Parent: THPDFDictionaryObject; const NumberingStyle: AnsiString = 'None'): THPDFDictionaryObject;
function EmitTaggedListItem(ListElem: THPDFDictionaryObject; LblX, LblY: Single; const LabelText: WideString; BodyX, BodyY: Single; const BodyText: WideString): THPDFDictionaryObject;
function BeginTaggedTable(Parent: THPDFDictionaryObject): THPDFDictionaryObject;
function AddTaggedTableRow(TableElem: THPDFDictionaryObject): THPDFDictionaryObject;
function EmitTaggedTableHeader(TRElem: THPDFDictionaryObject; X, Y: Single; const Text: WideString; const Scope: AnsiString): THPDFDictionaryObject;
function EmitTaggedTableCell(TRElem: THPDFDictionaryObject; X, Y: Single; const Text: WideString): THPDFDictionaryObject;
function BeginTaggedFigure(Parent: THPDFDictionaryObject; const AltText: AnsiString; const BBox: array of Single): THPDFDictionaryObject;
procedure EndTaggedFigure;
procedure RegisterAnnotForStructure(AnnotDict: THPDFDictionaryObject; StructElem: THPDFDictionaryObject);

function StandardStructureTypeToName(T: THPDFStandardStructureType): AnsiString;
function IsStandardStructureType(const Name: AnsiString): Boolean;

Vytváranie prvkov štruktúry

AddStructureElement vytvorí slovník /StructElem a pridá ho ako potomka Parent; odovzdajte nil, ak ho chcete pripojiť pod koreň stromu štruktúry. PageIndex prepojí prvok so stránkou cez /Pg, zatiaľ čo záporná hodnota toto prepojenie vynechá. MCID, keď je nula alebo väčšie, spojí marked-content sekvenciu na stránke s prvkom a zaregistruje ju v dokumentovom /ParentTree. Overload so šiestimi argumentmi pridá /Alt pre alternatívny opis a /ActualText pre náhradný text pri kopírovaní. Overload so siedmimi argumentmi zapíše aj v dokumente jedinečné /ID

Štandardné typy štruktúry (Table 333)

Overload s THPDFStandardStructureType je type-safe vstupný bod: zapísaná rola /S vždy patrí medzi štandardné typy štruktúry podľa ISO 32000-1 §14.8.4 Table 333, čím sa znižuje riziko preklepov alebo rozdielov veľkosti písmen v otvorenom textovom názve role

• Zoskupenie: sstDocument, sstPart, sstArt, sstSect, sstDiv, sstBlockQuote, sstCaption, sstTOC, sstTOCI, sstIndex, sstNonStruct, sstPrivate
• Bloková úroveň: sstH, sstH1-sstH6, sstP, sstL, sstLI, sstLbl, sstLBody, sstTable, sstTR, sstTH, sstTD, sstTHead, sstTBody, sstTFoot
• Inline úroveň: sstSpan, sstQuote, sstNote, sstReference, sstBibEntry, sstCode, sstLink, sstAnnot
• Ruby a Warichu: sstRuby, sstRB, sstRT, sstRP, sstWarichu, sstWT, sstWP
• Ilustrácia: sstFigure, sstFormula, sstForm

Všimnite si malé písmená v sstLbl / sstLBody: skutočné názvy PDF rolí sú Lbl a LBody. Vlastné názvy rolí možno stále odovzdať cez overload AnsiString a namapovať späť na štandardnú rolu pomocou AddStructRoleMap

Príklad

PDF.PDFUACompliance := pdfuaPDFUA1;
PDF.BeginDoc;
Doc := PDF.AddStructureElement(sstDocument, nil);
H1 := PDF.AddStructureElement(sstH1, Doc);
PDF.SetStructureElementLanguage(Doc, 'en-US');
PDF.SetStructureElementTitle(H1, 'Annual Report');
// Alt / ActualText ride on the AnsiString overload; reuse the
// spec-prescribed role name via StandardStructureTypeToName
Fig := PDF.AddStructureElement(StandardStructureTypeToName(sstFigure), Doc, 0, -1,
  'Sales by quarter: Q1 4.2M, Q2 5.1M, Q3 5.8M, Q4 6.4M', '');

Atribúty štruktúry a mapovanie rolí

SetStructureElementLanguage zapisuje BCP-47 override pre /Lang, SetStructureElementExpansionText zapisuje rozširujúci text /E, SetStructureElementTitle zapisuje čitateľný titulok /T a AddStructRoleMap mapuje vlastné štruktúrne role späť na štandardné PDF role. StandardStructureTypeToName vráti názov PDF role pre hodnotu THPDFStandardStructureType a IsStandardStructureType overí, či je názov role štandardný

Vysokoúrovňové pomocné funkcie pre tagged obsah

EmitTaggedHeading, BeginTaggedList, EmitTaggedListItem, BeginTaggedTable, AddTaggedTableRow, EmitTaggedTableHeader, EmitTaggedTableCell, BeginTaggedFigure, EndTaggedFigure a RegisterAnnotForStructure pokrývajú bežné PDF/UA prepojenie nadpisov, zoznamov, tabuliek, obrázkov a anotácií bez ručnej správy MCID

Typický pracovný postup

Zapnite tagged výstup alebo PDFUACompliance, vytvorte koreňový prvok štruktúry, použite pomocné funkcie na sémantický obsah a pred EndDoc zatvorte každú začatú tagged-content alebo figure sekvenciu