ユーザーズマニュアル・応用編
用途別目次: ユーザーズマニュアル 項目別目次: 利用手順
(初期登録日目次: 2001/12/21 更新日: 2002/03/18)
/************************************************/
/* PopCornマニュアル（応用編） Ver.2001.1221
/*
/* 2001/12/21
/* PopCornワーキンググループ
/*
/************************************************/
目次
（注意：本マニュアルは未だ作りかけです）
．トップページを編集するときの注意点
．素材プレーンテキストファイル、素材HTMLファイルの取込
．多言語対応機能
．テーブルデータの取込と整形
．画面デザインの変更
．動画、音声、その他各種の素材ファイルの扱い方
．クリップのフォルダ指定
．マスタクリップ
▼ トップページを編集するときの注意点
PopCornでページ生成を行なうと、トップページ（index.html）も生成されますが、このトップページは必要最低限の機能をもっただけの、非常にシンプルなページです。おそらく、このトップページのままでネット上に公開しようと思う人は少ないと思われます。
このシンプルなトップページを、各自が市販のホームページ作成ソフトなどで編集して、もっと見栄えの良いページに変えることができます。
ａ）トップページ系のアルゴリズム
PopCornは、トップページに関しては次のような手順の動作をします。
・ index.htmlが既に存在するかどうかをチェックします。
・もし存在しない場合には…
− 新しくindex.htmlを作成します
・もし存在する場合には…
− index.htmlを読み込みます。
−下記のような特定のタグが存在するかどうかを探します。（タグはいずれも行頭になります）
<!--date=cat--> 最終更新日
<!--numbers=cat--> 全トピック件数
<!--new--> New!トピック件数
<!--cat--> 分類の個別インデクスへのリンクリスト（またはセレクトフォーム）
<!--rgn--> 地域の個別インデクスへのリンクリスト（またはセレクトフォーム）
<!--date--> 撮影日の個別インデクスへのリンクリスト（またはセレクトフォーム）
<!--update--> 登録日の個別インデクスへのリンクリスト（またはセレクトフォーム）
|
−これらのタグがあった場合には、それぞれ該当する情報に書き換えます
−書き換え後のデータを、新しいindex.htmlとして出力します。
ｂ）index.html手作業編集のコツと注意点
手作業でindex.htmlを編集する場合に、最も注意すべきことは「上記の各タグで始まる行を決していじらない」ことです。
しかし、言うのは簡単ですが、実際には意外に難しい面があります。HTMLを手書きする人にとっては、ついうっかりいじってしまいそうになりますし、ホームページ製作ソフトの類を使う場合には、そのソフトが勝手にこの行を改変してしまうかも知れません。
今のところは、このあたりのコツは、各自が色々と試行錯誤して身につけるしかないかも知れません。
▼ 素材プレーンテキストファイル、素材HTMLファイルの取込
DBソースファイルやクリップファイル中でファイル名を指定することによって、画像と同様にプレーンテキストやHTMLファイルも、ページ中に取り込むことができます。
取込元になるプレーンテキストファイルやHTMLファイル（素材テキスト）本体は、それぞれtxtフォルダやhtmlフォルダに配置して下さい。
ａ）DBソース中での指定方法
ＤＢソース中でファイルを指定する方法は、画像ファイルの場合とよく似ていますが、現バージョンでは日付や題名の指定機能はありません。ファイル名がhogehoge.txtまたはhogehoge.htmlの場合は、指定方法は次のようになります。
#プレーンテキストの取込
hogehoge.txt
|
プレーンテキストの場合、各行の末尾に自動的にBRタグが付加された形で、ページ中に取り込まれます。従って、わざわざ素材テキストファイル側で行末にBRタグをつける必要はありません。
HTMLの場合、BODY部だけが抜き取られ、特に加工されることなく取り込まれます。従って、HEAD部に記述されたJavaScriptは取り込まれませんが、BODY部に書いてあれば取り込まれます。
ｂ）素材テキストの部分的取込
ある素材テキストファイルの中から、一部分だけを指定してページ中に取り込みたいという場合があります。このような場合、次のような指定方法をとることができます。
（注意：現バージョンではHTMLの場合のみ有効です。プレーンテキストについては未対応です）
このように指定すると、hogehoge.htmlの中から、「chapter1というラベル名のa nameタグと、その次の任意のa nameタグで挟まれた範囲」だけが、ページ中に取り込まれます。例示すると次のようになります。
＜a name="chapter1"＞
（この行から取込開始）
・・・
・・・
（この行まで取込）
＜a name="（任意の名前）"＞
|
ｃ）取り込んだテキストの装飾（仕様のみ記します。まだ実装はしていません）
テキストファイル名を指定するときに、名前の次にタブコードで区切って
hogehoge.txt[TAB]<textconfig>
|
と記述すると、この取り込んだテキストデータが、で指定した書式設定に整形されます。
書式設定は、拡張子confのファイルで定義することができます。この定義ファイル自体はconfフォルダに配置します。
定義ファイルの仕様や記述方法についてはここでは触れませんが、背景色付きblockquote（tablequote指定と同等の書式）や、自動箇条書き化加工、あるいは別ウィンドウを開いての出力といったことまで、この定義ファイルでの記述の工夫で可能になる予定です。
▼ 多言語対応機能
ページ生成スクリプトの中で、多言語化G変数「$GLANGUAGE」を設定することによって、生成されるページ中の各種表記を日本語以外の各種言語に変更することができます。例えば
と指定すると、英語版のページが出力されます。
この場合、単に$GLANGUAGE変数を指定するだけではなく、このパラメータと同じ名前の「言語設定ファイル」を、masterフォルダの中に配置する必要があります。（英語の言語設定ファイルは english.dat）
なお、$GLANGUAGE変数が指定されていない場合や、指定が間違っている場合には、デフォルトの日本語でページ生成が行われます。この場合は言語設定ファイルは使われません。
言語設定ファイルは http://www.mmdb.net/popcorn/kit/ にて公開されています。使うものをダウンロードして、masterフォルダに入れておいて下さい。公開初期段階では以下の種類の言語設定ファイルがあります。
japanese.dat 日本語（参考用。デフォルトの日本語版生成の時には言語設定ファイルは不要です）
english.dat 英語
esperanto.dat エスペラント語
j-kana.dat 日本語仮名書き
なお、日本語以外の言語でのサイトをきちんと作る場合には、$GLANGUAGE指定と言語設定ファイルだけでは不十分ですのでご注意下さい。この他に、script.pl中の$GINDEX_DATA変数の定義や、サイト名なども書き換えてください。つまり、
$GINDEX_DATA {"cat"} = "cat\t分類目次\t分類\tpage\tpage2"; ←分類インデクスの定義
$GINDEX_DATA {"region"} = "rgn\t地域目次\t地域\tpager\tpager2"; ←地域インデクスの定義
$GINDEX_DATA {"date"} = "date\t撮影日目次\t撮影日\tpaged\tpaged2"; ←撮影日インデクスの定義
$GINDEX_DATA {"update"} = "update\t登録日目次\t登録日\tpageu\tpageu2"; ←登録日インデクスの定義
|
ここに記されている「分類目次」「地域目次」などの記述も、該当の言語に訳しておいて下さい。
※ もちろん、肝心のページの中身自体も、該当の言語で記述する必要があります。PopCornには自動翻訳機能などはありません。:-)
▼ 画面デザインの変更
PopCornには各種の設定項目（G変数）があり、これをうまく調整すれば画面デザインを色々と変更することができます。以下に、いくつかの例を挙げて説明します
ａ） 各ページへの背景画像の貼り方
通常、HTMLページに背景画像を設定する場合は、bodyタグの中にbackgroundオプションを記述して壁紙画像を指定します。
<body background="backimage.gif">
|
PopCornの場合は、bodyタグのオプション記述を定義するために$GBODYというG変数が用意されています。例えば
$GBODY = "background=\"../gif/backimage.gif\"";
|
と記述すると（ダブルクォートを書くときには￥マークでエスケープする）、自動生成されるすべてのHTMLのbodyタグが、
<body background="../gif/backimage.gif">
|
になります。
ここで重要なのは、画像ファイルの相対パス指定の方法です。
PopCornで生成されるページは、種類別に違う様々なフォルダ（cat,rgn,date,update,page...）内に格納されますが、各HTMLファイルに共通して言えることは「PopCornサイトのルートフォルダの一段下に格納されている」ということです（トップページを除く）。すなわち、どのフォルダにあるHTMLファイルであっても、相対パス指定で../gif/backimage.gifと記述してあれば、必ずgifフォルダ直下に格納されたbackimage.gifを参照することになる…というわけです。
ｂ） 「New!」マーク関連
インデクスページなどでは、新しいトピックが登録されたことを示す「New!」マークが随所で使われています。
デフォルトでは単に「New!」と書かれているだけですが、これを変更するＧ変数もあります。
$GTAG_NEW = " <img src=\"../gif/new.gif\" align=\"bottom\">";
|
と書けば、「New!」マークとして画像 gif/new.gif が使用されます。
なお、「New!」マークの対象となるトピックは、デフォルトでは………と設定されていますが、この期間を変更することも可能です。例えば、次のようにＧ変数を定義すれば、「New!」を出す期間を３日間に短縮することができます。
ｃ）画面の配色など
画面各部の色指定を指定するＧ変数も各種あります。詳しくはリファレンスマニュアルを調べて、いろいろと工夫をしてみて下さい。
（あまりやりすぎると、ついつい毒々しい色使いになってしまう場合がありますので、ご注意下さい。:-) ）
▼ 動画、音声、その他各種の素材ファイルの扱い方
ａ） MIMEフォルダ
既に解説した通り、PopCornの素材ファイル（画像・音声・動画など）の格納場所に関しては、「PopCornルートフォルダ直下に設けられたMIME名（多くの場合、拡張子の名前）と同名のフォルダに格納される」というのが大原則です。
このようなフォルダのことを「MIMEフォルダ」と呼びます。
MP3ファイルを置きたければ「mp3」フォルダ、PDFファイルを置きたければ「pdf」フォルダ…というわけです。
その上で、DBソース上では、そのファイルを扱いたいトピック記述の所に、
という具合に記述すればよいわけです。
ｂ） PopCornがサポートするMIMEタイプ
その素材ファイルが文書ファイルであるか、静止画であるか、それとも音声であるかによって、トピックページ中でファイルをどう表現すればよいかは変わってきます。
・文書ファイル（対応MIMEタイプ：txt, html）
既に２章で解説したように、これらの文書ファイルの内容は、テキストとして抽出、HTML形式に整形されて、トピックページの中に直接挿入されます。
・静止画像ファイル（対応MIMEタイプ：jpg,gif,png）
これらの画像ファイルは、そのままトピックページの中に張り込まれます。さらに、画像説明や日付も下に添えられます。
DBソースの記述形式は
画像ファイル名[TAB]日付(YYYY/MM/DD)[TAB]画像説明
|
・PopCorn独自MIMEタイプ（clip, table）
PopCornの機能であるクリップやテーブル定義も、定義ファイルを拡張子と同じ名前のフォルダに格納して管理するという意味では、一種のMIMEタイプと見なされます。
ｃ）未サポートのMIMEタイプのファイル
MIMEタイプが未サポートの場合、トピック中には、そのファイルへの直接リンク（a hrefタグによる参照）が設置されます。
ｄ）未サポートのMIMEタイプを新たにサポートするには
どうしても、自分の望みのMIMEタイプをPopCornでサポートできるようにしたい場合は、ご自分でPopCornのソースコードを改造して対処するしかありません。
PopCornのソースコードはPerlスクリプトですので、Perlの知識や経験のある方は挑戦してみてはいかがでしょうか？
なお、プラグインの併用によってサポート種類を増やすというアーキテクチャには、現在のところなっていません。これは今後の課題になるかもしれません。
|