Szerkesztő:Bináris/Tartalomjegyzékbot/Használati útmutató

A tartalomjegyzékbot egy Bináris által írt, a Pywikipedia keretrendszerben készült program. Feladata a több archívumra széttagolt lapok összefüggő tartalomjegyzékének elkészítése. Ezen a lapon a felhasználói ismeretek olvashatók; a botgazdáknak szóló tudnivalók itt vannak.

A tartalomjegyzékbot a konfigurációk segítségével vezérelhető. Ezeknek két fajtájuk van:

  1. Az úgynevezett központi lapokon elhelyezett konfigurációk elsősorban a közösségi archívumok tömeges leírására és a tesztek egyszerűsítésére valók. A magyar Wikipédia központi lapjai a itt, itt és itt vannak, és Bináris tartja karban őket. Ennek a leírásnak alapján a hozzáértők szerkeszthetik, de ne ezeken kísérletezz.
  2. Az egyedi konfigurációk az archiválóbot sablonjaihoz hasonlítanak, és elsősorban a szerkesztők személyes használatára ajánlottak.

A két típus között csekély eltérés van az első sorban és a sorok elején álló karakterekben. Ez az útmutató mindkettőnek a leírását tartalmazza.

Olvasd el a Szerkesztő:Bináris/Tartalomjegyzékbot#Mit tehetsz a tartalomjegyzék használhatóságáért te? szakaszban leírt tanácsokat, hogy minél jobban használhatóak legyenek a Wikipédia közösségi és személyes archívumai. Ezeknek a betartásával akkor is hozzájárulhatsz a megbeszélések visszakereshetőségéhez és a közösség jólétéhez, ha te magad nem kértél tartalomjegyzéket az archívumokhoz.

A bot által nem kezelt archívumokSzerkesztés

  • Az olyan archívumok, amelyek nem allapjai semminek. A magyar Wikipédiában még nem találkoztam ilyennel, az eszperantóban már igen (de azóta már ők is normalizálták). Ebből a megoldásból olyan kevés van, hogy nem éri meg dolgozni vele.
  • A difflinkekkel képzett álarchívumok
  • Archívumokra mutató átirányítások. Ha átnevezted az archívumokat, frissítsd fel a konfigurációt.
  • A Liquid Threadshez tartozó lapok (folyékony beszélgetések) – ezek nem számítanak archívumnak, és a botnak nincs is dolga velük.

KonfigurációSzerkesztés

A konfiguráció az archívumok nevét és sorrendjét írja le. Először ismerkedjünk meg a szerkezetével!

Központi lapokonSzerkesztés

Egy központi lap több konfigurációt is tartalmazhat (lásd például itt). A konfiguráció háromféle sort tartalmazhat:

  • Minden konfiguráció első sora egy darab : karakterrel kezdődik, és a kettőspont után a feldolgozandó főlap címét tartalmazza, szögletes zárójelek nélkül. (Lásd a következő szakaszt is a cím alakjáról.)
  • Ezután egy vagy több :: karakterekkel kezdődő sor áll. Ezek a konfigurációs paramétereket tartalmazzák paraméter = érték alakban. Minden paraméternév szigorúan kisbetűs! A bot eldobja az érték előtti és utáni szóközöket.
  • Egy vagy több vagy kevesebb (de legalább nulla) megjegyzés, amelyet a bot figyelmen kívül hagy. Ezek a sorok a :* karakterekkel kezdődnek, és bárhol elhelyezhetők a paramétereket leíró sorok között vagy után.

Ez a szintaxis biztosítja, hogy a konfiguráció ember és gép számára egyformán olvasható és áttekinthető legyen.

Bármely más sor (beleértve az üres sort és a félregépelt paramétert is) a konfiguráció végét jelenti. A bot abbahagyja a feldolgozást, és nekiáll keresni a következő : kezdetű sort egy újabb konfiguráció reményében (és lehet, hogy letapossa a füvet útközben). Külön lezáró sorra tehát nincs szükség.

Egyedi konfigurációkSzerkesztés

