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

1.3. Filename Conventions

The Fedora Documentation Project provides the tools, scripts, and stylesheets to transform your XML documents into other output formats such as HTML. In addition, these tools can build your document into a RPM package. To take advantage of these services, you must follow conventions for naming your files.

1.3.1. Document Filenames

Each document lives in a peer directory to the docs-common directory you extracted from the Fedora archive earlier. On the CVS server, these directories are called modules. Use the cvs co -c command to view existing module names.

cd ~/localrepo/fedora-docs/
build-docs   infrastructure/build-docs
cvsroot      CVSROOT
desktop-up2date desktop-up2date
developer-guide developer-guide
docs         .
docs-common  docs-common
documentation-guide documentation-guide
example-tutorial example-tutorial

Example 1.1. Partial List of CVS Modules


Choose a module name that accurately reflects your document's subject, but avoid any name already taken.

[Important]Avoid Redundancy

Do not use the word Fedora to name modules in the Fedora Documentation Project CVS repository.

displayFooter('$Date: 2007/09/16 19:16:25 $'); ?>