Skip to content

Commit

Permalink
Convert help documents to use XInclude instead of SYSTEM entities
Browse files Browse the repository at this point in the history
This is mostly the same thing as in the previous commit for guide documents.
Note I have made one additional change in the txf-categories files: they
had two top-level para nodes, but xml only allows one. So I have moved the
content of the second one (which cited the source of the txf-categories)
into the first para to make the builds work again.
  • Loading branch information
gjanssens committed Oct 12, 2018
1 parent df2bddb commit 3d7124d
Show file tree
Hide file tree
Showing 44 changed files with 231 additions and 163 deletions.
9 changes: 7 additions & 2 deletions help/C/Help_ch_Account-Actions.xml
@@ -1,3 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//GnuCash//DTD DocBook XML V4.5-Based Extension 1.0//EN"
"../../docbook/gnc-docbookx.dtd">

<!--
(Do not remove this comment block.)
Version: 2.0.x
Expand All @@ -17,7 +21,8 @@
(translators put your name and email here)
-->

<chapter id="setup-accounts">
<chapter id="setup-accounts"
xmlns:xi="http://www.w3.org/2001/XInclude">
<title>Setting Up, Editing &amp; Working with Accounts</title>

<para>This section describes the process of setting up, editing and working with <application>&app;</application> Accounts.
Expand Down Expand Up @@ -228,7 +233,7 @@
the main branches are shown in the report, rather than the individual accounts. For
example, a chart of accounts might look like the following:</para>

&chartacctseg;
<xi:include href="Help_chtacctseg.xml" />

<note id="accts-code">
<title>Accounts codes</title>
Expand Down
4 changes: 4 additions & 0 deletions help/C/Help_ch_Business.xml
@@ -1,3 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//GnuCash//DTD DocBook XML V4.5-Based Extension 1.0//EN"
"../../docbook/gnc-docbookx.dtd">

<!--
(Do not remove this comment block.)
Version: 2.0.0
Expand Down
9 changes: 7 additions & 2 deletions help/C/Help_ch_Customize.xml
@@ -1,3 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//GnuCash//DTD DocBook XML V4.5-Based Extension 1.0//EN"
"../../docbook/gnc-docbookx.dtd">

<!--
(Do not remove this comment block.)
Version: 2.0.1
Expand All @@ -20,7 +24,8 @@
(translators put your name and email here)
-->

<chapter id="custom-gnucash">
<chapter id="custom-gnucash"
xmlns:xi="http://www.w3.org/2001/XInclude">
<title>Customizing <application>&app;</application></title>

<sect1 id="account-options">
Expand Down Expand Up @@ -2564,7 +2569,7 @@

<para>Table 32. Detailed <acronym>TXF</acronym> Category Descriptions</para>

&txf-categories;
<xi:include href="Help_txf-categories.xml" />
</sect2>
</sect1>

Expand Down
4 changes: 4 additions & 0 deletions help/C/Help_ch_GUIMenus.xml
@@ -1,3 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//GnuCash//DTD DocBook XML V4.5-Based Extension 1.0//EN"
"../../docbook/gnc-docbookx.dtd">

<!--
(Do not remove this comment block.)
Version: 2.0.x
Expand Down
4 changes: 4 additions & 0 deletions help/C/Help_ch_GettingHelp.xml
@@ -1,3 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//GnuCash//DTD DocBook XML V4.5-Based Extension 1.0//EN"
"../../docbook/gnc-docbookx.dtd">

<!--
(Do not remove this comment block.)
Expand Down
4 changes: 4 additions & 0 deletions help/C/Help_ch_GettingStarted.xml
@@ -1,3 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//GnuCash//DTD DocBook XML V4.5-Based Extension 1.0//EN"
"../../docbook/gnc-docbookx.dtd">

<!--
(Do not remove this comment block.)
Expand Down
6 changes: 2 additions & 4 deletions help/C/Help_ch_Intro.xml
@@ -1,8 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" >
-->
<!DOCTYPE chapter PUBLIC "-//GnuCash//DTD DocBook XML V4.5-Based Extension 1.0//EN"
"../../docbook/gnc-docbookx.dtd">

<!--
(Do not remove this comment block.)
Expand Down
4 changes: 4 additions & 0 deletions help/C/Help_ch_Reports.xml
@@ -1,3 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//GnuCash//DTD DocBook XML V4.5-Based Extension 1.0//EN"
"../../docbook/gnc-docbookx.dtd">

<!--
(Do not remove this comment block.)
Version: 2.0.x
Expand Down
4 changes: 4 additions & 0 deletions help/C/Help_ch_Tools_Assistants.xml
@@ -1,3 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//GnuCash//DTD DocBook XML V4.5-Based Extension 1.0//EN"
"../../docbook/gnc-docbookx.dtd">

<!--
(Do not remove this comment block.)
Version: 2.0.x
Expand Down
4 changes: 4 additions & 0 deletions help/C/Help_ch_Transactions.xml
@@ -1,3 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//GnuCash//DTD DocBook XML V4.5-Based Extension 1.0//EN"
"../../docbook/gnc-docbookx.dtd">

