Изворни код странице Корисник:Kadzo/Bot/Uputstvo

{{warning|Pre nego što podesite automatsko arhiviranje neke stranice, molim Vas da se uverite da za to postoji konsenzus.}}<br>
== Podešavanje automatskog arhiviranja ==
Stavite sledeći šablon na ''vrh'' stranice koju želite da bot arhivira:

{{warning|Ukoliko '''samo iskopirate''' donji kôd, arhiviranje '''neće funkcionisati''' - pogledajte u daljem tekstu neke od konkretnih primera.}}

<pre style="overflow: auto">
{{Korisnik:Kadzo/Bot/archive
| algo    = old(...)
| archive = Naziv stranice na koju se arhivira sadržaj
[ostali parametri - ***pogledajte ispod***]
}}
</pre>

Pa, možda '''ne baš tako''' (pročitajte ispod koji su sve parametri neophodni), ali to je otprilike to. Usput, [[Šablon:Kadzo/archive|šablon]] je '''potpuno prazan (nema nikakav sadržaj)''', tako da ne morate da brinete kako će stranica izgledati nakon njegovog dodavanja :)
Bot očekuje da vidi samo jedan parametar po liniji. Zagrade za zatvaranje šablona <tt>}}</tt> moraju da budu u zasebnoj liniji i pre njih ne sme da bude praznina. Ukoliko čitav šablon stavite u jednu liniju (umesto kao u gornjem primeru), bot možda neće pravilno funkcionisati.

Takođe, šablon mora da bude smešten:
#pre prvog <tt>==podnaslova==</tt> na stranici
#na konkretnoj stranici, a ne na njenim podstranicama.

== Primeri ==

:<span style="color:darkred;">'''Zamenite „''Razgovor sa korisnikom:Primer''“ nazivom odgovarajuće stranice!'''</span>
:<span style="color:darkgreen;">'''Ukoliko arhiviranje i dalje ne funkcioniše, pročitajte ispod o opcijama „''minthreadsleft''“ i „''minthreadstoarchive''“.'''</span>

=== Primer 1 ===
{{warning|Iako je najjednostavniji, ovaj primer verovatno nije baš najbolji izbor - primer br. 2 je znatno bolji.}}

<pre style="overflow: auto">
{{Korisnik:Kadzo/Bot/archive
| algo    = old(7d)
| archive = Razgovor sa korisnikom:Primer/1
}}
</pre>

Ovo omogućava arhiviranje sadržaja sa stranice [[Razgovor sa korisnikom:Primer]] na stranicu [[Razgovor sa korisnikom:Primer/1]] i to onih podnaslova koji su stariji od 7 dana (računajući od najnovijeg komentara u tom podnaslovu). U ovom primeru arhiva '''će rasti beskonačno'''. To i nije baš preporučljivo (osim kod slanja sadržaja u neku vrstu „kante za đubre“ koja se periodično prazni ili ukoliko želite sami da odlučite kada bot treba da pređe na sledeću stranicu za arhiviranje).

=== Primer 2 ===
<pre style="overflow: auto">
{{Korisnik:Kadzo/Bot/archive
| archiveheader       = {{zaglavlje arhive}}
| maxarchivesize      = 70K
| counter             = 1
| minthreadsleft      = 4
| minthreadstoarchive = 1
| algo                = old(31d)
| archive             = Razgovor sa korisnikom:Primer/%(counter)d
}}
</pre>

