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

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