(DocBook moved to User:Pfrields/DocBook: Get rid of page in the way) |
(→Creating DocBook using common tools: update Documentation Guide URL) |
||
| (6 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
The standard markup language used by the DocsProject. Refer to the [http://www.docbook.org/ DocBook home page] for everything DocBook. | |||
== Getting started == | |||
=== Good reading === | |||
* [http://opensource.bureau-cornavin.com/crash-course/en/index.html Quick crash course] | |||
* [http://cyberelk.net/tim/docbook/selfdocbookx/ Self-referential tutorial] | |||
* [http://tldp.org/HOWTO/DocBook-Demystification-HOWTO/index.html Dated but useful for understanding] | |||
=== Publican toolchain === | |||
Fedora Docs uses a toolchain that wraps around DocBook building tools. | |||
* [http://jfearn.fedorapeople.org/en-US/Publican/index.html Publican Users Guide] | |||
* [https://fedorahosted.org/publican Project pages] | |||
To install publican from the command line: | |||
<pre> | |||
su -c 'yum install publican' | |||
</pre> | |||
Once installed, you can use the <code>create_book</code> command to generate a new, empty book that you can begin writing in immediately. It serves as a self-referential toolchain tutorial. | |||
=== Example tutorial === | |||
In addition to the [http://cyberelk.net/tim/docbook/selfdocbookx/ Self DocBook] sef-referential tutorial, the [[DocsProject]] maintains a [http://docs.fedoraproject.org/en-US/Fedora_Draft_Documentation/0.1/html/Documentation_Guide/chap-documentation_guide-docbook.html guide] with an overview of docbook. | |||
=== Complete Reference === | |||
"DocBook: The Definitive Guide" (often called "The DocBook Book" or "TDG"), available at the site, has a complete reference of all tags used in DocBook. The DocsProject currently uses version 4.4 of the DocBook DTD. The reference in TDG shows you which tags belong to newer versions of the DocBook DTD, so you don't violate the specification when you are writing your documents. You can download or read the book here: | |||
* http://www.docbook.org/tdg/en/html/docbook.html | |||
{{Anchor|tools}} | |||
== Creating DocBook using common tools == | |||
The [https://docs.fedoraproject.org/en-US/Fedora_Draft_Documentation/0.1/html/Documentation_Guide/index.html Documentation Guide] explains how to configure <code>vi</code> and <code>Emacs</code> for DocBook support. | |||
OpenOffice.org has some limited capabilities for producing DocBook XML from documents that adhere to strict use of built-in styles. See [[DocsProject/OOoDocBook]] for information on using [http://www.openoffice.org OpenOffice.org] Writer for working with DocBook. | |||
Users can export pages from this wiki to DocBook. To ease the conversion process, refer to the guidelines found at [[Docs/WritingUsingTheWiki]] . | |||
---- | |||
[[Category:Documentation tools]] | |||
Latest revision as of 18:10, 19 January 2017
The standard markup language used by the DocsProject. Refer to the DocBook home page for everything DocBook.
Getting started
Good reading
Publican toolchain
Fedora Docs uses a toolchain that wraps around DocBook building tools.
To install publican from the command line:
su -c 'yum install publican'
Once installed, you can use the create_book command to generate a new, empty book that you can begin writing in immediately. It serves as a self-referential toolchain tutorial.
Example tutorial
In addition to the Self DocBook sef-referential tutorial, the DocsProject maintains a guide with an overview of docbook.
Complete Reference
"DocBook: The Definitive Guide" (often called "The DocBook Book" or "TDG"), available at the site, has a complete reference of all tags used in DocBook. The DocsProject currently uses version 4.4 of the DocBook DTD. The reference in TDG shows you which tags belong to newer versions of the DocBook DTD, so you don't violate the specification when you are writing your documents. You can download or read the book here:
Creating DocBook using common tools
The Documentation Guide explains how to configure vi and Emacs for DocBook support.
OpenOffice.org has some limited capabilities for producing DocBook XML from documents that adhere to strict use of built-in styles. See DocsProject/OOoDocBook for information on using OpenOffice.org Writer for working with DocBook.
Users can export pages from this wiki to DocBook. To ease the conversion process, refer to the guidelines found at Docs/WritingUsingTheWiki .