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.25.2.2 - (show annotations) (download)
Tue Feb 5 11:38:08 2008 UTC (16 years, 2 months ago) by konn
Branch: RELEASE_0_8_0
CVS Tags: RELEASE_0_8_6, RELEASE_0_8_5
Changes since 1.25.2.1: +28 -5 lines
  * Fixed Bug that deb package doesn't correspond to Apache2.2.
  * Added features:
    ``ChxjImageCacheLimit'' directive.
  * Added Document:
    ``ChxjImageCacheLimit'' directive.

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

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