= Documentation for Web admin interface =

Package: '''debserver-common'''

== Password change ==
''(change my password)''

Available to all users. Here they can change their password.

== Dictionaries ==

Dictionary files and features definition. 
  code::
   short dictionary code, used as a dictionary identification
  name::
   dictionary name, displayed to users
  file::
   name of dbxml file
  class::
   Ruby class used for dictionary API, list is fixed and contains all possible classes. File containing class definition must be included in runner script. ''Dictionary'' class is the most common.
  root tag::
   root element of each entry
  key::
   XPath of each entry key
  indexes::
   List of indexed elements/attributes, pairs of element name (attributes name without @) and index type (choose the right type, or the wrong index may cause performance issues). For Wordnet dictionaries, basic set of indexes is filled automatically.
  xslt::
   List of XSLT templates for entries preview, pairs of template name (used in code) and XSLT filename. For Wordnet dictionaries, basic set of templates is filled automatically.
  packages::
   ''(for Wordnet and Cornetto dictionaries)'' list of client packages, pairs of package code (used for identification) and package name (displayed to users). At the moment, only one package is used, but it's possible to have two different packages displaying data in different form for one dictionary. Usually, package code is the same as dictionary code with number 1.
  eq tags::
   ''(for Wordnet and Cornetto dictionaries)'' List of equivalence tags relations to do lookup in other dictionary. Path of element used for relation (same syntax as for WN queries) and dictionary package code.
  lookup dict::
   ''(for Wordnet and Cornetto dictionaries)'' List of dictionary packages to allow (auto)lookup to. List of package codes, separated by comma (,).
  reload dict::
   ''(for Wordnet and Cornetto dictionaries)'' List of dictionaries to reload in client after entry edit. List of dictionary codes, separated by comma (,). Dictionary itself is always included.

=== Example ===
 * code = wnen
 * name = English Wordnet
 * file = wnen.dbxml
 * class = !WordNet
 * root tag = SYNSET, cid
 * key = /SYNSET/ID, /cid/@cid_id
 * indexes = ID:node-element-equality-string, LITERAL:node-element-substring-string
 * xslt = xml:xmlpretty.xsl (for neat XML preview), preview:wn-preview.xslt, vb:wnvb.xslt
 * packages = wneng1:English WN
 * eq tags = cid.@d_sy_id:cdbsyn1, cid.@c_lu_id:cdblu1
 * lookup dict = wncze1,wngre1,wnfre1
 * reload dict = wncz

== Services ==

Service is one DEB server running on separate port. Several services can use the same dictionaries.

  code::
   short service code, used as an identification.
   This code is also used in start script, for example in ''bin/wordnet_services.rb'': 
{{{
wninfo = WordNetAdmin.new(db_path, 'admininfo.dbxml', '', env)
wninfo.service_name = 'debvisdic'
}}}
  name::
   service name
  dictionaries::
   check the box for dictionaries that should be part of this service

== Users ==

== Sequences ==

Definition of ID sequences for each dictionary. You can set pattern and number for each dictionary. Whenever a new entry is created, number is raised by 1 and new ID is created by substituting [id] in pattern with new number. For example: for ''cdb_syn'' dictionary, the pattern is '''c_[id]''' and if a new number is 29, then new ID is c_29