戻る 目次へ
§3.3.1.1 スタック一覧
戻る 目次へ

@pop命令で値をプッシュできるスタックを詳説する。

  1. lang - 使用言語
  2. charset - 使用文字セット
  3. docname - ドキュメント名
  4. head - <head>〜</head>間に挿入されるコード
  5. body-attributes - bodyタグの共通属性(群)
  6. body-header - 共通ヘッダ
  7. body-footer - 共通フッタ
  8. section-bar-color - セクションのタイトルの背景色
  9. section-mark - セクションのマーク
  10. number-separator - セクション番号のセパレータ
  11. anchor-* - アンカー
  12. text-section-disjoined - 別ファイルに記述された子セクションへの誘導文
  13. indexfile - インデックスページのファイル名
  14. text-index - インデックスページのサブタイトル
  15. indexfile-introduction - インデックスページの前書き
  16. text-relation - 関連セクションのリンク(群)への誘導文
  17. filename-* - ファイル名の命名規則
  18. include-* - @include命令用の緒設定
  19. tab-spaces - タブの取り扱い

戻る 目次へ
§3.3.1.1.1 lang - 使用言語
戻る 目次へ

@push lang "X" 
は、使用言語をXに設定する。 
デフォルトでは "ja"(日本語)である。 

戻る 目次へ
§3.3.1.1.2 charset - 使用文字セット
戻る 目次へ

@push charset "X" 
は、文字セットがXであることを伝える。 
ezhtが受け付ける文字セットは現在のところiso-8859-1,EUC-JP,Shift_JISの三種類である。 
なお、文字セット名の大文字小文字は区別しない。(Shift_JISでもshift_jisでもかまわない) 
 
UNIX系の環境のデフォルト設定はEUC-JPである。 
Windows環境のデフォルト設定はShift_JISである。 

戻る 目次へ
§3.3.1.1.3 docname - ドキュメント名
戻る 目次へ

@push docname "NAME" 
は、ドキュメント名をNAMEに設定する。 
ドキュメント名は、生成されるHTMLドキュメントのタイトルの一部に使われる。 
デフォルトは "" である。 

関連項目:

戻る 目次へ
§3.3.1.1.4 head - <head>〜</head>間に挿入されるコード
戻る 目次へ

@push head 
挿入されるコード 
@end 
 
は、<head>と</head>の間に挿入されるコードを指定する。 
デフォルトは "" である。 
タイトルと文字セットの記述は自動的に行われるため、これらの記述は不要である。 
 
例えば、全ファイル共通のスタイルシートを挿入したければ 
@push head 
<style type="text/css"> 
<!-- 
        B {color: red} 
--> 
</style> 
@end 
 
あるいは、 
 
@push head 
<link rel="StyleSheet" "styles.css"> 
@end 
 
などとすればよい。 
 

戻る 目次へ
§3.3.1.1.5 body-attributes - bodyタグの共通属性(群)
戻る 目次へ

@push body-attributes "ATTRS" 
 
は、生成される文書に共通するbodyタグの属性をATTRSに指定する。 
デフォルトは "" である。 
 
例えば、 
 
@push body-attributes (link="red" alink="blue" vlink="green") 
 
とすれば、生成される文書のbodyタグは 
<body link="red" alink="blue" vlink="green"> 
のようになる。 
 

戻る 目次へ
§3.3.1.1.6 body-header - 共通ヘッダ
戻る 目次へ

@push body-header 
共通ヘッダのコード 
@end 
は、生成される文書の<body>に続いて挿入される共通ヘッダを指定する。 
デフォルトは "" である。 

関連項目:

戻る 目次へ
§3.3.1.1.7 body-footer - 共通フッタ
戻る 目次へ

@push body-footer 
共通フッタのコード 
@end 
は、生成される文書の</body>の直前に挿入される共通フッタを指定する。 
デフォルトは "" である。 

関連項目:

戻る 目次へ
§3.3.1.1.8 section-bar-color - セクションのタイトルの背景色
戻る 目次へ

@push section-bar-color "COL" 
は、セクションのタイトルの背景色をCOLに指定する。 
デフォルトでは、"silver"である。 
ここで、COLORは#rrggbbのようなRGB形式の色コードか、あるいはgrayやblackといった色名のいずれかである。 
いずれにせよ、一般的なブラウザが認識できる形式であることが前提である。 

戻る 目次へ
§3.3.1.1.9 section-mark - セクションのマーク
戻る 目次へ

@push section-mark "MARK" 
は、セクションのマークをMARKに指定する。 
デフォルトは"#"である。 
 
本ドキュメントでは、 
@push section-mark "§" 
としてマークを"§"に変更してある。 
 

戻る 目次へ
§3.3.1.1.10 number-separator - セクション番号のセパレータ
戻る 目次へ

@push number-separator "SEP" 
は、セクション番号のセパレータをSEPに指定する。 
デフォルトは"."である。 
 

戻る 目次へ
§3.3.1.1.11 anchor-* - アンカー
戻る 目次へ

anchor-*スタックは、セクション間の移動やインデックスページへ戻るためのアンカーテキストあるいはアンカーイメージを指定する。

@push anchor-next "ANC" 
は、直後のセクションへのアンカーANCを設定する。 
デフォルトでは "Next&gt;"である。 
 
@push anchor-prev "ANC" 
は、直前のセクションへのアンカーANCを設定する。 
デフォルトでは "&lt;Prev"である。 
 
@push anchor-up "ANC" 
は、親セクション(親がいなければインデックスページ)へのアンカーANCを設定する。 
デフォルトでは "Up"である。 
 
@push anchor-back "ANC" 
は、直前のロケーションへのアンカーANCを設定する。 
デフォルトでは "Back"である。 
 
