Getting Involved in Documentation
=================================
:Author:    Robert Soulliere
:Email:     robert.soulliere@mohawkcollege.ca
:Date:      March 28, 2011

== Sample Files Included:
 - +++<filename>documentationpresentation.txt</filename>+++ - AsciiDoc file. Raw plain text file.
 - +++<filename>documentationpresentation.xml</filename>+++ - DocBook XML converted from +++<filename>documentationpresentation.txt</filename>+++
 - +++<filename>documentationpresentation.html</filename>+++ - HTML version of the files converted using AsciiDoc
 - +++<filename>documentationpresentation.pdf</filename>+++ - PDF file converted from DocBook XML file +++<filename>documentationpresentation.xml</filename>+++ using xsltproc and fop (DocBook toolchain).  

== About the DIG (Documentation Interest Group) 
	
DIG Information: http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-docs:dig 
 
== DocBook XML

Evergreen DocBook style guide: http://docs.evergreen-ils.org/style_guide/html/

DocBook 5: The Definitive Guide: http://docbook.org/tdg5/en/html/docbook.html 

== AsciiDoc: Processing DocBook XML Files

AsciiDoc information and documentation: http://www.methods.co.nz/asciidoc/		

AsciiDoc cheat sheet: http://powerman.name/doc/asciidoc

Download AsciiDoc from: http://sourceforge.net/projects/asciidoc/files/asciidoc/

== The  Documentation Publication Process: “how its made” 
    . XML file chapter added to git repository
    . Add chapter reference to root.xml
    . Files are pulled from git repository to web server nightly (CRON job) 
    . HTML and PDF files processed using (xsltproc) and image files copied to web server (CRON job)

Official Evergreen documentation: http://docs.evergreen-ils.org/ 

== How to Contribute
	. Using git to submit changes to documentation... 
	. Edit files directly in github via web browser
	. Submit to the DIG list
	. Email to DocBook XML conversion team
	. Put or locate documentation on Evergreen wiki and let the DIG know about it 
	. Submit fix and enhancement requests using launchpad 


== GIT Guides

Setting up Git on Windows:  http://help.github.com/win-set-up-git/ (github)

Git cheat sheet: http://help.github.com/git-cheat-sheets/

Git Basics: http://cworth.org/hgbook-git/tour/

Git Reference: http://gitref.org/ 


== Asking Questions and Getting More Information

DIG List: http://libmail.georgialibraries.org/mailman/listinfo/open-ils-documentation 

Robert Soulliere: robert.soulliere@mohawkcollege.ca

DIG Facilitators: docs@evergreen-ils.org 






