Fedora Documentation Guide
		Next

Fedora Documentation Guide

Fedora Documentation Project

Version 0.4 (2008-04-09)

Legal Notice

Revision History

Introduction

1. Prerequisites

1.1. System Packages

1.2. Fedora Documentation Tools

1.3. Naming Conventions

1.3.1. Module Names
1.3.2. File Names

2. How Modules Work

2.1. Structure of a Module

2.2. The Document Build System

2.2.1. The Document Makefile
2.2.2. The Document rpm-info.xml

2.3. Build System Actions

2.4. Adding or Changing Targets

2.5. Using Document Image Files

2.6. Adding a New DocBook XML File

2.7. Adding a Translation

3. Fedora Documentation Guidelines

3.1. File Header

3.1.1. XML Header
3.1.2. CVS Id Header

3.2. ID Naming Conventions

3.3. XML Tags

3.4. Admonitions

3.4.1. Creating a note, tip, caution, important, or warning

3.5. Screenshots

3.6. Previewing Your Work

4. Emacs and PSGML Mode

4.1. Installing PSGML

4.2. Setting Up Your .emacs File

4.3. Customizing Emacs

4.4. Basic Emacs Commands

4.5. Examples

4.5.1. Tag Completion

4.5.2. Tag Closure

4.5.3. Other Emacs Tasks

4.5.3.1. Working with One Window
4.5.3.2. Saving Work
4.5.3.3. The "Clear/Quit" Command
4.5.3.4. Opening a new file
4.5.3.5. Closing Emacs

4.6. Additional Resources

5. VIM and DocBook

5.1. Setting Up Your .vimrc File
5.2. Keymapping with VIM
5.3. Additional VIM Resources

6. The Layout of a Tutorial

6.1. The Article
6.2. The Metadata

7. Publishing Official Documentation

7.1. How the Site Works

7.2. Setting Up a Web Sandbox

7.3. Creating a New Publication

7.3.1. General Guidelines
7.3.2. Adding Content
7.3.3. Pushing Content to the Web

8. CVS

8.1. How CVS Works

8.2. Preparing For CVS Use

8.2.1. Is CVS Installed On Your System
8.2.2. Generating SSH Keys

8.3. Configuring For CVS Access

8.3.1. Avoiding Repetitive Typing
8.3.2. Configuring for Read-Only CVS Access
8.3.3. Configuring Read/Write CVS Access

8.4. Basic CVS Commands

8.4.1. Checking Out Modules

8.4.1.1. Checking Out Branches of Modules

8.4.2. Updating Files

8.4.3. Committing Files

8.4.4. Adding Files

8.4.5. Managing Binary Files

8.4.6. Removing Files

8.4.7. Status of Files

8.4.8. Resolving Conflicts

8.4.9. Summary

9. Localization (L10n)

9.1. PO Files
9.2. Creating or Updating a POT
9.3. Updating PO Files
9.4. Checking Statistics

10. Acknowledgments

Index

		Next
		Introduction