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

Revision 30, 4.5 KB checked in by atzm, 15 years ago (diff)

modified indentation
  • Property svn:keywords set to Id
Line 
1$Id$
2
3= これは䜕 =
4C/Migemo を Python から䜿うための wrapper です
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
34
35== リファレンス ==
36=== モゞュヌルコンテンツ ===
37 * VERSION
38   * MIGEMO_VERSION
39     * C/Migemo のバヌゞョン
40   * PYMIGEMO_VERSION
41     * PyMigemo のバヌゞョン
42
43 * DICTID
44   * DICTID_MIGEMO
45     * migemo-dict 蟞曞
46   * DICTID_ROMA2HIRA
47     * ロヌマ字→平仮名倉換衚
48   * DICTID_HIRA2KATA
49     * 平仮名→カタカナ倉換衚
50   * DICTID_HAN2ZEN
51     * 半角→党角倉換衚
52   * DICTID_ZEN2HAN
53     * 党角→半角倉換衚
54   * DICTID_INVALID
55     * load メ゜ッドで蟞曞の読み蟌みに倱敗した堎合に返る
56
57 * OPINDEX
58   * OPINDEX_OR
59     * 論理和
60     * Migemo.get_operator() に枡した際のデフォルトは "|"
61   * OPINDEX_NEST_IN
62     * グルヌピング時の開き括匧
63     * Migemo.get_operator() に枡した際のデフォルトは "("
64   * OPINDEX_NEST_OUT
65     * グルヌピング時の閉じ括匧
66     * Migemo.get_operator() に枡した際のデフォルトは ")"
67   * OPINDEX_SELECT_IN
68     * 遞択の開始を衚す開き鈎括匧
69     * Migemo.get_operator() に枡した際のデフォルトは "["
70   * OPINDEX_SELECT_OUT
71     * 遞択の終了を衚す閉じ鈎括匧
72     * Migemo.get_operator() に枡した際のデフォルトは "]"
73   * OPINDEX_NEWLINE
74     * 各文字の間に挿入される「0 個以䞊の空癜もしくは改行にマッチする」パタヌン
75     * Migemo.get_operator() に枡した際のデフォルトは "" (空文字列)
76
77 * Migemo クラス
78   * __init__(dictionary)
79     * Migemo クラスのコンストラクタ
80     * 匕数
81       * dictionary: migemo-dict 蟞曞ファむルのパス (str)
82   * get_encoding()
83     * migemo-dict 蟞曞の゚ンコヌディングを str で返す
84       äŸ‹ãˆã° EUC-JP で曞かれた蟞曞であれば "euc_jp" が返る
85       cp932euc_jputf8 のいずれかを返すが
86       èŸžæ›žã®ã‚šãƒ³ã‚³ãƒŒãƒ‡ã‚£ãƒ³ã‚°ãŒã“れらに該圓しなかった堎合は "ascii" を返す
87     * 匕数
88       * なし
89     * 返り倀
90       * ゚ンコヌディング文字列 (str)
91   * get_operator(index)
92     * index で指定された正芏衚珟に䜿甚するメタ文字を返す (str)
93     * 匕数
94       * index: 前述の OPINDEX のいずれか
95     * 返り倀
96       * メタ文字列 (str)
97   * is_enable()
98     * Migemo 内郚に正垞に蟞曞が読み蟌めおいるかどうかをチェックする
99     * 匕数
100       * なし
101     * 返り倀
102       * 真停倀 (int) : 正垞に読み蟌めおいる堎合に真
103   * load(dict_id, dict_file)
104     * Migemo オブゞェクトに蟞曞を远加で読み蟌む
105     * 匕数
106       * dict_id: 前述の DICTID のいずれか
107       * dict_file: 蟞曞ファむルのパス
108     * 返り倀
109       * 読み蟌んだ蟞曞の DICTID
110         èª­ã¿èŸŒã¿ã«å€±æ•—した堎合 DICTID_INVALID が返る
111   * query(query)
112     * query で䞎えられた文字列から日本語怜玢のための正芏衚珟を返す
113     * 匕数
114       * query: 問い合わせる文字列 (Unicode or str)
115         str で ascii 以倖の文字列を枡す堎合
116         èŸžæ›žãšåŒã˜ã‚šãƒ³ã‚³ãƒŒãƒ‡ã‚£ãƒ³ã‚°ã®æ–‡å­—列でないず゚ラヌになる可胜性がある
117     * 返り倀
118       * 正芏衚珟文字列 (Unicode)
119   * set_operator(index, op)
120     * index で指定された正芏衚珟に䜿甚するメタ文字を op に倉曎する
121     * 匕数
122       * index: 前述の OPINDEX のいずれか
123       * op: メタ文字列 (str)
124     * 返り倀
125       * 真停倀 (int) : 成功時に真
126
127
128= その他 =
129本゜フトりェアに察するコメントバグ報告パッチなどは倧いに歓迎したす
130䞋蚘メヌルアドレスたでお気軜にお寄せ䞋さい
131
132Atzm WATANABE <atzm@atzm.org>
Note: See TracBrowser for help on using the repository browser.