OLBCK(付録)

オプション一覧

　g_body、g_cntsが受け付けるオプションをまとめておきます。アルファベット順ではなく、分類して並べてあります。g_body、g_cntsの欄は、◎ならカテゴリ付きでサポート、○ならカテゴリなしでサポート、×ならサポートせずを意味します。

オプション名	g_body	g_cnts	機能	デフォルト
出力ファイル制御
type	○	○	0ならインデックスファイルの参照番号フィールドの指定に従って出力ファイルを作成する 1なら入力ファイル1つにつき1個の出力ファイルを作成する 2ならすべての入力ファイルから1個の出力ファイルを作成する	0
出力ファイル名
body	○	○	typeオプションが2のときの本文ファイル名	body.html
contents	○	○	目次ファイル名。g_bodyでは、ファイル名の後ろに#nameを追加でき、ヘッダ、フッタ、中仕切りファイルの$contents（及びlnktype_が1のときの先頭ページ、ページ冒頭の$prev_、末尾ページ、ページ末尾の$next_*）の内容として展開される。g_cntsでは、#以下が取り除かれる。そして、目次ファイルはg_cntsの出力ファイルである	index.html
ext	○	○	typeオプションが2以外のときの本文ファイルの拡張子	html
suffix	○	○	typeオプションが2以外のときに本文ファイル名の末尾（拡張子の.の手前）に追加されるサフィックス	(空文字列)
インデックスファイル
index	○	○	インデックスファイル名	index.dat
補助入力ファイル
head	◎*	○	ヘッダファイル（ソーステキスト、または目次リストの前に挿入されるファイル）名。g_cntsでは、$all_、$prev_、$next_*、$contentsが含まれている行は読み飛ばされる	head.dat
foot	◎*	○	フッタファイル（ソーステキスト、または目次リストの後ろに挿入されるファイル）名。g_cntsでは、$all_、$prev_、$next_*、$contentsが含まれている行は読み飛ばされる	foot.dat
middle	◎	×	中仕切りファイル（ソーステキスト同士の間に挿入されるファイル）名。空文字列なら何も挿入しない	(空文字列)
midtype	◎*	×	middleが指定されていないときは無意味。 0なら1個目のソーステキストファイルの前に中仕切りファイルを挿入しない。 1なら1個目のソーステキストファイルの前に中仕切りファイルを挿入する	1
sup_hf	○	○	0ならヘッダ、フッタを出力する。 1ならヘッダ、フッタを出力しない	0
base	×	○	ベースファイル（インデックスの地の文のファイル）名。空文字列ならデフォルトのタイトルが使われる	(空文字列)
リンク表示制御
sep_all_o	○	×	$all_oから展開される各リンクの間に挿入される文字列	(空文字列)
sep_all_i	○	×	$all_iから展開される各リンクの間に挿入される文字列	(空文字列)
lnktype_o	○	×	先頭ページの$prev_o、末尾ページの$next_oの展開方法を指定する。 1なら先頭ページの前ページ、末尾ページの次ページは目次ページになる。$prevf_o、$nextf_oはcontentsの内容、$prev_o、$next_oはcntstrの内容になる 2なら先頭ページの前ページは末尾ページ、末尾ページの次ページは先頭ページになる 3なら$prev_o、$next_oはnoneオプションの内容になる。$prevf_o、$next_oとそれらを囲む<A>タグは削除される。 4なら、$prev_o、$next_oを囲む<Aから/A>までが削除される。	1
lnktype_i	○	×	ページ冒頭の$prev_i、ページ末尾の$next_iの展開方法を指定する。 1ならページ冒頭の前、ページ末尾の次は目次ページになる。$prevf_i、$nextf_iはcontentsの内容、$prev_i、$next_iはcnttitの内容になる 2ならページ冒頭の前はページ末尾、ページの次はページ冒頭になる 3なら$prev_i、$next_iはnoneオプションの内容になる。$prevf_i、$next_iとそれらを囲む<A>タグは削除される。 4なら、$prev_i、$next_iを囲む<Aから/A>までが削除される。	4
cntstr	○	○	ヘッダ、フッタ、中仕切りファイルの$contentsマクロの値として展開される文字列。g_cntsでは、cnttit、ecnttitのデフォルトとして使われる。	Contents
none	○	×	lnktype_o、lnktype_iオプションとして3を指定したときに先頭の$prev_o、$prev_i、末尾の$next_o、$next_iとして展開される文字列	none
改行タグの制御、特殊文字の処理
sup_br	○	○	0なら、<DT>、<DD>、<HR>、<LI>、</?P>、</?CENTER>、</?OL>、</?UL>、</?DL>。</?Hn>、<BR>、</?TABLE>、</?TR>、</?TH>、</?TD*>、</?DIR>、</?MENU>が含まれている行、<PRE>から</PRE>までの行を除く各行の末尾に<BR>タグを付加する。 1なら、<BR>タグの自動付加を一切行わない。	0
notag	○	×	1なら、&を&、<を<、>を>、"を"に変換する 0なら、上記変換を行わない	1
タイトルバーテキスト
etitle	○	×	typeオプションが2のとき、本体ファイルに挿入されるヘッダ、フッタ、中仕切りファイルの$etitマクロの値として展開される。ちなみに、typeオプションが2でないときの$etitは、インデックスファイルの出力ファイル提供行の第3フィールドの内容になる	Body Text
ecntstr	×	○	目次ファイルに挿入されるヘッダ、フッタファイルの$etitマクロの値として展開される。etitleの目次ファイル版	cntstrの内容
egtitle	○	○	ヘッダ、フッタ、中仕切りファイルの$egtitマクロの値として展開される。オンラインブック全体の総タイトルという意味合いでtitleとeの間にg（general、global）をはさんである。	(空文字列)
issue	○	○	ヘッダ、フッタ、中仕切りファイルの$issueマクロの値として展開される。雑誌の号数などに使うことを意図している。	(空文字列)
インデックスファイル操作
ignore	◎	◎	1ならインデックスファイルを無視する 0ならインデックスファイルを処理する通常はカテゴリを使って指定されたカテゴリのエントリを無視するために使う	0
intact	×	◎	1ならインデックスファイル第1フィールドに手を付けない 0ならインデックスファイル第1フィールドの拡張子をextオプションの内容で置き換える（拡張子のないファイルの場合には、拡張子を付加する）通常は、html以外のファイルへのリンクをリストに挿入したいときに使う。それらのファイルに対してカテゴリを指定し、そのカテゴリの入力ファイルから生成されるリンクの拡張子がhtmlになってしまわないようにするわけである	0
ブラウザのフレーム機能支援
target	○	○	g_cntsでは、本文ファイルに対するリンクタグ（<A HREF=...>）にtarget="..."という部分を挿入し、“...”の部分の内容を提供する。フレーム機能を使うページ以外では指定しない方がよい g_bodyでは、targetが空文字列なら、ソーステキストファイル内のリンクタグからtarget="..."の部分を取り除く。もちろん、ソーステキストファイルを書き換えるのではなく、出力される本文ファイルにtarget="..."が埋め込まれないようにするのである	(空文字列)
タイトル行の装飾、タイトル文字列
sur_tit	◎	○	タイトル行（ソーステキストの先頭から最初の空行まで）を囲むHTMLタグ。たとえば<H4>を指定すれば、タイトル行の前後に<H4>と</H4>を挿入する。g_cntsのsur_c_titのデフォルトも提供する	(空文字列)
end_tit	◎	○	タイトル行（ソーステキストの先頭から最初の空行まで）の末尾に挿入されるHTMLタグ。たとえば<HR>を指定すれば、タイトル行の後ろに横線が入る。g_cntsのend_c_titのデフォルトも提供する	(空文字列)
sur_c_tit	×	○	baseオプションが空文字列のときの目次ファイルのタイトル行を囲むHTMLタグ。たとえば<H4>を指定すれば、タイトル行の前後に<H4>と</H4>を挿入する	sur_titの内容
end_c_tit	×	○	baseオプションが空文字列のときの目次ファイルのタイトル行の末尾に挿入されるHTMLタグ。たとえば<HR>を指定すれば、タイトル行の後ろに横線が入る	end_titの内容
cnttit	×	○	baseオプションが空文字列のときの目次ファイルのタイトル文字列	cntstrの内容
本文の装飾
sur_bdy	◎	○	本文全体を囲むHTMLタグ。たとえば<FONT SIZE="4">を指定すれば、本文の前後に<FONT SIZE="4"H4>と</FONT>を挿入する。g_cntsのsur_c_bdyのデフォルトも提供する	(空文字列)
sur_c_bdy	×	○	目次ファイルのリスト部全体を囲むHTMLタグ。たとえば<FONT SIZE="4">を指定すれば、リスト部の前後に<FONT SIZE="4"H4>と</FONT>を挿入する	sur_bdyの内容
著者名の表示制御、装飾
ath_enbl	◎	○	1なら著者名の表示をサポートする 0なら著者名の表示をサポートしない g_cntsのath_c_enblのデフォルトも提供する（カテゴリ付きのものは除く）	0
ath_c_enbl	×	◎	1なら著者名の表示をサポートする 0なら著者名の表示をサポートしないカテゴリなしのath_c_enblのデフォルトは、カテゴリなしのath_enblになる。カテゴリ付きオプションのデフォルトは、カテゴリなしオプションとなる	左欄参照
sur_ath	◎	×	著者名行を囲むHTMLタグ。たとえば<P ALIGN="RIGHT">を指定すれば、著者名行の前後に<P ALIGN="RIGHT">と</P>を挿入する	(空文字列)
end_ath	◎	×	著者名行の末尾に挿入されるHTMLタグ。たとえば<HR>を指定すれば、著者名行の後ろに<HR>を挿入する	(空文字列)
sep_ath	◎	×	著者名が複数あるときに個々の著者名の間に挿入される文字列またはHTMLタグ	(空文字列)
sur_c_ath	×	◎	目次アイテム行の著者名部を囲むHTMLタグ。たとえば<FONT SIZE="2">を指定すれば、著者名部の前後に<FONT SIZE="2">と</FONT>を挿入する	(空文字列)
sta_c_ath	×	◎	目次アイテム行の著者名部の前に挿入される文字列、HTMLタグ。たとえば<b>　<b>を指定すれば、タイトルと著者名部の間に<b>　<b>を挿入する	(空文字列)
end_c_ath	×	◎	目次アイテム行の著者名部の後ろに挿入される文字列、HTMLタグ。たとえば<P>を指定すれば、著者名部の後ろに<P>を挿入する	(空文字列)
sep_c_ath	×	◎	著者名が複数あるときに個々の著者名の間に挿入される文字列またはHTMLタグ	(空文字列)
目次のリスト、アイテムの装飾
lststr	×	◎	目次のリストスタイルを指定するHTMLタグ。<UL>、<OL>、<DL>など。(1)、(2)などのレベルを指定すれば、レベルごとにリストスタイルを変更できる。レベルのリストスタイルのデフォルトは、前のレベル	(空文字列)
itmstr	×	◎	目次リストのアイテムスタイルを指定するHTMLタグ。<LI>、<DT><DD>など。アイテム行の冒頭に挿入される。lststrと同様にレベルごとに変更できる	(空文字列)
sur_c_itm	×	◎	目次アイテム行全体（タイトルと著者名）を囲むHTMLタグ。たとえば<I>を指定すれば、アイテム行の前後に<I>と</I>を挿入する	(空文字列)
sta_c_itm	×	◎	目次アイテム行の前に挿入される文字列、HTMLタグ	(空文字列)
end_c_ath	×	◎	目次アイテム行の後ろに挿入される文字列、HTMLタグ。たとえば<P>を指定すれば、アイテム行の後ろに<P>を挿入する	(空文字列)

