Технічна стаття

Технічна стаття: Tagged PDF Structure Trees in Delphi with PDFlibPas українською

Ця локалізована версія зосереджується на Building Tagged PDF Structure Trees in Delphi with PDFlibPas і використовує оновлену англійську статтю як технічну основу для команд Delphi, PDF і документального ПЗ

Сторінка перетворює оновлену базову статтю на конкретні контрольні точки для проєктування, реалізації та перевірки

Що синхронізовано з англійської статті

Англійський базовий матеріал розширено практичним контекстом, технічними рішеннями та конкретними прикладами, тому цю сторінку слід читати як робочий посібник, а не короткий огляд

Важливі розділи оновленої базової статті:

  • Спочатку використовуйте невеликі відтворювані вхідні файли
  • Залишайте назви продуктів, API, файлів і literal-значення без змін
  • Зберігайте результат валідатора й відомості про версії разом зі створеним зразком

Практичні рішення для реалізації

Починайте з типу файлу, очікуваного результату та стану помилки, який має побачити користувач. Далі прив'яжіть кожен виклик API до перевірного результату, щоб валідація, журнали та підтримка могли відтворити сценарій клієнта

  • Спочатку використовуйте невеликі відтворювані вхідні файли
  • Залишайте назви продуктів, API, файлів і literal-значення без змін
  • Зберігайте результат валідатора й відомості про версії разом зі створеним зразком

Код і точки API

Приклади коду залишено без змін, щоб розробники могли напряму порівняти їх із проєктами Delphi, C++Builder і Lazarus/FPC

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

Перевірка перед випуском

Перевіряйте вихідний файл тими самими інструментами, якими користуватиметься клієнт або архів. Записуйте версію компонента, тестові дані, версію валідатора та спостережений результат, щоб пізнішу регресію можна було точно відстежити

Додаткові нотатки

Це доповнення перетворює коротку версію на корисніший робочий матеріал і водночас залишається узгодженим із Building Tagged PDF Structure Trees in Delphi with PDFlibPas та технічною базою англійської статті. Текст має чітко показувати, з якого типу вхідних даних починається тема, який результат очікується і в якій точці поведінку потрібно підтвердити через validation.

Під час переписування важливий порядок рішень: спочатку форма даних, потім межа зміни, далі залежності API, і лише після цього кінцева поведінка. Якщо стаття згадує кілька варіантів, варто пояснити, який шлях краще захищений для maintenance, support і відтворення проблеми.

Будь-який code block, назва файлу, назва API та literal-значення мають залишатися без змін. Навколишнє пояснення може бути ширшим, але приклад коду повинен бути точною опорою, щоб читач міг напряму порівняти його зі своїм Delphi-, C++Builder- або Lazarus/FPC-проєктом.

У розділі validation слід згадати малий файл-зразок, порівняння результату та фіксацію версії component або validator. Якщо сторінка описує bug fix чи migration, маршрут відтворення, початковий стан і точку підтвердження потрібно описати явно, щоб будь-який regression можна було відстежити без здогадок.

Таке розширення робить сторінку корисною не лише після першого прочитання: для reviewer це пояснення рішення, для support це діагностичний контекст, а для команди супроводу це помітка, на яку можна спертися перед наступними змінами.

  • Не змінюй назви продуктів, API, файлів і literal-значення
  • Code block, якщо є, лишай без змін
  • Пояснюй validation через зразок і порівнюваний результат
  • Показуй порядок рішень, а не лише дуже короткий підсумок