Akitoshi Manabe
akito****@gmail*****
2007年 7月 17日 (火) 08:20:43 JST
A_M です > FSWikiのドキュメントWikiに上記の内容の移植を試みています。 > http://fswiki.poi.jp/wiki.cgi/docs?page=%A5%C6%A5%F3%A5%D7%A5%EC%A1%BC%A5%C8 こうしたページの存在も大切ですね。 リファレンスとして機能するドキュメントは、 「どのようなユーザに伝えるか?」で、細かな表現も変わると思います。 対象者を明確にし、「FSWikiのテンプレートはこのように編集するだけですよ」 というテーマで編集するが良いかもしれませんね。 「HTML+CSSは分かる。けれどもPerlは分からないが、設置くらいはできる。」といった人が 対象者になりそうでしょうか。 同ページ内で表現上、「ん?」と感じた事が3点あります。 反面、「FSWikiテンプレートタグ」という表現は、分かり易くてよいなぁと思いました。 造語ではなく、オフィシャルな言葉にしちゃいたいくらいですね。 上記ページを直接編集しても良いのですが、 リファレンスには、編集意図を書き込む必要はないのでMLで意見を投稿いたします。 「ん?」と感じた点について 1.「CSSのタグ(ただしスタイルシートは別)」といった表現について 「テンプレート内のDIV要素のことを差しているのかな?」とは思うのですが、 HTMLの全要素でスタイル指定できると理解する人(HTML+CSSでデザインする人)には、 受け入れ難い表現かもしれません。 もし、DIV要素のことを指しているのであれば、 「汎用DIV要素(CSSでデザインし易くする目的)」と明記したほうがよいと思います。 HTML+CSSでデザインする人には、DIV要素を極力排除してデザインしようとする人も多く、 動的システムでは「DIVを用いたHTML+CSSを書かなければ…」と諦めもつきます。 2.「HTML::Templateタグ書式」と表現される内容について、 pod(邦訳) では「マークアップ言語の要素形式」として例示されていますが、 モジュール自体は「HTML言語のコメント形式」にも対応していますから、 「FSWikiでは書式がHTMLのコメント形式で統一されています」の方が良いかもしれません。 統一される理由は、単に見易さだと思います。 マークアップ言語の要素形式(混在するHTMLと見分けが困難) <TMPL_VAR NAME="PARAM"> ※尚、FSWikiも HTML::Template 依存要素ではこの表記ができる。 HTML言語のコメント形式(HTMLを書く人には見分け易い) <!--TMPL_VAR NAME="PARAM"--> 3.「FSWIKI_INCLUDE はTMPL_INCLUDEの拡張タグ」という表現 FSWIKI_INCLUDE はテンプレートエンジンに無い要素としての独自の拡張です。 用途は、「常時表示するページをテンプレートに書くため」だと思います。 (テンプレートで特別ページを指定できる) 「TMPL_INCLUDE は機能としてどうなったのか?」といった疑問も感じ、 テンプレートを次のようなファイル構成にして、試してみました。 FSWiki +- /tmpl +- /example +- example.tmpl +- include.tmpl 結果、ファイル取り込み機能はそのまま利用できました。 example.tmpl 内で <TMPL_INCLUDE NAME="include.tmpl"> と記しておくと、 include.tmpl内に記述したHTMLが表示されます。 Wikiページに関するテンプレートの特徴として、次のようになっています。 メインページは <!--TMPL_VAR NAME="CONTENT"--> で置き換えられる。 常時表示ページは <!--FSWIKI_INCLUDE PAGE="(WikiPageName)"--> で置き換えられる。 「FSWikiテンプレートタグ」をまとめると、次のような区分ができると思います。 FSWikiテンプレートタグ … HTML::Template タグ + FSWiki 独自タグ | +- HTML::Template タグ … TMPL_(*) 要素 / NAME属性が必須 | 書式 <!--TMPL_(command) NAME="(PARAM)"--> | (HTML::Template 依存) | +- FSWiki 独自タグ … FSWIKI_INCKUDE 要素 / PAGE属性が必須 (コアの正規表現 依存) 書式 <!--FSWIKI_INCLUDE PAGE="(WikiPageName)"--> 常時表示ページを取り込む為の独自拡張 Wikiページ存在状況で切り分けるため、 HTML::Template の専用パラメータがある 切り分けの為の専用パラメータ … EXIST_PAGE_(WikiPage) TMPL_IF , TMPL_ELSE, TMPL_UNLESS の記述で活用 以上が、こんな感じだと伝わり易いのかな(?)と感じる内容です。 いかがでしょうか?