[OPEN-ILS-DOCUMENTATION] ***SPAM*** RE: ***SPAM*** Re: ***SPAM*** Docbook

[Soulliere, Robert]

Hi Lori,

I think the best starting place for  getting involved is:
http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-docs:dig_participation
I think the most important part is getting in touch with the folks who are working on a specific part you are interested in.


For how the pieces work together. I think it will go something like this:
1) Content contributors submit documentation to the DIG for a particular chapter, including any images used in his/her chapter.
2) Documentation is tested and converted to DocBook XML
4) XML file is added to repository
5) DocBook chapter is added to/included in the root.xml file to be published with the larger work.
6) The DocBook XML files are  processed as HTML and PDF files for human consumption. The XML stylesheets and html CSS files are very critical here for formatting.
7) Documentation is tested and improved...

For a greater understand of DocBook, I think a good start is the SITKA Docbook reference at:
http://coconut.pines.bclibrary.ca:21080/docbook/Style/draft/html/ch01.html

These have some of the most commonly used elements.  The elements link to:
http://www.docbook.org/tdg5/en/html/ which, as its title says, is the definitive guide for DocBook.

The definitive source for information on DocBook XSL stylesheets is found at:
http://www.sagehill.net/docbookxsl/index.html

At some point we should have a DocBook XML template perhaps for those interested in creating DocBook documents?

Thanks,
Robert














From: open-ils-documentation-bounces at list.georgialibraries.org [mailto:open-ils-documentation-bounces at list.georgialibraries.org] On Behalf Of Lori Bowen Ayre
Sent: Friday, June 04, 2010 10:44 AM
To: Documentation discussion for Evergreen software
Subject: [OPEN-ILS-DOCUMENTATION] ***SPAM*** Re: ***SPAM*** Docbook

You said:  Let me know if you have any questions or would like to help out in the DocBook  XML conversion and would like some recommended readings to get started, let me know.

Hi Robert,

I'd love to have some suggestions for how to get started understanding how all of these pieces work and how one gets involved in contributing documentation.  Is there a "So you want to contribute your documentation to the community eh?"  page?

Lori


On Thu, Jun 3, 2010 at 1:03 PM, Soulliere, Robert <robert.soulliere at mohawkcollege.ca<mailto:robert.soulliere at mohawkcollege.ca>> wrote:
Hi all,

I've been experimenting with DocBook for a few days. I want to thank Jeremy and SITKA for letting me use their stylesheets and processing tools which saved me a ton of time.

I produced an experimental docbook document I placed on our test server at Mohawk College. You can take a look at:
http://libdog.mohawkcollege.ca/evergreen_documentation/draft/html/index.html

A link to the pdf version is available at the bottom right corner of each page.

Just a few notes about how DocBook works.

The Table of contents is auto-generated based on the chapters. As we add new chapters in the form of XML files and include them in the root.xml file, they will appear in the TOC. Moreover, they will be automatically numbered.

The index in the Appendices section is also auto-generated.   To add a term to the index use the <indexterm> DocBook element
see: http://www.docbook.org/tdg5/en/html/indexterm.singular.html for more details.

Let me know if you have any questions or would like to help out in the DocBook  XML conversion and would like some recommended readings to get started, let me know.

I also added a new github repository for documentation at:
http://github.com/rsoulliere/Evergreen-DocBook

This is not forked from any evergreen repositories, but might serve as a temporary DocBook repository until we find a permanent repository home. I will add the contributors to my other repository to this one as well.

Let me know if anyone has any other suggestions for a different server for the DocBook documentatin or for the repository, or if everyone  is OK  with this setup for now?

Thanks,
Robert










________________________________
This E-mail contains privileged and confidential information intended
only for the individual or entity named in the message. If the reader
of this message is not the intended recipient, or the agent responsible
to deliver it to the intended recipient, you are hereby notified that
any review, dissemination, distribution or copying of this communication
is prohibited. If this communication was received in error, please
notify the sender by reply E-mail immediately, and delete and destroy
the original message.

_______________________________________________
OPEN-ILS-DOCUMENTATION mailing list
OPEN-ILS-DOCUMENTATION at list.georgialibraries.org<mailto:OPEN-ILS-DOCUMENTATION at list.georgialibraries.org>
http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation


________________________________
This E-mail contains privileged and confidential information intended
only for the individual or entity named in the message. If the reader
of this message is not the intended recipient, or the agent responsible
to deliver it to the intended recipient, you are hereby notified that
any review, dissemination, distribution or copying of this communication
is prohibited. If this communication was received in error, please
notify the sender by reply E-mail immediately, and delete and destroy
the original message.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://list.georgialibraries.org/pipermail/open-ils-documentation/attachments/20100607/1a3cb74c/attachment-0001.htm