THotPDF.AddStructureElement ja Tagged PDF -apuohjelmat

Tämä sivu dokumentoi nykyiset THotPDF-apuohjelmat Tagged PDF -tuotantoon ja PDF/UA-rakennepuuhun. Kooditunnisteet vastaavat julkisia määrittelyjä

Nykyinen Delphi-rajapinta

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;

Rakenne-elementtien luonti

AddStructureElement luo /StructElem-sanakirjan ja lisää sen Parent-elementin lapseksi; nil liittää sen rakennepuun juuren alle. PageIndex sitoo elementin sivuun /Pg-avaimella, ja negatiivinen arvo jättää sidoksen pois. MCID arvosta nolla ylöspäin yhdistää sivun marked-content-jakson elementtiin ja rekisteröi sen dokumentin /ParentTree-rakenteeseen. Kuuden argumentin overload lisää /Alt-kuvauksen ja /ActualText-korvaustekstin, ja seitsemän argumentin overload kirjoittaa lisäksi dokumentissa yksilöllisen /ID-arvon

Vakiomuotoiset rakennetyypit (Table 333)

THPDFStandardStructureType-overload on tyyppiturvallinen sisäänkäynti: tuotettu /S-roolinimi on aina yksi ISO 32000-1 §14.8.4 Table 333 -taulukon vakiotyypeistä, jolloin avoimen merkkijonoroolin kirjoitusvirheet ja kirjainkoon riskit vältetään

• Ryhmittely: sstDocument, sstPart, sstArt, sstSect, sstDiv, sstBlockQuote, sstCaption, sstTOC, sstTOCI, sstIndex, sstNonStruct, sstPrivate
• Lohkotaso: sstH, sstH1-sstH6, sstP, sstL, sstLI, sstLbl, sstLBody, sstTable, sstTR, sstTH, sstTD, sstTHead, sstTBody, sstTFoot
• Sisätekstin taso: sstSpan, sstQuote, sstNote, sstReference, sstBibEntry, sstCode, sstLink, sstAnnot
• Ruby ja Warichu: sstRuby, sstRB, sstRT, sstRP, sstWarichu, sstWT, sstWP
• Kuvitus: sstFigure, sstFormula, sstForm

Huomaa pienet kirjaimet tunnisteissa sstLbl / sstLBody: varsinaiset PDF-roolinimet ovat Lbl ja LBody. Mukautetut roolinimet voidaan silti antaa AnsiString-overloadilla ja mapata vakioksi AddStructRoleMap-kutsulla

Esimerkki

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', '');

Rakenneattribuutit ja roolien mappaus

SetStructureElementLanguage kirjoittaa BCP-47-muotoisen /Lang-ylikirjoituksen, SetStructureElementExpansionText kirjoittaa /E-laajennustekstin, SetStructureElementTitle kirjoittaa luettavan /T-otsikon ja AddStructRoleMap mapittaa mukautetut rakenneroolit takaisin PDF-vakiorooleihin. StandardStructureTypeToName palauttaa PDF-roolinimen THPDFStandardStructureType-arvolle, ja IsStandardStructureType tarkistaa onko roolinimi vakio

Korkean tason apuohjelmat tagged-sisällölle

EmitTaggedHeading, BeginTaggedList, EmitTaggedListItem, BeginTaggedTable, AddTaggedTableRow, EmitTaggedTableHeader, EmitTaggedTableCell, BeginTaggedFigure, EndTaggedFigure ja RegisterAnnotForStructure kattavat tavallisen PDF/UA-kytkennän otsikoille, listoille, taulukoille, kuvioille ja annotaatioille ilman MCID-arvojen käsinhallintaa

Tyypillinen työnkulku

Ota tagged-tulostus tai PDFUACompliance käyttöön, luo juurirakenne-elementti, tuota semanttinen sisältö apuohjelmilla ja sulje jokainen aloitettu tagged-content- tai kuvioketju ennen EndDoc-kutsua