Изворни код странице Корисник:MickiBot/Упутство

{{warning|Пре него што подесите аутоматско архивирање неке странице, молим Вас да се уверите да за то постоји консензус.}}<br>
== Подешавање аутоматског архивирања ==
Ставите следећи шаблон на ''врх'' странице коју желите да бот архивира:

{{warning|Уколико '''само ископирате''' доњи кôд, архивирање '''неће функционисати''' - погледајте у даљем тексту неке од конкретних примера.}}

<pre style="overflow: auto">
{{MickiBot/archive
| algo    = old(...)
| archive = Назив странице на коју се архивира садржај
[остали параметри - ***погледајте испод***]
}}
</pre>

Па, можда '''не баш тако''' (прочитајте испод који су све параметри неопходни), али то је отприлике то. Успут, [[Шаблон:MickiBot/archive|шаблон]] је '''потпуно празан (нема никакав садржај)''', тако да не морате да бринете како ће страница изгледати након његовог додавања :)

Бот очекује да види само један параметар по линији. Заграде за затварање шаблона <tt>}}</tt> морају да буду у засебној линији и пре њих не сме да буде празнина. Уколико читав шаблон ставите у једну линију (уместо као у горњем примеру), бот можда неће правилно функционисати.

Такође, шаблон мора да буде смештен:
#пре првог <tt>==поднаслова==</tt> на страници
#на конкретној страници, а не на њеним подстраницама.

== Примери ==

:<span style="color:darkred;">'''Замените „''Разговор са корисником:Пример''“ називом одговарајуће странице!'''</span>
:<span style="color:darkgreen;">'''Уколико архивирање и даље не функционише, прочитајте испод о опцијама „''minthreadsleft''“ и „''minthreadstoarchive''“.'''</span>

=== Пример 1 ===
{{warning|Иако је најједноставнији, овај пример вероватно није баш најбољи избор - пример бр. 2 је знатно бољи.}}

<pre style="overflow: auto">
{{MickiBot/archive
| algo    = old(7d)
| archive = Разговор са корисником:Пример/1
}}
</pre>

Ово омогућава архивирање садржаја са странице [[Разговор са корисником:Пример]] на страницу [[Разговор са корисником:Пример/1]] и то оних поднаслова који су старији од 7 дана (рачунајући од најновијег коментара у том поднаслову). У овом примеру архива '''ће расти бесконачно'''. То и није баш препоручљиво (осим код слања садржаја у неку врсту „канте за ђубре“ која се периодично празни или уколико желите сами да одлучите када бот треба да пређе на следећу страницу за архивирање).

=== Пример 2 ===
<pre style="overflow: auto">
{{MickiBot/archive
| archiveheader       = {{заглавље архиве}}
| maxarchivesize      = 70K
| counter             = 1
| minthreadsleft      = 4
| minthreadstoarchive = 1
| algo                = old(31d)
| archive             = Разговор са корисником:Пример/%(counter)d
}}
</pre>

