Műszaki cikk

Taggelt PDF struktúrafák létrehozása Delphi-ben PDFlibPas-szal

Ez a magyar cikk a(z) Tagged PDF Structure Trees in Delphi with PDFlibPas magyarul témát foglalja össze olyan csapatoknak, amelyek Delphi, C++Builder, Lazarus/FPC és losLab komponensek köré építenek üzleti megoldásokat

A hangsúly a gyakorlati döntéseken, a buktatókon és az ellenőrzési pontokon van, hogy a megoldás éles környezetben is megbízható legyen

Mikor hasznos ez a téma

A téma akkor fontos, amikor a dokumentumkezelésnek éles környezetben is ismételhetőnek, mérhetőnek és támogatásbarátnak kell lennie, nem csak egy bemutatóprojektben

  • Rögzítse a bemeneti fájlokat, jogosultságokat, várt kimenetet és hibautakat
  • A terméknevek, API-nevek és fájlnevek maradjanak pontosan az eredeti alakjukban
  • Őrizzen meg rövid regressziós fájlokat és naplókat a későbbi támogatáshoz

Gyakorlati munkafolyamat

Az angol forrás fő pontjai alapján érdemes a megvalósítást áttekinthető Delphi-munkafolyamattá alakítani. A forrás kiemelt témái:

  • A kód módosítása előtt rögzítse a használati esetet
  • Az eredményt kis tesztfájlokkal ellenőrizze
  • Az API-neveket és literal értékeket hagyja változatlanul

Először egy kisméretű, reprodukálható példát készítsen, majd ehhez kapcsolja a komponenshívásokat, a hibakezelést és a felhasználói üzeneteket. A dokumentumformátumoknál a részletek döntik el, hogy a megoldás megbízható-e

API- és kódhorgonyok

var
  Lib: TPDFlib;
begin
  Lib := TPDFlib.Create;
  try
    Lib.SetOrigin(1);                          // top-left origin
    Lib.SetPDFUAMode('en-US');                 // bumps the save version to PDF 1.7
    Lib.SetInformation(1, 'Service Manual');   // /Title is mandatory for PDF/UA
    Lib.AddRoleMap('ManualTitle', 'H1');       // custom type -> standard role
    Lib.AddStandardFont(4);
    Lib.SetTextSize(18);
    Lib.BeginTagEx2('ManualTitle', '', '', 'en-US', '', 'h1-cover', '');
    Lib.DrawText(72, 96, 'Service Manual');
    Lib.EndTag;
    Lib.BeginTag('Figure', 'Exploded view of the gearbox assembly', '');
    Lib.AddImageFromFile('gearbox.png', 0);
    Lib.EndTag;
    Lib.BeginArtifact('Layout');               // page decoration: excluded from reading
    // ... draw rules and background tint ...
    Lib.EndArtifact;
    Lib.SaveToFile('manual.pdf');
  finally
    Lib.Free;
  end;
end;
Lib.BeginTag('Table', '', '');
Lib.BeginTag('TR', '', '');
Lib.BeginTagEx2('TH', '', '', '', '', 'col-part', '');
Lib.SetStructElemScope('Column');          // valid only while this TH is open
Lib.DrawText(72, 120, 'Part');
Lib.EndTag;
Lib.BeginTagEx2('TH', '', '', '', '', 'col-torque', '');
Lib.SetStructElemScope('Column');
Lib.SetStructElemColSpan(2);               // header spans the value and unit columns
Lib.DrawText(200, 120, 'Tightening torque');
Lib.EndTag;
Lib.EndTag;
Lib.BeginTag('TR', '', '');
Lib.BeginTag('TD', '', '');
Lib.SetStructElemHeaders('col-part');      // explicit binding for irregular tables
Lib.DrawText(72, 140, 'M8 flange bolt');
Lib.EndTag;
Lib.EndTag;
Lib.EndTag; // Table

Ellenőrzés kiadás előtt

Kiadás előtt ellenőrizze a kimeneti fájlt, a metaadatokat, a titkosítást, a renderelést vagy az importált állapotot, a cikk témájának megfelelően. Jegyezze fel az eszközverziót, a komponensverziót, a tesztfájlt és a megfigyelt eredményt

A terméknevek, API-nevek és kódrészletek változatlanok maradnak, hogy a fejlesztők könnyen összevethessék őket a dokumentációval és a forráskóddal

Kapcsolódó olvasnivaló

Kiegészítő megjegyzések

Ez a kiegészítés a rövid verziót egy használhatóbb munkalappá bővíti, miközben továbbra is illeszkedik a Building Tagged PDF Structure Trees in Delphi with PDFlibPas és az angol alapcikk technikai keretéhez. A szövegnek világosan meg kell mutatnia, milyen bemenettől indul a téma, milyen kimenet a cél, és melyik ellenőrzési ponton kell a viselkedést visszaigazolni

Az átdolgozásnál a döntési sorrend számít: először az adat alakja, utána a módosítás határa, majd az API-függőségek, végül a tényleges viselkedés. Ha a cikk több lehetőséget említ, érdemes azt is leírni, melyik út védhetőbb karbantartás, támogatás és hibareprodukció szempontjából

Minden code block, fájlnév, API-név és literal érték maradjon változatlan. A környező magyarázat lehet részletesebb, de a példakódnak ugyanazt a pontos referenciát kell adnia, hogy az olvasó közvetlenül összevesse a saját Delphi-, C++Builder- vagy Lazarus/FPC-projektjével

A validation részben szerepeljen kis mintaállomány, kimenet-összevetés, valamint component- vagy validator-verzió rögzítése. Ha bug fixről vagy migrációról van szó, a reprodukciós útvonalat, az első megfigyelt állapotot és az ellenőrzési pontot is világosan kell leírni, hogy a regression később ne találgatás legyen

Az ilyen bővítés azért hasznos, mert a lap nem csak első olvasásra marad értelmezhető: reviewernek döntési háttér, supportnak vizsgálati kontextus, a karbantartó csapatnak pedig hivatkozható megjegyzés lesz a következő módosítások előtt

  • A termék-, API-, fájl- és literal neveket ne módosítsd
  • A code blockot, ha van, hagyd érintetlenül
  • A validationhez adj mintafájlt és összevethető kimenetet
  • A döntési sorrendet ne csak röviden, hanem érthetően írd le