<!--
(Do not remove this comment block.)
Version: 2.0.x
Expand Down
6 changes: 5 additions & 1 deletion help/C/Help_chartofaccts.xml
@@ -1,4 +1,8 @@
<itemizedlist>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE itemizedlist PUBLIC "-//GnuCash//DTD DocBook XML V4.5-Based Extension 1.0//EN"
"../../docbook/gnc-docbookx.dtd">

<itemizedlist>
<listitem>
<para> Assets

Expand Down
4 changes: 4 additions & 0 deletions help/C/Help_chtacctseg.xml
@@ -1,3 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE literallayout PUBLIC "-//GnuCash//DTD DocBook XML V4.5-Based Extension 1.0//EN"
"../../docbook/gnc-docbookx.dtd">

<literallayout>
<literal> 300 Expenses
|
Expand Down
4 changes: 4 additions & 0 deletions help/C/Help_fdl-appendix.xml
@@ -1,3 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE appendix PUBLIC "-//GnuCash//DTD DocBook XML V4.5-Based Extension 1.0//EN"
"../../docbook/gnc-docbookx.dtd">

<!--
The GNU Free Documentation License 1.1 in DocBook
Markup by Eric Baudais <baudais@okstate.edu>
Expand Down
4 changes: 4 additions & 0 deletions help/C/Help_legal.xml
@@ -1,3 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE legalnotice PUBLIC "-//GnuCash//DTD DocBook XML V4.5-Based Extension 1.0//EN"
"../../docbook/gnc-docbookx.dtd">

<legalnotice id="legalnotice">
<para>
Permission is granted to copy, distribute and/or modify this
Expand Down
4 changes: 4 additions & 0 deletions help/C/Help_tips-appendix.xml
@@ -1,3 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE appendix PUBLIC "-//GnuCash//DTD DocBook XML V4.5-Based Extension 1.0//EN"
"../../docbook/gnc-docbookx.dtd">

<!--
(Do not remove this comment block.)
Version: 2.6.20
Expand Down
9 changes: 6 additions & 3 deletions help/C/Help_txf-categories.xml
@@ -1,3 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE para PUBLIC "-//GnuCash//DTD DocBook XML V4.5-Based Extension 1.0//EN"
"../../docbook/gnc-docbookx.dtd">

<para>
<!-- Translators: You will probably have your own codes.
Look for similar files as the source at the end of this file,
Expand Down Expand Up @@ -982,7 +986,6 @@ The fair market value of donated property, such as used clothing or furniture.</
</tbody>
</tgroup>
</table>
</para>
<para>Source:
<ulink url="https://github.com/Gnucash/gnucash/blob/maint/src/tax/us/txf-help.scm"></ulink>
Source:
<ulink url="https://github.com/Gnucash/gnucash/blob/maint/src/tax/us/txf-help.scm"></ulink>
</para>
52 changes: 17 additions & 35 deletions help/C/gnucash-help.xml
@@ -1,25 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//GnuCash//DTD DocBook XML V4.5-Based Extension 1.0//EN"
"../../docbook/gnc-docbookx.dtd" [

<!-- List of files: -->
<!ENTITY intro SYSTEM "Help_ch_Intro.xml">
<!ENTITY chGettingHelp SYSTEM "Help_ch_GettingHelp.xml">
<!ENTITY chGettingStarted SYSTEM "Help_ch_GettingStarted.xml">
<!ENTITY chGUIMenus SYSTEM "Help_ch_GUIMenus.xml">
<!ENTITY chAccounts SYSTEM "Help_ch_Account-Actions.xml">
<!ENTITY chTransactions SYSTEM "Help_ch_Transactions.xml">
<!ENTITY chBusiness SYSTEM "Help_ch_Business.xml">
<!ENTITY chToolsAssistants SYSTEM "Help_ch_Tools_Assistants.xml">
<!ENTITY chReports SYSTEM "Help_ch_Reports.xml">
<!ENTITY custom SYSTEM "Help_ch_Customize.xml">
<!ENTITY chartacctseg SYSTEM "Help_chtacctseg.xml">
<!ENTITY chartofaccts SYSTEM "Help_chartofaccts.xml">
<!ENTITY txf-categories SYSTEM "Help_txf-categories.xml">
<!ENTITY legal SYSTEM "Help_legal.xml">
<!ENTITY GFDL SYSTEM "Help_fdl-appendix.xml">
<!ENTITY Tips SYSTEM "Help_tips-appendix.xml">
]>
"../../docbook/gnc-docbookx.dtd" >

<!--
(Do not remove this comment block.)
Expand All @@ -31,7 +12,8 @@
(translators put your name and email here)
-->

<book id="help" lang="en-US">
<book id="help" lang="en-US"
xmlns:xi="http://www.w3.org/2001/XInclude">
<!-- please do not change the id; for translations, change lang to -->
<!-- appropriate code -->

