Getting Started with Docbook using Lyx

Docbook is a document structure standard that is widely used and a useful tool for the technical writer.  The complexities of learning the markup isn't a big difficulty when using WYSIWYM (what you see is what you mean) document processing applications such as Lyx (Free and Cross-Platform) and Adobe FrameMaker.  Its open source roots allows users to edit and work with Docbook across various platforms.

Getting started with Docbook using Lyx is quick and easy.  Users just need to set up their document for Docbook (SGML) and can start writing away.

To set up a Lyx Document for Docbook markup:

1. Click File then New.
2. Click Document then Settings.

3. The left hand panel displays numerous settings for the new document.  Select Document Class and in the menu, choose between Docbook book (SGML), Docbook article, Docbook chapter, and Docbook section.

4. Most users can start working on the document already.  However, other settings users may want to set up are the following:

• Font - select font sets to be used
• Text Layout - set spacing and indentation settings  
• Margin Layout - set margins
• Page Layout - set the default page output
• Numbering and TOC
• Bibliography
• Bullets - users can optimize the bullet item used per level
• PDF Properties - allow the creation of bookmarks and navigation trees

Bullet characters can be changed.

PDF settings can be set.

5. Text can now be imported or pasted on to the document window.  

Users can import a variety of documents into Lyx.

6. Using Lyx's Environment choice box, text can be tagged and formatted as paragraphs, subparagraphs, subsubsections, Itemize, Enumerate, Code, Part, Section, Subsection, etc.
6. Once the document is finished, save the file in .lyx format by clicking File and then Save.
7. To create a Docbook file from the Lyx document click File then Export.  Since the Document Class Docbook was selected during setup, the document has options to be exported to either Docbook or Docbook XML.

8.   Lyx will automatically export the file to the same folder where the Lyx document was saved.

Linux users can review the Docbook markup using the text editor Gedit.  With the Docbook file exported from Lyx opened in Gedit, click View, then Highlight Mode.  Select Docbook or XML to highlight the XML tags.

Linux's Gedit text editor can highlight the XML markup.