====== Glossary Plugin ======

---- plugin ----
description: Manage glossary for translation
author     : François Merciol
email      : dokuplugin@merciol.fr
type       : syntax
lastupdate : 2019-09-25
compatible : Greebo, Frusterick Manners, Hogfather
depends    : 
conflicts  : 
similar    : 
tags       : boxes, style, translation

downloadurl: https://admin.parlenet.org/files/plugins/glossary.tgz
bugtracker : 
sourcerepo : 
donationurl: 

screenshot_img : http://admin.parlenet.org/_media/plugins/glossary/glossary-sample.png
----

===== Installation =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

===== Examples/Usage =====

See the plugin in action [[http://fsl56.org/glossaire/|here]].

In this case, French "Newspeak" expression are translate in the real world. 

<code>
{{glossary list}}
</code>

You have to manage the proposition in back-office (page under access control).
<code>
{{glossary admin-proposal}}

{{glossary admin-definition}}
</code>

===== Syntax =====

<code>
{{glossary>namespace [help] (sample|list|proposal|admin-proposal|admin-definition|admin-glossaries)}}
</code>
  * **namespace** -- name of the glossary to manage multiple glossary in a site and referred the appropriate one when management\\ (by default the namespace of the page where the syntax appears)
  * **help** -- give a help
  * **sample** -- select randomly a new to be showe (for instance by [[showSamples]])
  * **list** -- list of all definitions
  * **proposal** -- proposition form
  * **admin-proposal** -- list the proposition and remove when taken in account
  * **admin-definition** -- add or remove definitions (can be replace "proposal" if you trust on users)
  * **admin-glossaries** -- manage (include removal) all glossaries in the site

You can include the icons used by this plugin with:
<code>
<glossary (help|clock|face-smile|face-sad|stop|one-way|search) />
</code>
Use one of parameters name according the icon you want to show

To highlight words according the input language, use:
<code>
<glossary word> some input word </glossary>
</code>

To highlight words according the output language, use:
<code>
<glossary translate> some output word </glossary>
</code>

===== Configuration and Settings =====

  * **dataDir** -- for xml file database directory. More precisely, place where you can find one directory per namespace (md5 of namespace)
  * **recentDays** -- number of days to show a clock beside a new definition
  * **maxIP** -- maximun of proposition for the same IP (proposition are remove by administrator)
  * **adminGroup** -- group of administrator
  * **propGroup** -- group wihtout limitation of proposition
  * **transSep** -- separator for multi definition (can't be used in input or output word)
  * **propositionPage** -- page where a proposition form can be found
  * **sampleDelai** -- delay before change the sample
  * **listDelai** -- delay of cache (depending of proposition frequencies)