リストファイルの項目
生成するHTML群に関する設定はリストファイルに記載します。リストファイルの名前は「list_任意の文字列.txt」でなければなりません。任意の文字列(半角の英数字のみ)の部分は識別コードとして使われます。
なおファイル名や記載内容において、半角と全角、前後の空白の有無は厳密に区別されます。普段あまり意識していない方はご注意ください。リストファイルを編集する際は、半角と全角(特に空白)の区別、タブや改行の視認ができるエディタの使用をお勧めします。
ヘッダ部
指定できるキーと値は以下の通りです。リストファイルに記載していない項目は規定値が使われます。
入出力フォルダの指定(必須項目)
-
path
- 入出力フォルダ
-
最低限、ヘッダとして当項目が指定してあれば実行可能です。入出力のパスを一括して指定する場合にフルパスで記載します。入力であるdatファイルは (path)\dat\識別コード 下にあると見なされ、出力であるHTMLファイルは (path)\html\識別コード 下に保存されます。
サンプル1のpath指定は D:\testdir なので、datは D:\testdir\dat\test 直下にあると解釈されます。生成したHTMLファイルは D:\testdir\html\test 下に保存されます。
-
dat_path
- 入力フォルダ
-
datとHTMLのフォルダを別々にしたい場合に、datの格納フォルダをフルパスで指定します。D:\hogedir を指定した場合、D:\hogedir 直下にdatがあるということです。たとえばdatは2ちゃんねる専用ブラウザが取得したファイルを使うけれども、生成したHTMLは別のフォルダに置きたいといった場合に使います。
pathが指定されていた場合は、当項目は無視されます。
-
out_path
- 出力フォルダ
-
生成したHTMLファイルの保存先をフルパスで指定します。ジェネレータが末尾に識別コードを付加するので、(out_path)\識別コード が実際の出力先になります。dat_path と併せて指定します。
pathが指定されていた場合は、当項目は無視されます。
スレッド一覧ページの生成に関する指定
-
title
- タイトル
-
実際のスレッド一覧ページでは、「(板名):(タイトル) スレッド一覧」の形式で使われます。
規定値:空白(長さゼロの文字列)
-
note
- 任意の注釈
-
スレッド一覧の直前に挿入される、任意の注釈を指定します。複数行を書くときは、半角のパイプ記号 | で連結します。
規定値:なし(null)
-
use_default_note
- デフォルトの注釈を使うか
-
ジェネレータが用意している注釈を付加するか否かを指定します。付加しない場合は1以外を指定します。
規定値:付加する
-
start_thread_num
- スレッド一覧における連番の開始値
-
通常は1から始まる連番を、それ以外の数で始めたいときに開始値を指定します。
規定値:1
-
show_url
- スレッドURLのラベルとして実URLを使う
-
スレッドのURLをそのまま掲載すると一行の幅が長くなるため、通常は「URL」という三文字がリンクのラベルになります。幅が長くなっても構わないからスレッドのURLをそのままラベルにしたい場合に1を指定します。
規定値:ラベルとして「URL」という文字列を使う
datのzip化に関する設定
-
dat_to_zip
- datをzipにするか
-
datファイルをzip圧縮する場合に1を指定します。zipファイルは生成した当該スレッドのHTMLと同じ場所に保存されます。
当項目が1でも、スレッド一覧で処理可否フラグを1以外にしたスレッドのzipは作成(または上書き)されません。
当項目を1で実行後、1以外に変更して再実行した場合、スレッド一覧での処理可否フラグが1なら既存の該当zipは削除されます。
規定値:zipを作成しない
-
remake_zip
- 既にzipがあっても再作成するか
-
既にzip圧縮したdatがあっても、実行するたびに再作成して上書きする場合に1を指定します。一覧のスレッドの数によっては時間がかかる上にエラーも起きやすくなるため、datの内容が変わらないのであれば再作成する必要はありません。生成対象のスレッドが多い場合、datが変わらない古いスレッドは1以外にして実行しておき、その後、datが更新されているスレッドのみを処理対象とし、かつremake_zipに1を設定して再実行するといいでしょう。
dat_to_zipに1以外を指定した場合、そもそもzipが作られないので当項目は無視されます。
規定値:再作成しない
総合目次(手動作成)に関する設定
-
root_use
- 総合目次へのリンクを張る
-
スレッド一覧ページの、さらに上位の総合目次ページを手動で作成している場合、総合目次をHomeとするリンクを張る場合は1を指定します。
規定値:リンクしない
-
root_title
- 総合目次のタイトル
-
総合目次のタイトルを指定します。当項目は、root_useの値に関わらず、保管庫全体のタイトルとしても使われます。
規定値:スレッド保管庫
-
root_path
- スレッド一覧から見た総合目次の相対パス、または総合目次の絶対パス
-
総合目次のパス部分を指定します。総合目次が他のドメインにある場合、絶対URLで http://〜/ と記載することもできます。
当項目は、root_useが1のときのみ使われます。
規定値:../(スレッド一覧のすぐ上のフォルダに総合目次がある)
-
root_fileName
- 総合目次のファイル名
-
総合目次のファイル名を指定します。当項目は、root_useが1のときのみ使われます。
規定値:index.html
-
root_label
- パンくずリスト中の総合目次用ラベル
-
パンくずリストにおける総合目次のラベルを指定します。当項目は、root_useが1のときのみ使われます。
規定値:Home
その他の設定
-
no_all_page
- 一括ページを生成しない
-
全レスを格納した一括ページを生成しない場合に1を指定します。この値を変えた場合、生成済のファイルと矛盾が起きる可能性があるため、生成済の全ファイルを削除した上で再生成することをお勧めします。
一括ページと分割ページの両方を生成しない設定にすることはできません。
規定値:一括ページを生成する
-
no_part_page
- 分割ページを生成しない
-
100レス(規定値)ごとに分割したページを生成しない場合に1を指定します。この値を変えた場合、生成済のファイルと矛盾が起きる可能性があるため、生成済の全ファイルを削除した上で再生成することをお勧めします。
一括ページと分割ページの両方を生成しない設定にすることはできません。
規定値:分割ページを生成する
-
no_search_robot
- 検索避け用のmetaタグを挿入する
-
生成するHTMLファイルに、検索避け用のmetaタグを挿入する場合に1を指定します。
規定値:metaタグを挿入しない
-
no_outsite_link
- 2ch以外の外部サイトにリンクを張らない
-
外部サイトのURLに対し、2ちゃんねる、PINKちゃんねるのスレッド以外にリンクを張らない場合に1を指定します。リンク先にリファラを取得されたくない場合、リンクを張らないほうが無難です。1を指定した場合、2ちゃんねる、PINKちゃんねるのURLであっても、倉庫などアクティブなスレッド以外のURLにもリンクは張られません。
規定値:リンクを張る
-
no_appName
- HTMLページ末尾にジェネレータ名を挿入しないか
-
生成するHTMLファイルのフッタに、当ジェネレータ名を挿入したくない場合に1を指定します。その場合は代わりにページのタイトルが挿入されます。
規定値:ジェネレータ名を挿入する
スレッド一覧部
保管庫に入れるスレッドの情報を羅列します。スレッドひとつにつき一行、以下の三項目をこの順でタブで区切って記載します。
-
連番
- 任意の番号
-
当項目の値は、ジェネレータで使用されません。なので実際には数値以外を書いても可。リストファイルを目視した際に、見やすくするための項目です。
スレッドが多い場合、普通に1から連番をふっておけば、すぐにそれが何スレ目かわかります。流れが速くてスレ立てが被った場合はスレタイ中の番号は当てにならないので、「実質xxスレ目」のようなメモを入れてもいいでしょう。
-
URL
- スレッドのURL
-
以下の2形式に対応しています。
http://hoge.2ch.net/test/read.cgi/foo/1234567890/ …… 現行の形式
http://hoge.2ch.net/test/read.cgi?bbs=foo&key=1234567890 …… 古い形式
URLのサーバ部分は異なっていても構いませんが、板名はすべて同じでなければなりません。http://hoge.2ch.net/test/read.cgi/foo/1234567890/ というURLの場合、板名は foo なので、同じリストファイル中で指定できるのはfoo板のスレッドだけです。板を移動した場合や、異なる板のスレッドもまとめたい場合は、板ごとにリストファイルを作り、総合目次でそれぞれのスレッド一覧ページにリンクしましょう。
URL中のスレッド番号はdatファイルの名前としても使われます。http://hoge.2ch.net/test/read.cgi/foo/1234567890/ のスレッド番号は 1234567890 ですから、対応するdatファイルは 1234567890.dat でなければなりません。
URLを記載しなかった場合はdatを探せないため、datがないと見なされて、一覧にその旨が書かれます。URLは記載してあるのに、実際にはdatがなかったときも同様です。
-
フラグ
- 処理可否
-
HTMLを生成するスレッドの場合は1を指定します。
スレッド一覧ページ用にタイトルやレス数、スレ立て日時を取得するため、このフラグの値に関わらずdatファイルの読み込み自体は行なわれます。