FORMATS/Dir.txt

   1 /* Copyright (C) 2003, 2004, 2005
   2      National Institute of Advanced Industrial Science and Technology (AIST)
   3      Registration Number H15PRO112
   4    See the end for copying conditions.  */
   5
   6 /***en
   7
   8 @page mdbDir List of data in a database directory.
   9
  10 @section dir-description DESCRIPTION
  11
  12 The m17n library loads a list of definitions of data of the m17n
  13 database from files of name "mdb.dir" in each database directory at
  14 initialization time.  The plist format of this file is as follows:
  15
  16 @verbatim
  17 MDB-DIR ::= DEFINITION *
  18
  19 DEFINITION ::= '(' TAG0 [ TAG1 [ TAG2 [ TAG3 ] ] ] FILE [ VERSION ]')'
  20
  21 TAGn ::= SYMBOL
  22
  23 FILE ::= MTEXT
  24
  25 VERSION ::= MTEXT
  26 @endverbatim
  27
  28 If TAG0 is neither `charset' nor `char-table', and TAGn (n > 0) is a
  29 symbol `*', FILE can contain a wildcard charater, and all files
  30 matching FILE accoding to the rules used by the shell are the target
  31 of database files.  In that case, each file must contain
  32 SELF-DEFINITION which is a plist element providing the actual TAGn
  33 values by the form:
  34
  35 @verbatim
  36 SELF-DEFINITION ::= '(' TAG0 TAG1 TAG2 TAG3 [ VERSION ] ')'
  37 @endverbatim
  38
  39 For instance, if a database directory contains these files:
  40
  41 @verbatim
  42 zh-py.mim:
  43 (input-method zh py)
  44 ...
  45
  46 ko-han2.mim:
  47 (input-method ko han2)
  48 ...
  49 @endverbatim
  50
  51 these lines in "mdb.dir":
  52
  53 @verbatim
  54 (input-method zh py "zh-py.mim")
  55 (input-method ko han2 "ko-han2.mim")
  56 @endverbatim
  57
  58 can be shortened to this single line:
  59
  60 @verbatim
  61 (input-method * "*.mim")
  62 @endverbatim
  63
  64 VERSION is a required version number of the m17n library.  The format
  65 is "XX.YY.ZZ" where XX is a major version number, YY is a minor
  66 version number, and ZZ is a patch level.
  67
  68 */
  69
  70 /*
  71 Copyright (C) 2003, 2004, 2005
  72   National Institute of Advanced Industrial Science and Technology (AIST)
  73   Registration Number H15PRO112
  74
  75 This file is part of the m17n database; a sub-part of the m17n
  76 library.
  77
  78 The m17n library is free software; you can redistribute it and/or
  79 modify it under the terms of the GNU Lesser General Public License
  80 as published by the Free Software Foundation; either version 2.1 of
  81 the License, or (at your option) any later version.
  82
  83 The m17n library is distributed in the hope that it will be useful,
  84 but WITHOUT ANY WARRANTY; without even the implied warranty of
  85 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  86 Lesser General Public License for more details.
  87
  88 You should have received a copy of the GNU Lesser General Public
  89 License along with the m17n library; if not, write to the Free
  90 Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  91 Boston, MA 02110-1301, USA.
  92 */