guide, how to include datafile into documentation, glossary, index

[Yawar Amin]

On 2010-09-07, at 17:02, jh wrote:

> Hi,
> 
> 1.
> I'm currently working on german documentation for the new CSV-Import
> Funktion. I would like to include a short external file as an example.
> As much as I could find out from the documentation for DocBook 4.1.2,
> the following code should do this. The code also get's validated,
> however the effect is only an empty box. What do I do wrong?
> 
> 
> <programlisting>
> <inlinemediaobject>
> <imageobject>
> <imagedata fileref="figures/Kontoumsaetze.csv" format="linespecific"/>
> </imageobject>
> </inlinemediaobject>
> </programlisting>

Kontoumsaetze.csv is a plain text file (just some text with commas), right? You can just put the contents of the file inside the <programlisting>:

<programlisting>
  a,b,c,d
  e,f,g,h
  i,j,k,l
</programlisting>

> 2.
> I think a Glossary would be a really good idea, besides, that it is
> announced in the chapter overview. Why is there no glossary in the
> guide?

Someone didn't have the time to do it.

> 3.
> Same for an Index. Unfortunately the official Gnome 'DocBook Basics'
> chapter on Indexing is empty and besides it is completely outdated. Is
> there any point in putting <indexterm> tags into the text?

Yes, at some point in the future we want to have an auto-generated index for the docs. In preparation for that, it is better to add index terms diligently whenever possible.

Regards,

Yawar

-------------- next part --------------
A non-text attachment was scrubbed...
Name: PGP.sig
Type: application/pgp-signature
Size: 194 bytes
Desc: This is a digitally signed message part
URL: <http://lists.gnucash.org/pipermail/gnucash-devel/attachments/20100907/c8acacf3/attachment.bin>