*は出力ファイル単位でカテゴライズ可能なもの。+は目次レベルによって変更できるものを表わす

付属ファイルの内容

　OLBCKのパッケージには、設定、ヘッダ、フッタ、中仕切りファイルのサンプルがいくつか含まれています。ここではそれらについて説明します。なお、ファイルの種類は、拡張子で見分けることができるようになっています。config.dat、head.dat、foot.dat、middle.datの4つを除き、次のようになっています。

設定ファイル	.cfg
ヘッダファイル	.hed
フッタファイル	.fut
中仕切りファイル	.mdl

それでは、個々のファイルの内容を説明します。

設定ファイル
config.dat	g_shortがデフォルトで使う設定ファイル。内容は以下の通り cntstr = 目次 # 目次ページ表示文字列 sur_tit = <h2><b> # タイトルのまわりの修飾 end_tit = <hr> # タイトルのうしろの修飾 lststr = <UL> # 目次用タグ itmstr = <LI> # 目次アイテム用タグ sep_all_o = \| # $all_o用セパレータ sep_all_i = \| # $all_i用セパレータ
long.cfg	g_longがデフォルトで使う設定ファイル。内容は以下の通り middle = middle.dat foot = long.fut cntstr = 目次 # 目次ページ表示文字列 sur_tit = <H2><B> # タイトルのまわりの修飾 end_tit = <HR> # タイトルのうしろの修飾 lststr = <UL> itmstr = <LI> sep_all_o = \| # $all_o用セパレータ sep_all_i = \| # $all_i用セパレータ中仕切り、フッタファイルの指定を除けば、config.datと同じ。フッタは、中仕切りとの兼ね合いでconfig.datとは異なるスタイルのものを使っている
olist.cfg ulist.cfg	この2つは、g_cntsを使って目次ファイルではなく、単純なリストを作るためのもの。たとえば、olist.cfgの内容は以下の通り。 lststr=<OL> itmstr=<LI> sup_hf=1 sup_br=1 olist.cfgがOLタグを使うのに対し、ulist.cfgがULタグを使うことを除けば両者は同じである。OLは、Ordered Listの略で、1、2、3といった番号が振られているリスト。ULは、Unordered Listの略で、●とか◇などの記号が付けられているリストである
ヘッダファイル
none.hed	$etitマクロでタイトルを指定し、背景を白く塗っているだけのヘッダ
black.hed	背景を黒くしたnone.hed
all_i.hed	none.hedに$all_iマクロを追加したもの。内容は以下の通り。 <HTML> <HEAD> <TITLE>$etit</TITLE> </HEAD> <BODY BGCOLOR="#FFFFFF" TEXT="#002000" LINK="#000077" VLINK="#007700"> <FONT SIZE="1"><I>$all_i</A></I></FONT> 最後の行を取り除けばnone.hedと同じになる
all_ic.hed	all_i.hedに目次リンクを追加したもの。内容は以下の通り。 <HTML> <HEAD> <TITLE>$etit</TITLE> </HEAD> <BODY BGCOLOR="#FFFFFF" TEXT="#002000" LINK="#000077" VLINK="#007700"> <I><font size=1>\|<A HREF="$contents">目次\|</A> $all_i\|</font></I>
all_o.hed	$all_iマクロではなく、$all_oマクロを使っている点を除けばall_i.hedと同じ
all_oc.hed	$all_iマクロではなく、$all_oマクロを使っている点を除けばall_ic.hedと同じ
pn_o.hed	none.hedに$prev_o、$next_oマクロを追加したもの。内容は以下の通り。 <HTML> <HEAD> <TITLE>$etit</TITLE> </HEAD> <BODY BGCOLOR="#FFFFFF" TEXT="#002000" LINK="#000077" VLINK="#007700"> <I><FONT SIZE=1><A HREF="$prevf_o">\|前頁（$prev_o）</A>\| <A HREF="$nextf_o">次頁（$next_o）\|</A></I></FONT> $all_とは異なり。$prev_、$next_*を使うときにはAタグをこまめに指定しなければならない
pn_oc.hed	pn_o.hedに目次リンクを追加したもの
head.dat	デフォルトで使われるヘッダファイル。none.hedと同じ
フッタファイル
none.fut	ほぼ何もないと言ってよいフッタ。内容は以下の通り </BODY> </HTML>
hr.fut	横線を1本引くだけのフッタ。内容は以下の通り <HR> </BODY> </HTML>
all_i.fut	hr.futに$all_iマクロを追加したもの。内容は以下の通り <HR><FONT SIZE="1"><I>\|$all_i\|</I></FONT> <HR> </BODY> </HTML>
all_ic.fut	all_i.futに目次リンクを追加したもの
all_o.fut	$all_iマクロではなく、$all_oマクロを使っている点を除けばall_i.futと同じ
all_oc.fut	$all_iマクロではなく、$all_oマクロを使っている点を除けばall_ic.futと同じ
pn_o.fut	hr.futに$prev_o、$next_oマクロを追加したもの。内容は以下の通り。 <HR><FONT SIZE="1"><I>\|<A HREF="$prevf_o">前頁（$prev_o）\|</A> <A HREF="$nextf_o">次頁（$next_o）\|</A></I></FONT> <HR> </BODY> </HTML>
pn_oc.fut	pn_o.futに目次リンクを追加したもの
long.fut	g_longがデフォルトで使うフッタ。hr.futに目次リンクを追加したもの
foot.dat	g_shortがデフォルトで使うフッタ。pn_oc.futと同じ
中仕切りファイル
hr5.mdl	太い横線を引くだけの中仕切ファイル。内容は以下の通り <HR SIZE="5">
all_i.mdl	hr5.mdlに$all_iマクロを追加したもの
all_ic.mdl	all_i.mdlに目次リンクを追加したもの
all_oic.mdl	all_ic.mdlに$all_oマクロを追加したもの。内容は以下の通り <HR SIZE="5"> <FONT SIZE="1"><I>\|<A HREF="$contents">目次\|</A>$all_o\|<BR> \|$all_i\|</I></FONT>
pn_i.mdl	hr5.mdlに$prev_i、$next_iマクロを追加したもの
pn_ic.mdl	pn_i.mdlに目次リンクを追加したもの
middle.dat	long.cfgが参照している中仕切ファイル。pn_i.mdlと同じ