Wikipedysta:MalarzBOT/archiwum/config
UWAGA
- bot się uruchamia raz dziennie w godzinach porannych
- dodanie konfiguracji lub jej zmiana będzie skutkować dopiero przy najbliższym uruchomieniu bota
Najprostsze / najszybsze uruchomienie bota
Jeżeli strona nie była nigdy archiwizowana w żaden sposób, wstaw na początku strony dyskusji (przed pierwszym wątkiem):
{{Wikipedysta:MalarzBOT/archiwum/config |licznik = 1 |archiwum = /Archiwum $licznik }}{{archiwum box|box-width=250px|auto=tak}}
Strony będą archiwizowane w podstronach /Archiwum NUMER.
Szablon {{archiwum box}} wstawia automatyczny spis treści archiwów. Szerokość jest ustawiona na 250px (domyślna infoboksów).
W przypadku gdybyś chciał(a) strony archiwizować na podstronach Archiwum/NUMER (slash zamiast spacji oddziela słowo Archiwum od numeru) to konfiguracja powinna wyglądać następująco:
{{Wikipedysta:MalarzBOT/archiwum/config |licznik = 1 |archiwum = /Archiwum/$licznik }}{{archiwum box|box-width=250px|separator=/}}
Do wygenerowania spisu treści numerowanych kolejno archiwów mogą też służyć szablony:
- {{Wikipedysta:MalarzBOT/archiwum/info}} (z informacją o bocie archiwizującym, dopasowany tylko do pierwszej konfiguracji)
- {{spis treści archiwum}} (uniwersalny)
Wywołanie proste
W większości przypadków wystarczy użyć prostego wywołania. Aby zadziałało można użyć tylko część parametrów:
{{Wikipedysta:MalarzBOT/archiwum/config |minimum = |licznik = |archiwum = |max rozmiar = |max wątki = |nowe = |dni = |co najmniej = }}
Puste można w wywołaniu pominąć. Aby bot użył tę konfigurację muszą zostać spełnione wszystkie następujące warunki:
- w nazwie archiwum musi być użyty $licznik albo $year
- jeżeli w nazwie archiwum jest użyty $licznik to musi być podany licznik
- nazwa archiwum musi być podana jako względna w stosunku do archiwizowanej strony; musi zaczynać się od znaku "/"
- nie można użyć opcji: "poziom", "spis treści" ani "wątki"
- archiwizacja musi dotyczyć strony z którejkolwiek przestrzeni dyskusji
- parametr "max rozmiar" nie może być mniejszy niż 50k ani większy niż 250k (o ile podany)
- parametr "max wątki" nie może być mniejszy niż 50 ani większy niż 200 (o ile podany)
- parametr "minimum" nie może być mniejszy niż 5 ani większy niż 25 (o ile podany)
- parametr "dni" nie może być mniejszy niż 7 ani większy od 90 (o ile podany)
- parametr "co najmniej" nie może być mniejszy niż 2 ani większy niż 10 (o ile podany)
Przykład
{{Wikipedysta:MalarzBOT/archiwum/config |minimum = 5 |licznik = 1 |archiwum = /Archiwum/$licznik |max rozmiar = 100k |dni = 14 }}
Archiwizacja będzie następowała do podstron "/Archiwum/numer" bieżącej strony dyskusji. Archiwizacja zacznie się od podstrony o numerze 1. Archiwizowane będą wątki starsze niż 14 dni w taki sposób aby przynajmniej 5 najmłodszych wątków w dyskusji pozostało niezarchiwizowanych. Nowa podstrona archiwum zostanie utworzona gdy poprzednia przekroczy objętość 100k.
Zachęcam do użycia {{spis treści archiwum}} do wygenerowania spisu treści dla tak utworzonych archiwów. Jeżeli nazwy stron będą tak nazywane jak w przykładzie to szablon bez parametrów będzie działał poprawnie. Jak będą się różniły to trzeba do wywołania tego szablonu dodać dodatkowe parametry. ~malarz pl PISZ 22:53, 7 mar 2011 (CET)
Wywołanie zaawansowane
Wymagany udział malarz pl w konfiguracji.
{{Wikipedysta:MalarzBOT/archiwum/config |metoda = |minimum = |licznik = |archiwum = |max rozmiar = |max wątki = |zawiera = |nie zawiera = |nowe = |dni = |bezwarunkowo dni = |co najmniej = |poziom = |spis treści = |wątki = |kod = }}
Opis parametrów
- metoda
- archiwum lub usuń
- minimum
- minimalna liczba wątków pozostawionych w archiwizowanej dyskusji; domyślnie 0
- licznik
- bieżący kolejny numer archiwum; w wywołaniu prostym musi mieć jakąś wartość
- archiwum
- plik (artykuł) z archiwum; w wywołaniu prostym należy podać ścieżkę względną w stosunku do dyskusji (z "/" na początku)
- w tej nazwie można podać następujące zmienne
- $licznik - numer archiwum
- $year - rok
- $month - polska nazwa miesiąca
- $monn - numer miesiąca
- $mon0n - dwucyfrowy numer miesiąca
- $mon3 - numer kwartału
- $mon6 - numer półrocza
- $day10 - numer 1/3 miesiąca
- $day15 - numer połówki miesiąca
- max rozmiar
- maksymalny rozmiar (w bajtach) archiwum; domyślnie 200k
- max wątki
- maksymalny rozmiar (w wątkach) archiwum; jeżeli ustawiony to rozmiar w bajtach nie jest brany pod uwagę
- zawiera
- (regexp) jeżeli znaleziony w wątku to watek podlega archiwizacji
- nie zawiera
- (regexp) jeżeli znaleziony w wątku to wątek nie podlega archiwizacji; ma pierwszeństwo przed "zawiera"
- nowe
- zawartość nagłówka nowego archiwum; domyślnie {{archiwum}}
- dni
- liczba dni, po których wątek podlega archiwizacji; domyślnie 31
- bezwarunkowo dni
- liczba dni, po których wątek podlega archiwizacji bez względu na pozostałe warunki
- co najmniej
- minimalna liczba wątków spełniająca pozostałe warunki archiwizacji, która spowoduje włączenie procesu archiwizacji; domyślnie 1 (dla opcji zaawansowanych) lub 2 (dla opcji prostych)
- poziom
- poziom nagłówków
- spis treści
- artykuł ze spisem treści
- wątki
- początek nazwy wątku dla dyskusji w podstronach
- kod
- kod autoryzacyjny dla specjalnych konfiguracji