From 27f054b7e2b2a0847a3812a24324fcc48779641f Mon Sep 17 00:00:00 2001 From: Moritz Bunkus Date: Wed, 11 Jan 2012 15:30:49 +0100 Subject: [PATCH] Script zum Bauen der Dokumentation sowie Dobudish-Custom-CFGs --- .gitignore | 1 + doc/build/custom-cfg/common.xsl | 24 ++ doc/build/custom-cfg/eclipse.xsl | 29 ++ doc/build/custom-cfg/epub.xsl | 29 ++ doc/build/custom-cfg/fo.xsl | 26 ++ doc/build/custom-cfg/html.xsl | 29 ++ doc/build/custom-cfg/htmlhelp.xsl | 29 ++ doc/build/custom-cfg/javahelp.xsl | 29 ++ doc/build/custom-cfg/local-entities.xml | 19 + doc/build/custom-cfg/localbuild.properties | 22 + doc/build/custom-cfg/localbuild.xml | 32 ++ doc/build/custom-cfg/manpages.xsl | 29 ++ doc/build/custom-cfg/rtf.xsl | 29 ++ doc/build/custom-cfg/singlehtml.xsl | 29 ++ doc/build/custom-cfg/singlexhtml.xsl | 29 ++ doc/build/custom-cfg/slides.xsl | 29 ++ doc/build/custom-cfg/style-common.css | 453 +++++++++++++++++++++ doc/build/custom-cfg/style-eclipse.css | 109 +++++ doc/build/custom-cfg/style-javahelp.css | 76 ++++ doc/build/custom-cfg/wordml.xsl | 29 ++ doc/build/custom-cfg/xhtml.xsl | 29 ++ doc/dokumentation.xml | 91 +++++ scripts/build_doc.sh | 40 ++ 23 files changed, 1241 insertions(+) create mode 100644 doc/build/custom-cfg/common.xsl create mode 100644 doc/build/custom-cfg/eclipse.xsl create mode 100644 doc/build/custom-cfg/epub.xsl create mode 100644 doc/build/custom-cfg/fo.xsl create mode 100644 doc/build/custom-cfg/html.xsl create mode 100644 doc/build/custom-cfg/htmlhelp.xsl create mode 100644 doc/build/custom-cfg/javahelp.xsl create mode 100644 doc/build/custom-cfg/local-entities.xml create mode 100644 doc/build/custom-cfg/localbuild.properties create mode 100644 doc/build/custom-cfg/localbuild.xml create mode 100644 doc/build/custom-cfg/manpages.xsl create mode 100644 doc/build/custom-cfg/rtf.xsl create mode 100644 doc/build/custom-cfg/singlehtml.xsl create mode 100644 doc/build/custom-cfg/singlexhtml.xsl create mode 100644 doc/build/custom-cfg/slides.xsl create mode 100644 doc/build/custom-cfg/style-common.css create mode 100644 doc/build/custom-cfg/style-eclipse.css create mode 100644 doc/build/custom-cfg/style-javahelp.css create mode 100644 doc/build/custom-cfg/wordml.xsl create mode 100644 doc/build/custom-cfg/xhtml.xsl create mode 100755 scripts/build_doc.sh diff --git a/.gitignore b/.gitignore index 81d3e4951..10b67869e 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,4 @@ crm /config/lx_office.conf /doc/online/*/*.html pod2html* +/doc/build/dobudish* diff --git a/doc/build/custom-cfg/common.xsl b/doc/build/custom-cfg/common.xsl new file mode 100644 index 000000000..13239cb6d --- /dev/null +++ b/doc/build/custom-cfg/common.xsl @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/build/custom-cfg/eclipse.xsl b/doc/build/custom-cfg/eclipse.xsl new file mode 100644 index 000000000..817da3211 --- /dev/null +++ b/doc/build/custom-cfg/eclipse.xsl @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/build/custom-cfg/epub.xsl b/doc/build/custom-cfg/epub.xsl new file mode 100644 index 000000000..508d78331 --- /dev/null +++ b/doc/build/custom-cfg/epub.xsl @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/build/custom-cfg/fo.xsl b/doc/build/custom-cfg/fo.xsl new file mode 100644 index 000000000..bee213690 --- /dev/null +++ b/doc/build/custom-cfg/fo.xsl @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/build/custom-cfg/html.xsl b/doc/build/custom-cfg/html.xsl new file mode 100644 index 000000000..042bd8a9b --- /dev/null +++ b/doc/build/custom-cfg/html.xsl @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/build/custom-cfg/htmlhelp.xsl b/doc/build/custom-cfg/htmlhelp.xsl new file mode 100644 index 000000000..5462cd877 --- /dev/null +++ b/doc/build/custom-cfg/htmlhelp.xsl @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/build/custom-cfg/javahelp.xsl b/doc/build/custom-cfg/javahelp.xsl new file mode 100644 index 000000000..50d5aee94 --- /dev/null +++ b/doc/build/custom-cfg/javahelp.xsl @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/build/custom-cfg/local-entities.xml b/doc/build/custom-cfg/local-entities.xml new file mode 100644 index 000000000..9f4216b15 --- /dev/null +++ b/doc/build/custom-cfg/local-entities.xml @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + + + + + + diff --git a/doc/build/custom-cfg/localbuild.properties b/doc/build/custom-cfg/localbuild.properties new file mode 100644 index 000000000..d6bef7633 --- /dev/null +++ b/doc/build/custom-cfg/localbuild.properties @@ -0,0 +1,22 @@ +# BEGIN Do not overwrite +document.type = book +# END Do not overwrite + +# Overwrite properties here + +# If you happen to have sub documents you can set here the document type of each one of those. +#document..type = article|book|set|website|slides... + +# These are needed for the 'eclipse' target +eclipse.plugin.id=com.mycompany +eclipse.plugin.name=Document Name +eclipse.plugin.provider=My Company + +# The version of the eclipse plugin +eclipse.plugin.version=${document.version} + +# The version of the document +document.version = 1.0 + +# The name of the folder whose content will be carbon copied to the output directory +special.folder.name.carbonCopy=copy_to_output diff --git a/doc/build/custom-cfg/localbuild.xml b/doc/build/custom-cfg/localbuild.xml new file mode 100644 index 000000000..acd490d44 --- /dev/null +++ b/doc/build/custom-cfg/localbuild.xml @@ -0,0 +1,32 @@ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/build/custom-cfg/manpages.xsl b/doc/build/custom-cfg/manpages.xsl new file mode 100644 index 000000000..9a1b74474 --- /dev/null +++ b/doc/build/custom-cfg/manpages.xsl @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/build/custom-cfg/rtf.xsl b/doc/build/custom-cfg/rtf.xsl new file mode 100644 index 000000000..da292db9b --- /dev/null +++ b/doc/build/custom-cfg/rtf.xsl @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/build/custom-cfg/singlehtml.xsl b/doc/build/custom-cfg/singlehtml.xsl new file mode 100644 index 000000000..f4339067d --- /dev/null +++ b/doc/build/custom-cfg/singlehtml.xsl @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/build/custom-cfg/singlexhtml.xsl b/doc/build/custom-cfg/singlexhtml.xsl new file mode 100644 index 000000000..24689739e --- /dev/null +++ b/doc/build/custom-cfg/singlexhtml.xsl @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/build/custom-cfg/slides.xsl b/doc/build/custom-cfg/slides.xsl new file mode 100644 index 000000000..015358616 --- /dev/null +++ b/doc/build/custom-cfg/slides.xsl @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/build/custom-cfg/style-common.css b/doc/build/custom-cfg/style-common.css new file mode 100644 index 000000000..b001aba85 --- /dev/null +++ b/doc/build/custom-cfg/style-common.css @@ -0,0 +1,453 @@ +/* Basic Settings: */ + +body { + background-color: White; /* black foreground */ + color: Black; /* center the body content in browser window */ + margin: auto; /* padding ("inner margin") leaves space between */ + padding: 24px; /* set width according to browser window width */ + width: auto; /* text alignment */ + text-align: justify; /* text-align: left; */ +} + +/* para */ +p { + /* font size, line height, font */ + /* list of fonts provides fallbacks if a font is not present */ + font: 12px/18px Verdana, Arial, Helvetica, Sans-Serif; + + /* margin (top - right - bottom - left) */ + margin: 0 15px 6px 15px; +} + + + + +/* NEEDS TO BE CLEARED UP */ + + +p, td, li, dt, dd +{ + /* font size, line height, font */ + /* list of fonts provides fallbacks if a font is not present */ + font: 12px/18px Verdana, Arial, Helvetica, Sans-Serif; +} + + + +/* set font for most elements */ +/* p: paragraphs (regular text, docbook ) */ +/* (...) */ +/* body: anything else */ +body, p, td, li, dt, dd, +{ +/* set font size and line height */ +/* list of fonts provides fallbacks if a font is not present */ +font: 12px/18px Verdana, Arial, Helvetica, Sans-Serif; +} + +/* images */ +/* docbook: */ +img { +/* no margin */ +margin: 0; + +/* no padding ("inner margin") */ +padding: 0; + +/* no border */ +border: 0; +} + + +/* emphasized text, can occur in most places */ +/* docbook: */ +em { +/* bold face, higher number is more bold */ +font-weight: 600; +/* italic */ +font-style: italic; +} + + +/* sect(ion)1 title */ +h2 { + font-family: Georgia, Verdana, Arial, Helvetica, Sans-Serif; /* font size, relative to body font size */ + font-size: 125%; /* bold face, higher number is more bold */ + font-weight: 600; /* underlined text */ + text-decoration: none; /* foreground color: dark blue */ + color: Black; /* background color: gray */ + background-color: Orange; /* margin settings are top - right - bottom - left (think clockwise) */ + margin: 15px 0 15px 0; /* padding ("inner margin") settings are top - right - bottom - left */ +/* (think clockwise) */ + padding: 8px 15px 8px 15px; + /* border: 1px solid #000; */ +} + + +/* sect(ion)2 title */ +h3 { + font-family: Georgia, Verdana, Arial, Helvetica, Sans-Serif; /* font size, relative to body font size */ + font-size: 110%; /* bold face, higher number is more bold */ + font-weight: 600; /* underlined text */ + text-decoration: none; /* foreground color: dark blue */ + color: Black; /* background-color is a very light grey */ + background-color: #fefefe; /* padding ("inner margin") settings are top - right - bottom - left */ +/* (think clockwise) */ + padding: 0 0 0 15px; +} + + +/* sect(ion)3 title */ +h4 { + font-family: Georgia, Verdana, Arial, Helvetica, Sans-Serif; /* font size, relative to body font size */ + font-size: 100%; /* bold face, higher number is more bold */ + font-weight: 600; /* underlined text */ + text-decoration: none; /* foreground color: dark blue */ + color: Black; /* background-color is a very light grey */ + background-color: #fefefe; /* padding ("inner margin") settings are top - right - bottom - left */ +/* (think clockwise) */ + padding: 0 0 0 15px; +} + + +/* sect(ion)4 title */ +h5 { + font-family: Georgia, Verdana, Arial, Helvetica, Sans-Serif; /* font size, relative to body font size */ + font-size: 100%; /* bold face, higher number is more bold */ + font-weight: 300; /* not underlined */ + text-decoration: none; /* foreground color: dark blue */ + color: Black; /* background-color is a very light grey */ + background-color: #fefefe; /* padding ("inner margin") settings are top - right - bottom - left */ +/* (think clockwise) */ + padding: 0 0 0 15px; +} + +/* the following formats refer to the docbook tags of the same name */ +/* for more information, see the docbook reference at */ +/* http://www.docbook.org/tdg/en/html/docbook.html */ + +.mediaobject +{ +/* center */ +text-align: center; +} + + +/* */ +.calloutlist, .figure, .table +{ +/* margin settings are top - right - bottom - left (think clockwise) */ +margin: 15px 30px 15px 30px; +} + + +/* */ +.itemizedlist, .variablelist { +/* margin settings are top - right - bottom - left (think clockwise) */ +margin: 15px 30px 15px 15px; +} + +/* blockquote formatting is a little more complex */ +/* because block quotes are rendered as a html table */ + +/* blockquote block */ +.blockquote +{ +/* override bottom margin, the other margins are inherited */ +margin-bottom: 30px; +} + +.blockquote p, .blockquote td +{ +/* set font size and line height */ +/* list of fonts provides fallbacks if a font is not present */ +font: 12px/18px Verdana, Arial, Helvetica, Sans-Serif; + +/* bold face, higher number is more bold */ +font-weight: 450; +} + + +.epigraph +{ +/* override bottom margin, the other margins are inherited */ +margin-bottom: 30px; +} + +.epigraph p, .epigraph td +{ +/* set font size and line height */ +/* list of fonts provides fallbacks if a font is not present */ +font: 10px/14px Verdana, Arial, Helvetica, Sans-Serif; + +/* bold face, higher number is more bold */ +font-weight: 600; +} + + + +/* custom header and footer that are displayed on all pages */ +#customheader, #customfooter +{ +/* list of fonts provides fallbacks if a font is not present */ +font-family: Verdana, Arial, Helvetica, Sans-Serif; + +/* font size, relative to body font size */ +font-size: 80%; + +/* line height, relative to body font size */ +line-height: 200%; + + +text-align: center; +vertical-align: middle; +color: #fff; +background-color: #009; +} + + +/* leave more space between last paragraph and footer */ +/* some browser do not add up the bottom margin of the prior element */ +/* and the top margin of the footer */ +#customfooter { +margin-top: 15px; +} + + + +/* table { margin: 0 15px 6px 15px; } */ + + +/* title and navigation links in header and footer */ +.navheader th, .navheader td, .navfooter th, .navfooter td +{ +font-size: 11px; +font-weight: 450; +} + + +/* table of contents, list of figures and list of tables */ +.toc, .list-of-figures, .list-of-tables, .list-of-examples +{ +/* margin settings are top - right - bottom - left (think clockwise) */ +margin: 15px 30px 15px 15px; +} + + +/* the "headings" are rendered as paragraphs */ +.toc p, .list-of-figures p, .list-of-tables p, .list-of-examples p +{ +/* no margin */ +margin: 0; +} + + +.figure +{ +/* margin settings are top - right - bottom - left (think clockwise) */ +margin: 5px 5px 5px 5px; + +/* no padding ("inner border") */ +padding: 0; + +/* no border */ +border: 0; + +/* center text */ +text-align: center; +} + + +/* figure title */ +.figure p, .table p, .example p +{ +font-size: 80%; +} + + +/* +acronym { + border-bottom: 1px dashed #00cc00; + cursor: help; +} +*/ + + +/* admonition headings */ +div.note, div.important, div.warning, div.caution, div.tip +{ +padding: 0px 15px 0px 0px; +} + +div.note th, div.important th, div.warning th, div.caution th, div.tip th +{ +/* set font size and line height */ +/* list of fonts provides fallbacks if a font is not present */ +font: 12px/18px Verdana, Arial, Helvetica, Sans-Serif; + +font-weight: 600; + +text-decoration: underline; + +/* left align */ +text-align: left; +} + +.note p, .important p, .warning p, .caution p, .tip p +{ +margin: 0; +} + +.note img, .important img, .warning img, .caution img, .tip img +{ +margin: 0px 15px 0px 15px; +} + + +/* programlisting */ +pre.programlisting +{ +/* non-proportional font */ +/* list of fonts provides fallbacks if a font is not present */ +font-family: "Courier New", Courier, Monospace; + +/* color: black */ +color: #000; + +/* background color: gray */ +background-color: #eee; + +/* no margin */ +margin: 0; + +/* gray dotted border, 1 px wide */ +border: 1px dotted #ddd; + +/* padding ("inner margin") settings are top - right - bottom - left */ +/* (think clockwise) */ +padding: 6px 6px 6px 6px; +} + + +/* title page */ + + +/* heading1 is used for document title */ +h1 +{ + font-family: Georgia,Verdana, Arial, Helvetica, Sans-Serif; /* font size, relative to body font size */ + font-size: 150%; /* bold face, higher number is more bold */ + font-weight: 600; /* line height, relative to body line height */ + line-height: 250%; /* center */ + text-align: center; /* foreground color: dark blue */ + color: Black; /* background color: gray */ + background-color: Orange; /* margin settings are top - right - bottom - left (think clockwise) */ + margin: 15px 0 15px 0; /* no padding ("inner margin") */ + padding: 15; + border: 1px solid #000; +} + + + +/* author on title page is formatted as h3 */ +/* these settings overwrite the regular h3 settings */ +h3.author { +/* set font size and line height */ +/* list of fonts provides fallbacks in case selected fonts are not present */ +font: 12px/18px Verdana, Arial, Helvetica, Sans-Serif; + +/* bold face, higher number is more bold */ +font-weight: 600; + +/* do not underline */ +text-decoration: none; + +/* center text */ +text-align: center; + +/* color: black */ +color: #000; + +/* background-color is a very light grey */ +/* alternative: #fff = white */ +background-color: #fefefe; + +/* margin settings are top - right - bottom - left (think clockwise) */ +margin: 0 15px 15px 15px; + +/* no padding */ +padding: 0; + +/* no border */ +border: 0; +} + + +/* copyright and date */ +.copyright, .pubdate +{ +/* list of fonts provides fallbacks if a font is not present */ +font-family: Verdana, Arial, Helvetica, Sans-Serif; + +/* font size, relative to body font size */ +font-size: 90%; + +/* center */ +text-align: center; + +/* margin settings are top - right - bottom - left (think clockwise) */ +margin: 15px 15px 15px 15px; + +/* no padding ("inner margin") */ +padding: 0; + +/* no border */ +border: 0; +} + + +/* legal notice box */ +div.legalnotice +{ + font-family: Verdana, Arial, Helvetica, Sans-Serif; /* font size, relative to body font size */ + font-size: 90%; /* color: black */ + color: #000; /* background color: gray */ + background-color: Orange; /* margin settings are top - right - bottom - left (think clockwise) */ + margin: 10px 45px 10px 45px; /* padding ("inner margin") settings are top - right - bottom - left */ + padding: 5px 5px 5px 5px; /* solid black border, 1px wide */ + border: 1px solid #000; +} + + +table { + /* border: thin solid orange; */ + border-spacing: 0pt; + margin-top: 5; + margin-bottom: 5; +} + +td { + font-family: SansSerif, Arial, Helvetica, sans-serif; + padding-left: 1; + padding-right: 1; + padding-top: 1; + padding-bottom: 1 +} + +th { + /* border: thin solid orange; */ + padding-left: 1; + padding-right: 1; + padding-top: 1; + padding-bottom: 1 +} + +.informaltable { + border-collapse: collapse; + table-layout: auto; +} + +.revhistory { + border-collapse: collapse; + table-layout: auto; +} \ No newline at end of file diff --git a/doc/build/custom-cfg/style-eclipse.css b/doc/build/custom-cfg/style-eclipse.css new file mode 100644 index 000000000..f43bf3e99 --- /dev/null +++ b/doc/build/custom-cfg/style-eclipse.css @@ -0,0 +1,109 @@ +body {font-size: 10pt; + font-family: SansSerif, Arial, Helvetica, sans-serif; + margin-left: 10; + margin-right: 5; + color: Black; + background-color: White} + +h1 { + font-size: 18pt; +} + +h2 { + font-size: 16pt; +} + +h3 { + font-size: 14pt; +} + +h4 { + font-size: 12pt; +} + +table { + font-size: 10pt; + border-style: none; + border-color: silver; + margin-top: 5; + margin-bottom: 5 +} + +td {font-size: 10pt; + font-family: SansSerif, Arial, Helvetica, sans-serif; + border-color: silver; + padding-left: 1; + padding-right: 1; + padding-top: 1; + padding-bottom: 1} + +th {border-style: none; + font-weight: bold; + border-color: silver; + padding-left: 1; + padding-right: 1; + padding-top: 1; + padding-bottom: 1} + +kbd { + font-family: monospace; + font-weight: bold; +} + +var { + font-style: italic; +} + +ol { + margin-bottom: 1em; +} + +dt { + font-weight: bold; + margin-top: 1em; +} + +li { + margin-top: 1em; +} + +span.control { + font-weight: bold; +} + +span.name { + font-style: italic; + font-weight: bold; +} + +span.action { + font-style: italic; +} + +span.code { + font-family: monospace; +} + +span.menu { + color: #660033; + font-weight: bold; +} + +span.filefolder { + font-family: monospace; +} + +blockquote { + background-color: #e8e8e8; + border: 1pt black; + margin: 2em; border: 1px solid black; + padding: 1em; +} + +.tasks, .reference, .faq { + padding-left: 18px; + font-size: 14pt; + background-image:url(images/bullet14.png); + background-repeat: no-repeat; + background-position: left; + } \ No newline at end of file diff --git a/doc/build/custom-cfg/style-javahelp.css b/doc/build/custom-cfg/style-javahelp.css new file mode 100644 index 000000000..29440e5a6 --- /dev/null +++ b/doc/build/custom-cfg/style-javahelp.css @@ -0,0 +1,76 @@ +/* + * jhexamples.css 06/17/2003 + * + * Copyright 2002 Sun Microsystems, Inc. All rights reserved. + * Use is subject to license terms. + * + */ + +body {font-size: 12pt; + font-family: SansSerif, Arial, Helvetica, sans-serif; + margin-left: 10; + margin-right: 5; + color: Black; + background-color: White} + +p {font-size: 12pt; + margin-top: 5; + margin-bottom: 5} + + +h1 { font-size: 22pt; + font-weight: bold; + margin-top: 0; + margin-bottom: 10} + +h2 { font-size: 18pt; + font-weight: bold; + margin-top: 20; + margin-bottom: 10} + +h3 { font-size: 14pt; + font-weight: bold; + margin-top: 10; + margin-bottom: 5} + +h4 { font-size: 12pt; + font-weight: bold; + margin-top: 10; + margin-bottom: 5} + +ol {margin-top: 5; + margin-bottom: 0; + margin-left: 30} + +li {margin-top: 0; + margin-bottom: 5} + +li p{margin-top: 5; + margin-bottom: 0} + +ul {margin-top: 5; + margin-bottom: 0; + margin-left: 30} + +table {border-style: none; + border-color: silver; + margin-top: 5; + margin-bottom: 5} + +td {font-size: 12pt; + font-family: SansSerif, Arial, Helvetica, sans-serif; + border-color: silver; + padding-left: 1; + padding-right: 1; + padding-top: 1; + padding-bottom: 1} + +th {border-style: none; + border-color: silver; + padding-left: 1; + padding-right: 1; + padding-top: 1; + padding-bottom: 1} + +small {font-size: x-small} + diff --git a/doc/build/custom-cfg/wordml.xsl b/doc/build/custom-cfg/wordml.xsl new file mode 100644 index 000000000..3eecdf577 --- /dev/null +++ b/doc/build/custom-cfg/wordml.xsl @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/build/custom-cfg/xhtml.xsl b/doc/build/custom-cfg/xhtml.xsl new file mode 100644 index 000000000..2ced74b26 --- /dev/null +++ b/doc/build/custom-cfg/xhtml.xsl @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/dokumentation.xml b/doc/dokumentation.xml index 9e57a961a..b2bc70847 100644 --- a/doc/dokumentation.xml +++ b/doc/dokumentation.xml @@ -5429,5 +5429,96 @@ $some_hash{42} = 54; + + + Dokumentation erstellen + + + Einführung + + + Diese Dokumentation ist in DocBook XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein + Text-Editor. Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen Editor nutzt, der spezielle Unterstützung für + DocBook mitbringt. Wir empfehlen dafür den XMLmind XML + Editor, der bei nicht kommerzieller Nutzung kostenlos ist. + + + + + Benötigte Software + + + Bei DocBook ist Prinzip, dass ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden dann + mit entsprechenden Stylesheets andere Formate wie PDF oder HTML erzeugt. Bei Lx-Office übernimmt diese Aufgabe das Shell-Script + scripts/build_doc.sh. + + + + Das Script benötigt zur Konvertierung verschiedene Softwarekomponenten, die im normalen Lx-Office-Betrieb nicht benötigt werden: + + + + + + Java in einer halbwegs aktuellen Version + + + + + + Das Java-Build-System Apache Ant + + + + + + Das Dokumentations-System Dobudish für DocBook 4.5, eine Zusammenstellung diverser Stylesheets und + Grafiken zur Konvertierung von DocBook XML in andere Formate. Das Paket, das benötigt wird, ist zum + Zeitpunkt der Dokumentationserstellung dobudish-nojre-1.1.4.zip, aus auf code.google.com bereitsteht. + + + + + + Apache Ant sowie ein dazu passendes Java Runtime Environment sind auf allen gängigen Plattformen verfügbar. Beispiel für + Debian/Ubuntu: + + + apt-get install ant openjdk-7-jre + + + Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis doc/build entpackt werden. Beispiel unter der + Annahme, das Dobudish in $HOME/Downloads heruntergeladen wurde: + + + cd doc/build +unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip + + + + PDFs und HTML-Seiten erstellen + + + Die eigentliche Konvertierung erfolgt nach Installation der benötigten Software mit einem einfachen Aufruf direkt aus dem + Lx-Office-Installationsverzeichnis heraus: + + + ./scripts/build_doc.sh + + + + Einchecken in das Git-Repository + + + Sowohl die XML-Datei als auch die erzeugten PDF- und HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass nach + Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut und alles zusammen in einem Commit eingecheckt werden sollten. + + + + Die "dobudish"-Verzeichnisse bzw. symbolischen Links gehören hingegen nicht in das Repository. + + + diff --git a/scripts/build_doc.sh b/scripts/build_doc.sh new file mode 100755 index 000000000..0db7bf330 --- /dev/null +++ b/scripts/build_doc.sh @@ -0,0 +1,40 @@ +#!/bin/bash + +# Usage: +# cd /path/to/lx-office +# ./scripts/build_doc.sh + +set -e + +if [[ ! -d doc ]]; then + echo "Please run this from the installation directory." + exit 1 +fi + +dobudish=$(ls -d doc/build/dobudish* 2> /dev/null) + +if [[ -z $dobudish ]] || [[ ! -d ${dobudish} ]]; then + echo "There's no dobudish directory inside doc/build." + exit 1 +fi + +cd ${dobudish} + +base=documents/dokumentation +if [[ ! -d $base ]]; then + ./generator.sh dokumentation create book +fi + +input=${base}/input +output=${base}/output +custom=${base}/custom-cfg + +rm -f ${input}/*.xml +cp ../../dokumentation.xml ${input}/ + +rm -f ${custom}/* +cp -R ../custom-cfg/* ${custom}/ + +./generator.sh dokumentation pdf + +cp ${output}/pdf/dokumentation.pdf ../../ -- 2.20.1