Käyttäjä:HarrivBOT/config

Sivujen arkistointibotin (HarrivBOT) ohje

Ohjeet ovat saatavilla myös englanniksi täällä.

Botin avulla voit asettaa haluamallesi sivulle tapahtumaan automaattisen arkistoinnin. Sinun pitää kuitenkin itse lisätä keskustelusivullesi wikilinkki arkistosivulle.

Arkistoinnin ottaminen käyttöön

Lisää seuraava koodi arkistoitavan sivun yläosaan:

{{Käyttäjä:HarrivBOT/config
| algo    = old(...)
| archive = Arkistosivun nimi
[muut muuttujat - ***lue alta***]
}}

Botti olettaa, että yhdellä rivillä on vain yksi muuttuja. Mallineen sulkevien aaltosulkujen }} täytyy olla omalla rivillä. Ennen pystyviivoja (|) ei saa olla välilyöntejä. Jos poistat ylläolevan esimerkin rivinvaihdot, botti ei välttämättä toimi olettamallasi tavalla.

Mallineen täytyy olla lisäksi

1. ennen ensimmäistä ==toisen tason otsikkoa==
2. oikealla sivulla, sitä ei voi sisällyttää toisen sivun kautta.

Yksinkertaiset esimerkit

Ole hyvä ja muuta "Keskustelu käyttäjästä:Esimerkki" oman keskustelusivusi nimeksi!

Jos koodi ei toimi, lue alta muuttujista "minthreadsleft" ja "minthreadstoarchive".

Esimerkki 1 - yksi arkisto

{{Käyttäjä:HarrivBOT/config
| algo    = old(7d)
| archive = Keskustelu käyttäjästä:Esimerkki
}}

Ylläoleva koodi arkistoi aiheet sivulta Keskustelu käyttäjästä:Esimerkki arkistosivulle Keskustelu käyttäjästä:Esimerkki/Arkisto, kun ne ovat yli 7 päivää vanhoja. Arkisto kasvaa loputtomasti. Tämän takia tämän esimerkin käyttö ei ole järkevää.

Esimerkki 2 - monta arkistoa

{{Käyttäjä:HarrivBOT/config
| algo                = old(31d)
| archive             = Keskustelu käyttäjästä:Esimerkki/Arkisto %(counter)d
| counter             = 1
| maxarchivesize      = 70K
| archiveheader       = {{Arkisto}}
| minthreadstoarchive = 1
| minthreadsleft      = 4
}}

Tässä esimerkissä botti arkistoi yli kuukauden vanhat aiheet (mutta jättää neljä viimeisintä) sivulta Keskustelu käyttäjästä:Esimerkki arkistoon Keskustelu käyttäjästä:Esimerkki/Arkisto 1 (lisätietoja arkistosivun muuttujista alla), kunnes sen koko ylittää 70 kilotavua. Tämän jälkeen botti käyttää sivua 2 (laskuri muuttuu auomaattisesti). Muista määrittää arkiston enimmäiskoko, tai muuten koodi toimii samalla tavalla kuin ensimmäinen esimerkki. Lisäksi jokaiselle arkistosivulle lisätään {{Arkisto}}, merkiksi siitä, että sivu on arkisto.

Esimerkki 3 - arkistosivun nimi kuukauden ja vuoden perusteella

{{Käyttäjä:HarrivBOT/config
| algo    = old(5d)
| archive = Keskustelu käyttäjästä:Esimerkki/Arkistot/%(year)d/%(monthname)s
}}

Tässä koodissa yli 5 päivän vanhat aiheet siirretään arkistoon vuoden ja kuukauden perusteella. Voit lukea muista arkistosivun muuttujista alla.

Muuttujien tarkempi kuvaus

{{Käyttäjä:HarrivBOT/config
| archive             = 
| algo                = 
| counter             = 
| maxarchivesize      = 
| minthreadsleft      = 
| minthreadstoarchive = 
| archiveheader       = 
| key                 = 
}}

Muuttuja	Kuvaus
archive	Sivun, johon arkistoitavat keskustelut siirretään, nimi. Tässä muuttujassa voi käyttää muuttujia, joiden avulla voidaan tehdä selkeästi nimettyjä arkistoja (kuten päiväyksen mukaan). Huomioi, että taikasanat ja mallineet eivät toimi tässä muuttujassa. Lisäksi, jos muuttujaa key ei ole annettu (katso alta), kohdesivun täytyy olla nykyisen sivun alisivu.
algo	Tämän arvon avulla botti päättää, arkistoidaanko aihe vai ei. Monimutkaisemmat muodot (kuten säännölliset lausekkeet) tulevat saataville myöhemmin, mutta tällä hetkellä muuttujan täytyy olla muodossa old(...), jossa ... määrittää, kuinka vanhat aiheet arkistoidaan (tunneissa tai päivissä: esim. 24h → 24 tuntia, 72h → 72 tuntia, 5d → 5 päivää, 21d → päivää jne.)
counter	Lukeman nykyinen arvo. Jos %(counter)d -muuttuja ei ole käytössä, tällä ei ole väliä. HarrivBOT päivittää tämän muuttujan tarpeen vaatiessa.
maxarchivesize	Arkiston enimmäiskoko, kun arkiston koko ylittää tämän, luodaan uusi arkisto. Tällä ei ole väliä jos käytetään vain yhtä arkistosivua. Arvo täytyy antaa muodossa #M, #K tai #T. Esimerkiksi maxarchivesize=256K tarkoittaa, että arkiston koko saa olla enintään 256 kilotavua. M tarkoittaa megatavua ja T (thread) otsikkoa.
minthreadsleft	Aiheiden vähimmäismäärä sivulla (tämän avulla voidaan välttää sivun tyhjentyminen kokonaan). Oletusarvo: 5
minthreadstoarchive	Kerrallaan arkistoitavien aiheiden vähimmäismäärä. Tämän avulla voidaan vähentää muokkaustiheyttä. HarrivBOT ei arkistoi aiheita, jos arkistoitavia on vähemmän kuin tämän muuttujan määritys. Oletusarvo: 2
archiveheader	Koodi, joka lisätään arkistosivujen alkuun. Tässä muuttujassa voi käyttää arkistosivun muuttujia. Tämän muuttujan arvo ei voi olla monirivinen (jos haluat tehdä rivinvaihdon, käytä koodia <br/>)! Voit käyttää esimerkiksi mallinetta {{Arkisto}}.
key	Salattu avain, joka (jos on kelpaava) salliia arkistojen olla myös muilla sivuilla kuin arkistoitavan sivun alisivuilla. Jos tarvitset kyseisen avaimen, ota yhteyttä käyttäjään Harriv ja perustele tarpeesi.

Arkistosivun muuttujat

Muuttuja	korvataan...
%(counter)d	luvun (esimerkiksi arkistosivujen määrä) arvolla
%(year)d	arkistoitavan aiheen vuosi
%(month)d	arkistoitavan aiheen kuukausi (numero 1-12)
%(monthname)s	kuukauden englanninkielinen nimi
%(monthnameshort)s	kolme ensimmäistä kirjainta kuukauden englanninkielisestä nimestä

Kun olet asettanut arkistoinnin

Botti käynnistyy kerran päivässä. Odota vain seuraavaan kierrokseen ja sinun tulisi nähdä botin muutokset arkistoitavan sivun (kuten keskustelusivusi) historiassa, jos sivulla oli arkistoitavaa. Historiassa pitäisi olla myös linkki määrittämääsi arkistosivuun.