FreeBSD Documentation Project Primer for New Contributors
|  | Next

# FreeBSD Documentation Project Primer for New Contributors

### The FreeBSD Documentation Project

Revision: 42410

Copyright © 1998-2013 DocEng

Copyright
Last modified on 2013-07-24 by wblock.
Abstract

Thank you for becoming a part of the FreeBSD Documentation Project. Your contribution is extremely valuable, and we appreciate it.

This primer covers details needed to start contributing to the FreeBSD Documentation Project, or FDP, including tools, software, and the philosophy behind the Documentation Project.

This is a work in progress. Corrections and additions are always welcome.

[ Split HTML / Single HTML ]

1. A Sample Example
7.1. Using an Element (Start and End Tags)
7.2. Using an Element Without Content
7.3. Elements Within Elements; `em`
7.4. Using an Element with an Attribute
7.5. Single Quotes Around Attributes
7.6. `.profile`, for sh(1) and bash(1) Users
7.7. `.cshrc`, for csh(1) and tcsh(1) Users
7.8. XML Generic Comment
7.9. Erroneous XML Comments
7.10. Defining General Entities
7.11. Defining Parameter Entities
7.12. Using General Entities to Include Files
7.13. Using Parameter Entities to Include Files
7.14. Structure of a Marked Section
7.15. Using a `CDATA` Marked Section
7.16. Using `INCLUDE` and `IGNORE` in Marked Sections
7.17. Using a Parameter Entity to Control a Marked Section
8.1. Normal XHTML Document Structure
8.2. `h1`, `h2`, and Other Header Tags
8.3. `p`
8.4. `blockquote`
8.5. `ul` and `ol`
8.6. Definition Lists with `dl`
8.7. `pre`
8.8. Simple Use of `table`
8.9. Using `rowspan`
8.10. Using `colspan`
8.11. Using `rowspan` and `colspan` Together
8.12. `em` and `strong`
8.13. `tt`
8.14. Using `<a href="...">`
8.15. Creating an Anchor
8.16. Linking to a Named Part of a Different Document
8.17. Linking to a Named Part of the Same Document
9.1. Boilerplate `book` with `bookinfo`
9.2. Boilerplate `article` with `articleinfo`
9.3. A Simple Chapter
9.4. Empty Chapters
9.5. Sections in Chapters
9.6. `para`
9.7. `blockquote`
9.8. `warning`
9.9. `itemizedlist`, `orderedlist`, and `procedure`
9.10. `programlisting`
9.11. `co` and `calloutlist`
9.12. `informaltable`
9.13. Tables Where `frame="none"`
9.14. `screen`, `prompt`, and `userinput`
9.15. `emphasis`
9.16. Acronyms
9.17. Quotations
9.18. Keys, Mouse Buttons, and Combinations
9.19. Applications, Commands, and Options
9.20. `filename`
9.21. `filename` Tag with `package` Role
9.22. `devicename`
9.23. `hostid` and Roles
9.24. `username`
9.25. `email` with a Hyperlink
9.26. `email` Without a Hyperlink
9.27. `maketarget` and `makevar`
9.28. `literal`
9.29. `replaceable`
9.30. `guibutton`
9.31. `errorname`
9.32. `id` on Chapters and Sections
9.33. `anchor`
9.34. Using `xref`
9.35. Using `link`
9.36. `ulink` to a FreeBSD Documentation Web Page
9.37. `ulink` to a FreeBSD Web Page
9.38. `ulink` to an External Web Page
A.1. DocBook `book`
A.2. DocBook `article`
A.3. Converting DocBook to XHTML (One Large File)
A.4. Converting DocBook to XHTML (Several Small Files)
A.5. Converting DocBook to PostScript®
A.6. Converting DocBook to PDF

|  | Next
|  | Preface

All FreeBSD documents are available for download at http://ftp.FreeBSD.org/pub/FreeBSD/doc/

Questions that are not answered by the documentation may be sent to <freebsd-questions@FreeBSD.org>.
Send questions about this document to <freebsd-doc@FreeBSD.org>.