Documents to be converted using AurigaDoc should have the following structure:-
- The root element of the document is <document>
- The meta info about the document is contained in
<document-meta-info> element inside the document
root. This element has elements like title, attribute, etc.
- The formatting info about the document is contained within
<document-formatting-info> under the document
root.
The following elements are supported in this element:-
-
<stylesheet url="url" /> - Used to associate a css to the generated html. (html only)
-
<stylesheet-fo url="url" /> - Used to associate a css to the output (pdf/postscript)
-
<left-margin>Xpt</left-margin> - Used to specify left margin for pdf document. (pdf/postscript/rtf)
-
<right-margin>Xpt</right-margin> - Used to specify right margin for pdf document. (pdf/postscript/rtf)
-
<top-margin>Xpt</top-margin> - Used to specify top margin for pdf document. (pdf/postscript/rtf)
-
<header-height>Xpt</header-height> - Used to specify bottom height for the page header in pdf. (pdf/postscript/rtf)
-
<footer-height>Xpt</footer-height> - Used to specify bottom height for the page footer in pdf. (pdf/postscript/rtf)
-
<bottom-margin>Xpt</bottom-margin> - Used to specify bottom margin for pdf document. (pdf/postscript/rtf)
-
<body-font-family></body-font-family> - Used to specify the font name for the pdf document body. (Removed. use css for this)
-
<body-font-size></body-font-size> - Used to specify the font size for the pdf document body. (Removed. use css for this)
-
<document-title-font-family></document-title-font-family> - Used to specify the font family for document title. (Removed. use css for this)
-
<document-title-font-size></document-title-font-size> - Used to specify the font size for document title. (Removed. use css for this)
-
<document-attributes-font-family></document-attributes-font-family> - Used to specify the font family for document attributes. (Removed. use css for this)
-
<document-attributes-font-size></document-attributes-font-size> - Used to specify the font size for document attributes. (Removed. use css for this)
-
<generate-section-numbers>yes or no</generate-section-numbers> - Used to specify whether sections numbers should be generated for each section. Default is yes. (pdf/postscript/rtf)
-
<generate-toc-page>yes or no</generate-toc-page> - Used to specify whether a toc page should be generated. Default is yes. (pdf/postscript/rtf)
- The data to be displayed as a document header can be specified in
the <document-header> element.
- The <document-body> element contains the actual content of
the document.
- The <table-of-content> element has a hierarchical tree of
<links> elements defining the sections hierarchy in
the document.
- The <link> element has a href attribute which
specifies the <section> element to link to. The value
of the href attribute should start with a # and should not contain
white spaces.
The name/label of the section to link to is described as text of
<link> element.
In order to define sections in a nested manner just define the sections hierarchy in the this section. The actual <section> should not be nested i.e. while writing the actual section tag there should not be nesting of section tag within it. For details see the nested-sections sample.
- The <section> element is used to define the contents
for each section of the document. This element has two attributes.
-
name - the name of the section. This should be same as the
the href attribute (without the #) of the <link> element
for this section under <table-of-content>.
-
label - the label to be displayed as the section's name.
The <section> can have text
and any xml safe html elements.
- The <section-link> element has a href attribute
which specifies the <section> element to link to. This tag is
basically used for giving links to a section from the document body.
Using this tag to link to sections makes sure that the link is maintained
irrespective of whether the document is converted to pdf, single html or
multi html format.
- The <document-footer> element contain the information to
be displayed as page footer.
- The are a set of special elements which are used while converting to pdf
format. These are:-
-
<page-break> - This element forces a page break
in the pdf document.
-
<page-number> - Inserts the page number of the
pdf document.
Any html tag can be used in the document but while converting to pdf/postscript/rtf only the following tags are supported.
-
a
-
img
-
font
-
u
-
s
-
b/strong
-
i/em
-
h1-h6
-
br
-
hr
-
div
-
p
-
pre
-
code
-
blockquote
-
address
-
center
-
ol
-
ul
-
li
-
dl/dt/dd
-
table
-
tr
-
td
-
sub
-
sup