source: trunk/pymigemo/README.ja_JP.UTF-8 @ 37

Revision 37, 4.5 KB checked in by atzm, 15 years ago (diff)
  • fix document
  • Property svn:keywords set to Id
Line 
1$Id$
2
3= これは䜕 =
4C/Migemo を Python から䜿うための binding です
5
6
7= 必芁なもの =
8C/Migemo ラむブラリがむンストヌルされおいるこずが前提ずなっおいたす
9ラむブラリ怜玢パスに migemo.so がヘッダ怜玢パスに migemo.h が存圚するこずをご確認䞋さい
10
11
12= むンストヌル方法 =
13同梱の setup.py をご利甚䞋さい
14
15{{{
16$ ./setup.py build
17# ./setup.py install
18}}}
19
20
21= ラむセンス =
22二条項 BSD ラむセンスに準拠したす
23詳现は同梱の LICENSE ファむルをご芧䞋さい
24
25
26= 䜿い方 =
27{{{
28>>> import migemo
29>>> m = migemo.Migemo("/usr/share/migemo/migemo-dict")
30>>> print m.query("hoge")
31(hoge||ほげ|捕鯚|垆桁|補元|ホゲ)
32}}}
33 * ※ query() 結果は読み蟌んだ蟞曞によっお異なりたす
34
35
36== リファレンス ==
37=== モゞュヌルコンテンツ ===
38 * VERSION
39   * MIGEMO_VERSION
40     * C/Migemo のバヌゞョン
41   * PYMIGEMO_VERSION
42     * PyMigemo のバヌゞョン
43
44 * DICTID
45   * DICTID_MIGEMO
46     * migemo-dict 蟞曞
47   * DICTID_ROMA2HIRA
48     * ロヌマ字→平仮名倉換衚
49   * DICTID_HIRA2KATA
50     * 平仮名→カタカナ倉換衚
51   * DICTID_HAN2ZEN
52     * 半角→党角倉換衚
53   * DICTID_ZEN2HAN
54     * 党角→半角倉換衚
55   * DICTID_INVALID
56     * load メ゜ッドで蟞曞の読み蟌みに倱敗した堎合に返る
57
58 * OPINDEX
59   * OPINDEX_OR
60     * 論理和
61     * Migemo.get_operator() に枡した際のデフォルトは "|"
62   * OPINDEX_NEST_IN
63     * グルヌピング時の開き括匧
64     * Migemo.get_operator() に枡した際のデフォルトは "("
65   * OPINDEX_NEST_OUT
66     * グルヌピング時の閉じ括匧
67     * Migemo.get_operator() に枡した際のデフォルトは ")"
68   * OPINDEX_SELECT_IN
69     * 遞択の開始を衚す開き鈎括匧
70     * Migemo.get_operator() に枡した際のデフォルトは "["
71   * OPINDEX_SELECT_OUT
72     * 遞択の終了を衚す閉じ鈎括匧
73     * Migemo.get_operator() に枡した際のデフォルトは "]"
74   * OPINDEX_NEWLINE
75     * 各文字の間に挿入される「0 個以䞊の空癜もしくは改行にマッチする」パタヌン
76     * Migemo.get_operator() に枡した際のデフォルトは "" (空文字列)
77
78 * Migemo クラス
79   * __init__(dictionary)
80     * Migemo クラスのコンストラクタ
81     * 匕数
82       * dictionary: migemo-dict 蟞曞ファむルのパス (str)
83   * get_encoding()
84     * migemo-dict 蟞曞の゚ンコヌディングを str で返す
85       äŸ‹ãˆã° EUC-JP で曞かれた蟞曞であれば "euc_jp" が返る
86       cp932euc_jputf8 のいずれかを返すが
87       èŸžæ›žã®ã‚šãƒ³ã‚³ãƒŒãƒ‡ã‚£ãƒ³ã‚°ãŒã“れらに該圓しなかった堎合は "ascii" を返す
88     * 匕数
89       * なし
90     * 返り倀
91       * ゚ンコヌディング文字列 (str)
92   * get_operator(index)
93     * index で指定された正芏衚珟に䜿甚するメタ文字を返す (str)
94     * 匕数
95       * index: 前述の OPINDEX のいずれか
96     * 返り倀
97       * メタ文字列 (str)
98   * is_enable()
99     * Migemo 内郚に正垞に蟞曞が読み蟌めおいるかどうかをチェックする
100     * 匕数
101       * なし
102     * 返り倀
103       * 真停倀 : 正垞に読み蟌めおいる堎合に真
104   * load(dict_id, dict_file)
105     * Migemo オブゞェクトに蟞曞を远加で読み蟌む
106     * 匕数
107       * dict_id: 前述の DICTID のいずれか
108       * dict_file: 蟞曞ファむルのパス
109     * 返り倀
110       * 読み蟌んだ蟞曞の DICTID
111         èª­ã¿èŸŒã¿ã«å€±æ•—した堎合 DICTID_INVALID が返る
112   * query(query)
113     * query で䞎えられた文字列から日本語怜玢のための正芏衚珟を返す
114     * 匕数
115       * query: 問い合わせる文字列 (Unicode or str)
116         str で ascii 以倖の文字列を枡す堎合
117         èŸžæ›žãšåŒã˜ã‚šãƒ³ã‚³ãƒŒãƒ‡ã‚£ãƒ³ã‚°ã®æ–‡å­—列でないず゚ラヌになる可胜性がある
118     * 返り倀
119       * 正芏衚珟文字列 (Unicode)
120   * set_operator(index, op)
121     * index で指定された正芏衚珟に䜿甚するメタ文字を op に倉曎する
122     * 匕数
123       * index: 前述の OPINDEX のいずれか
124       * op: メタ文字列 (str)
125     * 返り倀
126       * 真停倀 : 成功時に真
127
128
129= その他 =
130本゜フトりェアに察するコメントバグ報告パッチなどは倧いに歓迎したす
131䞋蚘メヌルアドレスたでお気軜にお寄せ䞋さい
132
133Atzm WATANABE <atzm@atzm.org>
Note: See TracBrowser for help on using the repository browser.