Moduł:Sprawdź/opis

To jest podstrona dokumentacji dla modułu {{#invoke:Sprawdź}}.
Zawiera ona informacje na temat sposobu użycia, kategoryzacji modułu i inną zawartość niebędącą częścią oryginalnej strony.

Ten moduł jest klasyfikowany jako gotowy do użytku ogólnego. Osiągnął „dojrzałą” formę, jest uważany za wolny od błędów i gotowy do użycia wszędzie tam, gdzie to właściwe. Jest gotowy do omówienia na stronach pomocy i w innych zasobach Wikibooks jako nowa opcja do nauki dla nowych użytkowników. Aby zmniejszyć obciążenie serwera i uniknąć nieprawidłowych wyników wyjściowych, testy powinny być przeprowadzane brudnopisach, zamiast edycji metodą prób i błędów.

Ten moduł zapewnia platformę programistyczną dla tworzenia szablonów budujących przypadki testowe szablonów Wikibooksa. Przypadki testowe mogą być tworzone ręcznie, aczkolwiek te tworzone za pomocą szablonów opartych na module Lua, takim jak niniejszy moduł, mają taką zaletę, że argumenty szablonu muszą być wprowadzone jedynie jednokrotnie, co zmniejsza nakład pracy konieczny do tworzenia testów, a także zmniejsza ryzyko występowania błędów w danych wejściowych.

`Porównaj`

Ta funkcja jest obecnie wykorzystywana przez szablon {{Przypadek testowy}}.

`Parametry`

Funkcja do wykrywania wywołań szablonów z nierozpoznanymi, pustymi lub przestarzałymi parametrami. Należy ją wywołać ze wszystkimi możliwymi parametrami jakie przyjmuje szablon podlegający sprawdzaniu.

Opis parametrów

pole	opis	status	uwagi
bez nazwy	konfiguracja działania	wymagany	klasa lub klasa odstęp suffix
inny	deklaracja pola obsługiwanego w szablonie	opcjonalny	`txt`, `num`, `num?`, `uri`, `uri?`, `old`, `^…$` lub pusty

Konfiguracja

klasa – ciąg znaków bez spacji umieszczany jako wartość atrybutu class w tagu <span> z wygenerowanym raportem
odstęp – ciąg znaków odstępu oddzielający pozostałą treść konfiguracji, jeśli zawiera znak nowej linii to przed wygenerowanym raportem jest również umieszczany znak nowej linii
suffix – treść dołączana po wygenerowanym raporcie, zwykle deklaracja technicznej kategorii

Sprawdzanie parametrów

pusty – parametr jest opcjonalny, jest to najczęściej stosowany sposób użycia
txt – oczekiwany jest dowolna niepusta wartość pola
num – sprawdzanie czy przekazana wartość jest liczbą
num? – sprawdzanie czy przekazana wartość jest pusta lub jest liczbą
uri – sprawdzanie czy przekazana wartość jest linkiem obsługiwanym przez MediaWiki
uri? – sprawdzanie czy przekazana wartość jest pusta lub jest linkiem
old – informuje, że przekazywany parametr jest przestarzały
^…$ – tekst rozpoczynający się znakiem ^ i zakończony na $ w całości traktowany jest jako wyrażenie regularne Lua wskazującego prawidłowy parametr

Przykład: {{#invoke:Sprawdź|Parametry|=problemy-w-szablonie [[Kategoria:Błędy wywołań w szablonie]]|argument1=|argument2=}}

`odn`

Funkcja sprawdzająca prawidłowość parametrów w {{odn}}.