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

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