利用者:ArchiverBot/config/doc

このテンプレートを設置したページでは、古くなった節が自動的に過去ログ化されます。引数の記入方法については下記をご覧ください。

過去ログ化の設定

自動過去ログ化を設定したいページの最上部に、次のようなテンプレート呼び出し文を加えてください。

{{利用者:ArchiverBot/config
| algo    = old(...)
| archive = 過去ログページの名前
[他にも引数があります - ***詳しくは下記をみてください***]
}}

おおまかには上記のように設定します。ちなみに、このテンプレート自体には内容がありませんので、表示上邪魔になることはありません。

このボットは各引数がかならず別々の行に書かれていることを想定しています。最後の }} はそれだけを1行に書いてください。パイプ記号「|」の前には空白があってはいけません。たとえば改行をすべて消して {{ から }} までを1行につなげたりすると、このボットはただしく動きません。

また、次のことにも注意してください。

1. このテンプレートは最初の== 第2レベル見出し ==より前に書かれなければなりません。
2. このテンプレートは、過去ログ化するページ本体に直接書く必要があります。参照読み込みではダメです。

簡単な例

このボットの設定はすこしとっつきにくいかもしれませんが、柔軟で多様な使いかたができるようになっています。

「利用者‐会話:Example」の部分は自分の会話ページのページ名に変えてください。

それでも動かないときは下にある「minthreadsleft」引数と「minthreadstoarchive」引数の説明をお読みください。

例1：固定されたページへの過去ログ化

{{利用者:ArchiverBot/config
| algo    = old(7d)
| archive = 利用者‐会話:Example/過去ログ
}}

上記の設定を利用者‐会話:Exampleに書くと、利用者‐会話:Exampleのうち（スレッド内の最後の書きこみから）7日以上が経過したスレッドが、利用者‐会話:Example/過去ログに移動されます。過去ログが 2000KB を越えると過去ログ化がとまります。ですので、おそらくあまり便利ではありません（過去ログページが一杯になるたびに、手動でページを移動して空きをつくるつもりがあるなら別ですが）。

例2：番号つきの過去ログ

{{利用者:ArchiverBot/config
| algo                = old(31d)
| archive             = 利用者‐会話:Example/過去ログ%(counter)d
| counter             = 1
| maxarchivesize      = 70K
| archiveheader       = {{archives}}
| minthreadstoarchive = 1
| minthreadsleft      = 4
}}

この設定を利用者‐会話:Exampleに書くと、利用者‐会話:Example のうち1ヶ月以上経過したスレッドが 利用者‐会話:Example/過去ログ 1 に移動されます。ただし最低4スレッド (minthreadsleft = 4) は残るようにします。70キロバイトを越える (maxarchivesize = 70K) と、過去ログ 2 に移動されるようになります（このとき counter の値が2に書き換えられます）。maxarchivesize で過去ログの上限サイズを指定するのを忘れないでください。指定しなかった場合、例1と同じようになってしまいます。過去ログページの冒頭には {{archives}} がつきます。

例3：日付つきの過去ログ

{{利用者:ArchiverBot/config
| algo    = old(5d)
| archive = 利用者‐会話:Example/Archives/%(year)d/%(month)02d
}}

この設定では、（最後の書き込みから）5日以上経過したスレッドが、その日付に応じた過去ログページに移動されます。year などの変数については下記をご覧ください。

引数の説明

{{利用者:ArchiverBot/config 
| archive             = 
| algo                = 
| counter             = 
| maxarchivesize      = 
| minthreadsleft      = 
| minthreadstoarchive = 
| archiveheader       = 
| key                 = 
}}

引数	説明
archive	スレッドが過去ログ化される先のページ名です。日付など、動的にかわる部分を指定するために変数を含めることができます。key （後述）が指定されていないかぎり、マジックワードは使えません。対象ページのサブページである必要があります。
algo	過去ログ化をするかどうかを判断するアルゴリズムを指定します。複雑なアルゴリズムの実装も予定されていますが、いまのところは経過時間を指定する old(...) しか使えません。括弧のなかには時間や日数を入れます。たとえば old(24h) は24時間、 5d は5日です。
counter	カウンターの現在の値を指定します。%(counter)d 変数をつかっていないときは無視されます。ボットは必要に応じてこの値を増やしていきます。
maxarchivesize	過去ログページの上限サイズです。この値を越えるとカウンターが更新されます。カウンターを使わないときは無視されます。値は大文字のKを使った表記である必要があります。たとえば maxarchivesize=256K と書くと、上限が256キロバイトになります。
minthreadsleft	ページに残すスレッド数の下限値です。これによりページが完全に空になってしまうことを防げます。未設定の場合 5 とみなされます。
minthreadstoarchive	一度に過去ログ化するスレッド数の最小値です。この値より少ない数のスレッドしか過去ログ化対象にならない場合は、過去ログ化されません。これによりボットの編集が頻繁になりすぎることを防げます。未設定の場合 2 とみなされます。
archiveheader	過去ログページを作るとき、その冒頭に追加される内容です。変数をサポートしています。この引数の値は複数行にできません。書くべき内容が多い場合は {{archive navigation}} のようなテンプレートにしてください。未設定の場合 {{Archives}} とみなされます。
key	サブページでない場所に過去ログ化することを許可する秘密の鍵です。

変数

変数	この内容におきかわります
%(counter)d	counterの現在の値
%(year)d	過去ログ化されるスレッドの日付の年
%(month)d	過去ログ化されるスレッドの日付の月
%(monthname)s	その月の英語名
%(monthnameshort)s	その月の英語名の省略形

Pythonをご存じの方は、上記の変数が % 演算子で使われるものだということにお気づきでしょう。書式を変える場合も、通常の % 演算子の使いかたに従えば大丈夫です。Python に詳しくない方のために簡単にまとめておくと：

• 閉じ括弧のあとの文字は変えないでください。「d」は整数、「s」は文字列を意味します。
• 次のようにすると整数値をゼロ詰めできます。

  %(counter)03d とすると、 counter の値が 13 であれば 013 になります。

  %(month)02d とすると、5月の場合は 05 になります。

過去ログ化の設定をしたあと

ボットはこのテンプレートが貼られているページを定期的に巡回しますので、次の巡回をお待ちください。過去ログ化すべきスレッドがあれば、過去ログ化が実行され、その結果は履歴ページを見ると確認できます。要約欄のメッセージで、事前に指定されていたページへと移動が行なわれたことが記されているはずです。

過去ログサブページの一覧を自動的につくるためのテンプレートがいくつかあります。多くの場合、最上位のページにこうしたテンプレートを置いておくと、過去ログがみつけやすくなります。好きな場所にテンプレートの名前を{{波括弧で囲んで}}置いてください。よく使われるのは次のテンプレートです。

• {{archives3}}
• {{archive box}}
• Template:MonthlyArchive

特定のスレッドだけ過去ログ化を先送りまたは禁止する

Template:DNAU が含まれるスレッドは過去ログ化が先送りされます。期限なしでそのスレッドを移動させずにおきたい場合 {{subst:DNAU}} を使ってください。ある日数だけ先送りしたい場合は {{subst:DNAU|その日数}} としてください。使いかたと機能について詳しくは当該テンプレートのページをご覧ください。