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

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