Guestions & Observations on Docs (1.9.0)
David V Herman
dvherman at gmail.com
Fri Jun 9 13:01:45 EDT 2006
I have been reviewing the latest GnuCash Docs (1.9.0) and have several
questions & observations.
First however I think (not an unbiased opinion) the Concept Guide is
"looking good". Some sections need to be expanded, others written
however in general it is in good condition !!!
Observations;
1) Section 1.3 of Concept Guide is inconsistent in linking to other
sections. Which I started to address, then noticed that many of the
other Chapters do NOT follow the guidelines in the HACKING (re: SGML
tweeks - 3. Avoid underscores in id attribute values.
e.g. id="getting-started" instead of id="getting_started").
Question - is this tweek still relevant? It would be a small diff for
most chapter files.
2) The Help documentation "needs updating".
3) I believe there are many out-of-date files in the docs tree - are
they there for a reason other than historical?
General questions;
1) I have been "Building" the documentation for some time using the
"make all install" command at the top level directory of the
documentation tree.
I have several doc trees, working, and standard base. Since I built
1.9.0 I have not been able to build the working documents. No error
messages, just "nothing to do". I have made modification to several
source XML files in both the "guide" and "help" branches of the working
tree and the docs do not get built.
Have performed "make distclean", "make clean", no effect.
I even tried the "make all install --always-make" this resulted in what
appeared to be an endless loop (stopped after only 15 min.).
Is this the correct method to build the documentation - both Help &
Concept Guide ?
Any suggestion to problem isolation/resolution?
Dave
More information about the gnucash-devel
mailing list