| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| evergreen-docs:dig [2020/01/24 08:39] – [Projects and To-do Lists] rjs7 | evergreen-docs:dig [2023/07/03 16:11] (current) – [Other Evergreen Documentation] dluchenbill |
|---|
| ====== 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 ([[http://list.evergreen-ils.org/cgi-bin/mailman/listinfo/evergreen-documentation]]). There's a role for everyone! |
| |
| ==== About DIG ==== | ==== About DIG ==== |
| ==== 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: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]] |
| | * [[https://docs.google.com/spreadsheets/d/1nPD0_blC51wVcYJsdQqGYFoRrlcGmbmqbZlrlosaHgE/edit#gid=0|Documentation Reorganization Spreadsheet]] |
| | * [[https://docs.google.com/spreadsheets/d/1gJkFRNIH4tMzr-P2JoOb704uSlUwrcFvdkL5KlnLyrg/edit#gid=1107472678|Library Settings Definitions List]] |
| | * [[https://bugs.launchpad.net/evergreen/+bug/2022100]]LP 2022100: Writing a page on item statuses |
| | |
| | * ANTORA Project |
| | * [[https://bugs.launchpad.net/evergreen/+bug/1848524|Launchpad Bug Report]] (for tracking progress) |
| | * [[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 ==== |
| == 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) |
| | * [[http://www.methods.co.nz/asciidoc/userguide.html|User Guide]] -- Detailed guide for ASciiDoc syntax. (methods.co.nz) |
| | |
| | * 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://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://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: | * Additional DIG AsciiDoc Tutorials and documentation |
| | * [[https://www.youtube.com/watch?v=0KcfFiqCtP4|2021 Conference presentation]] |
| | * [[https://docs.evergreen-ils.org/eg/docs/latest/shared/how_to_contribute_docs.html|Integrated "How to contribute documentation]] |
| |
| * [[https://github.com/rsoulliere/Evergreen-DocBook/blob/master/circulation/circulating_items.txt]] -- Example with images. | * Convert Word files to AsciiDoc |
| | * https://alldocs.app/convert-word-docx-to-asciidoc |
| 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]] | |
| |
| |
| | |
| * [[:community_servers|community demo servers]]: These are community Evergreen servers available for testing procedures and learning. | * [[:community_servers|community demo servers]]: These are community Evergreen servers available for testing procedures and learning. |
| | |
| | |
| | ==== Community-Created Evergreen Documentation ==== |
| | |
| | * [[https://www.biblio.org/documentation/|Bibliomation documentation]] |
| | * [[https://evergreenindiana.org/?page_id=2632|Evergreen Indiana manuals]] |
| | * [[https://nccardinalsupport.org/index.php|NC Cardinal support and staff education]] |
| | * [[https://sparkpa.atlassian.net/servicedesk/customer/portals|PaILS/SPARK support portal]] |
| | * [[https://pines.georgialibraries.org/dokuwiki/doku.php?id=home|PINES documentation]] |
| | * [[http://asciidoc.libraries.coop/|Sitka asciidoc index]] |
| | * [[http://docs.libraries.coop/|Sitka manuals]] |
| | * |
| | |
| | |
| ==== Other Evergreen Documentation ==== | ==== Other Evergreen Documentation ==== |
| |
| * [[:start|Community Produced Documentation]] - the Dokuwiki start page | |
| * [[evergreen-docs:existing_docs_survey|Existing Documentation in the Wild]] | * [[evergreen-docs:existing_docs_survey|Existing Documentation in the Wild]] |
| |
| ==== Other Tools for Contributors ==== | ==== Other Tools for Contributors ==== |
| * See [[evergreen-docs:digresources|Documentation Resources]] | * See [[evergreen-docs:digresources|Documentation Resources]] |
