Szablon:L-pk/opis

Przeznaczenie (użycie)

Dany szablon (makro) formatuje podaną liczbę zgodnie z polską konwencją, w której trzycyfrowe grupy cyfr w części całkowitej są oddzielane spacjami, z tym że w miejscu zwykłych spacji (pozwalają przy wyświetlaniu łamać liczbę pomiędzy wierszami) są wstawiane tzw. spacje twarde, które powodują, że liczba jest zawsze wyświetlana w całości (nie jest łama pomiędzy wierszami). Efekt taki można uzyskiwać tzw. ręcznym wstawianiem w kodzie oznaczeń twardych spacji (  lub   w miejsce spacji zwykłych - szablon wykonuje to za piszącego.

Istotne dane szablonu

Parametry:

• szablon zawiera 1 parametr pozycyjny (numerowy) i 0 (zero) parametrów kluczowych (nazwanych)
• wymaganie podania parametrów pozycyjnych: n/d
• wymagania szczególne dla parametrów kluczowych: n/d
• uwarunkowanie ogólne parametrów kluczowych: n/d
• wykaz parametrów z dokładnym opisem jest podany w następnych sekcjach (wykaz tradycyjny jako strukturyzacja VE)

Wołane szablony (wikimakra):

• Dokumentacja

Wołane funkcje parsera:

• #if

Wołany przez szablon:

• n/d

Magiczna słowA:

• formatnum:...

Wołane inne funkcje:

• Moduł:String (funkcja replace)

Parametry

Opis (format tradycyjny)

Poniższa tabela podaje rozwinięty opis wszystkich parametrów makra.

W pierwszej kolumnie podano typ parametru:

• P - pozycyjny, identyfikowany przez pozycję w wywołaniu szablonu lub nazwę (klucz), którą jest liczba naturalna
• K - kluczowy, identyfikowany w wywołaniu szablonu wyłącznie przez nazwę (klucz)

Druga kolumna zawiera wskazanie, czy parametr jest:

• W - wymagany
• o - opcjonalny

Nazwa	Typ	Rodz.	Opis, sposób nadania wartości i wynik
1	P	W	Liczba do sformatowania - jeśli jest to liczba rzeczywista, to jako znak dziesiętny MUSI być użyty przecinek (zgodnie z polską konwencją), natomiast grupy po trzy cyfry części całkowitej mogą nie być oddzielane lub mogą być oddzielane spacjami zwykłymi lub kropkami (jest to stosowane zamiast spacji). Nie może być zastosowane konwencja anglosaska (znak dziesiętny - kropka, separator grup trzycyfrowych części całkowitej - przecinek). Wartości:
			liczba	Tekst w postaci liczby zgodnie z powyższymi wymaganiami - zostanie wyświetlona zgodnie z polską konwencją wyświetlania liczb
			dowolny tekst	Tekst inny niż liczba - zostanie wyświetlony z wycięciem spacji i kropek.
			<brak>	brak wartości spowoduje wyświetlenie komunikatu Błąd! Makro {{L-pk}} nie otrzymało liczby do sformatowania.

Strukturyzacja VE

Formatowanie liczby do wyświetlania w polskiej konwencji z twardymi spacjami

Parametry szablonu

Dla tego szablonu preferowane jest formatowanie parametrów w linii.

Parametr		Opis	Typ	Status
Liczba	1	Liczba do sformatowania Wartość domyślna brak Przykład 1234567,89 Wartość automatyczna brak	Liczba	opcjonalny

Przykłady

Przekazywana wartość	Wywołanie szablonu	Wynik działania szablonu
Wartości parametru poprawne - zgodne z wymaganiami
1234567,89	{{L-pk|1234567,89}}	1 234 567,89
1 234 567,89	{{L-pk|1 234 567,89}}	1 234 567,89
1.234.567,89	{{L-pk|1.234.567,89}}	1 234 567,89
Wartości parametru błędne - niezgodne z wymaganiami
1,234,567.89	{{L-pk|1,234,567.89}}	1,234,56789
Ależ, więc pójdźmy.	{{L-pk|Ależ, więc pójdźmy.}}	Ależ.więcpójdźmy