User Tools

Site Tools


evergreen-docs:adding_indexterms

Differences

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

Link to this comparison view

Next revision
Previous revision
Next revisionBoth sides next revision
evergreen-docs:adding_indexterms [2018/05/02 10:37] – created sandbergjaevergreen-docs:adding_indexterms [2018/06/26 09:21] – [Adding terms to the index] rjs7
Line 4: Line 4:
  
 Here's an example from the Acquisitions manual: http://docs.evergreen-ils.org/reorg/3.1/acquisitions/_index.html Here's an example from the Acquisitions manual: http://docs.evergreen-ils.org/reorg/3.1/acquisitions/_index.html
 +
 +====== What To Add ======
 +
 +The docs can be searched by keyword, so we don't need to index every concept.  Our index is most useful for words or spellings that don't exist within the text.  This might be synonyms, aliases, abbreviations, acronyms, etc.  Some examples:
 +
 +  * Add **Org Unit Setting** and **YAOUS** (stands for "Yet Another Org Unit Setting") to the Library Settings Editor section
  
 ====== Adding terms to the index ====== ====== Adding terms to the index ======
Line 162: Line 168:
   * [[https://github.com/evergreen-library-system/Evergreen/blob/master/docs/shared/about_evergreen.adoc|shared/about_evergreen.adoc]]   * [[https://github.com/evergreen-library-system/Evergreen/blob/master/docs/shared/about_evergreen.adoc|shared/about_evergreen.adoc]]
   * [[https://github.com/evergreen-library-system/Evergreen/blob/master/docs/shared/workstation_settings.adoc|shared/workstation_settings.adoc]]   * [[https://github.com/evergreen-library-system/Evergreen/blob/master/docs/shared/workstation_settings.adoc|shared/workstation_settings.adoc]]
 +
 +
 +====== Re-generating this list ======
 +
 +Run the following command in the main Evergreen directory.
 +
 +<code>
 +grep -rL indexterm docs | grep /.*adoc | grep -Ev 'TechRef|RELEASE|root'
 +</code>
evergreen-docs/adding_indexterms.txt · Last modified: 2022/02/10 13:34 by 127.0.0.1

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki

© 2008-2022 GPLS and others. Evergreen is open source software, freely licensed under GNU GPLv2 or later.
The Evergreen Project is a U.S. 501(c)3 non-profit organization.