%FEDORA-ENTITIES-EN; ]> Prerequisites To work on official &FED; documentation you need to install the required tools. Follow the directions below to configure your system.
System Packages Install the "Authoring and Publishing" package group, which contains required DocBook XML files, stylesheets and scripts: su -c 'yum groupinstall "Authoring and Publishing"' Next, install the cvs package, which is used to handle revision control on files in the official repository: su -c 'yum install cvs' If you plan to use Emacs to edit DocBook XML documentation, install psgml, which adds helpful and time-saving functionality to maximize editing efficiency: su -c 'yum install psgml'
Fedora Documentation Tools The &FDP;'s custom scripts and stylesheets are stored in CVS on the cvs.fedoraproject.org CVS server. When you check out a document module from CVS, the tools are included in the module inside the docs-common/ directory. To work on existing documents in CVS, refer to .
Filename Conventions The &FDP; 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.
Document Filenames Each document lives in a peer directory to the docs-common directory you extracted from the &FED; archive earlier. On the CVS server, these directories are called modules. Use the cvs co -c command to view existing module names. Partial List of CVS Modules cd ~/localrepo/fedora-docs/ developer-guide developer-guide docs . docs-common docs-common documentation-guide documentation-guide example-tutorial example-tutorial Choose a module name that accurately reflects your document's subject, but avoid any name already taken. Avoid Redundancy Do not use the word &FED; to name modules in the &FDP; CVS repository.