Az egyedi konfigurációk bárhol elhelyezhetők a feldolgozandó főlap (pl. a vitalapod) bevezető szakaszában, az első címsor előtt. Egy lapon több is lehet belőlük, ha kell. Ez akkor lehet szükséges, ha túl sokszor változtattad meg az archívumelnevezési szokásaidat. Amíg lehet, jobb elkerülni, mert akkor a tartalomjegyzékekből is több lesz. A konfiguráció lehet bármilyen más tartalom (szöveg, sablonok, archívumlista, Cherybot konfigurációja stb.) előtt vagy után, és nagyon hasonlít a fentiekben leírt központi lapos konfigurációhoz, az alábbi eltérésekkel:

  • Az első sor minden esetben pontosan így nézzen ki, a sor elején kezdve:
{{user:BinBot/config
  • A paramétereket leíró sorok a | karakterrel kezdődnek (a szóköz megengedett az áttekinthetőség kedvéért). Ez a sablonparaméterek szokásos elválasztó karaktere, de a konfigurációban kötelezően új sorban kell állnia.
  • A megjegyzéssorok elején a |* karakterek állnak.
  • A sablont lezáró }} jelek külön sorban legyenek.

Egy egyszerű példa:

{{user:BinBot/config
 | rex = Archívum [nn]
 | kat = Személyes tartalomjegyzékek
 |* Ez akkor lesz jó, ha az archívumaid neve pl. Archívum 1 … Archívum 37.
}}

(Az itt látható kategóriát légy szíves, használd te is a vitalapodon.)

Mire való a konfiguráció?Szerkesztés

A fő feladata hármas:

  1. megtalálja az archívumaidat, amelyek ideális esetben a megadott főlap allapjai (a későbbiekben leírt kivételekkel), és kiválogatja őket az egyéb allapjaid közül,
  2. sorba rendezi őket, ami általában értelemszerűen időrendet jelent,
  3. mindegyikhez egy rövid nevet rendel, amely az eredményül kapott táblázat második oszlopában fog megjelenni.

Alapparamétereknek fogom nevezni azt a négy paramétert, amelyek a fent leírt feladatot végzik. Ezenkívül lehetnek kiegészítő paraméterek is a konfigurációdban: ezek megmondják, hogy hova kerüljön a táblázat, mi legyen a címe, milyen sablonok és kategóriák legyenek rajta, vagy éppen hogy a lap muzeális, és nem kell minden alkalommal újból feldolgozni.

A bot angolul és magyarul is felismeri a paraméterek nevét. A továbbiakban csak a magyar neveket használom; az eredetiek az angol leírásban olvashatók.

A bot írása közben számos wiki számtalan archívumát böngésztem át, és úgy találtam, hogy a felhasználók roppant kreatívak a névadásban (messze nem mindenkit elégít ki az unalmas „Archívum 1”-megoldás), és ezért nekem is kreatívnak kellett lennem az archívumok felismerésében.   A tartalomjegyzékbot a különböző elnevezési rendszerek sokaságát kezeli rugalmasan, beleértve a különböző dátumformátumokat, arab és római számokat, bináris és hexadecimális számokat és még a betűkkel számozott archívumokat is, mint Hkoaláé.

A címekrőlSzerkesztés

A lapok címe – akár a konfiguráció első sorában van megadva, akár a holvan paraméter értékeként – a névterek kanonikus magyar nevét kell, hogy tartalmazza. Például a Szerkesztővita:Bináris, a user vita:Bináris és a user talk:Bináris egyaránt a vitalapomhoz vezet, de csak az elsőt ismeri fel a bot. Ez azért van, mert a bot a Special:Prefixindex lapról gyűjti ki az allapokat, és az ott megjelenő címeket hasonlítja össze a konfigurációban megadottakkal.

Az alapparaméterekSzerkesztés

A központi lapokon:

::holvan = 
::lista =
::rex =
::rex2 =

Egyedi konfigurációban (a személyes vitalapokhoz ez fog kelleni):

|holvan = 
|lista =
|rex =
|rex2 =

A botnak először is annak a lapnak a címére van szüksége, amelyiknek az archívumait gyűjtjük. Ezt a lapot főlapnak fogjuk nevezni. (Ne keverd össze a wiki főoldalával!) A központi lapos konfigurációkban az első, : kezdetű sor tartalmazza a főlap címét, az egyedi konfigurációkban pedig nem kell feltüntetni, mert az a lap lesz az, ahova a sablont beillesztették.

