%chapters; ]> The FreeBSD Documentation Project 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 DocEng $FreeBSD$ $FreeBSD$ &legalnotice; Thank you for becoming a part of the FreeBSD Documentation Project. Your contribution is extremely valuable. This primer covers details needed to start contributing to the FreeBSD Documentation Project, from the tools and software (both mandatory and recommended) to the philosophy behind the Documentation Project. This document is a work in progress. Corrections and additions are welcomed. The following table shows the default system prompt and superuser prompt. The examples will use this prompt to indicate which user you should be running the example as. User Prompt Normal user &prompt.user; root &prompt.root; The following table describes the typographic conventions used in this book. Meaning Examples The names of commands. Use ls -l to list all files. The names of files. Edit .login. On screen computer output. You have mail. What you type, when contrasted with on-screen computer output. &prompt.user; su Password: Manual page references. Use &man.su.1; to change user names. User and group names Only root can do this. Emphasis You must do this. Command line variables; replace with the real name or variable. To delete a file, type rm filename Environment variables $HOME is your home directory. Within the text appear notes, warnings, and examples. Notes are represented like this, and contain information that you should take note of, as it may affect what you do. Tips are represented like this, and contain information that you might find useful, or lead to an easier way to do something. Important information is represented like this. Typically they flag extra steps you may need to carry out. Warnings are represented like this, and contain information warning you about possible damage if you do not follow the instructions. This damage may be physical, to your hardware or to you, or it may be non-physical, such as the inadvertent deletion of important files. Examples are represented like this, and typically contain examples you should walk through, or show you what the results of a particular action should be. My thanks to Sue Blake, Patrick Durusau, Jon Hamilton, Peter Flynn, and Christopher Maden, who took the time to read early drafts of this document and offer many valuable comments and criticisms. &chap.overview; &chap.tools; &chap.xml-primer; &chap.xhtml-markup; &chap.docbook-markup; &chap.stylesheets; &chap.structure; &chap.doc-build; &chap.the-website; &chap.translations; &chap.writing-style; &chap.psgml-mode; &chap.see-also; &app.examples;