@push anchor-index "ANC" 
は、インデックスページへのアンカーANCを設定する。 
デフォルトでは "Index"である。 
 
参考: 
本ドキュメントでは、以下のようにアンカーを設定している。 
@push anchor-next "▼" 
@push anchor-prev "▲" 
@push anchor-up   "△" 
@push anchor-index "目次へ" 

戻る 目次へ
§3.3.1.1.12 text-section-disjoined - 別ファイルに記述された子セクションへの誘導文
戻る 目次へ

@push text-section-disjoined "TEXT" 
は、当該セクションの子セクションが別ページ(別ファイル)に格納され当該セクションと同一ページにはその子セクションのリンクのみが記載される場合に、そのリンクの左側に置かれる誘導文を指定する。 
デフォルトでは"See --&gt;"である。 
 
本ドキュメントでは、 
@push text-section-disjoined "本セクションは別ページに記述されています:" 
としている。 
 
関連項目:

戻る 目次へ
§3.3.1.1.13 indexfile - インデックスページのファイル名
戻る 目次へ

@push indexfile "FNAME" 
は、生成されるインデックスページ(つまりezhtの生成するドキュメント群の最上位となるページ)のファイル名をFNAMEに設定する。 
デフォルトは "index.html" である。 

関連項目:

戻る 目次へ
§3.3.1.1.14 text-index - インデックスページのサブタイトル
戻る 目次へ

@push text-index "TEXT" 
は、インデックスページのサブタイトルをTEXTに設定する。 
デフォルトは "Index" である。 
 
ここで、インデックスページのタイトルは、 
"ドキュメント名 - サブタイトル" 
と定められる。 
 
関連項目:
関連項目:

戻る 目次へ
§3.3.1.1.15 indexfile-introduction - インデックスページの前書き
戻る 目次へ

@push indexfile-introduction 
コード 
@end 
 
は、インデックスページに挿入される前書きを指定する。 
デフォルトは "" である。 
 
例: 
@push indexfile-introduction 
<center> 
本ドキュメントは○○について書かれています。 
</center> 
@end 
 

関連項目:

戻る 目次へ
§3.3.1.1.16 text-relation - 関連セクションのリンク(群)への誘導文
戻る 目次へ

@push text-relation "TEXT" 
は、@relate命令によって生成される関連セクションへのリンク(群)への誘導文を指定する。 
デフォルトでは、"<strong>See also:</strong>"である。 
 
本ドキュメントでは、 
@push text-relation "関連項目:" 
としてある。 
 
実例でいえば、こういう(↓)ことである。 

関連項目:

戻る 目次へ
§3.3.1.1.17 filename-* - ファイル名の命名規則
戻る 目次へ

filename-*スタックは、セクション毎に生成されるファイルの命名規則を規定する。

@push filename-prefix "PREFIX" 
は、ファイル名の先頭をPREFIXに設定する。 
デフォルトは "doc" である。 

@push filename-suffix "SUFFIX" 
は、ファイル名の末尾・拡張子をSUFFIXに設定する。 
デフォルトは ".html" であるが、これ以外の選択肢としてはおそらく".htm"くらいだろう。 
通常変更する必要はないと思われる。 
 

@push filename-rule "RULE" 
は、命名ルールをRULEに設定する。 
現在、3種類のルールのみを設定できる(下表参照) 

ルール意味
lineソースファイル上で当該セクションの始まった行番号をファイル名とする
そのセクションがソースのどの位置から始まるのかがわかる
sectionセクション番号をファイル名とする。
例えば1.2.3というセクションなら1-2-3がファイル名となる
serial1から始まる5桁の通し番号をファイル名とする

デフォルトでは "section" である。

例: 
@push filename-rule   serial 
@push filename-prefix help 
@push filename-suffix .htm 
 
とすると、生成されるファイルは 
 
help00001.htm 
help00002.htm 
help00003.htm 
... 
 
となる。 

戻る 目次へ
§3.3.1.1.18 include-* - @include命令用の緒設定
戻る 目次へ

@push include-header "HEAD"

は、@include命令および@files命令によりファイルの内容が挿入される直前に置かれるヘッダをHEADに設定する。
たとえば、@push include-header "<p>" などとする。

@push include-footer "FOOT"

は、@include命令および@files命令によりファイルの内容が挿入された直後に置かれるフッタをFOOTに設定する。
たとえば、上記のヘッダであれば、必然的に@push include-footer "</p>" となるだろう。

@push include-filter "CMD"

は、@include命令および@files命令によりファイルの内容がインクルードされる際、ファイルを直接読むのではなくフィルタプログラムを間にはさみたい場合に、それを実現するシェルコマンドをCMDに指定する。
ezhtはそのシェルコマンドからの標準出力を、あたかも指定されたファイルを直接読み込んでいるかのように扱う

たとえば、バイナリファイルの先頭部分のダンプ表示を取り込みたい場合、UNIX系であればhexdumpとheadとをパイプで繋いで
@push include-filter (hexdump %file% | head)
などとすればよい。ここで、シンボル %file% はezhtによりインクルードファイル名に自動的に置換されるもので、必ず記述されなければならない。

関連項目:

戻る 目次へ
§3.3.1.1.19 tab-spaces - タブの取り扱い
戻る 目次へ

@push tab-spaces N

は、@include命令または@files命令によって、プレーンテキスト(もしくは番号付きテキスト)としてファイルが取込まれる際に、タブコードがN個のスペース(&nbsp;)に変換されることを約束する。
デフォルトでは 8 である。

関連項目:




Copyright 2004 Tradcrafts. ALL RIGHTS RESERVED.