Ha az orvos másképp nem rendeli, minden archívum ennek a főlapnak a „leszármazottja” (allapja vagy al-allapja vagy al-al-allapja, folytasd tovább egyedül). Ha az orvos másképp szeretné rendelni, akkor ezt a holvan paraméterrel teheti meg. Például vannak, akik a vitalapjuk archívumait nem a vitalap, hanem a szerkesztői lap alá teszik, mint Hkoala, vagy pedig egy Archívum allap alá, mint Lji1942. Egyes wikikben meg a népek fogják magukat, és átnevezik a közösségi lapokat, új kocsmafalakat nyitnak, és ennek folytán egyik-másik lap archívumai más lapok allapjaira kerülnek. Na ilyenkor segít a holvan. A holvan paraméter abszolút cím (nem a főlaphoz képest kell megadni, hanem a teljes címével, névtérrel együtt). Ne tedd ki a szögletes zárójeleket. Ilyenkor is igaz azonban, hogy minden archívum ennek az allapja (vagy al-allapja…) lesz. Ha az archívumaid egy része a vitalap allapja, a másik része meg a szerkesztői lapé, mint Pasztillának, akkor nincs más hátra, mint két konfigurációt készíteni, amiből két külön tartalomjegyzék lesz (vagy pedig egyszer nekiveselkedni, és átnevezni az egyik felét).

Nos, miután sikerült a botnak elmagyarázni, hogy hol keresse az archívumaidat, azt is meg kell mondani, hogy mit keressen. A legegyszerűbb elmagyarázni neki a szabályt, valahogy így:

Az archívumaim neve az Archív szóval kezdődik, és utána szóközzel elválasztva egy szám áll, 1-től 17-ig, így két számjeggyel még elleszek egy darabig.

Vagy:

Az archívumaim évenként vannak csoportosítva, minden évnek egy kétjegyű számmal jelölt allapja van a vitalapom alatt, és maguk az archívumok ezeknek az éves lapoknak az allapjai, a hónap teljes kisbetűs nevével jelölve, mint például Szerkesztővita:Példafelhasználó/09/január.

Vagy éppen:

Ennek a közösségi lapnak az archívumai az Archívumok allap alatt vannak, és mindegyiknek egy nyolcjegyű szám a neve: az év, a hónap és a nap ebben a sorrendben, például /Archívumok/20110923.

Az efféle szabályokat leíró kifejezéseket rexnek hívjuk. Aki egy kicsit jártas a reguláris kifejezések (regexek) világában, annak ismerős lesz az elképzelés. Ezek a rexek (vagyis pszeudo-regexek) kicsiny sablonok, amelyek a bot futása során valódi reguláris kifejezésekké transzformálódnak, és így biztosítják ezt a fajta rugalmasságot, amellyel a bot az archívumnevek kavalkádjában is kiismeri magát. A rex felépítését a következő szakasz taglalja részletesen. A fenti három szöveges leírást például rendre ezekkel a rexekkel lehetne formalizálni:

::rex = Archív [nn]
::rex = [YY]/[MMMM]
::rex = Archívumok/[YYYY][MM][DD]

A harmadikat másképp is lehetne definiálni:

::holvan = <a főlap neve>/Archívumok
::rex = [YYYY][MM][DD]

Az egyedi konfigurációkban :: helyett a | karaktert használd a sor elején.

Az elnevezési szokások olykor megváltoznak, például amikor az embereknek hiányérzetük támad valamiféle rendszer iránt, vagy amikor elkezdik Cherybotot használni az automatikus archiválásra. Éppen ezért a konfiguráció két ilyen kifejezést is tartalmazhat, ha kell: a rexet a régebbi, a rex2-t az újabb archívumok leírására. Ez már többnyire elég szokott lenni.

De néha még így is vannak a sorból kilógó archívumok, jellemzően a legkorábbiak. Ilyenkor lép akcióba a lista paraméter. A lista = után egyszerűen felsorolhatod az allapokat, mégpedig szokatlan módon a | karakterrel elválasztva (ez ugyanis a vesszővel szemben tiltott karakter a lapok címében, és így biztosan nem okoz konfliktust). Ez valahogy így nézhet ki:

