Szablon:Dane tekstu2

Dokumentacja

Ten opis jest dołączany ze strony Szablon:Dane tekstu2/opis. (edytuj | historia)

Wyjaśnienie

Wyjaśnić cel i sposób działania szablonu można na kilka sposobów:

Najprostsze wyjaśnienie

Na wyjściowej stronie (zazwyczaj strona główna w przestrzeni głównej)

Aby ustalić na wszystkich stronach (wyjściowej i wywołujących) dany parametr dajemy np.: | pochodzenie = Ciekawa książka
Aby ustalić na wszystkich stronach z wyjątkiem wyjściowej dany parametr dajemy np.: | _pochodzenie = Ciekawa książka

Albo co jest równoważne: | _pochodzenie = Ciekawa książka
Albo co jest równoważne: | pochodzenie =
Albo co jest równoważne: | pochodzenie =
Albo co jest równoważne: | _pochodzenie = Ciekawa książka

Aby ustalić parametr tylko dla strony wyjściowej damy np.: | okładka = link_do_okładki
Aby ustalić parametr tylko dla strony wyjściowej damy np.: | _okładka =

Albo co jest równoważne: | _okładka =
Albo co jest równoważne: | okładka = link_do_okładki

Na stronie wywołującej argument może zostać dowolnie „nadpisany” (oczywiście już bez podkreślenia).

np.: na stronie Ciekawa książka/całość : | inne = {{epub}}

Wywołanie szablonu już wywołującego (przez argument referencja) inny szablon zwraca błąd.

Bardziej formalne wyjaśnienie

Szablon Dane tekstu2 oferuje znaną funkcjonalność szablonu {{Dane tekstu}} ale dodatkowo:

• jeśli jest wywołany z argumentem referencja szuka na danej stronie w pierwszym szablonie na tej stronie pól dla danych tekstu
• jeśli natrafi w szablonie referencyjnym na argument referencja, zwraca informację, że pobrane mogą być dane tylko z szablonu, który sam nie dziedziczy już danych
• argumenty szablonu zmieniają lub dopisują argumenty dziedziczonego szablonu (referencyjnego)
• jeśli argument jest poprzedzony znakiem podkreślenia _, nie jest on ewaluowany, jednak gdy jest odziedziczony, to z kolei jest używany zamiast danego argumentu.

Inne wyjaśnienie

Argumenty ze strony wyjściowej są oznaczane na zielono; argumenty ze strony wywołującej są oznaczane na niebiesko.
Na stronie wyjściowej (na której nie ma argumentu | referencja = ...) obowiązuje następująca reguła:

• | _parametr = ... → ∅ (np.: | _pochodzenie = ... jest pomijany)

Na stronie wywołującej

1. W pierwszym kroku argumenty strony wyjściowej są doklejane (wkopiowywane) do argumentów ze strony wywołującej
2. W drugim kroku argumenty są ewaluowane wg następujących reguł:
   • | referencja = ... + | referencja = ... → BŁĄD (Możliwe jedynie pojedyncze odwołanie.)
   • | _parametr = ... → ∅ (np. | _pochodzenie = ... jest pomijany)
   • | parametr = XXX + | _parametr = YYY → | parametr = YYY
   • | _parametr = YYY → | parametr = YYY
   • | parametr = XXX + | parametr = ZZZ → | parametr = ZZZ

Czwarte wyjaśnienie

Argumenty ze strony wyjściowej są oznaczane na zielono; argumenty ze strony wywołującej są oznaczane na niebiesko.
Na stronie wyjściowej (na której nie ma argumentu | referencja = ...) obowiązuje następująca reguła:

• | _parametr = ... → ∅ (np.: | _pochodzenie = ... jest pomijany)

Na stronie wywołującej

