1 / 10

FreeBSD Documentation Project BoF BSDCon, San Francisco February 13, 2002 8-9pm

This document provides an update on the progress made by the FreeBSD Documentation Project, including committer activity, infrastructure enhancements, and print output improvements. It also shares the wishlist for the 3rd edition of the FreeBSD Handbook, highlighting areas for improvement and potential additions.

kmcbride
Download Presentation

FreeBSD Documentation Project BoF BSDCon, San Francisco February 13, 2002 8-9pm

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. FreeBSD Documentation Project BoF BSDCon, San Francisco February 13, 2002 8-9pm

  2. Progress this year • Committer Activity • Upcoming Projects • FreeBSD Handbook 2nd Edition • Constructive Criticism • Wish list for 3rd Edition

  3. Doc Manager Hat?

  4. Progress This Year • Committer Activity • 6 committers with over 100 commits in the past 12 months. • 5,893 messages to freebsd-doc in 2001. • 883 from January 1 to February 9, 2002. • New translations into Italian, Serbian, and Portuguese. • Over 15 new articles. • Hundreds of new pages for the Developer's Handbook.

  5. Progress This Year • Infrastructure Enhancements • Added index support to our Jade-based toolchain. • Added 795 index terms to the Handbook. • Print output enhancements. • Several new chapters and appendices. • Hundreds of typos fixed.

  6. Print Output Enhancements • Build variables • NICE_HEADERS - more aesthetically pleasing chapter headers. • MIN_SECT_LABELS - only print numbers for top level sections. • TWO_SIDE - Only start new chapters on odd numbered pages, and insert blank pages as necessary. • JUSTIFY - Justify the text so that the right edge is smooth. • GEN_INDEX - Generate an index of the document • BOOK_OUTPUT -All of the above. • Example : make BOOK_OUTPUT=1 book.ps

  7. Future Directions • Optional XSLT based toolchain support. • XML man pages. • Splitting up the Handbook! • Finding a more effective search engine.

  8. Handbook • Current division: ~640 pages, 3 parts (Basics, System Administration, and Appendices) • Problems with "one large handbook" • Raises the barrier to entry for new contributors. • Difficult to find relevant information on a topic.

  9. Handbook Wishlist • Problems with 2nd Edition • No information about wireless networking. • No information about DVD / multimedia. • PPP and many other sections are out of date. • Grammar is HORRIBLE. • IPSec section is completely unintelligible.

  10. Handbook Wishlist • New chapters? • More high-quality diagrams.

More Related