::lista = Első és legkedvesebb archívumom|Második archívumom|Na ennek miért nem adtam rendes nevet?

És utána jöhetnek a szabályosan elnevezett archívumok a rex és a rex2 paraméterekkel megadva.

A lista és a rex közül legalább az egyiket feltétlenül tartalmaznia kell a konfigurációdnak (könnyű belátni, hogy másképpen értelmetlen volna futtatni a botot). A rex2-vel kiegészítve ezek szinte minden archívum leírására képesek, amely valamilyen rendszert tartalmaz. Ha mégsem, akkor ideje nekiállni, és egyszer átnevezni őket valami használható alakra. A legtöbb esetben egyetlen rex is elég lesz.


Néhány könnyen emészthető példa: Egyszerű rex sorszámokkalEgy másik egyszerű példaA holvan, a lista és a rex kombinált használataRex és rex2Holvan, lista és rex vagy rex és rex2Lista, rex és rex2 együttLista és rex

A rex részeiSzerkesztés

A rex állandó és változó részekből áll. A változó részek egyszeres szögletes zárójelek között vannak, és öt csoportra oszthatók: az évet, a hónapot, a napot, a sorszámot (ami lehet betű is) és egy tetszőleges változó szakaszt leíró részre. Mindegyikből csak egy lehet, tetszőleges sorrendben. A kis- és nagybetűk különböznek! Van néhány korlátozás is, ezek ésszerű kompromisszumok a felismerési pontosság kedvéért. Ez egy egyszerűsített, a magyar Wikipédiára szabott leírás; az általános szöveg az angol változatban található.

Évszám
  • [YYYY] a négyjegyű évszámokhoz. Az első két számjegy kötelezően 20. Ne akard elhitetni velem, hogy még 1998-ban archiváltad először a vitalapodat.
  • [YY] a kétjegyű évszámokhoz. A vezető nulla kötelező. (A 09 és a 2009 érvényes évszámok, míg a 9 nem.)
Hónap
  • [MMMM] jelöli a teljes kisbetűs magyar névvel kiírt hónapokat (természetesen helyesen írva).
  • [MMM] a szabályosan rövidített kisbetűs magyar hónapnevek jele (jan, febr stb.). A pontot nem tartalmazza, azt írd ki külön.
  • Akár az MMMM, akár az MMM után írhatsz egy u betűt (upper case) a nagybetűs alak jelölésére. Tehát [MMMMu] lesz a megfelelő kód, ha Január, Február stb. van az allapjaid nevében.
  • [MM] jelöli a két számjeggyel megadott hónapokat 01-től 12-ig,
  • [M] pedig a vezető nulla nélkülieket, 1-től 12-ig. (Természetesen egyiknél sem előírás, hogy mind a 12 meglegyen!)
Nap

Hasonlít a hónapokhoz:

  • [DD] a kétjegyű napok jele, 01 és 31 között,
  • [D] a vezető nulla nélkülieké, 1 és 31 között.
    Habár ezek puszta számoknak tűnhetnek, és néha tényleg helyettesíthetők is a sorszámokkal, speciális funkciójuk van (lásd a következő két szakaszt).
Sorszámozás

