Re: DOCBOOK-APPS: Document structure; how to setup...

[Robert McIlvride <robert at cogent dot ca>]

Hi Simon,

You can take a look at what we've done to address the questions you've raised by looking at the following pages in our in-house guide for producing documentation.  We are still using SGML instead of XML, but the organization of documents and files is identical.  In answer to Q2, you can link between books that are in a set, and we do it frequently.

File organization:

http://developers.cogentrts.com/cogent/prepdoc/pd-introduction.html
http://developers.cogentrts.com/cogent/prepdoc/pd-makingeditsindoci.html
http://developers.cogentrts.com/cogent/prepdoc/pd-workingwithoutputfiles.html

Document organization:

http://developers.cogentrts.com/cogent/prepdoc/pd-mainsgmlfile.html
http://developers.cogentrts.com/cogent/prepdoc/pd-specialorganization.html

Hope that helps.

Cheerio!

Bob

---------------------------------------
Robert McIlvride (robert@cogent.ca)
Cogent Real-Time Systems (www.cogent.ca)


On Thu, 31 Oct 2002 21:38:12 +0100
Kraa de Simon <Simon.de.Kraa@services.fujitsu.com> wrote:

> Hello,
> 
> I have a few question for you. If you would be so kind...
> 
> Q1
> 
> Is there a way to do something like:
> 
> <!-- set.xml -->
> <!DOCTYPE set SYSTEM "docbookx.dtd">
> <set>
>   <!-- book1.xml -->
>   <!DOCTYPE book SYSTEM "docbookx.dtd">
>   <book>
>   </book>
> 
>   <!-- book2.xml -->
>   <!DOCTYPE book SYSTEM "docbookx.dtd">
>   <book>
>   </book>
> </set>
> 
> or
> 
> - DOCTYPE set
>   - set
>     - book1
>     - book2
> 
> and
> 
> - DOCTYPE book1
>   - book1
> 
> - DOCTYPE book2
>   - book2
> 
> So the editors can process the set and individual books (chapters?)
> separately.
> 
> Q2
> 
> Can I xref from one book to another?
> 
> E.g. from book1.xml to book2.xml.
> 
> Q3
> 
> Can someone give me some hints and tips about how to setup the directory
> structure on disk?
> 
> Can I use some nested entity definitions for this?
> 
> Use logical names (e.g. users_manual.xml, users_manual_chapter_one.xml) or
> book01.xml, chapter01.xml.
> 
> Is there some reading material / papers available on this subject?
> 
> ./set.xml
> ./book1.xml
> ./book1ch1.xml
> ./book1ch2.xml
> ./book2.xml
> ./book2ch1.xml
> ./book2ch2.xml
> 
> or
> 
> ./set.xml
> ./book/1/book.xml
> ./book/1/ch/1.xml
> ./book/1/ch/2.xml
> ./book/2/book.xml
> ./book/2/ch/1.xml
> ./book/2/ch/2.xml
> 
> And where to put the images, entities and other stuff?
> 
> Separate dirs? Per set or per book?
> 
> I really could use some hints and tips from you.
> 
> Thank you.
> 
> Simon de Kraa
> Systems Architect
> Logistic Systems
> 
> FUJITSU SERVICES
> Fujitsu Services B.V., Het Kwadrant 1
> Postbus 1726, 3600 BS Maarssen, The Netherlands
> Tel: +31 346 598865
> Mob: +31 651 204719
> Fax: +31 346 562703
> 
> Email: mailto:Simon.de.Kraa@services.fujitsu.com
> Web: http://nl.services.fujitsu.com
> 
> Fujitsu Services B.V., Registered in the Netherlands no 30078286
> ___________________________________________________________________________
> 
> The information in this e-mail (and its attachments) is confidential and
> intended solely for the
> addressee(s). If this message is not addressed to you, please be aware that
> you have no
> authorisation to read this e-mail, to copy it or to forward it to any person
> other than the
> addressee(s). Should you have received this e-mail by mistake, please bring
> this to the
> attention of the sender, after which you are kindly requested to destroy the
> original message
> and delete any copies held in your system. Fujitsu Services and its
> affiliated companies
> cannot be held responsible or liable in any way whatsoever for and/or in
> connection with
> any consequences and/or damage resulting from the contents of this e-mail
> and its proper
> and complete dispatch and receipt. Fujitsu Services does not guarantee that
> this e-mail has
> not been intercepted and amended, nor that it is virus-free.
> ___________________________________________________________________________
> 
>