Przejdź do zawartości

Szablon:Ramy czasowe zdarzenia/LSnK/opis

Z Wikibooks, biblioteki wolnych podręczników.
Spis treści

Przeznaczenie

[edytuj]

Dany szablon (makro) przekształca podaną w sekundach długość trwania odcinka czasu na tekst opisowy wskazujący, że jest to czas albo dłuższy niż 30 dni albo oznaczający wyliczoną liczbę dni (dób), godzin, minut i sekund.

Istotne dane szablonu

[edytuj]

Parametry:

  • szablon nie zawiera parametrów pozycyjnych (numerowych) i zawiera 1 parametr kluczowy (nazwany)
  • wymaganie podania parametrów pozycyjnych: n/d
  • wymaganie szczególne dla parametrów kluczowych: nie ma
  • uwarunkowanie ogólne parametrów kluczowych: wszystkie są w wywołaniu szablonu opcjonalne
  • wykaz parametrów z dokładnym opisem jest podany w następnej sekcji

Pominięcie wszystkich parametrów nazwanych jest możliwe i nie powoduje błędu.

Wołane szablony (wikimakra):

  • Dokumentacja

Wołane funkcje parsera:

  • #expr
  • #ifexpr
  • #floor

Wołany przez szablon:

Użycie

[edytuj]

Szablon używany jest w standardowy sposób, przez wstawienie do kodu artykułu jego wywołania - tak jak jest podane w poniższych przykładach. W wywołaniu szablonu można nie podawać jedynego parametru nazwanego.

W postaci ogólnej wywołanie szablonu ma poniższą postać - kursywą wskazano miejsca, w których należy wpisać adekwatny tekst:

{{Ramy czasowe zdarzenia/tabela/LSnK|LS=liczba sekund}}

Parametry

[edytuj]

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
LS K o Długość odcinka czasowego w sekundach. Powinna to być liczba naturalna, czyli większa od zera, bez znaków grupowania cyfr. Wartość nienumeryczna wygeneruje komunikat o błędzie, wartość mniejsza od zera - informację o tym oznaczoną jako błąd, a wartość większa niż 2 592 000 informację, że jest to ponad 30 dni.

Wartości:

LS=1000 odcinek liczy 1000 sekund
LS= zostanie podstawiona domyślna długość - 1 sekunda
<brak> jw.

Przykłady

[edytuj]

Przykład ogólny wywołania ze wskazaniem parametru kluczowego, ale bez podania wartości dla niego.

{{Ramy czasowe zdarzenia/LSnK| LS = }}


Przykład nr 1
Przykład ten z kodem jak poniżej:

{{Ramy czasowe zdarzenia/LSnK| LS = 1000000 }}

tworzy poniższy komunikat - tekst podający ile dni, godzin, minut i sekund stanowi jeden milion sekund:

11 dni 13 godz. 46 min 40 s


Przykład nr 2
Przykład ten z kodem jak poniżej podającym nienumeryczną wartość parametru LS:

{{Ramy czasowe zdarzenia/LSnK|LS=abrakadabra}}

tworzy komunikat o błędzie:

Błąd w wyrażeniu – nierozpoznane słowo „abrakadabra”