Az alábbi kódok közül csak egyet használhatsz. Ha több is van a rexben, akkor hibás lesz, és kimaradsz a dobásból.

  • [N], [NN], [NNN]… stb: állandó szélességű számok (NN a kétjegyűekhez, és így tovább). Ha a sorszámaid tényleg ugyanannyi jegyből állnak (pl. 01, 02 … 29), akkor használd ezt, biztonságosabb.
  • [nn], [nnn] stb.: vezető nulla nélküli, azaz változó szélességű számok, pl. 1-től 29-ig. Az [n] értelemszerűen nem megengedett. Annyi n-et írjál, amennyi a lehetséges maximum; ha például 01-től 95-ig tartanak a sorszámaid, amire még az [NN] is jó lenne, de már látszik, hogy hamarosan sorra kerül a 100, akkor az [nnn] a te barátod.
  • [H], [HH] stb. jelöli az állandó szélességű, nagybetűvel jelölt hexadecimális számokat (ha nem tudod, mi az, akkor szinte biztosan nem úgy számoztad az archívumokat),
  • [hh], [hhh]… pedig a változó szélességű, vezető nulla nélkülieket (de ezek is nagybetűsök!).
  • [BBBB] stb. a fix szélességű bináris számok jele. Találd ki, miért van ez beépítve.   Ennek a típusnak van egy különlegessége, hogy szóközöket is tartalmazhat. Az én archívumaimnak ilyen nevük van: 0000 0001, 0000 0010, 0000 0011 stb. A rexem [BBBB BBBB].
  • [bbbb] (a négy darab csak egy példa) ugyanúgy a vezető nullák nélküli bináris számokat jelöli. Ezeket kombinálhatod is, de jelenleg csak az első csoport lehet kisbetűs. A [bbbb BBBB BBBB] érvényes kód, a [bbbb bbbb] nem.
  • [L], [LL], [LLL]… írandó a rexbe, ha fix szélességen betűket használsz sorszám gyanánt. Ilyenre példa Hkoala vitalapja. Csak az angol ábécé nagybetűi játszanak, A-tól Z-ig. Az [LL] jelentése ezek szerint AA-tól ZZ-ig.
  • [l], [ll], [lll]… (kis L betű) pedig ugyanígy az angol ábécé kisbetűit jelzi, a-tól z-ig. (Itt tehát a fentiektől eltérő jelentése van a kisbetűs alaknak!)
    Ne használd az L és l kódokat állandó szövegre; ha ugyanaz van mindenhol, gépeld be. Ezek igazából sorszámokat jelölnek, csak éppen számok helyett betűvel. A változó szélesség itt nem játszik, mivel több problémát okozna, mint hasznot.
  • [R] (csak egy darab!) a római számok jele. Nem kell megadni a jegyek számát (nem is lehet), hanem addig olvassa a karaktereket a bot, amíg római számként értelmezhetőek. Ha közvetlenül utána jönne egy M vagy L, az pech. A bot csak a szabályos nagybetűs római számokat támogatja, azaz a 49 XLIX és nem IL, a 4 pedig IV és nem IIII vagy iv. A fent említett példatárban találsz ilyeneket is, használd a ctrl F-et.
Változó rész
  • [*] (a jól ismert joker karakter) jelzi a tetszőleges hosszúságú változó szöveget. Lehet a rex elején, közepén és végén is, és megfelel a nulla hosszúságú szövegnek is (azaz az Archívum, Archívum1, Archívum2 lefedhető az Archívum[*] mintával). Erre is van egy csomó példa. Csak a változó részhez használd.

Rendezési szempontokSzerkesztés

A táblázat összeállításakor mindig a lista paraméter után megadott archívumok kerülnek először sorra, az ott megadott sorrendben. Ezután a rex, végül a rex2 mintájára illeszkedők következnek.

A rex, illetve rex által leírt archívumokon belül a rendezés szempontjai a következők (függetlenül attól, hogy az egyes kódok milyen sorrendben szerepelnek a rexben):

  1. év
  2. hónap
  3. nap
  4. sorszám vagy betű
  5. * (a tetszőleges változó rész)

A rövid névSzerkesztés

A bot mindegyik archívumnak ad egy rövid nevet, amely a táblázat második oszlopában jelenik meg. Minél rövidebb, annál szebb lesz a táblázat. A képzési szabály a következő:

  • A lista paraméterben felsorolt archívumok rövid neve megegyezik az eredeti nevükkel, a szélső szóközök eltávolítása után. Ezekkel sajnos nincs mit tenni, mondjuk ki: csúnyák lesznek. Vegyük azt a példát, hogy az archívumaid az Archívumok allap alatt vannak, és így sorolod fel őket:
::lista = Archívumok/egyik|Archívumok/másik
akkor a „rövid” nevük pont olyan hosszú lesz, ahogy itt látod. De ha ezt írod a konfigurációba:
  ::holvan = <főlap>/Archívumok 
  ::lista = egyik|másik
