ardour/livetrax
13
0
Fork 0
Code
d5435543ab
livetrax/manual/xmlformat/xmlformat-ardour.conf

138 lines
2.5 KiB
Plaintext
Raw Normal View History

Added the BSD licensed xmlformat utility for keeping the xml pretty and consistant aswell as a configuration file. When I converted the manual to docbook I was using an old version that I'd modified to insert tabs rather than spaces so using it on the existing documentation will appear to reformat the whole file. I don't think that matters at this stage and I'm tempted to reformat everything now while it isn't an issue. Rewrote the Makefile that builds the docs so that: - building the html only depends on having xsltproc installed. - the xsl and xml files aren't copied to the build directory. - make test does not remove an existing build of the docs. Changed the glossary so that the acronym/abbreviations are the glossary terms, which I've discovered is how it is generally done. It makes total sense now that I actually think about it because you need to find the terms based on their use in the manual. Added a bit of xsl to add the status attribute as a class attribute in the html so that the css can use a draft watermark(or any other watermark). DocBook supports the draft status without the xsl but it has problems, which I've described in the xsl file. Minor tweak to the css to make the glossary terms and any other definition lists bold(that includes the index). git-svn-id: svn://localhost/ardour2/trunk@1457 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-02-14 06:23:38 -05:00
# Comments are treated as CDATA and not touched. It's best to set
# them out from other text if possible. A doublespace is nice but
# code is still code, so it's not really that important. (Down, inner
# stickler...)
#
*DEFAULT
format = block
entry-break = 1
element-break = 1
exit-break = 1
Add a help target(the default target) and format target to the manual Makefile Reformat the docs, I explained in a prior commit why this modifies every file git-svn-id: svn://localhost/ardour2/trunk@1463 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-02-14 22:49:43 -05:00
subindent = 2
Added the BSD licensed xmlformat utility for keeping the xml pretty and consistant aswell as a configuration file. When I converted the manual to docbook I was using an old version that I'd modified to insert tabs rather than spaces so using it on the existing documentation will appear to reformat the whole file. I don't think that matters at this stage and I'm tempted to reformat everything now while it isn't an issue. Rewrote the Makefile that builds the docs so that: - building the html only depends on having xsltproc installed. - the xsl and xml files aren't copied to the build directory. - make test does not remove an existing build of the docs. Changed the glossary so that the acronym/abbreviations are the glossary terms, which I've discovered is how it is generally done. It makes total sense now that I actually think about it because you need to find the terms based on their use in the manual. Added a bit of xsl to add the status attribute as a class attribute in the html so that the css can use a draft watermark(or any other watermark). DocBook supports the draft status without the xsl but it has problems, which I've described in the xsl file. Minor tweak to the css to make the glossary terms and any other definition lists bold(that includes the index). git-svn-id: svn://localhost/ardour2/trunk@1457 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-02-14 06:23:38 -05:00
normalize = no
Add a help target(the default target) and format target to the manual Makefile Reformat the docs, I explained in a prior commit why this modifies every file git-svn-id: svn://localhost/ardour2/trunk@1463 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-02-14 22:49:43 -05:00
wrap-length = 76
Added the BSD licensed xmlformat utility for keeping the xml pretty and consistant aswell as a configuration file. When I converted the manual to docbook I was using an old version that I'd modified to insert tabs rather than spaces so using it on the existing documentation will appear to reformat the whole file. I don't think that matters at this stage and I'm tempted to reformat everything now while it isn't an issue. Rewrote the Makefile that builds the docs so that: - building the html only depends on having xsltproc installed. - the xsl and xml files aren't copied to the build directory. - make test does not remove an existing build of the docs. Changed the glossary so that the acronym/abbreviations are the glossary terms, which I've discovered is how it is generally done. It makes total sense now that I actually think about it because you need to find the terms based on their use in the manual. Added a bit of xsl to add the status attribute as a class attribute in the html so that the css can use a draft watermark(or any other watermark). DocBook supports the draft status without the xsl but it has problems, which I've described in the xsl file. Minor tweak to the css to make the glossary terms and any other definition lists bold(that includes the index). git-svn-id: svn://localhost/ardour2/trunk@1457 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-02-14 06:23:38 -05:00
*DOCUMENT
format = block
wrap-length = 256
element-break = 2
article book
element-break = 2
articleinfo bookinfo
normalize = yes
year holder
entry-break = 0
exit-break = 0
normalize = yes
firstname surname othername
entry-break = 0
exit-break = 0
normalize = yes
revnumber date authorinitials
entry-break = 0
exit-break = 0
normalize = yes
revremark
normalize = yes
Add a help target(the default target) and format target to the manual Makefile Reformat the docs, I explained in a prior commit why this modifies every file git-svn-id: svn://localhost/ardour2/trunk@1463 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-02-14 22:49:43 -05:00
row listitem
entry-break = 1
exit-break = 1
normalize = yes
tbody
element-break = 2
Fix the formatting of appendix elements in the manual git-svn-id: svn://localhost/ardour2/trunk@2329 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-08-18 22:45:16 -04:00
section chapter glossary appendix
Added the BSD licensed xmlformat utility for keeping the xml pretty and consistant aswell as a configuration file. When I converted the manual to docbook I was using an old version that I'd modified to insert tabs rather than spaces so using it on the existing documentation will appear to reformat the whole file. I don't think that matters at this stage and I'm tempted to reformat everything now while it isn't an issue. Rewrote the Makefile that builds the docs so that: - building the html only depends on having xsltproc installed. - the xsl and xml files aren't copied to the build directory. - make test does not remove an existing build of the docs. Changed the glossary so that the acronym/abbreviations are the glossary terms, which I've discovered is how it is generally done. It makes total sense now that I actually think about it because you need to find the terms based on their use in the manual. Added a bit of xsl to add the status attribute as a class attribute in the html so that the css can use a draft watermark(or any other watermark). DocBook supports the draft status without the xsl but it has problems, which I've described in the xsl file. Minor tweak to the css to make the glossary terms and any other definition lists bold(that includes the index). git-svn-id: svn://localhost/ardour2/trunk@1457 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-02-14 06:23:38 -05:00
entry-break = 1
exit-break = 1
normalize = yes
# "Normalize" means make smart whitespace decisions
para simpara example important note warning caution itemizedlist variablelist varlistentry entry quote figure glossdiv glossentry
entry-break = 1
exit-break = 1
normalize = yes
title titleabbrev
format = inline
normalize = yes
table
entry-break = 1
exit-break = 1
normalize = yes
emphasis literal abbrev
format = inline
trademark
format = inline
# Do not fubar <screen> or <programlisting>
screen programlisting
format = verbatim
# <entry> is special because a linebreak has meaning, best leave the
# decisions up to the experts
#entry
# format = verbatim
command application filename option userinput computeroutput replaceable glossterm
format = inline
# The <primary> and <secondary> subelements of <indexterm> are still block
firstterm
format = inline
normalize = yes
indexterm
format = block
normalize = no
primary secondary
# format = inline
entry-break = 0
exit-break = 0
normalize = yes
varlistentry
element-break = 1
term
entry-break = 0
exit-break = 0
menuchoice guilabel guimenu guisubmenu guimenuitem guibutton keycap keycombo mousebutton
format = inline
wordasword systemitem citetitle footnote email
format = inline
acronym
format = inline
# Make <ulink> and <xref> less goofy in their use of whitespace
ulink xref link
format = inline
# Cover OMF files
creator description format identifier language maintainer omf relation subject type
format = block
normalize = yes
entry-break = 1
exit-break = 1
# Cover rpm-info files
details rights version
format = block
entry-break = 0
exit-break = 0
normalize = yes
Copy Permalink