[GNC-dev] Long Term Documentation Directions

David Cousens davidcousens at bigpond.com
Mon Sep 10 09:11:45 EDT 2018


Docbook has a mechanism for including other xlm files either by declaring an
ENTITY which maps on to the filename containing the snippet xml code. You
can then use &<entity-name> to include the file contents at any point. You
can also construct "header files" which contain the entity definitions which
can be included in files as required. There is another mechanism using
XInclude which apparently has some more desirable traits. I found a Stack
exchange post/article on it today which extolled the virtues of usng
Xinclude. I'll find it again and post a link.

The current source files could be easily merged into the one document as
each file in the two documents has an entity declared. By moving the entity
declarations from the Guide to the Help manual and similarly moving the
&entity-name> lines in the gnucash-guide.xml  into the gnucash-help.xml file
then moving the Guide source files in with the Help source files, they would
become one document (needing some major rearrangement of course).

 An initial rearrangement looks possible by just rearranging the order of
the &<entity-name> statements. At the moment each file is a chapter and is
imported by the above statements.

A full rearrangement would require breaking the chapters  down into snippets
and then including them where required or in some cases just providing a
link back to where the snippet is first included.

David Cousens

David Cousens
Sent from: http://gnucash.1415818.n4.nabble.com/GnuCash-Dev-f1435356.html

More information about the gnucash-devel mailing list