From: handa Date: Wed, 25 Jun 2003 13:03:10 +0000 (+0000) Subject: *** empty log message *** X-Git-Tag: XML-base~148 X-Git-Url: http://git.chise.org/gitweb/?p=m17n%2Fm17n-docs.git;a=commitdiff_plain;h=ae22060bce08f3848bec92b756e14d37dc1062da *** empty log message *** --- diff --git a/data-usr/dbformat.txt b/data-usr/dbformat.txt index f94397f..473f5c2 100644 --- a/data-usr/dbformat.txt +++ b/data-usr/dbformat.txt @@ -116,7 +116,7 @@ format of the data is as follows: @verbatim FONT-ENCODING ::= - '(' PER-FONT-INFO * ')' + PER-FONT-INFO * PER-FONT-INFO ::= '(' FONT-SPEC ENCODING ')' @@ -153,7 +153,7 @@ resize\>. The plist format of the data is as follows: @verbatim FONT-RESIZE ::= - '(' PER-FONT-INFO * ')' + PER-FONT-INFO * PER-FONT-INFO ::= '(' FONT-SPEC RESIZE-RATIO ')' @@ -184,7 +184,7 @@ as follows: @verbatim FONTSET ::= - '(' PER-SCRIPT + ')' + PER-SCRIPT + PER-SCRIPT ::= '(' SCRIPT PER-LANGUAGE + ')' diff --git a/data-usr/im.txt b/data-usr/im.txt index a107b4c..99a4292 100644 --- a/data-usr/im.txt +++ b/data-usr/im.txt @@ -1,191 +1,191 @@ -;; FILE-FORMAT ::= -;; TITLE MAP-LIST MODULE-LIST ? STATE-LIST -;; -;; TITLE ::= -;; '(' title MTEXT ')' -;; -;; MAP-LIST ::= -;; '(' 'map' MAP * ')' -;; -;; MAP ::= -;; '(' MAP-NAME RULE * ')' -;; -;; MAP-NAME ::= -;; SYMBOL -;; -;; RULE ::= -;; '(' KEYSEQ MAP-ACTION * ')' -;; -;; KEYSEQ ::= -;; MTEXT | '(' [ SYMBOL | INTEGER ] * ')' -;; -;; MAP-ACTION ::= -;; ACTION -;; -;; ACTION ::= -;; MTEXT | CANDIDATES | '(' ACTION-NAME ACTION-ARG * ')' -;; -;; CANDIDATES ::= -;; '(' CANDIDATE-GROUP * ')' -;; -;; (in ASCTION, -;; MTEXT is a short form of "(insert MTEXT)" -;; CANDIDATES is a short form of "(candidates CANDIDATE-GROUP *)") -;; -;; ACTION-NAME ::= -;; 'insert' | 'candidates' | 'delete' | 'select' | 'select-group' -;; | 'move' | 'mark' | 'pushback' | 'undo' | 'shift' | 'call' -;; -;; ACTION-ARG ::= -;; INTEGER | SYMBOL | MTEXT | CANDIDATE-GROUP -;; -;; CANDIDATE-GROUP ::= -;; MTEXT | '(' MTEXT * ')' -;; -;; PREDEFINED-SYMBOL ::= -;; '@0' | '@1' | '@2' | '@3' | '@4' | '@5' | '@6' | '@7' | '@8' | '@9' -;; | '@<' | '@=' | '@>' | '@-' | '@+' -;; -;; MARKER ::= -;; PREDEFINED-SYMBOL | SYMBOL -;; -;; CANDIDATE-INDEX ::= -;; PREDEFINED-SYMBOL -;; -;; CANDIDATE-GROUP-INDEX ::= -;; PREDEFINED-SYMBOL - -;; ;; The first five actions ('insert' .. 'select-group') are for -;; ;; editing a text in the preediting buffer. The buffer can keep -;; ;; multiple markers. Each marker is represented by a symbol, and -;; ;; keeps a position between characters in the preediting buffer. - -;; ;; PREDEFINED-SYMBOL has special meanings when used as MARKER: -;; ;; '@0', '@1', ... '@9' -;; ;; The 0th, 1th, ... 9th position. -;; ;; '@<', '@=', '@>' -;; ;; The first, current, and end position. -;; ;; '@-', '@+' -;; ;; The previous and next position. - -;; ;; PREDEFINED-SYMBOL has special meanings when used as CANDIDATE-INDEX: -;; ;; '@0', '@1', ... '@9' -;; ;; The 0th, 1th, ... 9th candidate of the current candidate group. -;; ;; '@<', '@=', '@>' -;; ;; The first, current, and end candidate of the current candidate -;; ;; group. -;; ;; '@-' -;; ;; The previous candidate. If the current candidate is the -;; ;; first of the current candidate group, the last candidate of -;; ;; the previous candidate group. -;; ;; '@+' -;; ;; The next candidate. If the current candidate is the last of -;; ;; the current candidate group, the first candidate of the -;; ;; previous candidate group. - -;; ;; PREDEFINED-SYMBOL has special meanings when used as CANDIDATE-INDEX: -;; ;; '@0', '@1', ... '@9' -;; ;; The 0th, 1th, ... 9th candidate of the current candidate group. -;; ;; '@<', '@=', '@>' -;; ;; The first, current, and end candidate of the current candidate -;; ;; group. -;; ;; '@-' -;; ;; The previous candidate. If the current candidate is the -;; ;; first of the current candidate group, the last candidate of -;; ;; the previous candidate group. -;; ;; '@+' -;; ;; The next candidate. If the current candidate is the last of -;; ;; the current candidate group, the first candidate of the -;; ;; previous candidate group. - -;; ;; PREDEFINED-SYMBOL has special meanings when used as -;; ;; CANDIDATE-GROUP-INDEX: -;; ;; '@0', '@1', ... '@9' -;; ;; The 0th, 1th, ... 9th candidate group. -;; ;; '@<', '@=', '@>' -;; ;; The first, current, and end candidate group. -;; ;; '@-', '@+' -;; ;; The previous and the next candidate group. - -;; ;; (insert MTEXT) inserts MTEXT before @=. - -;; ;; (candidates CANDIDATE-GROUP *) set the current candidates list -;; ;; to the list of arguments, set the current candidate group to the -;; ;; first argument, insert the first candidate of the current group -;; ;; before @=, and mark the inserted text as the current candidate. -;; ;; Each element of CANDIDATE-GROUP represents a candidate, i.e. if -;; ;; CANDIDATE-GROUP is MTEXT, each character in MTEXT is a -;; ;; candidate, if CANDIDATE-GROUP is a list of MTEXT, each MTEXT is -;; ;; a candidate. - -;; ;; (select CANDIDATE-INDEX) replaces the current candidate with -;; ;; what specified by CANDIDATE-INDEX. If a candidate of the -;; ;; different candidate group is specified, set the current -;; ;; candidate group to that group. - -;; ;; (select-group CANDIDATE-GROUP-INDEX) sets the current candidate -;; ;; group to a group indicated by CANDIDATE-GROUP-INDEX, and relaces -;; ;; the current candiate with the candiate of the same index in the -;; ;; new group. - -;; ;; (delete MARKER) deletes characters between @= and the position -;; ;; specified by MARKER. - -;; ;; (move MARKER) sets @= to the position of specified by MARKER. - -;; ;; (mark MARKER) sets MARKER to the position of @=. MARKER must -;; ;; not be PREDEFINED-SYMBOL. - -;; ;; (pushback) pushbacks the latest key events to the event queue. - -;; ;; (undo) cancels the last key events. - -;; ;; (shift STATE-NAME) shifts the current state to the state -;; ;; specified by STATE-NAME. - -;; ;; (call FUNCTION ARG *) calls the function FUNCTION of an external -;; ;; module. FUNCTION must be defined in MODULE-LIST. - -;; ;; The function is called with a property list (MPlist *) that has -;; ;; these properties in this order. -;; ;; KEY VALUE -;; ;; --- ----- -;; ;; mtext The current preedit text. -;; ;; symbol The current state name (MSymbol). -;; ;; The remaining properties (if any) are ARGs. -;; ;; -;; ;; The function must return a property list (MPlist *) that -;; ;; represents a list of ACTIONs to take. - -;; MODULE-LIST ::= -;; '(' 'module' MODULE * ')' -;; -;; MODULE ::= -;; '(' MODULE-NAME FUNCTION * ')' -;; -;; MODULE-NAME ::= -;; MTEXT -;; -;; FUNCTION ::= -;; SYMBOL - -;; STATE-LIST ::= -;; '(' 'state' STATE * ')' -;; -;; STATE ::= -;; '(' STATE-NAME BRANCH * ')' -;; -;; STATE-NAME ::= -;; SYMBOL -;; -;; BRANCH ::= -;; '(' [ MAP-NAME | 'nil' ] BRANCH-ACTION * ')' - -;; ;; If MAP-NAME is specified, it must be a name of a map defined in -;; ;; MAP-LIST. Otherwise, BRANCH is the default branch of STATE. - -;; BRANCH-ACTION ::= -;; ACTION +INPUT-METDHO ::= + '(' TITLE MAP-LIST MODULE-LIST ? STATE-LIST ')' + +TITLE ::= + '(' title MTEXT ')' + +MAP-LIST ::= + '(' 'map' MAP * ')' + +MAP ::= + '(' MAP-NAME RULE * ')' + +MAP-NAME ::= + symbol + +RULE ::= + '(' KEYSEQ MAP-ACTION * ')' + +KEYSEQ ::= + mtext | '(' [ symbol | integer ] * ')' + +MAP-ACTION ::= + ACTION + +ACTION ::= + mtext | CANDIDATES | '(' ACTION-NAME ACTION-ARG * ')' + +CANDIDATES ::= + '(' CANDIDATE-GROUP * ')' + + (in ASCTION, + MTEXT is a short form of "(insert MTEXT)" + CANDIDATES is a short form of "(candidates CANDIDATE-GROUP *)") + +ACTION-NAME ::= + 'insert' | 'candidates' | 'delete' | 'select' | 'select-group' + | 'move' | 'mark' | 'pushback' | 'undo' | 'shift' | 'call' + +ACTION-ARG ::= + integer | symbol | mtext | CANDIDATE-GROUP + +CANDIDATE-GROUP ::= + mtext | '(' mtext * ')' + +PREDEFINED-SYMBOL ::= + '@0' | '@1' | '@2' | '@3' | '@4' | '@5' | '@6' | '@7' | '@8' | '@9' + | '@<' | '@=' | '@>' | '@-' | '@+' + +MARKER ::= + PREDEFINED-SYMBOL | symbol + +CANDIDATE-INDEX ::= + PREDEFINED-SYMBOL + +CANDIDATE-GROUP-INDEX ::= + PREDEFINED-SYMBOL + +;; The first five actions ('insert' .. 'select-group') are for +;; editing a text in the preediting buffer. The buffer can keep +;; multiple markers. Each marker is represented by a symbol, and +;; keeps a position between characters in the preediting buffer. + +;; PREDEFINED-SYMBOL has special meanings when used as MARKER: +;; '@0', '@1', ... '@9' +;; The 0th, 1th, ... 9th position. +;; '@<', '@=', '@>' +;; The first, current, and end position. +;; '@-', '@+' +;; The previous and next position. + +;; PREDEFINED-SYMBOL has special meanings when used as CANDIDATE-INDEX: +;; '@0', '@1', ... '@9' +;; The 0th, 1th, ... 9th candidate of the current candidate group. +;; '@<', '@=', '@>' +;; The first, current, and end candidate of the current candidate +;; group. +;; '@-' +;; The previous candidate. If the current candidate is the +;; first of the current candidate group, the last candidate of +;; the previous candidate group. +;; '@+' +;; The next candidate. If the current candidate is the last of +;; the current candidate group, the first candidate of the +;; previous candidate group. + +;; PREDEFINED-SYMBOL has special meanings when used as CANDIDATE-INDEX: +;; '@0', '@1', ... '@9' +;; The 0th, 1th, ... 9th candidate of the current candidate group. +;; '@<', '@=', '@>' +;; The first, current, and end candidate of the current candidate +;; group. +;; '@-' +;; The previous candidate. If the current candidate is the +;; first of the current candidate group, the last candidate of +;; the previous candidate group. +;; '@+' +;; The next candidate. If the current candidate is the last of +;; the current candidate group, the first candidate of the +;; previous candidate group. + +;; PREDEFINED-SYMBOL has special meanings when used as +;; CANDIDATE-GROUP-INDEX: +;; '@0', '@1', ... '@9' +;; The 0th, 1th, ... 9th candidate group. +;; '@<', '@=', '@>' +;; The first, current, and end candidate group. +;; '@-', '@+' +;; The previous and the next candidate group. + +;; (insert MTEXT) inserts MTEXT before @=. + +;; (candidates CANDIDATE-GROUP *) set the current candidates list +;; to the list of arguments, set the current candidate group to the +;; first argument, insert the first candidate of the current group +;; before @=, and mark the inserted text as the current candidate. +;; Each element of CANDIDATE-GROUP represents a candidate, i.e. if +;; CANDIDATE-GROUP is MTEXT, each character in MTEXT is a +;; candidate, if CANDIDATE-GROUP is a list of MTEXT, each MTEXT is +;; a candidate. + +;; (select CANDIDATE-INDEX) replaces the current candidate with +;; what specified by CANDIDATE-INDEX. If a candidate of the +;; different candidate group is specified, set the current +;; candidate group to that group. + +;; (select-group CANDIDATE-GROUP-INDEX) sets the current candidate +;; group to a group indicated by CANDIDATE-GROUP-INDEX, and relaces +;; the current candiate with the candiate of the same index in the +;; new group. + +;; (delete MARKER) deletes characters between @= and the position +;; specified by MARKER. + +;; (move MARKER) sets @= to the position of specified by MARKER. + +;; (mark MARKER) sets MARKER to the position of @=. MARKER must +;; not be PREDEFINED-SYMBOL. + +;; (pushback) pushbacks the latest key events to the event queue. + +;; (undo) cancels the last key events. + +;; (shift STATE-NAME) shifts the current state to the state +;; specified by STATE-NAME. + +;; (call FUNCTION ARG *) calls the function FUNCTION of an external +;; module. FUNCTION must be defined in MODULE-LIST. + +;; The function is called with a property list (MPlist *) that has +;; these properties in this order. +;; KEY VALUE +;; --- ----- +;; mtext The current preedit text. +;; symbol The current state name (MSymbol). +;; The remaining properties (if any) are ARGs. +;; +;; The function must return a property list (MPlist *) that +;; represents a list of ACTIONs to take. + +MODULE-LIST ::= + '(' 'module' MODULE * ')' + +MODULE ::= + '(' MODULE-NAME FUNCTION * ')' + +MODULE-NAME ::= + mtext + +FUNCTION ::= + symbol + +STATE-LIST ::= + '(' 'state' STATE * ')' + +STATE ::= + '(' STATE-NAME BRANCH * ')' + +STATE-NAME ::= + symbol + +BRANCH ::= + '(' [ MAP-NAME | 'nil' ] BRANCH-ACTION * ')' + +;; If MAP-NAME is specified, it must be a name of a map defined in +;; MAP-LIST. Otherwise, BRANCH is the default branch of STATE. + +BRANCH-ACTION ::= + ACTION ;; Example: diff --git a/data-usr/mainpage.c b/data-usr/mainpage.c deleted file mode 100644 index 998b7d7..0000000 --- a/data-usr/mainpage.c +++ /dev/null @@ -1,62 +0,0 @@ -/***en - @mainpage The m17n library documentation - - @section what What is the m17n library? - - The @e m17n @e library is a multilingual text processing library - for the C language. - - - - The word "m17n" is an abbreviation of "multilingualization". - - The m17n library provides following facilities to handle - multilingual text. - - - - @section usage How to use it? - - Just include in your program, and link it with the m17n - library by -lm17n. See the documentation of the module \link - m17nIntro Introduction \endlink for the detail. - - @section contact Contact us: - - Global IT Security Group\n - Information Technology Research Institute\n - Institute of Advanced Industrial Science and Technology - - E-mail: mule-aist@m17n.org - -*/ -//// diff --git a/doxyfile.in b/doxyfile.in index 6bb4126..58b1350 100644 --- a/doxyfile.in +++ b/doxyfile.in @@ -308,7 +308,14 @@ WARN_LOGFILE = warning # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = "data-%USR_JA_DEV%/mainpage.txt" "@M17NLIB@/src/m17n-core.h" "@M17NLIB@/src/m17n.h" "@M17NLIB@/src/m17n-win.h" "@M17NLIB@/src/m17n-X.h" "@M17NLIB@/src/m17n-err.h" "@M17NLIB@/src/" "data-%USR_JA_DEV%/dbformat.txt" +INPUT = "data-%USR_JA_DEV%/mainpage.txt" +INPUT += "@M17NLIB@/src/m17n-core.h" +INPUT += "@M17NLIB@/src/m17n.h" +INPUT += "@M17NLIB@/src/m17n-win.h" +INPUT += "@M17NLIB@/src/m17n-X.h" +INPUT += "@M17NLIB@/src/m17n-err.h" +INPUT += "@M17NLIB@/src/" +INPUT += "data-%USR_JA_DEV%/dbformat.txt" # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp @@ -426,7 +433,6 @@ HTML_FOOTER = @abs_srcdir@/footer.html # will generate a default style sheet HTML_STYLESHEET = @abs_srcdir@/m17n-lib.css -# HTML_STYLESHEET = # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, # files or namespaces will be aligned in HTML using tables. If set to @@ -672,7 +678,7 @@ INCLUDE_FILE_PATTERNS = # omitted =1 is assumed. PREDEFINED = FOR_DOXYGEN -#PREDEFINED += DOXYGEN_INTERNAL_MODULE +#PREDEFINED += DOXYGEN_INTERNAL_MODULE # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then # this tag can be used to specify a list of macro names that should be expanded.