blob: 64d7285211958f69e4ef4cb0e08c26657c90338b [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Getting Started With DocBook on OpenOffice</title>
<meta HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=UTF-8">
<style TYPE="text/css">
<!--
H2.western { font-family: "Albany", sans-serif; font-size: 14pt; font-style: italic }
H2.cjk { font-family: "HG Mincho Light J"; font-size: 14pt; font-style: italic }
H2.ctl { font-size: 14pt; font-style: italic }
-->
</style>
</head>
<body>
<H1>Getting Started With DocBook on OpenOffice</H1>
<H2 CLASS="western">Who is this Guide intended for?</H2>
<P STYLE="margin-bottom: 0cm">This guide is intended to be a starting
point for somebody who wishes to use OpenOffice to produce and edit
DocBook documents. It does not cover all of the functionality that is
currently supported by the DocBook filter, but instead covers a few
of the more frequently used operations that are necessary to commence
using OpenOffice to edit and create DocBook files.</P>
<H2 CLASS="western">Before you Begin</H2>
<P>A template that supplies all of the custom styles that are
currently supported is available for download <A HREF="/xml/xmerge/downloads/DocBookTemplate.ott">here</A>.
Load the DocBookTemplate.ott Template so that the required Docbook
specific styles are available.Display the Style list by pressing <B>F11</B>.
Now choose 'All Styles', so that all available styles are displayed.</P>
<P ALIGN=CENTER STYLE="margin-bottom: 0cm"><FONT COLOR="#000000"><FONT COLOR="#000000"><IMG SRC="images/ParagraphStyles.png" NAME="Graphic3" ALIGN=BOTTOM WIDTH=231 HEIGHT=403 BORDER=1></FONT></FONT>
</P>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
<H2 CLASS="western">Navigating through a Document</H2>
<P STYLE="margin-bottom: 0cm">If you wish to see how sections are
nested, use the <B>F5</B> key to Display the Navigator window. Expand
the sections tag, to display the layout of the sections within the
document. You can skip to the start of a given section, by
double-clicking on it.
</P>
<P ALIGN=CENTER STYLE="margin-bottom: 0cm"><FONT COLOR="#000000"><FONT COLOR="#000000"><IMG SRC="images/Navigator.gif" NAME="Graphic1" ALIGN=BOTTOM WIDTH=257 HEIGHT=321 BORDER=1></FONT></FONT></P>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
<H2 CLASS="western">Setting the Document Title.</H2>
<P STYLE="margin-bottom: 0cm">Skip to the ArticleInfo Section by
double clicking on it in the Navigator window. Select the 'Document
Title' style from the stylelist and then type the Document Title.
This Document Title will become the articleinfo title element, when
the document is saved as DocBook.
</P>
<P ALIGN=CENTER STYLE="margin-bottom: 0cm"><FONT COLOR="#000000"><FONT COLOR="#000000"><IMG SRC="images/DocumentTitle.jpg" NAME="Graphic2" ALIGN=BOTTOM WIDTH=764 HEIGHT=533 BORDER=1></FONT></FONT></P>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
<H2 CLASS="western">Creating Sect1, Sect2,Sect3</H2>
<P STYLE="margin-bottom: 0cm">To insert a section, select
<B>Insert-&gt;Section</B> from the menu bar. Give the section a name
and click Insert. The new section will now be displayed. The name you
give the section will become the Section id in the produced Docbook
document. To add a Section Title, select either Section Title or one
of the Section# Title styles from the style list. When the final
Docbook document is created, the Section Title will be translated
into a 'Title' tag within that section.
</P>
<P STYLE="margin-bottom: 0cm">While typing, if you wish to escape the
current section type <B>ALT+Return</B> at the end of the Section.</P>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
<H2 CLASS="western">Adding a table</H2>
<P STYLE="margin-bottom: 0cm">To add a table, select <B>Insert-&gt;Table</B>
from the menu bar. You can set the tables properties using the <B>Insert
Table</B> dialog. When this is complete, click <B>OK</B>. The Name
will become the <B>id</B> attribute of the Docbook table.
</P>
<P STYLE="margin-bottom: 0cm">To give the table a Title in order to
make it a Formal table, right click on the Displayed table, and
select <B>Caption</B>. The caption will become the Table title.
</P>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
<P ALIGN=CENTER STYLE="margin-bottom: 0cm"><FONT COLOR="#000000"><FONT COLOR="#000000"><IMG SRC="images/Table.jpg" NAME="Graphic6" ALIGN=BOTTOM WIDTH=844 HEIGHT=557 BORDER=1></FONT></FONT></P>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
<H2 CLASS="western">Alternative Character Styles</H2>
<P>Docbook allows paragraphs to contain many different types of
formatted text (Emphasis, Sub Script, SuperScript, Filename, command
etc.). To apply these styles to a piece of text, do the following.</P>
<OL>
<LI><P>Select the text you wish to modify.</P>
<LI><P>On the StyleList, select the <B>Character styles </B>icon so
that the Character style list is displayed.
</P>
<LI><P>Select the character style that you wish to apply to selected
text.</P>
</OL>
<P><BR><BR>
</P>
<H2 CLASS="western">Saving to DocBook</H2>
<P>To Save your file to the DocBook format, select <B>File-&gt;Save
As</B> from the menu. In the <B>Save As Type</B> selection box,
select <B>DocBook (.xml). </B>When the <B>Save </B>button is pressed,
the file will be saved in the DocBook format.</P>
<P ALIGN=CENTER><FONT COLOR="#000000"><FONT COLOR="#000000"><IMG SRC="images/SaveAs.jpg" NAME="Graphic5" ALIGN=BOTTOM WIDTH=562 HEIGHT=409 BORDER=1></FONT></FONT></P>
<P><BR><BR>
</P>
<H2 CLASS="western">Sample Output</H2>
<P>Below is a sample of the output that would be produced by the
DocBook filter.
</P>
<P STYLE="margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;?xml
version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</FONT></FONT></P>
<P STYLE="margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;article
lang=&quot;en-US&quot;&gt;</FONT></FONT></P>
<P STYLE="margin-left: 2cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;articleinfo&gt;</FONT></FONT></P>
<P STYLE="margin-left: 4cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;title&gt;My
Document Title&lt;/title&gt;</FONT></FONT></P>
<P STYLE="margin-left: 4cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;subtitle&gt;My
Document Subtitle&lt;/subtitle&gt;</FONT></FONT></P>
<P STYLE="text-indent: 4.05cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;edition
/&gt;</FONT></FONT></P>
<P STYLE="margin-left: 2cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;/articleinfo&gt;</FONT></FONT></P>
<P STYLE="margin-left: 2cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;sect1
id=&quot;Sect1&quot;&gt;</FONT></FONT></P>
<P STYLE="margin-left: 4cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;title&gt;Section1
title &lt;/title&gt;</FONT></FONT></P>
<P STYLE="margin-left: 4cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;para&gt;Some
random text&lt;/para&gt;</FONT></FONT></P>
<P STYLE="margin-left: 4cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;sect2
id=&quot;Sect2&quot;&gt;</FONT></FONT></P>
<P STYLE="margin-left: 6cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;title&gt;Section
2 Title&lt;/title&gt;</FONT></FONT></P>
<P STYLE="margin-left: 6cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;para&gt;Some
more Text with </FONT></FONT>
</P>
<P STYLE="margin-left: 8cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;emphasis&gt;emphasis&lt;/emphasis&gt;</FONT></FONT></P>
<P STYLE="margin-left: 6cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;/para&gt;</FONT></FONT></P>
<P STYLE="margin-left: 6cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;table
frame=&quot;all&quot; id=&quot;myTable&quot;&gt;</FONT></FONT></P>
<P STYLE="margin-left: 8cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;title&gt;My
table Name&lt;/title&gt;</FONT></FONT></P>
<P STYLE="margin-left: 8cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;tgroup
cols=&quot;6&quot;&gt;</FONT></FONT></P>
<P STYLE="margin-left: 10cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;colspec
colnum=&quot;1&quot; colname=&quot;c1&quot; /&gt;</FONT></FONT></P>
<P STYLE="margin-left: 10cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;colspec
colnum=&quot;2&quot; colname=&quot;c2&quot; /&gt;</FONT></FONT></P>
<P STYLE="margin-left: 10cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;colspec
colnum=&quot;3&quot; colname=&quot;c3&quot; /&gt;</FONT></FONT></P>
<P STYLE="margin-left: 10cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;colspec
colnum=&quot;4&quot; colname=&quot;c4&quot; /&gt;</FONT></FONT></P>
<P STYLE="margin-left: 10cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;colspec
colnum=&quot;5&quot; colname=&quot;c5&quot; /&gt;</FONT></FONT></P>
<P STYLE="margin-left: 10cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;colspec
colnum=&quot;6&quot; colname=&quot;c6&quot; /&gt;</FONT></FONT></P>
<P STYLE="margin-left: 10cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;thead&gt;</FONT></FONT></P>
<P STYLE="margin-left: 12cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;row&gt;</FONT></FONT></P>
<P STYLE="margin-left: 14cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;entry&gt;</FONT></FONT></P>
<P STYLE="margin-left: 16cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;para&gt;Header&lt;/para&gt;</FONT></FONT></P>
<P STYLE="margin-left: 14cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;/entry&gt;</FONT></FONT></P>
<P STYLE="margin-left: 14cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;entry&gt;</FONT></FONT></P>
<P STYLE="margin-left: 16cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;para&gt;Rows&lt;/para&gt;</FONT></FONT></P>
<P STYLE="margin-left: 14cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;/entry&gt;</FONT></FONT></P>
<P STYLE="margin-left: 14cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;entry&gt;</FONT></FONT></P>
<P STYLE="margin-left: 16cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;para
/&gt;</FONT></FONT></P>
<P STYLE="margin-left: 14cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;/entry&gt;</FONT></FONT></P>
<P STYLE="margin-left: 14cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;entry&gt;</FONT></FONT></P>
<P STYLE="margin-left: 16cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;para
/&gt;</FONT></FONT></P>
<P STYLE="margin-left: 14cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;/entry&gt;</FONT></FONT></P>
<P STYLE="margin-left: 14cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;entry&gt;</FONT></FONT></P>
<P STYLE="margin-left: 16cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;para
/&gt;</FONT></FONT></P>
<P STYLE="margin-left: 14cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;/entry&gt;</FONT></FONT></P>
<P STYLE="margin-left: 12cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;/row&gt;</FONT></FONT></P>
<P STYLE="margin-left: 10cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;/thead&gt;</FONT></FONT></P>
<P STYLE="margin-left: 10cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;tbody&gt;</FONT></FONT></P>
<P STYLE="margin-left: 12cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;row&gt;</FONT></FONT></P>
<P STYLE="margin-left: 14cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;entry&gt;</FONT></FONT></P>
<P STYLE="margin-left: 16cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;para
/&gt;</FONT></FONT></P>
<P STYLE="margin-left: 14cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;/entry&gt;</FONT></FONT></P>
<P STYLE="margin-left: 14cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;entry&gt;</FONT></FONT></P>
<P STYLE="margin-left: 16cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;para&gt;Content
&lt;/para&gt;</FONT></FONT></P>
<P STYLE="margin-left: 14cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;/entry&gt;</FONT></FONT></P>
<P STYLE="margin-left: 14cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;entry&gt;</FONT></FONT></P>
<P STYLE="margin-left: 16cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;para&gt;Rows&lt;/para&gt;</FONT></FONT></P>
<P STYLE="margin-left: 14cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;/entry&gt;</FONT></FONT></P>
<P STYLE="margin-left: 14cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;entry&gt;</FONT></FONT></P>
<P STYLE="margin-left: 16cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;para
/&gt;</FONT></FONT></P>
<P STYLE="margin-left: 14cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;/entry&gt;</FONT></FONT></P>
<P STYLE="margin-left: 14cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;entry&gt;</FONT></FONT></P>
<P STYLE="margin-left: 16cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;para
/&gt;</FONT></FONT></P>
<P STYLE="margin-left: 14cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;/entry&gt;</FONT></FONT></P>
<P STYLE="margin-left: 12cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;/row&gt;</FONT></FONT></P>
<P STYLE="margin-left: 10cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;/tbody&gt;</FONT></FONT></P>
<P STYLE="margin-left: 8cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;/tgroup&gt;</FONT></FONT></P>
<P STYLE="margin-left: 6cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;/table&gt;</FONT></FONT></P>
<P STYLE="margin-left: 6cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;para
/&gt;</FONT></FONT></P>
<P STYLE="margin-left: 4cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;/sect2&gt;</FONT></FONT></P>
<P STYLE="margin-left: 2cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;/sect1&gt;</FONT></FONT></P>
<P STYLE="margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><FONT SIZE=2 STYLE="font-size: 9pt">&lt;/article&gt;</FONT></FONT></P>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
</body>
</html>