User Tools

Site Tools


evergreen-docs:dig

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
evergreen-docs:dig [2018/06/15 09:27]
rjs7 [Evergreen Documentation Guidelines]
evergreen-docs:dig [2020/01/28 15:09] (current)
rjs7 [Evergreen Documentation Interest Group (DIG)]
Line 1: Line 1:
 ====== Evergreen Documentation Interest Group (DIG) ====== ====== 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.+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, 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! ​ 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! ​
Line 16: Line 16:
 ==== Official Documentation ==== ==== Official Documentation ====
   * [[http://​docs.evergreen-ils.org/​|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]]+  * [[http://​git.evergreen-ils.org/?​p=Evergreen.git;​a=tree;​f=docs;​hb=HEAD|AsciiDoc ​Source ​Files]]
  
 ==== Projects and To-do Lists ==== ==== Projects and To-do Lists ====
-  * [[evergreen-docs:​documentation_needs|All Documentation Needs]] (includes undocumented "​new"​ features from all previous release notes)+  * [[evergreen-docs:​documentation_needs|TO-DO: ​All Documentation Needs]] (includes undocumented "​new"​ features from all previous release notes)
   * [[evergreen-docs:​reorg:​clean_up|Docs Reorganization Cleanup Tasks]]   * [[evergreen-docs:​reorg:​clean_up|Docs Reorganization Cleanup Tasks]]
   * [[evergreen-docs:​Glossary|Glossary of terms to define]]   * [[evergreen-docs:​Glossary|Glossary of terms to define]]
   * [[evergreen-docs:​webclient|Web Staff Client Documentation Project]]   * [[evergreen-docs:​webclient|Web Staff Client Documentation Project]]
 +
 +  * ANTORA Project
 +    * [[https://​bugs.launchpad.net/​evergreen/​+bug/​1848524|Launchpad Bug Report]] (for tracking progress)
 +    * [[http://​antora.mobiusconsortium.org/​prod/​docs/​latest/​index.html|Demo server]] (updated periodically)
 +    * [[https://​git.evergreen-ils.org/?​p=working/​Evergreen.git;​a=shortlog;​h=refs/​heads/​collab/​blake/​LP1848524_antora_ize_docs|Git collab branch]]
  
 ==== Evergreen Documentation Guidelines ==== ==== Evergreen Documentation Guidelines ====
Line 36: Line 41:
 == AsciiDoc == == 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:+The preferred format for documentation submissions is AsciiDoc, a plain-text format.
  
   * AsciiDoc Editing Tools   * AsciiDoc Editing Tools
     * [[https://​asciidoclive.com/​|Edit and preview in a web browser]]     * [[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]]     * [[http://​asciidoctor.org/​docs/​editing-asciidoc-with-live-preview/​|List of editors, browser plugins, and other things]]
-  ​* DIG AsciiDoc Tutorial +  * [[http://powerman.name/doc/asciidoc|Cheat Sheet]] -- Quick reference for AsciiDoc formatting(powerman.name
-     * [[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://​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:​ +  * DIG AsciiDoc ​Tutorial (by former DIG facilitator Yamil Suarez) 
- +     ​* [[https://docs.google.com/presentation/pub?​id=1o8HruJayUSEvXQlU_IjU6xN3cJbuw3yagENlcUM7sUU&​start=false&​loop=false&​delayms=3000|DIG AsciiDoc tutorial Slides]] 
-  * [[https://github.com/rsoulliere/Evergreen-DocBook/​blob/​master/​circulation/​circulating_items.txt]] -- Example with images. +     ​* [[https://www.youtube.com/watch?​v=7uX1NtlJRfU|DIG AsciiDoc ​training Video]] (1 hour long)
- +
-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]] +
  
  
evergreen-docs/dig.1529069253.txt.gz · Last modified: 2018/06/15 09:27 by rjs7

© 2008-2017 GPLS and others. Evergreen is open source software, freely licensed under GNU GPLv2 or later.
The Evergreen Project is a member of Software Freedom Conservancy.