initCommon(); $template->displayHeader(); ?>

Chapter 3. Fedora Documentation Guidelines

Please read this chapter carefully. This chapter describes the guidelines that must be followed such as naming conventions.

This chapter only discusses tags used for documentation for the Fedora Project, not all available DocBook XML tags. For the complete list, refer to http://www.docbook.org/tdg/en/html/docbook.html.

3.1. File Header

3.1.1. XML Header

In accordance with good XML practices, the first line in any DocBook XML source files should identify the file as XML. Use the following line as the first line of any new XML file:

<?xml version="1.0" encoding="UTF-8"?>

3.1.2. CVS Id Header

All the files must contain the CVS Id header. Use the following line as the second line of any new XML file:

<!-- $Id: -->

Any time the file is committed to CVS, the line is updated automatically to include information about the file. For example:

<!-- $Id: ch-writing-guidelines.php,v 1.6 2008/04/10 02:37:06 pfrields Exp $ -->
displayFooter('$Date: 2008/04/10 02:37:06 $'); ?>