Differences

This shows you the differences between two versions of the page.

--- evergreen-docs:dig [2018/06/15 09:27] – [Evergreen Documentation Guidelines] rjs7
+++ evergreen-docs:dig [2025/04/30 12:11] (current) – removed dluchenbill
@@ Line 1: / Line 1: @@
-====== 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 email list ([[open-ils-documentation@list.georgialibraries.org]]). There's a role for everyone!
-==== About DIG ====
-  * [[evergreen-docs:dig_participation|How to participate]]
-  * [[evergreen-docs:dig_meetings|Meetings]] - agendas and minutes.
-  * [[evergreen-docs:DIGParticipants|Roles and participants]]
-  * [[evergreen-docs:dig_terms_of_reference|Terms of reference]] (mission, scope, principles)
-  * [[evergreen-docs:how-to-contribute-documentation|Contributing documentation]]
-  * [[docs@evergreen-ils.org|Email the DIG facilitators]]
-==== Official Documentation ====
-  * [[http://docs.evergreen-ils.org/|Official Documentation]]
-  * [[http://git.evergreen-ils.org/?p=Evergreen.git;a=tree;f=docs;hb=HEAD|Browse Official Documentation GIT Source]]
-==== Projects and To-do Lists ====
-  * [[evergreen-docs:documentation_needs|All Documentation Needs]] (includes undocumented "new" features from all previous release notes)
-  * [[evergreen-docs:reorg:clean_up|Docs Reorganization Cleanup Tasks]]
-  * [[evergreen-docs:Glossary|Glossary of terms to define]]
-  * [[evergreen-docs:webclient|Web Staff Client Documentation Project]]
-==== Evergreen Documentation Guidelines ====
-== Liscensing Terms ==
-  * [[evergreen-docs:documentation_licensing_terms|Documentation Licensing Terms]]
-== DIG Style Guide ==
-  * [[evergreen-docs:dig_style_guide|DIG Style Guide]]
-== AsciiDoc ==
-The preferred format for documentation submissions is AsciiDoc, a plain-text format. AsciiDoc is much easier to format than XML. For information on AsciiDoc, see:
-  * AsciiDoc Editing Tools
-    * [[https://asciidoclive.com/|Edit and preview in a web browser]]
-    * [[http://asciidoctor.org/docs/editing-asciidoc-with-live-preview/|List of editors, browser plugins, and other things]]
-  * DIG AsciiDoc Tutorial
-     * [[https://docs.google.com/presentation/pub?id=1o8HruJayUSEvXQlU_IjU6xN3cJbuw3yagENlcUM7sUU&start=false&loop=false&delayms=3000|DIG AsciiDoc tutorial Slides]]
-     * [[https://www.youtube.com/watch?v=7uX1NtlJRfU| DIG AsciiDoc training Video]] (1 hour long)
-  * [[https://docs.google.com/document/pub?id=17KpO9tMYBObec3coijFAxFDjDCrOIfoVDMa3Q1k8_lE|DIG AsciiDoc cheat sheet]]
-  * [[http://www.methods.co.nz/asciidoc/userguide.html|User Guide]] -- Detailed guide for ASciiDoc syntax. (methods.co.nz)
-  * [[http://powerman.name/doc/asciidoc|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:
-  * [[http://www.methods.co.nz/asciidoc/INSTALL.html|AsciiDoc Installation instructions]]
-==== DIG Test Server ====
-  * [[:community_servers|community demo servers]]: These are community Evergreen servers available for testing procedures and learning.
-==== Other Evergreen Documentation ====
-  * [[:start|Community Produced Documentation]] - the Dokuwiki start page
-  * [[evergreen-docs:existing_docs_survey|Existing Documentation in the Wild]]
-==== Other Tools for Contributors ====
-  * See [[evergreen-docs:digresources|Documentation Resources]]