บทความเทคนิค

บทความเทคนิค: Tagged PDF Structure Trees in Delphi with PDFlibPas ภาษาไทย

ฉบับแปลนี้เจาะประเด็น Building Tagged PDF Structure Trees in Delphi with PDFlibPas โดยยึดบทความภาษาอังกฤษที่อัปเดตแล้วเป็นฐานอ้างอิงทางเทคนิคสำหรับทีม Delphi, PDF และซอฟต์แวร์เอกสาร

หน้านี้แปลงบทความฐานที่อัปเดตแล้วให้เป็นจุดตรวจสอบที่ใช้ได้จริงสำหรับการออกแบบ การนำไปใช้ และการตรวจสอบผล

เนื้อหาที่ซิงก์จากบทความภาษาอังกฤษ

บทความต้นฉบับภาษาอังกฤษได้รับการขยายด้วยบริบทการใช้งานจริง จุดตัดสินใจเชิงเทคนิค และตัวอย่างที่เป็นรูปธรรม หน้านี้จึงควรใช้เป็นคู่มือทำงาน ไม่ใช่บทสรุปสั้น

หัวข้อสำคัญในบทความฐานที่อัปเดตแล้ว:

  • ใช้ไฟล์นำเข้าขนาดเล็กที่ทำซ้ำได้ก่อนเชื่อมฟีเจอร์กับข้อมูลจริง
  • คงชื่อผลิตภัณฑ์ ชื่อ API ชื่อไฟล์ และค่า literal ไว้ตามเดิม
  • เก็บผล validator และข้อมูลเวอร์ชันไว้พร้อมไฟล์ตัวอย่างที่สร้างขึ้น

ทางเลือกสำหรับการนำไปใช้จริง

เริ่มจากชนิดไฟล์ ผลลัพธ์ที่ต้องการ และสถานะข้อผิดพลาดที่ผู้ใช้ควรเห็น จากนั้นผูกการเรียก API แต่ละครั้งกับผลลัพธ์ที่ตรวจสอบได้ เพื่อให้การตรวจสอบ log และงานสนับสนุนจำลองกรณีลูกค้าได้

  • ใช้ไฟล์นำเข้าขนาดเล็กที่ทำซ้ำได้ก่อนเชื่อมฟีเจอร์กับข้อมูลจริง
  • คงชื่อผลิตภัณฑ์ ชื่อ API ชื่อไฟล์ และค่า literal ไว้ตามเดิม
  • เก็บผล validator และข้อมูลเวอร์ชันไว้พร้อมไฟล์ตัวอย่างที่สร้างขึ้น

โค้ดและจุดอ้างอิง 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

การตรวจสอบก่อนเผยแพร่

ตรวจไฟล์ผลลัพธ์ด้วยเครื่องมือเดียวกับที่ลูกค้าหรือระบบเก็บถาวรใช้ บันทึกเวอร์ชันคอมโพเนนต์ ข้อมูลทดสอบ เวอร์ชัน validator และผลที่สังเกตได้เพื่อไล่รอย regression ได้ชัดเจน

อ่านเพิ่มเติม

หมายเหตุเพิ่มเติม

ส่วนเสริมนี้ทำให้เวอร์ชันสั้นกลายเป็นคู่มือที่ใช้งานได้จริงมากขึ้น และยังคงสอดคล้องกับ Building Tagged PDF Structure Trees in Delphi with PDFlibPas รวมถึงฐานทางเทคนิคของบทความภาษาอังกฤษ เนื้อหาควรแสดงให้ชัดว่าเรื่องเริ่มจาก input แบบใด คาดหวัง output อะไร และต้องยืนยันพฤติกรรมตรงจุดไหนผ่าน validation

ลำดับของการตัดสินใจสำคัญมาก: เริ่มจากรูปแบบข้อมูล ต่อด้วยขอบเขตของการเปลี่ยนแปลง จากนั้นคือ dependency ของ API แล้วจึงถึงพฤติกรรมสุดท้าย หากบทความพูดถึงหลายทางเลือก ก็ควรอธิบายด้วยว่าทางไหนเหมาะกับ maintenance, support และการทำซ้ำปัญหามากกว่า

code block ชื่อไฟล์ ชื่อ API และค่า literal ทุกอย่างต้องคงเดิม คำอธิบายรอบ ๆ จะขยายได้ แต่ตัวอย่างโค้ดต้องเป็นจุดอ้างอิงที่แม่นยำ เพื่อให้ผู้อ่านเทียบกับโปรเจ็กต์ Delphi, C++Builder หรือ Lazarus/FPC ของตนได้ตรง ๆ

ส่วน validation ควรพูดถึงไฟล์ตัวอย่างขนาดเล็ก การเทียบผลลัพธ์ และการบันทึก version ของ component หรือ validator ถ้าหน้านี้อธิบาย bug fix หรือ migration ต้องระบุเส้นทางการทำซ้ำ สถานะเริ่มต้นที่เห็น และจุดยืนยันให้ชัด เพื่อให้ติดตาม regression ได้โดยไม่ต้องเดา

การขยายแบบนี้ทำให้หน้ายังมีประโยชน์หลังอ่านครั้งแรก ทั้งสำหรับ reviewer ในฐานะคำอธิบายเหตุผล สำหรับ support ในฐานะบริบทการวิเคราะห์ และสำหรับทีมดูแลในฐานะบันทึกอ้างอิงก่อนการเปลี่ยนแปลงครั้งถัดไป

  • อย่าเปลี่ยนชื่อผลิตภัณฑ์ API ไฟล์ หรือ literal
  • ถ้ามี code block ให้คงไว้ตามเดิม
  • อธิบาย validation ด้วยไฟล์ตัวอย่างและผลลัพธ์ที่เทียบกันได้
  • แสดงลำดับการตัดสินใจให้ชัด ไม่ใช่แค่สรุปสั้นเกินไป