Differences

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

--- evergreen-docs:adding_indexterms [2018/05/02 10:37] – created sandbergja
+++ evergreen-docs:adding_indexterms [2022/02/10 13:34] (current) – external edit 127.0.0.1
@@ Line 4: / Line 4: @@
 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
+  * Add **Preferences** to sections where only the term "settings" is used.
 ====== Adding terms to the index ======
@@ Line 162: / Line 169: @@
   * [[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]]
+====== 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>