akkor csak a második sorban álló rövidebb alak lesz a nevük. (Használd a | sorkezdést a :: helyett egyedi konfigurációban.)
  • A rex és rex2 paraméterrel megadott nevekből a bot a változó részeket rakja össze az eredeti sorrendjükben. Egy példa: ha az archívumod neve Archívumok/2011 január, és a rex Archívumok/[YYYY] [MMMM], akkor a rövid név 2011január lesz.
  • Ritkán, de előfordulhat, hogy a bot nem talál változó részt a névben. Ez akkor lehet, ha a rex csak állandó részből és [*]-ból áll, és a [*] nem illeszkedik semmire. (Lásd a fenti példát, ahol az Archívum névben nem talál változó részt.) Ilyenkor egy kötőjellel helyettesíti a rövid nevet. (Jelenleg ilyent láthatsz Ogodej táblázatának első részében.)

Egyéb szempontokSzerkesztés

Néha úgy tűnik, hogy két megoldás egyenértékű, és lehet, hogy csakugyan az. De az is lehet, hogy csak első ránézésre.

  • Nem mindegy, hogyan rendeződnek sorba az archívumok. A fenti példák egyike ez volt:
    ::rex = [YY]/[MMMM]
    (Egyedi konfigurációban | áll a :: helyett.)
    Azt hihetnénk, hogy az [YY] helyett [nn] vagy [NN] vagy [*] is jó lenne. Ezek bármelyike jól kiválasztaná az archívumokat az allapok közül, és sorba is rendezné őket e szerint a két számjegy szerint; hanem a hónapnév a rendezési sorrendben az évszám után áll, és megelőzi a számozást meg a változó részt. Így aztán a tartalomjegyzékedben a végső sorrend 08/január, 09/január … 12/január lenne, majd ezt követné az összes februári archívum stb.
  • A rex, a rex2 és a lista között ne legyen átfedés, azaz ne legyen olyan archívum, amelyik ezek közül két vagy három mintára is illeszkedik, mert akkor az többször fog megjelenni a táblázatban is.
  • Az is lehet, hogy két megoldás egyformán választja ki és rendezi sorba az archívumokat, de más lesz a rövid név, amit a táblázat második oszlopába írnak. Lehet, hogy egy szebb vagy rövidebb alakot részesítenél előnyben. Ezen a lapon számos példát találsz az ilyen eltérésekre a részletes magyarázattal, ha a "rövid" szóra keresel a ctrl F-fel.
  • Kerüld az olyan kifejezéseket, amelyek az archívumokon kívül más allapokat is megtalálhatnak. Különösen a bármilyen szövegre illeszkedő [*] kód mértéktelen használata válthat ki ilyen hatást.
Ebben a példában az angol Wiktionary Tea room lapjának Archive 2003-tól Archive 2010-ig tartó allapjai vannak; csakhogy 2003-tól 2006-ig ezek éves archívumokat jelölnek, 2007-től kezdve pedig nem, ezért az Archive [YYYY] rossz választás lenne. Vagy tegyük fel, hogy a vitalapod alatt van 2009, 2010, 2011 és 9999 allap is, amelyek közül az első három az éves archívumaidat jelöli, a negyedik pedig a világegyetem 9999 legszebb dalát felsoroló allapod vitalapja. Az [NNNN] vagy a [*] mind a négyet szépen felsorolja és sorba is rendezi, hiszen négyjegyű számokról van szó. Csak az [YYYY] írja le pontosan, hogy az első három az archívum (mivel ez a 2000-es évekre korlátozódik). Hasonlóképpen az [nn] kód bármilyen szám lehet 0 és 99 között, a [dd] pedig csak 1-től 31-ig. Ezért jó mindig a legpontosabban kifejező változatot választani – nem véletlenül van ennyiféle lehetőség.
Ha az archívumaid a Szerkesztővita:Példafelhasználó/2011 01, Szerkesztővita:Példafelhasználó/2011 02, Szerkesztővita:Példafelhasználó/2011 03… címeket viselik, akkor az [YYYY] [MM] és az [YYYY] [*] kifejezések csaknem ekvivalensek – egész addig, amíg létre nem jön a Szerkesztővita:Példafelhasználó/2011 szócikk, amit meg kell írnom, mielőtt meghalok lap, mert a csillagos megoldás azt is megtalálná.   Itt látható egy érdekes konfliktus.

Kétség esetén készítsd el mindkét változatot két külön konfigurációban (az egyikben a hova paramétert is ki kell tölteni!), és tartsd meg a jót, vagy ha ez sem segít, akkor kérjél tesztfutást a botgazdától.

