is a personal and small business finance application (documentation).
| README (gnucash-docs-4.13) | : | README (gnucash-docs-5.0) |
|---|
| | |
| skipping to change at line 125 | | skipping to change at line 125 |
|---|
| make epub | | make epub |
| | |
| To generate the documentation in mobi format, instead run | | To generate the documentation in mobi format, instead run |
| | |
| make mobi | | make mobi |
| (Note: mobi is generated from epub, so this generates epub files as well.) | | (Note: mobi is generated from epub, so this generates epub files as well.) |
| | |
| If you only wish to generate a subset of the documentation, you can. However | | If you only wish to generate a subset of the documentation, you can. However |
| the way to do so depends on the build system: | | the way to do so depends on the build system: |
| | |
|
| - CMake | | |
| There are specific targets for each document. The target is of the form | | There are specific targets for each document. The target is of the form |
|
| <language>-gnucash-<doc>-<type>. | | <language>-<doc>-<type>. |
| | |
| For example to only generate the English concepts guide: | | For example to only generate the English concepts guide: |
| | |
|
| make C-gnucash-guide-html | | make C-guide-html |
| make C-gnucash-guide-pdf | | make C-guide-pdf |
| make C-gnucash-guide-epub | | make C-guide-epub |
| make C-gnucash-guide-mobi | | make C-guide-mobi |
| | |
| depending on the output format you require. | | depending on the output format you require. |
| | |
|
| In addition one could generate these formats for one document in all | | In addition one could generate all documents in these formats for one language |
| languages at once by omitting the language specifier in the target. | | at once by omitting the document specifier in the target. |
| | |
| For example: | | For example: |
| | |
|
| make gnucash-help-html | | make C-html |
| | |
|
| will generate the html version of the help document in all supported | | will generate the html version of all documents in English. At the time of |
| languages. | | writing this, there are two documents in English, namely guide and manual |
| | so these two will be built. |
| depending on the output format you require. | | |
| | |
| * Running syntax checks by xmllint | | * Running syntax checks by xmllint |
| ----------------- | | ----------------- |
| You can also run xmllint on all documents or a specific document with the comman
d | | You can also run xmllint on all documents or a specific document with the comman
d |
| | |
| make check # for toplevel check | | make check # for toplevel check |
|
| make de-gnucash-help-check # for a cmake check for one specific document | | make de-manual-check # for a cmake check for one specific document |
| # in this example - the German help guide | | # in this example - the German help manual |
| | |
| * XML/XSL-based tools: | | * XML/XSL-based tools: |
| ---------------------- | | ---------------------- |
| | |
| If you have xmlto installed, this can be used to convert to other formats | | If you have xmlto installed, this can be used to convert to other formats |
| but problems have been experienced with PDF generation. If you output | | but problems have been experienced with PDF generation. If you output |
| an XML-FO format using xmlto, you could use FOP to convert to PDF - this | | an XML-FO format using xmlto, you could use FOP to convert to PDF - this |
| step requires Java. See man xmlto for more information. | | step requires Java. See man xmlto for more information. |
| | |
| Formats available with xmlto include: | | Formats available with xmlto include: |
| | |
| skipping to change at line 184 | | skipping to change at line 182 |
|---|
| There are no manpages in gnucash-docs. | | There are no manpages in gnucash-docs. |
| | |
| xmlto uses xsltproc - the same tool and the same stylesheets as the main | | xmlto uses xsltproc - the same tool and the same stylesheets as the main |
| make and install. | | make and install. |
| | |
| Examples: | | Examples: |
| | |
| To convert the GnuCash Tutorial and Concepts Guide DocBook XML document | | To convert the GnuCash Tutorial and Concepts Guide DocBook XML document |
| to HTML and store the resulting HTML files in a separate directory use: | | to HTML and store the resulting HTML files in a separate directory use: |
| | |
|
| cd guide/C/ | | cd C/guide/ |
| xmlto -o html-dir html gnucash-guide.xml | | xmlto -o html-dir html index.docbook |
| | |
| (html-dir/ will be created if it does not already exist.) | | (html-dir/ will be created if it does not already exist.) |
| | |
| To convert the GnuCash Help Manual DocBook XML document to a single | | To convert the GnuCash Help Manual DocBook XML document to a single |
| HTML file in the current directory use: | | HTML file in the current directory use: |
|
| cd help/C/ | | cd C/manual/ |
| xmlto html-nochunks gnucash-help.xml | | xmlto html-nochunks index.docbook |
| | |
| Known Problems | | Known Problems |
| ############## | | ############## |
| | |
| - See the full list: | | - See the full list: |
| https://bugs.gnucash.org/buglist.cgi?quicksearch=product%3DDocumentation | | https://bugs.gnucash.org/buglist.cgi?quicksearch=product%3DDocumentation |
| | |
| - Please report any new problems to Gnucash's Bugzilla at | | - Please report any new problems to Gnucash's Bugzilla at |
| https://bugs.gnucash.org/describecomponents.cgi?product=Documentation. Then | | https://bugs.gnucash.org/describecomponents.cgi?product=Documentation. Then |
| choose a component. | | choose a component. |
| | | |
| End of changes. 9 change blocks. |
|---|
| 19 lines changed or deleted | | 17 lines changed or added |
|---|
"Fossies" - the Fresh Open Source Software Archive 