smokephil/ardour
1
0
Fork 0
mirror of https://github.com/Ardour/ardour.git synced 2025-12-17 12:16:30 +01:00
Code Issues Projects Releases Wiki Activity
ardour/manual/Makefile

44 lines
949 B
Makefile
Raw Normal View History

Add the ardour manual converted to docbook format with only a few minor additions. Add dbhelper.vim key stroke mappings I use for working with docbook source. There are no xsl or css files for customizing the html output so it will look really boring...this will only be temporary. Support for content localization and generation of pdf's is planned. git-svn-id: svn://localhost/ardour2/trunk@1405 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-02-02 04:29:55 +00:00
DOCNAME = ardour_manual
# Default values, only set if not set in book Makefile
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 11:23:38 +00:00
OUTDIR ?= tmp
XMLFILE ?= xml/$(DOCNAME).xml
XSLFILE ?= xsl/html.xsl
CSSFILE ?= $(DOCNAME).css
XSLTPROC ?= xsltproc
#PWD = $(shell pwd)
# xsltproc -output option gives I/O errors because??, so
# just move the html to the output directory
html:: clean
# creating output directory
-@mkdir $(OUTDIR)
# generating html
LANG=en_US.UTF-8 $(XSLTPROC) -xinclude $(XSLFILE) $(XMLFILE)
# copy html files to output directory
-@mv *.html $(OUTDIR)
# copy css file to output directory
-@cp css/$(CSSFILE) $(OUTDIR)/$(CSSFILE)
# copy the image files to the output directory
-@cp -r images $(OUTDIR)/images
Add the ardour manual converted to docbook format with only a few minor additions. Add dbhelper.vim key stroke mappings I use for working with docbook source. There are no xsl or css files for customizing the html output so it will look really boring...this will only be temporary. Support for content localization and generation of pdf's is planned. git-svn-id: svn://localhost/ardour2/trunk@1405 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-02-02 04:29:55 +00:00
.PHONY : html
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 11:23:38 +00:00
test::
Add the ardour manual converted to docbook format with only a few minor additions. Add dbhelper.vim key stroke mappings I use for working with docbook source. There are no xsl or css files for customizing the html output so it will look really boring...this will only be temporary. Support for content localization and generation of pdf's is planned. git-svn-id: svn://localhost/ardour2/trunk@1405 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-02-02 04:29:55 +00:00
xmllint --noout --postvalid --xinclude $(XMLFILE)
some fixes/improvements for track selection; add upload target to manual makefile; do not build peakfile for SilentFileSource git-svn-id: svn://localhost/ardour2/trunk@1426 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-02-06 15:50:05 +00:00
Add the ardour manual converted to docbook format with only a few minor additions. Add dbhelper.vim key stroke mappings I use for working with docbook source. There are no xsl or css files for customizing the html output so it will look really boring...this will only be temporary. Support for content localization and generation of pdf's is planned. git-svn-id: svn://localhost/ardour2/trunk@1405 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-02-02 04:29:55 +00:00
.PHONY : test
clean::
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 11:23:38 +00:00
@rm -rf $(OUTDIR)
Add the ardour manual converted to docbook format with only a few minor additions. Add dbhelper.vim key stroke mappings I use for working with docbook source. There are no xsl or css files for customizing the html output so it will look really boring...this will only be temporary. Support for content localization and generation of pdf's is planned. git-svn-id: svn://localhost/ardour2/trunk@1405 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-02-02 04:29:55 +00:00
.PHONY : clean
some fixes/improvements for track selection; add upload target to manual makefile; do not build peakfile for SilentFileSource git-svn-id: svn://localhost/ardour2/trunk@1426 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-02-06 15:50:05 +00:00
upload: html
cd tmp && tar cf - . | bzip2 > ../man.tar.bz2
scp man.tar.bz2 las@ardour.org:ardour.org
.PHONY : upload
Reference in a new issue Copy permalink