Kiegészítő paraméterekSzerkesztés

Ezek a tartalomjegyzék elkészítéséhez nem feltétlenül szükségesek, de növelik a használhatóságát. Tartsd szem előtt, hogy ezek is mind kisbetűsök!

A központi lapokon használt alakjukban:

::cím = 
::hova =
::sablon =
::kat =
::egyszer =
::régidátum =

Az egyedi konfigurációkban (a szerkesztői vitalapokon ez fog kelleni):

|cím = 
|hova =
|sablon =
|kat =
|egyszer =
|régidátum =
cím
A bot alapból „A <főlap> archívumainak tartalomjegyzéke” szakaszcímet írja a táblázat fölé (a főlapot linkelve), ezt változtathatod meg itt. Ne írd bele az egyenlőségjeleket, csak a kívánt címet. Belső link lehet benne.
hova
A bot alapértelmezés szerint a főlap /Tartalomjegyzék allapjára menti a táblázatot. Ezt változtathatod meg itt, például ha a Szerkesztővita:Példauser/Tartalomjegyzék helyett a Szerkesztő:Példauser/Archívummutató címre szeretnéd tenni (feltéve, hogy te vagy Szerkesztő:Példauser). A paraméter abszolút cím (nem a vitalaphoz képest kell megadni, hanem a teljes címével, névtérrel együtt). Ne tedd ki a szögletes zárójeleket. Az egyedi konfigurációkban – a mondott példát folytatva – a cél mindenképpen a Szerkesztő:Példauser vagy a Szerkesztővita:Példauser valamelyik allapja vagy al-allapja stb. (azaz a saját allapod) kell legyen. Ha más címet adsz meg, a bot figyelmen kívül hagyja. A lehetőséggel való rosszindulatú kísérletezést akár vandalizmusnak is tekinthetik.
sablon
Az ideírt szöveget (ami lehet egy valódi sablon neve vagy egy allapod is) sablonként illeszti be a lap tetejére. A {{ }} jeleket ne írd bele! Így lehet paraméterezni: template|param1|param2. Több sablont is beilleszthetsz a paraméter többszöri használatával (lásd a példát).
kat
Beilleszti a megadott kategóriát a lap aljára. Ne írd bele a Kategória: előtagot, csak a nevet! Több kategóriához használd többször. Rendezési kulcsot is megadhatsz utána kategória|kulcs alakban, de nem kezdődhet szóközzel. Használd a * karaktert helyette, ha a kategória elejére akarod sorolni a lapot.
A kat = Személyes tartalomjegyzékek sort kéretik minden szerkesztői vitaarchívum konfigurációjában szerepeltetni! (Ide sorolja be a táblázatot.)
egyszer
A későbbi fejlesztés során a True érték a muzeális lapokat fogja jelölni, amelyeknek az archívumai már nem frissülnek, és csak különleges esetben kell újból futtatni rajtuk a botot. (Még nincs beépítve.)
régidátum
A későbbi fejlesztés során egy reguláris kifejezés állhat majd itt, amely a 2004-ig használt (kissé zagyva) ősi dátumbélyegzőket definiálja. A legtöbb konfigurációban ez nem szükséges, a régi Kocsmafal meg Porta archívumánál és néhány nagyon alacsony regszámú usernél lehet szerepe. Még nincs beépítve, de a bot addig is működik, csak a dátumokat nem fogja felismerni ezekben a szakaszokban. (Itt látható, hogy fog működni.)
*
Bármilyen megjegyzést írhatsz ide, csak ne tegyél szóközt a csillag elé. Egyedi konfigurációban |*, központi laposban :* az alakja.
Példa
A saját tartalomjegyzékemnek ez a kísérleti változata három sablont tartalmaz (abból kettő paraméteres) és két kategóriát (az egyikben rendezést is). Az ehhez tartozó konfiguráció, amelyet a vitalapom bevezetőjébe írtam:
{{user:BinBot/config
 |rex = Archív/[BBBB BBBB]
 |* Szerintem ez egy komment
 |sablon = ambox|type=notice|text=Próba: így lehet beilleszteni egy sablont két paraméterrel
 |sablon = SN
 |sablon = bedolgoz|Kuka
 |kat = TOCbot|*
 |kat = Személyes tartalomjegyzékek
}}

