GnuCash Documentation in pdf Format

[Neil Williams]

On Saturday 26 February 2005 10:00 pm, Chris Lyttle wrote:
> On Sat, 2005-02-26 at 20:25 +0000, Neil Williams wrote:
> > All I'll be doing is adding a .docbook for each set (guide and help)
> > because I can't convert files based on <article>, I need <book> (a truly
> > minor change that doesn't require any further changes and is therefore a
> > really annoying discrepancy between the various docbook utilities) and
> > changing the id strings as above.
>
> As long as changing from article to book doesn't affect the html output
> and it looks the same in Yelp this is fine too.

It's an added file at the moment - that's where any duplication comes in. As 
you picked up later, docbook-utils is SGML rather than XML so it complains if 
the first line of the SGML file is an XML declaration - which xsltproc 
understandably needs. So just one file - the entity declaration file - is 
duplicated but that only contains the revision history currently so it's no 
big deal.

So xsltproc continues calling gnucash-guide.xml, docbook-utils calls 
gnucash-guide.docbook - or it could be .sgml if that's clearer.

> BTW The main aim behind making the help and guide docbook-xml was to
> have them be integrated into the gnome-help system (Yelp) so that when
> we finally get the g2 version of gnucash out the door we can drop the
> html conversion from the docs module code and just use yelp within
> gnucash for the help display. For me any changes must work in yelp, if
> there's no breakage there then I'm fine with just about anything you
> want to do.

Excellent, thanks - that helps me make sure I'm not breaking anything else - I 
can easily test in yelp.

> > Note the reference to images in PDF - I haven't solved that. The
> > workaround would seem acceptable though for those who do need embedded
> > images in the PDF. I've tried lots of tricks with the fileref attribute
> > with no success.
>
> I seem to remember some discussion of this on the gnome-docs list. I
> believe that images need to be in a certain format for conversion to pdf
> and that png doesn't work.

You're a star! Thanks! I should really have anticipated that - the 
docbook-utils.dsl only refers to EPS for print formats - so that makes sense 
now, it's worth a test. Even if images can only be incorporated locally, 
(i.e. with versions of figures/* converted to .eps), it's worth trying. 
(Didn't work first time but that's no surprise - more tweaks needed!)

> Yeah that's a bug, the /> for closing is standard docbook-xml. Are you
> sure those tools aren't using docbook-sgml which that would be an
> illegal tag for?

Yep, it makes sense now - it's using SGML, hence the warning.

> > If you agree, I can minimise future duplication if I take the existing 
> > content  from gnucash-guide.xml and gnucash-help.xml into a new XML file 
> > that is  referenced from the stub. Then there'll be no duplication in 
> > the .docbook -  it'll simply be a slightly altered version of the entity 
> > list and DTD  declaration. It's a real bind that I can't use the existing 
> > <article>. Still,  the .docbook will be tiny and will provide lots of 
> > alternative output formats  for a low overhead.

> Not really sure what you are referring to here. There isn't a lot of
> content that is shared between the guide and the help so I can't see how
> combining them would minimise duplication. Can you explain a bit more
> please?

Sorry, didn't mean to merge the two, I was referring to taking any duplicated 
content between the .xml and the to be added .docbook or .sgml file that is 
essentially the same except for the XML declaration, use of <book> and 
<bookinfo>, and putting that in a separate file.

gnucash-guide.xml - now
gnucash-guide.sgml - to be added.
gnucash-help.xml - now
gnucash-help.sgml - to be added.

Even then, it's only the revision history that is duplicated, so it might as 
well stay.

-- 

Neil Williams
=============
http://www.dcglug.org.uk/
http://www.nosoftwarepatents.com/
http://sourceforge.net/projects/isbnsearch/
http://www.neil.williamsleesmill.me.uk/
http://www.biglumber.com/x/web?qs=0x8801094A28BCB3E3

-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
Url : http://lists.gnucash.org/pipermail/gnucash-devel/attachments/20050226/10b4a9e8/attachment-0001.bin