Ovo govori botu da arhivira podnaslove starije od mesec dana (31 dan) (ostavljajući 4 najnovija podnaslova) sa stranice [[Razgovor sa korisnikom:Primer]] na stranicu [[Razgovor sa korisnikom:Primer/1]] (pročitajte [[#Promenljive|ispod]] o varijablama) sve dok arhiva ne dostigne veličinu od 70 kilobajta, nakon čega će bot nastaviti da arhivira sadržaj na stranicu [[Razgovor sa korisnikom:Primer/2]] (automatski podešavajući brojač - counter - prilikom snimanja stranice). Ne zaboravite da '''zadate maksimalnu veličinu''' arhive jer će ona, u suprotnom, nastaviti da raste beskonačno - kao u prvom primeru. Osim toga, bot u svaku arhivu dodaje {{tl|zaglavlje arhive}} (možete da ubacite i neki svoj šablon), što olakšava navigaciju.

=== Primer 3 ===
{{warning|'''Ne''' menjajte promenljive „year“ (godina) i „monthname“ (naziv meseca).}}

<pre style="overflow: auto">
{{Korisnik:Kadzo/Bot/archive
| algo    = old(5d)
| archive = Razgovor sa korisnikom:Primer/Arhiva/%(year)d/%(monthname)s
}}
</pre>

Kod ovog podešavanja, podnaslovi stariji od 5 dana biće smešteni u arhive u zavisnosti od njihovog datuma, odnosno u zavisnosti od datuma najnovijeg komentara u konkretnom podnaslovu. O varijablama možete da pročitate [[#Promenljive|ispod]].

== Objašnjenje parametara ==
<pre>
{{Korisnik:Kadzo/Bot/archive
| archiveheader       = 
| maxarchivesize      = 
| counter             = 
| minthreadsleft      = 
| minthreadstoarchive = 
| algo                = 
| archive             = 
}}
</pre>

{| class = "wikitable"
! Parametar || Opis
|-
| <tt>archiveheader</tt> || Šablon ili neki drugi sadržaj koji će biti stavljen na vrh arhiva. Ovde je moguće korišćenje [[#Promenljive|varijabli]]. Vrednost ovog parametra ''mora'' da bude u jednoj liniji! Koristite šablone poput {{tl|zaglavlje arhive}} ukoliko želite da dodate više sadržaja. Podrazumevana vrednost je {{tl|zaglavlje arhive}}.
|-
| <tt>maxarchivesize</tt> || Maksimalna veličina arhive pre promene brojača. Bot ignoriše ovaj parametar ukoliko brojač nije u upotrebi. Unesena vrednost mora da bude u formatu „brojK“, uz upotrebu velikog '''latiničnog''' slova „K“. Na primer: <tt>maxarchivesize=256K</tt>
|-
| <tt>counter</tt> || Trenutna vrednost brojača. Ukoliko varijabla <tt>%(counter)d</tt> nije u upotrebi, bot ignoriše ovaj parametar. Bot će automatski menjati (apdejtovati) brojač kada to bude neophodno.
|-
| <tt>minthreadsleft</tt> || Minimalan broj podnaslova koji treba da budu ostavljeni na stranici (kako stranice ne bi bile potpuno prazne). Podrazumevana vrednost: 5
|-
| <tt>minthreadstoarchive</tt> || Minimalan broj podnaslova koji treba da budu arhivirani. Bot neće arhivirati stranicu ukoliko bi trebalo da se arhivira manji broj podnaslova od zadatog. Podrazumevana vrednost: 2
|-
| <tt>algo</tt> || Algoritam koji upućuje bota kako da odluči da li da arhivira neki podnaslov ili ne. Složene formule (uključujući regex matching) će biti omogućene kasnije, ali za sada ovaj parametar '''mora''' da bude u formatu '''<tt>old(...)</tt>''' gde '''<tt>...</tt>''' određuje maksimalnu starost podnaslova (u satima ili danima: <tt>24h</tt>, <tt>72h</tt>, <tt>5d</tt>, <tt>21d</tt> itd). Podrazumevana vrednost: <tt>old(24h)</tt>
|-
| <tt>archive</tt> || Naziv stranice na koju će biti arhiviran sadržaj. Ovde je moguće korišćenje [[#Promenljive|varijabli]], koje omogućavaju pravljenje arhiva sa promenljivim nazivom (kao što je npr. korišćenje datuma u naslovu arhive). Imajte na umu da [[Pomoć:Magične reči|magične reči]] i šabloni ne rade kod ovog parametra, kao i da arhiva mora da bude podstranica trenutne stranice.
|}

== Promenljive ==
{| class = "wikitable"
! Promenljiva || Odnosi se na...
|-
| <tt>%(counter)d</tt> || trenutna vrednost brojača - <tt>counter</tt>
|-
| <tt>%(year)d</tt> || godina u naslovu stranice u koju se arhiviraju podnaslovi
|-
| <tt>%(month)d</tt> || mesec (broj 1-12) u naslovu stranice u koju se arhiviraju podnaslovi
|-
| <tt>%(monthname)s</tt> || pun naziv meseca iz gornjeg primera
|-
| <tt>%(monthnameshort)s</tt> || prva tri slova u nazivu meseca iz gornjeg primera
|}


Nekoliko napomena:

*uverite se da ne niste zabrljali poslednje slovo nakon zagrade (treba da bude '''latinično''' slovo „d“ za [[Ceo broj|cele brojeve]] i '''latinično''' slovo „s“ za [[Niska|niske]])
*promenljive sa celim brojem mogu da počinju nulom:
*:<tt>%(counter)03d</tt> daje <tt>013</tt> ukoliko je vrednost brojača - <tt>counter</tt> broj 13,
*:<tt>%(month)02d</tt> daje <tt>05</tt> za mesec maj itd.

== Nakon što ste podesili arhiviranje ==
Bot se pokreće periodično. Sačekajte sledeći ciklus i trebalo bi da vidite izmene koje je načinio bot u istoriji konkretnih stranica, pod uslovom da ima šta da se arhivira. U opisu izmena bi trebalo da bude dat i link ka stranici na koju je sadržaj arhiviran.<br />

Različiti šabloni mogu da se koriste kao zaglavlje, jer daju pregled i omogućavaju laku navigaciju između arhiva.  Obično se dodaju na vrh stranica. Neki od takvih šablona su:
* <code>{{tl|zaglavlje arhive}}</code>
* <code>{{tl|zaglavlje arhiva administratorska tabla}}</code>
* <code>{{tl|zaglavlje arhiva članci za brisanje}}</code>


a možete da napravite i neko svoje zaglavlje.

== Odlaganje ili sprečavanje arhiviranja ==

Automatsko arhiviranje određenog podnaslova može da bude odloženo ili sprečeno dodavanjem '''supstituisanog''' šablona {{tl|DNAU}} u taj podnaslov.  Dakle, koristite <code><nowiki>{{subst:DNAU}}</nowiki></code> da sprečite arhiviranje podnaslova na neodređeno, ili <code><nowiki>{{subst:DNAU|<ceo_broj>}}</nowiki></code> da odložite arhiviranje podnaslova za <ceo_broj> dana. Na primer, <code><nowiki>{{subst:DNAU|50}}</nowiki></code> će odložiti arhiviranje konkretnog podnaslova za 50 dana.