HírlevélSzerkesztés

Az újítások, fejlesztések a későbbiekben a Szerkesztő:Bináris/TOCbot/Newsletter lapon fognak megjelenni, ezt érdemes figyelőlistára tenni. A Szerkesztő:Bináris/TOCbot/Newsletter/subscribers lapon lehet feliratkozni e-mailes értesítésre is, de ez inkább a külföldieknek hasznos.

Ha nem működik valamiSzerkesztés

  • Ellenőrizd, hogy a konfigurációd alakilag megfelel-e a #Konfiguráció szakaszban leírtaknak, és csak az ott felsorolt háromféle sort tartalmazza. Bármilyen más sor (üres sor, elgépelt paraméter, nagybetűs paraméter) hatására megszakad a feldolgozás.
  • Az archívumneveid a főlaphoz képest relatívan vannak megadva? A / jel az elején nem kell.
  • Ha van holvan vagy hova paraméter a konfigurációdban, az abszolút címmel van megadva? Tehát olyannal, amit a keresőbe írva egyből arra a lapra jutnál. Csak ez a kettő, ami nem relatív a főlaphoz képest.
  • Jól írtad a rexeket? Keress hasonló példákat a mintaoldalon, figyelj oda a nagy- és kisbetűkre, és olvasd el még egyszer az #Egyéb szempontok szakaszt.
  • Ott keresed a táblázatodat, ahol van? Alapértelmezés szerint ez a vitalapod (vagy más főlap) /Tartalomjegyzék allapja. A hova paraméterrel lehet máshova tenni. Érdemes a tartalomjegyzéket a figyelőlistádra venni.
  • Vannak szakaszcímek az archívumodban? Ha valamelyikben egy sincs, a bot nem tud mit kezdeni vele, mivel a két egyenlőségjeles szakaszokat dolgozza fel. Az első cím előtti részt (pl. egy üdvözlősablon) kihagyja, amint az egy egyenlőségjeles főcímeket is. Ahogy egy könyv tartalomjegyzéke a fejezetek címéből áll össze, ugyanúgy az archívumoké is, ezek pedig a == Szakaszcím == alakú címek. Ezen belül az alcímeket is kigyűjti a bot, de a másodszintű címek vezérlik a feldolgozást. Ha egyik archívumban sincs szakaszcím, akkor üres táblázat keletkezne, amit meg nem ment el a bot. Ha kell, pótold a hiányzó címeket, illetve javítsd őket értelmesre, hogy használható legyen a tartalomjegyzék, és buzdítsad erre a szerkesztőtársaidat is, hogy írjanak értelmes címeket. Mi haszna egy tartalomjegyzéknek, ha harminchét olyan szakasz van benne, amelyiknek a címe Kérdés?
  • A nem szabványos (pl. időzóna nélküli) dátumbélyegzőket a bot nem tudja figyelembe venni sem az első és utolsó hozzászólás dátumának, sem a hozzászólások számának a megállapításánál.
  • Ellenőrizd, hogy a villásdugó jól érzi-e magát a konnektorban. Ha nincs áram a számítógépedben, nem fogod látni a tartalomjegyzéket.
  • Átnevezted netán valamelyik archívumot? Ha igen, frissítsd a konfigurációt, mert átirányításokat a bot nem kezel.
  • Kérd meg a botgazdát, hogy végezzen tesztfuttatást, ami felsorolja az archívumokat. Lehetőleg csak azt követően, hogy minden más lehetőséget kimerítettél és minden ellenőrzést elvégeztél. Vedd figyelembe, hogy a botgazdának nem biztos, hogy a te problémád a legsürgősebb. Fogalmazz pontosan, mondd el, mit tettél és mi a hiba, adjál linkeket, hogy ne kelljen vadászni, és ne legyél türelmetlen.
  • Kérdezd meg a botgazdát, hogy kizárt-e a szolgáltatásból. Erre abban az esetben kerülhet sor, ha nem rendeltetésszerűen próbáltad használni a lehetőséget, vagy ha valamilyen előre nem látható problémát okozott a lapod a feldolgozásban.
  • Ha valamit kijavítottál, természetesen csak a bot következő futása után fogod látni az eredményét, nem azonnal.