libthai 0.1.6, debian doc-base

ไม่ได้ blog ไปหนึ่งอาทิตย์เต็มๆ เพราะพยายามทำ libthai ตัวใหม่อยู่ โดยในรุ่นนี้ มีการแก้ compiler warning พร้อมๆ กับแพกเกจต่างๆ ที่ upload ขึ้น debian เนื่องจาก buildd ของ debian มันช่วย build package ในแพลตฟอร์มอื่นนอกเหนือจาก i386 ที่เรา upload ให้โดยอัตโนมัติ ทำให้พบ portability issue จำนวนหนึ่ง ก็เอามาแก้ ซึ่งสำหรับ libthai เอง ไม่ได้มี portability issue อะไรมากมาย นอกเสียจาก warning เล็กๆ น้อยๆ เรื่อง signed/unsigned กับขาด header file

แต่การเปลี่ยนแปลงที่เห็นได้ชัดที่สุดในรุ่นนี้ คงเป็นเรื่อง auto-generated document โดยใช้ doxygen ก็นั่งตกแต่ง comment ในฟังก์ชันต่างๆ ให้อยู่ในรูปแบบที่เหมาะสม และย้ายเนื้อหา manpage ที่คุณพูลลาภเคยเขียนไว้ เข้ามารวมด้วย แล้วก็ใช้ doxygen สร้างเอกสาร HTML และ manpage ในคราวเดียว และในระหว่างที่ตรวจแก้ ปรากฏว่าพบฟังก์ชันที่ขาดหาย ก็เขียนเพิ่มเข้าไปด้วย

แล้วก็ได้เป็น libthai 0.1.6 พร้อมทั้ง แปะประกาศ ที่ LTN Devel Webboard ด้วยเมื่อเช้าวานนี้

หลังจากนั้น ก็ลุยเคลียร์ OSS glossary กับทีมแปลที่ห้อง #tlwg ต่อ ตามที่นัดกันไว้ จนถึงเย็น

เลิกประชุม เจียะปึ่งแล้ว ก็มานั่ง build debian package ให้กับ libthai โดยคราวนี้ ทำความสะอาดแพกเกจเพิ่มเติมอีกหน่อย พร้อมทั้งเพิ่มแพกเกจ libthai-doc เพื่อติดตั้งเอกสาร HTML ด้วย เสร็จแล้วก็เมลติดต่อ sponsor

ยังไม่เคยพูดถึงเรื่องระบบเอกสารของ debian.. ความจริงแล้ว debian policy ได้กำหนดที่อยู่ของเอกสารต่างๆ ของแพกเกจไว้ที่ /usr/share/doc/package ใครติดตั้ง debian package เสร็จ จึงมักได้พึ่งพาอาศัยไดเรกทอรีนี้ในการเริ่มทำงาน โดยในนั้นจะมีแฟ้มพวก README ของ upstream, README.Debian, examples ฯลฯ ให้ตั้งต้นใช้งาน ซึ่งสำหรับหลายๆ แพกเกจ มักจะมีข้อมูลเพียงพอสำหรับคนที่ยังไม่เคยใช้งานมาก่อน เมื่อประกอบกับความสะดวกของ apt และ debconf ที่ช่วยกำหนดค่าเริ่มต้นต่างๆ ให้ ทำให้การลองเล่นซอฟต์แวร์ต่างๆ ใน debian เป็นเรื่องสนุกสนานมาก

แต่นอกเหนือจากนั้น ก็ยังมี document ในแบบ man page และ info page ตามปกติ เอาไว้ใช้อ่านรายละเอียดของคำสั่งหรือฟังก์ชัน ซึ่งที่หน้า QA ของเดเบียน จะมีการเชิญชวนคนในชุมชนมาช่วยกันเขียน man page ให้กับแพกเกจที่ยังขาด โดยระบบตรวจคุณภาพของแพกเกจจะลิสต์แพกเกจดังกล่าวโดยอัตโนมัติ

แล้วก็ยังมีหลายแพกเกจ ที่แยกแพกเกจ *-doc ออกมาต่างหาก โดยอาจจะเป็นเอกสาร HTML หรือ PDF อะไรก็ตามแต่ โดยไม่ติดตั้งกับระบบปกติ ให้ลงต่างหากเอาถ้าต้องการ

จากความหลากหลายของรูปแบบเอกสารนี้ debian มีวิธีจัดการให้สามารถเรียกดูและค้นหาได้ทั้งหมด ผ่านระบบเอกสารกลางที่เรียกว่า doc-base โดยให้ทุกแพกเกจที่มีเอกสาร ไปลงทะเบียนกับ doc-base ไว้ จากนั้น จะมี front-end ที่มาอ่านเอกสารที่ลงทะเบียนไว้ทั้งหมด โดยบาง front-end อาจมีการแปลงรูปแบบให้เป็น HTML ได้ด้วยถ้าทำได้ ซึ่งตอนนี้ มี front-end อยู่สามตัว คือ dhelp, dwww และ doc-central ซึ่งทั้งสามตัว เตรียมให้ดูด้วยเว็บเบราว์เซอร์ทั้งหมด ซึ่งเรียงตามลำดับขนาดแพกเกจจากเล็กไปใหญ่ ก็จะเริ่มจาก doc-central, dhelp แล้วก็เป็น dwww แต่ dhelp ดูจะน่าใช้ตรงที่ไม่ต้องใช้ web server ก็ดูได้ โดยแค่เปิดไฟล์ในเครื่องดูก็เป็นอันเสร็จ (แต่ถ้ามี จะ search ผ่าน CGI ได้) ส่วนอีกสองตัว ต้องใช้ web server โดย dwww สามารถ convert เอกสารรูปแบบอื่นเป็น HTML ก่อนเปิดใน web browser ได้ด้วย

นั่นคือ integration อีกอย่างหนึ่งของ debian ซึ่งอาจจะครอบคลุมกว้างกว่าระบบ scrollkeeper และ yelp ของ GNOME หรือระบบที่คล้ายกันของ KDE

และ libthai-doc ก็ได้ register ตัวเองเข้ากับ doc-base ของ debian ด้วย :-)