1. W pierwszym kroku argumenty strony wyjściowej są wklejane (wkopiowywane) do argumentów ze strony wywołującej w miejscu | referencja = ...
2. W drugim kroku argumenty są ewaluowane wg następujących reguł:
   • | referencja = ... → BŁĄD (Możliwe jedynie pojedyncze odwołanie.)
   • Właściwa wartość danego pola (argumentu jest ustalana wg pierwszej występującej wartości w kolejności | parametr = ZZZ , | _parametr = YYY , | parametr = XXX

Praktyczne wskazówki

• parametr referencja określa referencyjną stronę, z niej ściągane są dane. Najczęściej będzie to

 | referencja = {{ROOTPAGENAME}}

• Na przykład chcąc zrezygnować z okładki napiszemy | okładka = | strona z okładką =
• chcąc dodać pole pochodzenie napiszemy | pochodzenie = tutaj skąd pochodzi
• chcąc zmienić autora (np. dla wstępu) napiszemy | autor = Jan Kowalski

Jako wynik uzyskamy na nowo wywołany szablon z danymi tekstu.

Podwójne dziedziczenie

Szablon dopuszcza również podwójne dziedziczenie, choć budowa strony staje się przez to nieco trudniejsza do analizy.

Jako alternatywę można:

• na stronie wyjściowej zastosować jakąś konstrukcję warunkową badającą nazwę strony i zwracającą właściwą wartość ({{#switch:...}} lub {{#ifeq:...}}
• zastosować szablon {{takjak}} i adres podać w sposób dynamiczny (np. {{ROOTPAGENAME}})

Przykłady

Strona wyjściowa	Efekt na stronie wyjściowej jak	Strona wywołująca	Efekt na stronie wywołującej jak
Dane tekstu2 ⋮ | pochodzenie = Ciekawa książka ⋮	Dane tekstu ⋮ | pochodzenie = Ciekawa książka ⋮	Dane tekstu2 ⋮ | referencja = Strona główna ⋮	Dane tekstu ⋮ | pochodzenie = Ciekawa książka ⋮
Dane tekstu2 ⋮ | pochodzenie = Ciekawa książka ⋮	Dane tekstu ⋮ | pochodzenie = Ciekawa książka ⋮	Dane tekstu2 ⋮ | referencja = Strona główna ⋮ | pochodzenie = Nudna książka ⋮	Dane tekstu ⋮ | pochodzenie = Nudna książka ⋮
Dane tekstu2 ⋮ | pochodzenie = Ciekawa książka ⋮	Dane tekstu ⋮ | pochodzenie = Ciekawa książka ⋮	Dane tekstu2 ⋮ | referencja = Strona główna ⋮ | pochodzenie = ⋮	Dane tekstu ⋮ | pochodzenie = ⋮
Dane tekstu2 ⋮ | pochodzenie = Ciekawa książka ⋮	Dane tekstu ⋮ | pochodzenie = Ciekawa książka ⋮	Dane tekstu2 ⋮ | referencja = Strona główna ⋮ | pochodzenie = Nudna książka ⋮	Dane tekstu ⋮ | pochodzenie = Nudna książka ⋮
Dane tekstu2 ⋮ | _pochodzenie = Ciekawa książka ⋮	Dane tekstu ⋮ | pochodzenie = ⋮	Dane tekstu2 ⋮ | referencja = Strona główna ⋮	Dane tekstu ⋮ | pochodzenie = Ciekawa książka ⋮
Dane tekstu2 ⋮ | pochodzenie = Ciekawa książka | _pochodzenie = Nudna książka ⋮	Dane tekstu ⋮ | pochodzenie = Ciekawa książka ⋮	Dane tekstu2 ⋮ | referencja = Strona główna ⋮	Dane tekstu ⋮ | pochodzenie = Nudna książka ⋮
Dane tekstu2 ⋮ | pochodzenie = Ciekawa książka | _pochodzenie = Nudna książka ⋮	Dane tekstu ⋮ | pochodzenie = Ciekawa książka ⋮	Dane tekstu2 ⋮ | referencja = Strona główna | pochodzenie = Bzdurna książka ⋮	Dane tekstu ⋮ | pochodzenie = Bzdurna książka ⋮

Określenie strony wyjściowej

W parametrze referencja określona jest strona wyjściowa, na podstawie której tworzona jest metryka dokumentu (czyli wszystkie dane opisujące formalnie dokument np. rok wydania, autor itp.).
Biorąc pod uwagę, że nazwy stron mogą się kiedyś zmienić – na przykład, gdy pojawi się drugi tekst o tej samej nazwie – warto ten parametr określić dynamicznie.

Można to zrobić na trzy sposoby:

• jako nazwę strony do pierwszego ukośnika | referencja = {{ROOTPAGENAME}} – dla tekstów złożonych z części, rozdziałów itp.
• wg tytułu określonego w indeksie | referencja = {{tfi| Źródło (indeks) dokumentu }} – dla zbiorów samodzielnych utworów (np. tomiki wierszy, zbiory nowel)
• „na sztywno” wpisując nazwę tekstu wyjściowego (adres strony).

Rozwiązanie pierwsze jest zdecydowanie najlepsze powinno być stosowane zawsze, gdy części tekstu mają wspólną pierwszą część nazwy ze stroną wyjściową ({{ROOTPAGENAME}}). Rozwiązanie trzecie jest najgorsze, powinno być stosowane wyjątkowo, gdy nie można zastosować innych metod. Rozwiązanie to jest nie do końca zgodne z celem stosowania szablonu {{Dane tekstu2}} tj. automatyzacją, ułatwieniem w przenoszeniu stron, utrzymywaniem spójności wewnętrznej tekstów.