Ово говори боту да архивира поднаслове старије од месец дана (31 дан) (остављајући 4 најновија поднаслова) са странице [[Разговор са корисником:Пример]] на страницу [[Разговор са корисником:Пример/1]] (прочитајте [[#Променљиве|испод]] о варијаблама) све док архива не достигне величину од 70 килобајта, након чега ће бот наставити да архивира садржај на страницу [[Разговор са корисником:Пример/2]] (аутоматски подешавајући бројач - counter - приликом снимања странице). Не заборавите да '''задате максималну величину''' архиве јер ће она, у супротном, наставити да расте бесконачно - као у првом примеру. Осим тога, бот у сваку архиву додаје {{tl|заглавље архиве}} (можете да убаците и неки свој шаблон), што олакшава навигацију.

=== Пример 3 ===
{{warning|'''Не''' мењајте променљиве „year“ (година) и „monthname“ (назив месеца).}}

<pre style="overflow: auto">
{{MickiBot/archive
| algo    = old(5d)
| archive = Разговор са корисником:Пример/Архива/%(year)d/%(monthname)s
}}
</pre>

Код овог подешавања, поднаслови старији од 5 дана биће смештени у архиве у зависности од њиховог датума, односно у зависности од датума најновијег коментара у конкретном поднаслову. О варијаблама можете да прочитате [[#Променљиве|испод]].

== Објашњење параметара ==
<pre>
{{MickiBot/archive 
| archiveheader       = 
| maxarchivesize      = 
| counter             = 
| minthreadsleft      = 
| minthreadstoarchive = 
| algo                = 
| archive             = 
}}
</pre>

{| class = "wikitable"
! Параметар || Опис
|-
| <tt>archiveheader</tt> || Шаблон или неки други садржај који ће бити стављен на врх архива. Овде је могуће коришћење [[#Променљиве|варијабли]]. Вредност овог параметра ''мора'' да буде у једној линији! Користите шаблоне попут {{tl|заглавље архиве}} уколико желите да додате више садржаја. Подразумевана вредност је {{tl|заглавље архиве}}.
|-
| <tt>maxarchivesize</tt> || Максимална величина архиве пре промене бројача. Бот игнорише овај параметар уколико бројач није у употреби. Унесена вредност мора да буде у формату „бројK“, уз употребу великог '''латиничног''' слова „K“. На пример: <tt>maxarchivesize=256K</tt>
|-
| <tt>counter</tt> || Тренутна вредност бројача. Уколико варијабла <tt>%(counter)d</tt> није у употреби, бот игнорише овај параметар. Бот ће аутоматски мењати (апдејтовати) бројач када то буде неопходно.
|-
| <tt>minthreadsleft</tt> || Минималан број поднаслова који треба да буду остављени на страници (како странице не би биле потпуно празне). Подразумевана вредност: 5
|-
| <tt>minthreadstoarchive</tt> || Минималан број поднаслова који треба да буду архивирани. Бот неће архивирати страницу уколико би требало да се архивира мањи број поднаслова од задатог. Подразумевана вредност: 2
|-
| <tt>algo</tt> || Алгоритам који упућује бота како да одлучи да ли да архивира неки поднаслов или не. Сложене формуле (укључујући regex matching) ће бити омогућене касније, али за сада овај параметар '''мора''' да буде у формату '''<tt>old(...)</tt>''' где '''<tt>...</tt>''' одређује максималну старост поднаслова (у сатима или данима: <tt>24h</tt>, <tt>72h</tt>, <tt>5d</tt>, <tt>21d</tt> итд). Подразумевана вредност: <tt>old(24h)</tt>
|-
| <tt>archive</tt> || Назив странице на коју ће бити архивиран садржај. Овде је могуће коришћење [[#Променљиве|варијабли]], које омогућавају прављење архива са променљивим називом (као што је нпр. коришћење датума у наслову архиве). Имајте на уму да [[Помоћ:Магичне речи|магичне речи]] и шаблони не раде код овог параметра, као и да архива мора да буде подстраница тренутне странице.
|}

== Променљиве ==
{| class = "wikitable"
! Променљива || Односи се на...
|-
| <tt>%(counter)d</tt> || тренутна вредност бројача - <tt>counter</tt>
|-
| <tt>%(year)d</tt> || година у наслову странице у коју се архивирају поднаслови
|-
| <tt>%(month)d</tt> || месец (број 1-12) у наслову странице у коју се архивирају поднаслови
|-
| <tt>%(monthname)s</tt> || пун назив месеца из горњег примера
|-
| <tt>%(monthnameshort)s</tt> || прва три слова у називу месеца из горњег примера
|}

Неколико напомена:
*уверите се да не нисте забрљали последње слово након заграде (треба да буде '''латинично''' слово „d“ за [[Цео број|целе бројеве]] и '''латинично''' слово „s“ за [[Ниска|ниске]])
*променљиве са целим бројем могу да почињу нулом:
*:<tt>%(counter)03d</tt> даје <tt>013</tt> уколико је вредност бројача - <tt>counter</tt> број 13,
*:<tt>%(month)02d</tt> даје <tt>05</tt> за месец мај итд.

== Након што сте подесили архивирање ==
Бот се покреће периодично. Сачекајте следећи циклус и требало би да видите измене које је начинио бот у историји конкретних страница, под условом да има шта да се архивира. У опису измена би требало да буде дат и линк ка страници на коју је садржај архивиран.<br />

Различити шаблони могу да се користе као заглавље, јер дају преглед и омогућавају лаку навигацију између архива.  Обично се додају на врх страница. Неки од таквих шаблона су:
* <code>{{tl|заглавље архиве}}</code>
* <code>{{tl|заглавље архива администраторска табла}}</code>
* <code>{{tl|заглавље архива чланци за брисање}}</code>

а можете да направите и неко своје заглавље.

== Одлагање или спречавање архивирања ==
Аутоматско архивирање одређеног поднаслова може да буде одложено или спречено додавањем '''супституисаног''' шаблона {{tl|DNAU}} у тај поднаслов.  Дакле, користите <code><nowiki>{{subst:DNAU}}</nowiki></code> да спречите архивирање поднаслова на неодређено, или <code><nowiki>{{subst:DNAU|<цео_број>}}</nowiki></code> да одложите архивирање поднаслова за <цео_број> дана. На пример, <code><nowiki>{{subst:DNAU|50}}</nowiki></code> ће одложити архивирање конкретног поднаслова за 50 дана.