Expand Down Expand Up @@ -60,7 +42,7 @@
</address>
</publisher>

&legal;
<xi:include href="Help_legal.xml" />

<authorgroup>
<author><surname>The GnuCash Documentation Team</surname></author>
Expand Down Expand Up @@ -358,17 +340,17 @@
</para>
</preface>

&intro;
&chGettingHelp;
&chGettingStarted;
&chGUIMenus;
&chAccounts;
&chTransactions;
&chBusiness;
&chToolsAssistants;
&chReports;
&custom;
&Tips;
&GFDL;
<xi:include href="Help_ch_Intro.xml" />
<xi:include href="Help_ch_GettingHelp.xml" />
<xi:include href="Help_ch_GettingStarted.xml" />
<xi:include href="Help_ch_GUIMenus.xml" />
<xi:include href="Help_ch_Account-Actions.xml" />
<xi:include href="Help_ch_Transactions.xml" />
<xi:include href="Help_ch_Business.xml" />
<xi:include href="Help_ch_Tools_Assistants.xml" />
<xi:include href="Help_ch_Reports.xml" />
<xi:include href="Help_ch_Customize.xml" />
<xi:include href="Help_tips-appendix.xml" />
<!-- unused? xi:include href="Help_chartofaccts.xml" /-->
<xi:include href="Help_fdl-appendix.xml" />
</book>

4 changes: 4 additions & 0 deletions help/de/Help_ch_GettingStarted.xml
@@ -1,3 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//GnuCash//DTD DocBook XML V4.5-Based Extension 1.0//EN"
"../../docbook/gnc-docbookx.dtd">

<!--
(Do not remove this comment block.)
Expand Down
6 changes: 2 additions & 4 deletions help/de/Help_ch_Intro.xml
@@ -1,8 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" >
-->
<!DOCTYPE chapter PUBLIC "-//GnuCash//DTD DocBook XML V4.5-Based Extension 1.0//EN"
"../../docbook/gnc-docbookx.dtd">

<!--
(Do not remove this comment block.)
Expand Down
6 changes: 5 additions & 1 deletion help/de/Help_chartofaccts.xml
@@ -1,4 +1,8 @@
<itemizedlist>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE itemizelist PUBLIC "-//GnuCash//DTD DocBook XML V4.5-Based Extension 1.0//EN"
"../../docbook/gnc-docbookx.dtd">

<itemizedlist>
<listitem>
<para> Assets

Expand Down
4 changes: 4 additions & 0 deletions help/de/Help_chtacctseg.xml
@@ -1,3 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE literallayout PUBLIC "-//GnuCash//DTD DocBook XML V4.5-Based Extension 1.0//EN"
"../../docbook/gnc-docbookx.dtd">

<literallayout>
<literal> 300 Expenses
|
Expand Down
6 changes: 5 additions & 1 deletion help/de/Help_fdl-appendix.xml
@@ -1,4 +1,8 @@
<!--
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE appendix PUBLIC "-//GnuCash//DTD DocBook XML V4.5-Based Extension 1.0//EN"
"../../docbook/gnc-docbookx.dtd">

<!--
The GNU Free Documentation License 1.1 in DocBook
Markup by Eric Baudais <baudais@okstate.edu>
Maintained by the GNOME Documentation Project
Expand Down
4 changes: 4 additions & 0 deletions help/de/Help_legal.xml
@@ -1,3 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE legalnotice PUBLIC "-//GnuCash//DTD DocBook XML V4.5-Based Extension 1.0//EN"
"../../docbook/gnc-docbookx.dtd">

<legalnotice id="legalnotice">
<para>
Das vorliegende Dokument kann gemäß den Bedingungen der GNU Free Documentation License (GFDL), Version 1.1 oder jeder späteren, von der Free Software Foundation veröffentlichten Version ohne unveränderbare Abschnitte sowie ohne Texte auf dem vorderen und hinteren Buchdeckel kopiert, verteilt und/oder modifiziert werden. Eine Kopie der GFDL finden Sie unter diesem <ulink type="help" url="ghelp:fdl">Link</ulink> oder in der mit diesem Handbuch gelieferten Datei COPYING-DOCs.
Expand Down
4 changes: 4 additions & 0 deletions help/de/Help_tips-appendix.xml
@@ -1,3 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE appendix PUBLIC "-//GnuCash//DTD DocBook XML V4.5-Based Extension 1.0//EN"
"../../docbook/gnc-docbookx.dtd">

<!--
(Do not remove this comment block.)
Version: 2.6.20
Expand Down
4 changes: 4 additions & 0 deletions help/de/Help_txf-categories.xml
@@ -1,3 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE para PUBLIC "-//GnuCash//DTD DocBook XML V4.5-Based Extension 1.0//EN"
"../../docbook/gnc-docbookx.dtd">

<para>
<table>
<title>Detailed TXF Category Descriptions</title>
Expand Down

0 comments on commit 3d7124d

Please sign in to comment.