Develop and Download Open Source Software

Browse CVS Repository

Contents of /modchxj/mod_chxj/doc/modchxj.sdoc

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.17 - (show annotations) (download)
Tue Jul 11 17:16:02 2006 UTC (17 years, 9 months ago) by konn
Branch: MAIN
Changes since 1.16: +2 -1 lines
*** empty log message ***

1 <?xml version='1.0' encoding="EUC-JP" ?>
2
3 <doc xml:lang="ja">
4 <head>
5 <title>mod_chxj</title>
6 <subtitle></subtitle>
7 <author>Atsushi Konno</author>
8 <date>29 Mar 2005</date>
9 </head>
10 <body>
11 <section title="Overview">
12
13 mod_chxjはオープンソースの携帯向けコンテンツ変換Apache2.0用モジュールであり、
14 CHTML(DoCoMo i-Mode用 CHTML3.0)で記述された文書や通常のHTMLで記述された文書を、アクセスに来た端末のUser-Agentヘッダを見て、それぞれの端末にあった形式に変換します。
15 HTML文書に限らず、画像(jpg、gif、png)、絵文字についても、定義ファイルに従ってそれぞれのキャリアにあった絵文字に変換します。
16 Cookie非対応端末、Refer非対応端末のために、Set-Cookie、CookieヘッダやRefererヘッダをシミュレートすることもできます(EXPERIMENTAL)。
17
18
19 </section>
20 <section title="インストール">
21 <subsection title="準備">
22 mod_chxjをインストールする前に、下記のものを用意する必要があります。
23 <ol>
24 <li>Apache2.0のヘッダーファイル群</li>
25 <li>Apache2.0用のapxs</li>
26 <li>apr(Apache Portable Runtime)ライブラリとそのヘッダファイル郡(apu含む)</li>
27 <li>automake、autoconf、libtool1.3.X</li>
28 <li>ImageMagick(MagickWand)</li>
29 <li>libiconvまたはlibiconv_hook</li>
30 <li>Linux</li>
31 </ol>
32 </subsection>
33 <subsection title="mod_chxjの入手">
34 mod_chxjは<a href="http://sourceforge.jp/projects/modchxj/">こちら</a>からダウンロードすることができます。
35 </subsection>
36 <subsection title="インストール">
37 以下にmod_chxjインストール手順を示します。
38 <ol>
39 <li>Configure スクリプトを生成します<program title="Configure スクリプトの生成">
40 $ ./buildconf.sh
41 </program>
42 <note>"$"はプロンプトをあらわします。</note>
43 </li>
44 <li>Configure
45
46 以下は、/usr/include/apache2.0に、Apache2.0のヘッダーファイルが存在する場合です。
47 <program title="Configure">
48 $ ./configure --with-apache-header=/usr/include/apache2.0
49 </program>
50 <note>--with-apache-headerは必須です。</note>
51 <note>FreeBSD等の場合は--with-iconvも必須です。</note>
52 <note>場合によっては--with-aprや--with-apuも必要です。</note>
53 </li>
54 <li>mod_chxj.soを生成します
55 <program title="make">
56 $ make
57 </program>
58 </li>
59 <li>apacheにインストールします
60 <program title="install">
61 $ make install
62 </program>
63 </li>
64 <li>データの設置
65 etcディレクトリは以下のdevice_data.xmlとemoji.xmlをApache
66 からアクセスできるところに配置します。
67
68 以下、/etc/apache2/chxjディレクトリにchxj用設定ファイルを用意する場合
69
70 <program title="データの設置">
71 $ mkdir -p /etc/apache2/chxj
72 $ cp etc/device_data.xml /etc/apache2/chxj
73 $ cp etc/emoji.xml /etc/apache2/chxj
74 </program>
75 </li>
76 </ol>
77 </subsection>
78 </section>
79 <section title="Configuration">
80 以下はmod_chxjが/usr/lib/apache2/modulesディレクトリ配下に設置されたものとしています
81
82 <subsection title="htmlファイルが変換対象の場合">
83
84 例として、Locationが"/chxj"以下のものは全て変換する場合を説明します。
85
86 <ol>
87 <li>httpd.confに以下を追加します。
88
89 <program title="httpd.conf">
90 #====================================================================================
91 # モジュールをApache2.0にロード
92 #====================================================================================
93 LoadModule chxj_module /usr/lib/apache2/modules/mod_chxj.so
94
95 #====================================================================================
96 # デバイスデータファイルの設定
97 #====================================================================================
98 ChxjLoadDeviceData /etc/apache2/chxj/device_data.xml
99
100 #====================================================================================
101 # 絵文字データファイルの設定
102 #====================================================================================
103 ChxjLoadEmojiData /etc/apache2/chxj/emoji.xml
104
105 #====================================================================================
106 # 変換エンジン動作指示命令(下記のSetOutputFilter、SetInputFilterも必須です)
107 # ChxjConvRule ==> ディレクティブ
108 # "^/chxj.+$" ==> Perl互換のURIパターン
109 # EngineOn ==> 変換エンジンを動作させる指示
110 # NONE ==> サーバ側の文字コード。(NONEを指定した場合は文字コード変換しない)
111 #====================================================================================
112 ChxjConvertRule "^/chxj.+$" "EngineOn" "NONE"
113
114 </program>
115 </li>
116 <li>apacheの再起動。</li>
117 </ol>
118 </subsection>
119 <subsection title="php等の出力結果が変換対象の場合">
120 <ol>
121 <li>httpd.confに以下を追加します
122
123 <program title="httpd.conf">
124 #====================================================================================
125 # モジュールをApache2.0にロード
126 #====================================================================================
127 LoadModule chxj_module /usr/lib/apache2/modules/mod_chxj.so
128
129 #====================================================================================
130 # デバイスデータの設定
131 #====================================================================================
132 ChxjLoadDeviceData /etc/apache2/chxj/device_data.xml
133
134 #====================================================================================
135 # 絵文字データの設定
136 #====================================================================================
137 ChxjLoadEmojiData /etc/apache2/chxj/emoji.xml
138
139 #====================================================================================
140 # 変換エンジン動作指示命令(下記のSetOutputFilter、SetInputFilterも必須です)
141 # ChxjConvRule ==> ディレクティブ
142 # "^/chxj.+$" ==> Perl互換のURIパターン
143 # EngineOn ==> 変換エンジンを動作させる指示。動作させたく無い場合は"EngineOff"
144 # EUC-JP ==> サーバ側の文字コード。(NONEを指定した場合は文字コード変換しない)
145 # EUC-JPからCP932に文字コード変換します。
146 #====================================================================================
147 ChxjConvertRule "^/chxj.+$" "EngineOn" "EUC-JP"
148
149 </program>
150 </li>
151 <li>apacheの再起動。</li>
152 </ol>
153 </subsection>
154
155 <subsection title="xoopsを使用し、且つwordpress、bwikiを使用している場合">
156 <ol>
157 <li>httpd.confに以下を追加します
158
159 <program title="httpd.conf">
160 #====================================================================================
161 # モジュールをApache2.0にロード
162 #====================================================================================
163 LoadModule chxj_module /usr/lib/apache2/modules/mod_chxj.so
164
165 #====================================================================================
166 # デバイスデータの設定
167 #====================================================================================
168 ChxjLoadDeviceData /etc/apache2/chxj/device_data.xml
169
170 #====================================================================================
171 # 絵文字データの設定
172 #====================================================================================
173 ChxjLoadEmojiData /etc/apache2/chxj/emoji.xml
174
175 #====================================================================================
176 # 変換エンジン動作指示命令(下記のSetOutputFilter、SetInputFilterも必須です)
177 #====================================================================================
178 #====================================================================================
179 # bwikiの設定をします。bwikiではどうもxoopsヘッダの文字コードとbwiki内での携帯スキン
180 # の文字コードが一致していないようなので、bwiki内で文字コードを変換させないように
181 # 修正後、以下のルールを記述します。
182 #
183 # ChxjConvRule ディレクティブ
184 # "^/modules/bwiki.+$" このルールを適用したいURIパターン
185 # "EngineOn" 変換エンジンを有効にします。
186 # "EUC-JP" 出力時にEUC-JPからCP932に変換させます。
187 # "PC" 変換元HTMLはPCサイト用HTMLです。
188 # "DoCoMo/1.0/D501i" DoCoMo端末としてbwikiにアクセスさせます。
189 #
190 #====================================================================================
191 ChxjConvertRule "^/modules/bwiki.+$" "EngineOn" "EUC-JP" "PC" "DoCoMo/1.0/D501i"
192
193 #====================================================================================
194 # wordpressの設定をします。
195 #
196 # ChxjConvRule ディレクティブ
197 # "^/modules/wordpress.+$" このルールを適用したいURIパターン
198 # "EngineOn" 変換エンジンを有効にします。
199 # "NONE" 出力時に文字コード変換をさせません。
200 # "NONE" 変換元HTMLはPCサイト用HTMLではありません。
201 # "DoCoMo/1.0/D501i" DoCoMo端末としてwordpressにアクセスさせます。
202 #
203 #====================================================================================
204 ChxjConvertRule "^/modules/wordpress/.*$" "EngineOn" "NONE" "PC" "DoCoMo/1.0/D501i"
205
206 #====================================================================================
207 # その他の設定をします。
208 #
209 # ChxjConvRule ディレクティブ
210 # "^/.+$" このルールを適用したいURIパターン
211 # "EngineOn" 変換エンジンを有効にします。
212 # "EUC-JP" 出力時にEUC-JPからCP932に文字コード変換をさせます。
213 #
214 #====================================================================================
215 ChxjConvertRule "^/.+$" "EngineOn" "EUC-JP"
216
217
218 &lt;Location /&gt;
219 ChxjImageEngine On
220 AllowOverride All
221 &lt;/Location&gt;
222 </program>
223 </li>
224 <li>apacheの再起動。</li>
225 </ol>
226 </subsection>
227
228 <subsection title="mod_jk2を使用したtomcatの出力結果が変換対象の場合">
229 <ol>
230 <li>httpd.confに以下を追加します
231
232 <program title="httpd.conf">
233 #====================================================================================
234 # モジュールをApache2.0にロード
235 #====================================================================================
236 LoadModule chxj_module /usr/lib/apache2/modules/mod_chxj.so
237
238 #====================================================================================
239 # デバイスデータの設定
240 #====================================================================================
241 ChxjLoadDeviceData /etc/apache2/chxj/device_data.xml
242
243 #====================================================================================
244 # 絵文字データの設定
245 #====================================================================================
246 ChxjLoadEmojiData /etc/apache2/chxj/emoji.xml
247
248 #====================================================================================
249 # 変換エンジン動作指示命令(下記のSetOutputFilter、SetInputFilterも必須です)
250 # ChxjConvRule ==> ディレクティブ
251 # "^/chxj.+$" ==> Perl互換のURIパターン
252 # EngineOn ==> 変換エンジンを動作させる指示。動作させたく無い場合は"EngineOff"
253 # EUC-JP ==> サーバ側の文字コード。(NONEを指定した場合は文字コード変換しない)
254 # EUC-JPからCP932に文字コード変換します。
255 #====================================================================================
256 ChxjConvertRule "^/chxj.+$" "EngineOn" "EUC-JP"
257
258 &lt;Location /chxj&gt;
259 SetOutputFilter chxj_output_filter
260 &lt;/Location&gt;
261 </program>
262 <note>注意:input_filterは設定しないでください!!!</note>
263 </li>
264
265 <li>chxjfilter-0.0.1.jarを生成します
266 <ol>
267 <li>build.propertiesを環境に合わせて編集します
268
269 <program title="build.propertiesの編集">
270 $ cd java
271 $ vi build.properties
272 </program>
273 </li>
274 <li>chxjfilter-0.0.1.jarを生成します
275
276 <program title="コンパイル">
277 $ ant dist
278 </program>
279 </li>
280 <li>生成されたchxjfilter-0.0.1.jarにクラスパスをとおします</li>
281 </ol>
282 </li>
283
284 <li>web.xmlの編集し、以下を追加します。
285
286 <program title="web.xml">
287 &lt;filter&gt;
288 &lt;filter-name&gt;chxjfilter&lt;/filter-name&gt;
289 &lt;filter-class&gt;com.qsdn.filter.CHXJFilter&lt;/filter-class&gt;
290 &lt;/filter&gt;
291 &lt;filter-mapping&gt;
292 &lt;filter-name&gt;chxjfilter&lt;/filter-name&gt;
293 &lt;url-pattern&gt;/*&lt;/url-pattern&gt;
294 &lt;/filter-mapping&gt;
295 </program>
296 </li>
297
298 <li>apache等の再起動</li>
299 </ol>
300 </subsection>
301
302
303
304 <subsection title="画像自動変換機能を使用する場合">
305 <ol>
306 <li>httpd.confに以下を追加します。
307 下記は、URIが/imgで始まる全ての画像に対して動作するようmod_chxjに指示しています。
308
309 <program title="httpd.conf">
310 &lt;Location /img&gt;
311 ChxjImageEngine On
312 ChxjImageCacheDir /tmp
313 ChxjImageCopyright "A.Konno"
314 &lt;/Location&gt;
315 </program>
316
317 上記の説明を以下に示します。
318
319 <ol>
320 <li>ChxjImageEngine<br />
321 mod_chxjの画像変換ハンドラを起動するよう指示しています。
322 DefaultはOff
323
324 <br />
325 <br />
326 </li>
327
328
329 <li>ChxjImageCacheDir<br />
330 mod_chxj画像変換ハンドラが使用する変換後の画像をおいておくディレクトリを指定します。
331 デフォルトは/tmp。
332
333 <program title="ChxjImageCacheDir">
334 ChxjImageCacheDir /tmp
335 </program>
336
337 mod_chxjに画像変換キャッシュとして/tmpを使用するよう指示します。
338 <br />
339 <br />
340 </li>
341
342
343 <li>ChxjImageCopyright<br />
344 mod_chxjの画像変換ハンドラに、転送禁止設定を行うよう指示します。
345 パラメータとして任意の文字列をとります。
346 ChxjImageCopyrightディレクティブで指定された文字列は、それぞれのイメージの
347 コメント部に埋め込まれます。
348
349 <program title="ChxjImageCopyright">
350 ChxjImageCopyright "A.Konno"
351 </program>
352
353 mod_chxjに転送禁止設定を行うよう指示しています。
354 変換後イメージのコメント部分には、キャリア毎に以下の文字列を埋め込みます。
355
356 <b>AU の場合</b>
357 <program title="AU">
358 kddi_copyright=on,A.Konno
359 </program>
360
361 <b>DoCoMoの場合</b>
362 <program title="DoCoMo">copy="NO",A.Konno</program>
363
364 <b>Vodafone</b>の場合は、レスポンスヘッダに
365
366 <program title="Vodafone/J-PHONE">
367 x-jphone-copyright:no-transfer
368 </program>
369
370 を埋め込みます。
371 <note>Vodafoneの場合は、リクエストURLの最後が.pnzか、.jpzで終わるようにダミーを付けなければなりません。</note>
372 </li>
373 </ol>
374 </li>
375 </ol>
376 </subsection>
377
378 <subsection title="文字コードを変換したい場合(EXPERIMENTAL)">
379 <ol>
380 <li>httpd.confに以下を追加します。
381 下記は、URIが/chxjで始まる全てのコンテンツに対して動作するようmod_chxjに指示しています。
382 サーバ側はEUC-JPであった場合の例です。mod_chxjによってSJISに変換するように指示しています。
383
384 <program title="httpd.conf">
385 ChxjConvRule "^/chxj.+$" "EngineOn" "EUC-JP"
386 </program>
387
388 上記の説明を以下に示します。
389
390 <ol>
391 <li>ChxjConvertRule<br />
392 サーバサイドの文字コードを指定します。ここに、EUC-JPと指定してあった場合は、
393 EUC-JPからCP932に変換後、クライアントに出力されます。
394 省略した場合はNONE
395 <ol>
396 <li>変換エンジン動作指示命令(下記のSetOutputFilter、SetInputFilterも必須です)<br />
397 ChxjConvertRule ==> ディレクティブ<br />
398 "^/chxj.+$" ==> Perl互換のURIパターン<br />
399 EngineOn ==> 変換エンジンを動作させる指示。動作させたく無い場合は"EngineOff"<br />
400 EUC-JP ==> サーバ側の文字コード。(NONEを指定した場合は文字コード変換しない)<br />
401 <br />
402 EUC-JPからCP932に文字コード変換します。(libiconvに依存します)<br/>
403 </li>
404 </ol>
405
406 <br />
407 <br />
408 </li>
409 </ol>
410 </li>
411 </ol>
412 </subsection>
413 <subsection title="ディレクティブ">
414 <ol>
415 <li>ChxjLoadDeviceData<br />
416 デバイス定義ファイルを指定します。
417 <program title="ex)">
418 ChxjLoadDeviceData /etc/apache2/device.xml
419 </program>
420 </li>
421 <li>ChxjLoadEmojiData<br />
422 絵文字変換定義ファイルを指定します。
423 <program title="ex)">
424 ChxjLoadEmojiData /etc/apache2/chxj/emoji.xml
425 </program>
426 </li>
427 <li>ChxjImageEngine<br />
428 画像変換エンジンを有効にします。
429 パラメータとしてOnとOffを指定できます。
430 DefaultはOffです。
431 <program title="ex)">
432 ChxjImageEngine On
433 </program>
434 </li>
435 <li>ChxjImageCacheDir<br />
436 イメージの一時ファイル保存場所を指定します。
437 <program title="ex)">
438 ChxjImageCacheDir /tmp
439 </program>
440 </li>
441 <li>ChxjImageCopyright<br />
442 イメージに著作権情報を付与します。
443 <program title="ex)">
444 ChxjImageCacheDir "chosakuken jyoho"
445 </program>
446 </li>
447 <li>ChxjConvertRule<br />
448 HTML変換エンジンの適用ルールを記述します。
449 本ディレクティブを使用し、変換エンジンのOn|Offを指定します。
450 DefaultはOFFです。
451 また、ルールは記述された順番に評価し、マッチするものがあれば、その時点で対象ルールを適用します。
452 パラメータは3つ必要です。下記にパラメータを記します。
453 <table title="パラメータ">
454 <tbody>
455 <tr>
456 <td>第1パラメータ</td><td>URIを評価するPerl互換の正規表現を指定します</td>
457 </tr>
458
459 <tr>
460 <td>第2パラメータ</td><td>HTML変換エンジンのOn|Offを指定します。Onの場合は"EngineOn"。Offの場合は"EngineOff"を指定します。"EngineOn|EngineOff"の他に"CookieOn|CookieOff"を指定することもできます。複数指定する場合は","で区切って指定します。</td>
461 </tr>
462 <tr>
463 <td>第3パラメータ</td><td>文字コードを指定します。ここで指定した文字コードから"CP932"に変換します。指定できる文字コードはiconv -lコマンドによって確認することができます。変換しなくて良い場合はNONEを指定してください。</td>
464 </tr>
465 <tr>
466 <td>第4パラメータ</td><td>省略した場合は、携帯ページからの変換を意味します。PC用ページからの変換を行う場合は"PC"を第四パラメータに指定します。</td>
467 </tr>
468 <tr>
469 <td>第5パラメータ</td><td>サーバサイドアプリケーションに渡すUser-Agentを指定します。
470 例えば、wordpress等のようにCHTMLを出力するアプリケーションがある場合は、"DoCoMo/1.0/N501i"等適当なUser-Agentを指定することによって、アプリケーションにCHTMLを出力するように指示することができます。
471 ここで指定したUser-AgentはHTML出力時には評価されません。</td>
472 </tr>
473 </tbody>
474 </table>
475 <program title="ex)">
476 ChxjConvertRule "^/chxj.+$/" EngineOn EUC-JP
477 </program>
478 </li>
479 </ol>
480 </subsection>
481 </section>
482 <section title="対応するCHTMLタグ">
483 変換可能なCHTMLタグは以下のとおりです。
484
485 <table title="対応タグ一覧">
486 <thead>
487 <tr>
488 <td>タグ</td>
489 <td>属性</td>
490 <td>CHTML</td>
491 <td>HDML</td>
492 <td>XHTML</td>
493 <td>JHTML</td>
494 <td>備考</td>
495 </tr>
496 </thead>
497 <tbody>
498 <tr>
499 <td>&lt;HTML&gt;</td>
500 <td align="center"> </td>
501 <td align="center"></td>
502 <td align="center"></td>
503 <td align="center"></td>
504 <td align="center"></td>
505 <td align="left">属性を指定した場合は無視します</td>
506 </tr>
507 <tr>
508 <td>&lt;META&gt;</td>
509 <td align="center">http-equiv</td>
510 <td align="center"></td>
511 <td align="center">×</td>
512 <td align="center"></td>
513 <td align="center"></td>
514 <td align="left">CHTML1.0、HDMLでは無視します</td>
515 </tr>
516 <tr>
517 <td> </td>
518 <td align="center">content</td>
519 <td align="center"></td>
520 <td align="center">×</td>
521 <td align="center"></td>
522 <td align="center"></td>
523 <td align="left">CHTML1.0、HDMLでは無視します</td>
524 </tr>
525 <tr>
526 <td>&lt;HEAD&gt;</td>
527 <td align="center"> </td>
528 <td align="center"></td>
529 <td align="center"></td>
530 <td align="center"></td>
531 <td align="center"></td>
532 <td align="left">属性を指定した場合は無視します</td>
533 </tr>
534 <tr>
535 <td>&lt;TITLE&gt;</td>
536 <td align="center"> </td>
537 <td align="center"></td>
538 <td align="center"></td>
539 <td align="center"></td>
540 <td align="center"></td>
541 <td align="left">属性を指定した場合は無視します</td>
542 </tr>
543 <tr>
544 <td>&lt;BASE&gt;</td>
545 <td align="center"> </td>
546 <td align="center"></td>
547 <td align="center">×</td>
548 <td align="center"></td>
549 <td align="center"></td>
550 <td align="left">HDMLでは無視します</td>
551 </tr>
552 <tr>
553 <td>&lt;BODY&gt;</td>
554 <td align="center">bgcolor</td>
555 <td align="center"></td>
556 <td align="center">×</td>
557 <td align="center"></td>
558 <td align="center"></td>
559 <td align="left">HDML、CHTML1.0、CHTML2.0では無視します</td>
560 </tr>
561 <tr>
562 <td> </td>
563 <td align="center">text</td>
564 <td align="center"></td>
565 <td align="center">×</td>
566 <td align="center"></td>
567 <td align="center"></td>
568 <td align="left">HDML、CHTML1.0、CHTML2.0では無視します</td>
569 </tr>
570 <tr>
571 <td> </td>
572 <td align="center">link</td>
573 <td align="center"></td>
574 <td align="center">×</td>
575 <td align="center"></td>
576 <td align="center"></td>
577 <td align="left">HDML、CHTML1.0、CHTML2.0では無視します</td>
578 </tr>
579 <tr>
580 <td>&lt;A&gt;</td>
581 <td align="center">href</td>
582 <td align="center"></td>
583 <td align="center"></td>
584 <td align="center"></td>
585 <td align="center"></td>
586 <td align="left"> </td>
587 </tr>
588 <tr>
589 <td> </td>
590 <td align="center">accesskey</td>
591 <td align="center"></td>
592 <td align="center"></td>
593 <td align="center"></td>
594 <td align="center"></td>
595 <td align="left"> </td>
596 </tr>
597 <tr>
598 <td>&lt;BR&gt;</td>
599 <td align="center"> </td>
600 <td align="center"></td>
601 <td align="center"></td>
602 <td align="center"></td>
603 <td align="center"></td>
604 <td align="left"> </td>
605 </tr>
606 <tr>
607 <td>&lt;FONT&gt;</td>
608 <td align="center">color</td>
609 <td align="center"></td>
610 <td align="center">×</td>
611 <td align="center"></td>
612 <td align="center"></td>
613 <td align="left">HDML,CHTML1.0では無視します</td>
614 </tr>
615 <tr>
616 <td>&lt;FORM&gt;</td>
617 <td align="center">action</td>
618 <td align="center"></td>
619 <td align="center"></td>
620 <td align="center"></td>
621 <td align="center"></td>
622 <td align="left"> </td>
623 </tr>
624 <tr>
625 <td> </td>
626 <td align="center">method</td>
627 <td align="center"></td>
628 <td align="center">×</td>
629 <td align="center"></td>
630 <td align="center"></td>
631 <td align="left">HDMLでは無視します</td>
632 </tr>
633 <tr>
634 <td>&lt;INPUT&gt;</td>
635 <td align="center">name</td>
636 <td align="center"></td>
637 <td align="center"></td>
638 <td align="center"></td>
639 <td align="center"></td>
640 <td align="left"> </td>
641 </tr>
642 <tr>
643 <td> </td>
644 <td align="center">type</td>
645 <td align="center"></td>
646 <td align="center"></td>
647 <td align="center"></td>
648 <td align="center"></td>
649 <td align="left">text,password,hidden,radio,checkbox,submitに対応</td>
650 </tr>
651 <tr>
652 <td> </td>
653 <td align="center">value</td>
654 <td align="center"></td>
655 <td align="center"></td>
656 <td align="center"></td>
657 <td align="center"></td>
658 <td align="left"></td>
659 </tr>
660 <tr>
661 <td> </td>
662 <td align="center">istyle</td>
663 <td align="center"></td>
664 <td align="center"></td>
665 <td align="center"></td>
666 <td align="center"></td>
667 <td align="left"> </td>
668 </tr>
669 <tr>
670 <td>&lt;SELECT&lt;</td>
671 <td align="center">name</td>
672 <td align="center"></td>
673 <td align="center"></td>
674 <td align="center"></td>
675 <td align="center"></td>
676 <td align="left"> </td>
677 </tr>
678 <tr>
679 <td> </td>
680 <td align="center">size</td>
681 <td align="center"></td>
682 <td align="center">×</td>
683 <td align="center"></td>
684 <td align="center"></td>
685 <td align="left">HDMLでは無視します</td>
686 </tr>
687 <tr>
688 <td>&lt;OPTION&gt;</td>
689 <td align="center">value</td>
690 <td align="center"></td>
691 <td align="center"></td>
692 <td align="center"></td>
693 <td align="center"></td>
694 <td align="left"><note>必ず閉じてください。そのうち対応します。</note></td>
695 </tr>
696 <tr>
697 <td> </td>
698 <td align="center">checked</td>
699 <td align="center"></td>
700 <td align="center"></td>
701 <td align="center"></td>
702 <td align="center"></td>
703 <td align="left"> </td>
704 </tr>
705 <tr>
706 <td>&lt;DIV&gt;</td>
707 <td align="center">align</td>
708 <td align="center"></td>
709 <td align="center"></td>
710 <td align="center"></td>
711 <td align="center"></td>
712 <td align="left"> </td>
713 </tr>
714 <tr>
715 <td>&lt;HR&gt;</td>
716 <td align="center"> </td>
717 <td align="center"></td>
718 <td align="center"></td>
719 <td align="center"></td>
720 <td align="center"></td>
721 <td align="left"> </td>
722 </tr>
723 <tr>
724 <td>&lt;CENTER&gt;</td>
725 <td align="center"> </td>
726 <td align="center"></td>
727 <td align="center"></td>
728 <td align="center"></td>
729 <td align="center"></td>
730 <td align="left"> </td>
731 </tr>
732 <tr>
733 <td>&lt;IMG&gt;</td>
734 <td align="center">src</td>
735 <td align="center"></td>
736 <td align="center"></td>
737 <td align="center"></td>
738 <td align="center"></td>
739 <td align="left"> </td>
740 </tr>
741 <tr>
742 <td>&lt;CHXJ:IF&gt;</td>
743 <td align="center">lang</td>
744 <td align="center"></td>
745 <td align="center"></td>
746 <td align="center"></td>
747 <td align="center"></td>
748 <td align="left">lang="chtml" lang="xhtml" lang="hdml" lang="jhtml"が指定できます</td>
749 </tr>
750 </tbody>
751
752 上記以外のタグは全て無視されます。
753
754 </table>
755
756 </section>
757 <section title="独自拡張タグ">
758 <ol>
759 <li>&lt;CHXJ:IF&gt;<br />
760
761 &lt;CHXJ:IF&gt;タグと&lt;/CHXJ:IF&gt;タグではさまれたタグやテキストは、
762 変換せずに<b>そのまま</b><note>変換しませんので注意が必要です</note>出力します。必須の属性としてlangがあります。lang属性を指定することによって、
763 例えば、<b>「HDML機の場合のみ出力させる」</b>といったことを可能にします。<br />
764 <br />
765 ex)
766 <program title="HTML文書中にHDML機の場合のみ有効にしたいタグ、または文書がある場合">
767 &lt;CHXJ:IF lang="HDML" &gt;
768 &lt;NODISPLAY&gt;
769 &lt;ACTION TYPE=ACCEPT TASK=GOSUB DEST='device:data/dnld?url=abc&amp;name=abc.jpg&amp;size=100&amp;disposition=devjaww&amp;title=test'&gt;
770 &lt;/NODISPLAY&gt;
771 &lt;/CHXJ:IF&gt;
772 </program><br />
773
774 ex)
775 <program title="i-Modeのみ出力したい文書がある場合">
776 &lt;CHXJ:IF lang="chtml" &gt;
777 シークレットコードがどーのこーの。
778 &lt;/CHXJ:IF&gt;
779 </program><br />
780
781 また、lang属性は、複数指定することも可能です。<br />
782
783 <program title="HDML機,J-PHONE機は以下を出力します">
784 &lt;CHXJ:IF lang="chtml" lang="jhtml"&gt;
785 あなたの携帯は、HDML機かJ-HTML機です。
786 &lt;/CHXJ:IF&gt;
787 </program><br />
788
789 </li>
790 </ol>
791 </section>
792
793
794
795 <section title="文字コード">
796 文字コードは、絵文字の入出力がある関係上、Shift_JISのみとしています。
797 </section>
798
799
800 <section title="絵文字について">
801 i-Mode用の絵文字を書いておけば、アクセスしたキャリアによって、mod_chxjが対応の絵文字に自動変換します。
802 ソースに2byteのバイナリコードを直接書いても、10進参照文字列<note>16進参照文字列には対応していません</note>&amp;#XXX;の形)で書いても、どちらでも変換対象になります。
803 10進参照文字列で書いた場合は、mod_chxjにより、自動で2バイトコードに変換します。
804 <subsection title="絵文字変換定義">
805 絵文字の変換に関する動作を変えたい場合(例えば「ハートがあったら、AUの場合はスペードに」とか、「変換定義がおかしい」といった場合)は、
806 emoji.xmlファイルを直接編集することによって定義を変更することが可能です。emoji.xmlはXMLファイルとなっていますので、vi等で簡単に定義を
807 変更することができます<note>厳密にはXMLになっていないので、日本語の記述はSJISでお願いします。</note>
808
809 <br />
810 以下に、emoji.xmlファイルの一部を記します。
811 <program title="emoji.xml">
812 &lt;?xml encoding="Shift_JIS" &gt;
813
814 &lt;emoji&gt;
815 &lt;set&gt;
816 &lt;no&gt;1&lt;/no&gt;
817 &lt;imode&gt;
818 &lt;hex1&gt;f8&lt;/hex1&gt;
819 &lt;hex2&gt;9f&lt;/hex2&gt;
820 &lt;string&gt;&amp;#63647;&lt;/string&gt;
821 &lt;description&gt;&lt;/description&gt;
822 &lt;/imode&gt;
823 &lt;ezweb&gt;
824 &lt;A&gt;44&lt;/A&gt;
825 &lt;B&gt;44&lt;/B&gt;
826 &lt;C&gt;44&lt;/C&gt;
827 &lt;D&gt;44&lt;/D&gt;
828 &lt;/ezweb&gt;
829 &lt;jphone&gt;
830 &lt;string&gt;$Gj&lt;/string&gt;
831 &lt;/jphone&gt;
832 &lt;/set&gt;
833 </program>
834
835 絵文字の定義は、&lt;emoji&gt;タグから&lt;/emoji&gt;タグまでの間にあります。その中の要素を説明します。
836 1つの絵文字につき、1つのセット(&lt;set&gt;タグから&lt;/set&gt;タグまで)とし、キャリア毎の絵文字を定義しています。
837
838 <ol>
839 <li>&lt;imode&gt;要素<br />
840 まず、元となるi-Mode用の絵文字は、&lt;imode&gt;タグにはさまれた間に定義されています。
841 &lt;imode&gt;要素は、2バイトコード要素(&lt;hex1&gt;&lt;hex2&gt;)と、
842 10進参照文字列要素(&lt;string&gt;)を保持していて、この2つの要素を変換元の値として使用します。
843 アクセスしてきた端末が、i-Mode機であった場合で、かつCHTML中に10進参照文字列が絵文字として書かれている場合には、
844 &lt;hex1&gt;&lt;hex2&gt;要素に定義されている値に置換します。
845 </li>
846 <br />
847 <br />
848 <li>&lt;ezweb&gt;要素<br />
849 アクセスしてきた端末が、AU機であった場合、&lt;ezweb&gt;要素に定義されている値に変換します。
850 &lt;ezweb&gt;要素は、&lt;A&gt;&lt;D&gt;要素を持っていて、それぞれAUの絵文字タイプA〜Dに対応していますので、
851 もし、Dタイプの絵文字端末であったなら、&lt;D&gt;要素に定義されている値に変換します。ここで定義されている値は、
852 HDML機の場合は、<b>&lt;IMG ICON="XX"&gt;</b>の"XX"の部分に当てはめられて、置換されます。
853 XHTML機の場合は、<b>&lt;IMG LOCALSRC="XX"&gt;</b>の"XX"の部分に当てはめられて、置換されます。
854 </li>
855 <br />
856 <br />
857 <li>&lt;jphone&gt;要素<br />
858 アクセスしてきた端末が、Vodafone/J-Phone端末であった場合、&lt;jphone&gt;要素に定義されている値に変換します。
859 &lt;jphone&gt;要素は、&lt;string&gt;要素を保持していて、ここで定義されている値を直接使用します。
860 </li>
861 </ol><br />
862 emoji.xmlに定義されていない絵文字で、変換したい絵文字がある場合には、このファイルに新たな定義を足せば、
863 変換するようになります。
864 </subsection>
865 </section>
866
867
868 <section title="デバイス定義 device_data.xml">
869 mod_chxjの動作を決定付ける重要な定義です。変換対象の端末は全て、device_data.xmlファイルに定義される必要があります。
870 定義されていない端末は、mod_chxjとしては、認識することができません。認識できない場合には、CHTMLをそのまま出力します。
871 </section>
872
873
874 <section title="イメージ画像変換機能">
875 mod_chxjには、JPEG、GIF、PNG、BMPファイルを置いておくだけで、デバイス定義に従って、それぞれのキャリア対応のフォーマットに変換する機能があります。
876 画像のサイズ(縦X横)も、端末の画面サイズに合わせて変換します。
877 画像のサイズ(バイト数)については、デバイス定義中のキャッシュサイズを見て、その値よりも小さくなるように<b>努力</b>しますが、元の画像が
878 大きすぎる場合や、複雑な画像の場合には、キャッシュサイズよりも小さくできずに表示できない場合があります。
879 <br />
880 それぞれのタグで指定する場合には、ファイル名の拡張子(.jpgや.gif等)をはずした形で指定します。<br />
881 本機能には3つのモードが存在します。そのモードを以下に記します。
882
883 <subsection title="サムネイルモード">
884 端末側画面サイズの約3分の1程度のサイズ(縦X横)に画像を縮小表示します。
885 <program title="サムネイルモード 使用例">
886 &lt;IMG SRC="/img/logo?Mode=Thumbnail"&gt;
887 </program>
888 </subsection>
889 <subsection title="壁紙モード">
890 端末側画面のサイズにマッチするサイズに拡大・縮小します。横長の画像の場合には、縦幅を合わせた後に左右をトリミングします。
891 <program title="壁紙モード 使用例">
892 &lt;IMG SRC="/img/logo?Mode=WP"&gt;
893 </program>
894 </subsection>
895 <subsection title="EzGetモード">
896 壁紙ダウンロードを行いたい場合に使用します。EzGETモードは、壁紙モードで出力される画像サイズと同一サイズの画像が使用されます。
897 <program title="EzGetモード 使用例">
898 &lt;A HREF="/img/logo?Mode=EzGet"&gt;
899 </program>
900 </subsection>
901 <subsection title="その他の機能">
902 モードの他に、画像サイズ(縦X横)を直接指定することも可能です。
903 <b>w</b>パラメータ、<b>h</b>パラメータを使用して指定します。
904 <ol>
905 <li>wパラメータ<br />
906 横幅を指定します。
907 </li>
908 <li>hパラメータ<br />
909 縦幅を指定します。
910 </li>
911 <program title="w/hパラメータ 使用例">
912 &lt;IMG SRC="/img/logo?w=100&amp;h=200"&gt;
913 </program>
914 <li>User-Agentパラメータ(uaパラメータ)<br />
915 User-Agentを指定します。指定した場合は、リクエストヘッダ中のUser-Agentを本パラメータの値で上書きします。
916 このパラメータに"IGN"を指定した場合は、User-Agentを無視します。Thumbnailモード、壁紙モードと併用時は、
917 640x480を元に画像サイズを算出します。
918 </li>
919 </ol>
920 </subsection>
921 上記全てのモード、パラメータはGETリクエストとしてのみ使用できます。
922 </section>
923
924 <section title="QRコード出力機能">
925 <subsection title="QRコード出力ハンドラの登録">
926 QRコード出力機能を使用するには、QRコードハンドラを登録します。
927 httpd.confに以下の記述を追加します。
928 <program title="httpd.conf">
929 AddHandler chxj-qrcode .qrc
930 </program>
931 なお、ハンドラを登録しないでも、出力フィルターを経由させることで、QRコードを出力させることも可能です。(※QRコードの動的出力を参照)
932 </subsection>
933 <subsection title="QRコードソースファイルの設置">
934 ハンドラを登録したら、その登録した拡張子を持つファイルを用意します。
935 <program title="例:a.qrc">
936 &lt;?xml version=1.0 ?&gt;
937
938 &lt;qrcode&gt;
939 &lt;version&gt;13&lt;/version&gt;
940 &lt;level&gt;H&lt;/level&gt;
941 &lt;mode&gt;8bit&lt;/mode&gt;
942 &lt;size&gt;1&lt;/size&gt;
943 &lt;data&gt;テストデータです&lt;/data&gt;
944 &lt;/qrcode&gt;
945 </program>
946 .qrcファイルは、qrcode要素、version要素、level要素、mode要素、size要素、data要素から成り立ちます。
947 <ol>
948 <li>versionタグ
949 versionタグは出力するQRコードの生成に利用するバージョンを指定します。
950 使用できるバージョンは、1〜40までの40種類です。
951 </li>
952 <li>levelタグ
953 levelタグは出力するQRコードの生成に利用する誤り検出レベルを指定します。
954  使用できるレベルは、L、Q、M、Hの4つです。
955 </li>
956 <li>modeタグ
957 modeタグは出力するQRコードの生成に利用するモードを指定します。
958 使用できるモードは、NUM(数字モード)ALPHA(英数字モード)8BIT(8ビットバイトモード)KANJI(漢字モード)です。
959 </li>
960 <li>sizeタグ
961 sizeタグは1モジュールを何ピクセルであらわすかを指定します。
962 0を指定した場合は、4を指定した場合と同じ動作をします。
963  使用できるサイズは、0〜20までです。
964 </li>
965 <li>dataタグ
966 dataタグは、QRコードに出力するデータを指定します。改行した場合は、改行文字もQRコード内に符号化されます。
967 </li>
968 </ol>
969 </subsection>
970 <subsection title="QRコードの動的出力機能">
971 プログラム等を使用し、動的にQRコードを出力したい場合は、上記の.qrcファイルの内容をそのままOutputFilterに通してあげればOKです。
972
973 <program title="phpでQRコードを動的に出力する例">
974 &lt;php
975 $version = $_POST["version"];
976 $level = $_POST["level"];
977 $mode = $_POST["mode"];
978 $size = $_POST["size"];
979 $data = $_POST["data"];
980
981 echo "&lt;qrcode&gt;\n";
982 echo "&lt;version&gt;".$version."&lt;/version&gt;\n";
983 echo "&lt;level&gt;".$level."&lt;/level&gt;\n";
984 echo "&lt;mode&gt;".$mode."&lt;/mode&gt;\n";
985 echo "&lt;size&gt;".$size."&lt;/size&gt;\n";
986 echo "&lt;data&gt;".$data."&lt;/data&gt;\n";
987 echo "&lt;/qrcode&gt;\n";
988 &gt;
989 </program>
990 そして、上記のコードを、OutputFilterを通るところに設置すれば完了です。
991 なお、OutputFilterを通る場合は、画像変換エンジンも動作してしまうため、使用するクライアントのUser-Agentを定義するか、もしくは、
992 ua=IGNを指定して、リクエストしなければなりません。(もちろん、画像変換エンジンをそのまま使用する場合は何もしないでいいです。)
993
994
995 </subsection>
996 </section>
997 <section title="Cookieシミュレート機能(EXPERIMENTAL)">
998 <subsection title="Cookieシミュレート機能(EXPERIMENTAL)">
999 Cookieを受け付けない(無視する)端末のためにCookieをシミュレートします。本機能を有効にするためにはChxjConvertRuleディレクティブを使用する必要があります。ChxjConvertRuleディレクティブの第2パラメータにCookieOnを指定します。
1000
1001 <program title="Cookieシミュレート機能を有効にする例">
1002 ChxjConvertRule "^/chxj.+$" "EngineOn,CookieOn" "NONE"
1003 </program>
1004 </subsection>
1005 </section>
1006 </body>
1007 </doc>

Back to OSDN">Back to OSDN
ViewVC Help
Powered by ViewVC 1.1.26