Product SiteDocumentation Site

Chapter 3. Brief Introduction to DocBook

3.1. Why DocBook?
3.1.1. DocBook as an XML Markup Language
3.1.2. Human-readable Tags
3.1.3. Text-based Format for Easy Revision Control
3.1.4. Separation Between Content and Style
3.1.5. Output in a Variety of Formats
3.2. Parts of a DocBook File
3.2.1. Entities
3.3. Dividing a Document into Multiple Files with XIncludes
3.4. Entities: With Great Power Comes Great Responsibility
This chapter will give you a brief introduction to DocBook.

3.1. Why DocBook?

DocBook has many features which make it suitable for documentation in Fedora and other projects.

3.1.1. DocBook as an XML Markup Language

DocBook is an implementation of Extensible Markup Language (XML) . XML gives DocBook powerful flexibility.

3.1.2. Human-readable Tags

DocBook tags are generally self-explaining. They are named after what they define, even though shorter terms might make more effiecient use of space. This makes it easy for writers and editors to quickly look at a document and understand how it is constructed.

3.1.3. Text-based Format for Easy Revision Control

Version control provides two critical features for collaborative documentation work: concurrent editing and history. The text-based format of DocBook makes it well-suited to being managed by a version control system.

3.1.4. Separation Between Content and Style

The DocBook standard separates a document's content and its formatting. The writer uses XML tags to structure the elements of document, and the formatting can be changed independently later. A change to the formatting of an element does not require changing every instance of that element.

3.1.5. Output in a Variety of Formats

DocBook is a source format. The publican tool is used to generate rendered documents in several different formats. publican can generate HTML, PDF, and epub formats from the same source file.