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

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