Evergreen Documentation Interest Group (DIG)

The Evergreen DIG was established in May 2009 at the first Evergreen International Conference, where members of the Evergreen community committed to developing single-source, standards-based documentation for Evergreen. Since then, the DIG has been actively working toward that goal.

We welcome new participants and invite anyone interested to attend meetings, volunteer for tasks, and join the discussion lists. There's a role for everyone!

• How to participate
• Meetings - agendas and minutes.
• Roles and participants
• Terms of reference (mission, scope, principles)
• Contributing documentation with Git
• Email the DIG facilitators
• DIG conference Hackfest Project Ideas - Evergreen Conference 2013
• DIG conference Meeting Agenda Ideas - Evergreen Conference 2013
• DIG Hack-a-way 2013 - Agenda/Goal Ideas

• 2.0 Outline and Assignments
• 2.1 Outline and Assignments
• 2.2 Outline and Assignments
• 2.3 Outline and Assignments
• 2.4 Outline and Assignments
  • Evergreen 2.4 Documentation Needs
• Official Documentation
• DocBook Repository

• Documentation Licensing Terms

The preferred format for documentation submissions is AsciiDoc for documentation for 2.2 and later. AsciiDoc is much easier to format than XML. for Information on AsciiDoc, see:

• DIG AsciiDoc tutorial
• DIG AsciiDoc cheat sheet
• User Guide – Detailed guide for ASciiDoc syntax. (methods.co.nz)
• Cheat Sheet – Quick reference for AsciiDoc formatting. (powerman.name)

In addition you can find some examples in our repository to serve as templates for your AsciiDoc documents:

• https://github.com/rsoulliere/Evergreen-DocBook/blob/master/circulation/circulating_items.txt – Example with images.

While it is not necessary for you to install AsciiDoc on your machine for authoring, it does help you to verify proper AsciiDoc syntax. If you wish to install AsciiDoc, see:

• AsciiDoc Installation instructions

If you are Authoring documentation for Evergreen 2.1 or earlier, DocBook XML is the preferred format. However, we will accept documementation in any format!

• DocBook Style Guide for Evergreen Project - Commonly used tags and formatting for our project.
• DocBook 5: The Definitive Guide - General comprehensive site for all DocBook tags.

community demo servers: These are community Evergreen servers available for testing procedures and learning.

• Community Produced Documentation - the Dokuwiki start page
• Existing Documentation in the Wild

• See Documentation Resources