Pomoc:Metryka dokumentu
1 Wstęp
2 Terminologia
3 Opis pól
5 Szablon Nagłówek
6 W praktyce
Wstęp
edytujPrzy pomocy szablonu {{Dane tekstu}} formalnie opisujemy widoczny tekst oraz go linkujemy z innymi stronami projektu.
Natomiast szablon {{Dane tekstu}} nie jest technicznie konieczny do budowy e‑booka. Ściśle rzecz biorąc pobierana jest z niego okładka i tytuł e-booka.
- Funkcje metrykalno‑ się częściowo nachodzą:
- strony autora
- części tekstu (główna (tytuł), „nadrzędny” (pochodzenie))
- indeksu
- skanów na Commons
- okładki na Commons
- Jedynie linki nawigacyjne (bez formalnego opisu dokumentu) tworzą pola:
- poprzedni
- następny
- Funkcje metrykalno‑ się częściowo nachodzą:
- Poniżej podany jest opis poszczególnych argumentów szablonu. Nie są wymienione wszystkie – te można znaleźć w dokumentacji szablonu.
- Poniżej podany jest opis poszczególnych argumentów szablonu. Nie są wymienione wszystkie – te można znaleźć w dokumentacji szablonu.
Terminologia
edytujOpisując argumenty szablonu {{Dane tekstu}} lub {{Dane tekstu2}} wygodnie jest myśleć o nich jak o polach formularza (np. karty katalogowej). Stąd używane jest tu takie nazewnictwo.
Opis pól
edytujAutor
edytuj- Pole autor (
| autor =
) służy do wskazania autora dokumentu (utworu).- gdy mamy jednego autora danego tekstu napiszemy po prostu
| autor = Imię Nazwisko
lub w przypadkach bardziej skomplikowanych[1] ewentualnie| autor = [[Imię Nazwisko|Pseudonim]]
- w przypadku tekstu anonimowego
| autor = Anonimowy
- w przypadku kilku autorów
| autor = {{ListaAutorów|Imię Nazwisko; Imię2 Nazwisko2; Imię3 Nazwisko3; ...}}
- wyjątkowo w przypadku bardzo wielu autorów
| autor = Zbiorowy
- Należy zauważyć, że w polu tym są tworzone automatycznie lub manualnie linki do stron autorów
- gdy mamy jednego autora danego tekstu napiszemy po prostu
- Pole autor (
Tytuł
edytuj- W polu tytuł (
| tytuł =
) podawany jest tytuł samodzielnego utworu (patrz poradnik Samodzielność części tekstu )- w przypadku tekstów podzielonych na części, rozdziały będzie to zarazem pierwsza część nazwy strony
- dla Ciekawa książka/Rodział siódmy będzie to
| tytuł = [[Ciekawa książka]]
- dla Zajmująca historia (Kowalski, 1923)/Rodział ósmy będzie to
| tytuł = [[Zajmująca historia (Kowalski, 1923)|Zajmująca historia]]
- w tym wypadku można użyć konstrukcji
| tytuł = [[{{ROOTPAGENAME}}|Zajmująca książka]]
}}, co ma zaletę, że na każdej z podstron będzie niezmienny kod[2]
- Tworzone są tu linki do głównej części tekstu.
- w tym wypadku można użyć konstrukcji
- w przypadku przedmów, wstępów nie należących do tekstu głównego (szczególnie jeśli są innego autora) w tym polu wpiszemy nazwę tej części (np.:
| tytuł = Objaśnienia
albo| tytuł = Wprowadzenie
); nie ma tu potrzeby tworzenia linków (bez nawiasów kwadratowych). - w przypadku tekstów niepodzielonych na części (typ I wg Klasyfikacja tekstów ze względu na strukturę) nie ma potrzeby tworzenia linków (bez nawiasów kwadratowych) a tytuł powinien wyglądać tak, jak widoczny w tekście:
- dla Ciekawa książka –
| tytuł = Ciekawa książka
- dla Zajmująca książka (Kowalski, 1923) –
| tytuł = Zajmująca książka
- dla Ciekawa książka –
- w przypadku zbiorów samodzielnych tekstów (typ V-IX) tytułem będzie tytuł samodzielnego utworu
- przydatny może tu być kod
{{#invoke:string|replace|{{ROOTPAGENAME}}| %b()||plain=false}}
np.: Zajmująca książka (Kowalski, 1923) → Zajmująca książka [3]
- Pole Tytuł jest używane przy generowaniu e‑booka w charakterze tytułu.
- W polu tytuł (
Podtytuł
edytuj- To pole podtytuł ((| podtytuł = ) jest często pomijane, jest używane, gdy tytuł jest uzupełniany jakimś dodatkiem, nie tworzymy tu odnośników
Pochodzenie
edytuj- Pole pochodzenie (
| pochodzenie =
) używa się, gdy mamy do czynienia z publikacją typu zbiór opowiadań, antologia, seria wydawnicza itp. bądź przy rozdziale istotnie różnym od pozostałych (np. przedmowa tłumacza, dodatek, nie będący treścią utworu itp.) oraz gdy utwór był publikowany w periodyku. W innych wypadkach pole jest pomijane. Pole pochodzenie formatujemy kursywą. - Przydatny jest tu szablon {{tfi}}, który na podstawie nazwy indeksu znajduje nazwę strony tekstu głównego.
- Link („klikowalny”) jest tworzony do dokumentu, który mamy na Wikiźródłach.[4]
- Pole pochodzenie (
Tłumacz
edytuj- Pole tłumacz (
| tłumacz =
) jest wypełniane jedynie, gdy tekst jest tłumaczeniem. Dane są wpisywane tak, jak w polu autor. - Linki do strony autora (tłumacza) są tworzone automatycznie lub ewentualnie przy pomocy nawiasów kwadratowych.
- Pole tłumacz (
Tytuł oryginalny
edytuj- Dla tekstów będących tłumaczeniem wstawiamy w polu tytuł oryginalny kursywą tytuł oryginalny utworu (
| tytuł oryginalny =
). Tytuł oryginalny fomatujemy kursywą.
- Dla tekstów będących tłumaczeniem wstawiamy w polu tytuł oryginalny kursywą tytuł oryginalny utworu (
Ilustrator
edytuj- Pole ilustrator (
| ilustrator =
) jest dość często pomijane. Ponieważ nie tworzymy zasadniczo stron (w przestrzeni Autor: [5]) dla ilustratorów a jedynie dla autorów i tłumaczy, to przy wypełnianiu tego pola nie tworzymy linku, obok imienia i nazwiska autora można podać w nawiasie rok urodzenia i śmierci.
- Pole ilustrator (
Część
edytuj- Jeśli utwór jest podzielony na części można wypełnić pole część (
| część =
). Jest ono jednak w praktyce bardzo często pomijane. Ewentualnie można użyć kodu typu:{{#ifeq:{{#titleparts:{{PAGENAME}}|1|2}}|całość||{{#invoke:string|replace|{{#titleparts:{{PAGENAME}}|1|2}}|[^ ]* (.*)$|%1|plain=false}}}}
(patrz poradnik Podstrony, aspekty techniczne, taki kod jest stały dla każdej z podstron)
- Jeśli utwór jest podzielony na części można wypełnić pole część (
Tom
edytuj- Pole tom (
| tom =
) jest również z reguły pomijane. Zasady użycia jak dla pola część.
- Pole tom (
Rozdział
edytuj- Pole rozdział (
| rozdział =
) jest również z reguły pomijane. Zasady użycia jak dla pola część.
- Pole rozdział (
Rok wydania
edytuj- Pole rok wydania (
| rok wydania =
) jest dość istotne, pozwala przyporządkować daną stronę do określonego wydania. Podawane jest jako rok lub data dzienna. Ewentualnie zakres np.| data wydania = 1890–1891
, lub| data wydania = ok. 1917
. Dobrym źródłem informacji jest strona tytułowa tekstu, wpis w katalogu biblioteki narodowej lub innej biblioteki naukowej.
- Pole rok wydania (
Wydawca
edytuj- Nazwa wydawcy (wydawnictwa) jest podawana w polu wydawca (
| wydawca =
). Dobrym źródłem informacji jest strona tytułowa tekstu, wpis w katalogu biblioteki narodowej lub innej biblioteki naukowej.
- Nazwa wydawcy (wydawnictwa) jest podawana w polu wydawca (
Druk
edytuj- Nazwa drukarza, drukarni jest umieszczana w polu druk (
| druk =
). Dobrym źródłem informacji jest strona tytułowa tekstu, wpis w katalogu biblioteki narodowej lub innej biblioteki naukowej.
- Nazwa drukarza, drukarni jest umieszczana w polu druk (
Miejsce wydania
edytuj- Oznaczenie miejsca wydania jest umieszczane w polu miejsce wydania (
| miejsce wydania =
). Dobrym źródłem informacji jest strona tytułowa tekstu, wpis w katalogu biblioteki narodowej lub innej biblioteki naukowej.
- Oznaczenie miejsca wydania jest umieszczane w polu miejsce wydania (
Źródło
edytuj- W polu źródło (| źródło = ) umieszcza się link do skanów przechowywanych na Commons. W przypadku, gdy cały indeks jest oparty na jednym pliku będzie to:
| źródło = [[commons:File:Nazwa pliku wraz z rozszerzeniem|Skany na Commons]]
- Gdy indeks jest oparty na wielu plikach należy je na Commons ująć w jedną kategorię i podlinkować następująco:
| źródło = [[commons:Category:Nazwa kategorii|Skany na Commons]]
- We wszystkich tekstach utworzonych na podstawie danego indeksu najlepiej jest wtedy wpisywać jednolity link do kategorii.
- W tym polu mamy zatem link prowadzący na Commons.
- W polu źródło (| źródło = ) umieszcza się link do skanów przechowywanych na Commons. W przypadku, gdy cały indeks jest oparty na jednym pliku będzie to:
Okładka
edytuj- Pole okładka (
| okładka =
) wypełniamy, gdy istnieje okładka dla danej strony. Dotyczy to głównej strony tekstu i strony /całości. Pomija się je więc dla rozdziałów, części, tomów ale też, gdy okładka nie prezentuje się zachęcająco (np. artykuł z gazety). Pole to jest uwzględniane jako okładka e-booka.| okładka = Nazwa pliku
np.:
| okładka = Jan Kowalski Ciekawa książka.jpg
| okładka = Jan Kowalski Zabawne wiersze.djvu
- Pole okładka (
Strona z okładką
edytuj- Pole strona z okładką (
| strona z okładką =
) uzupełnia informację z pola okładka. Używane jest tylko dla plików wielostronicowych (.djvu i .pdf). Podawany jest numer strony, na której się znajduje okładka.| okładka = Jan Malinowski Nudne opowiadania.pdf
| strona z okładką = 7
- Pole strona z okładką (
Strona indeksu
edytuj- Pole strona indeksu (
| strona indeksu =
) przechowuje nazwę strony indeksu, czyli adres (bez nawiasów kwadratowych), na podstawie którego jest utworzony tekst. Podanie nie jest wymogiem technicznym jest jednak kluczowe z punktu widzenia zasad Wikiźródeł – oparcia na rozszerzeniu proofread. Więcej informacji można znaleźć w poradniku Indeks jako centralny element na Wikźródłach.
- Pole strona indeksu (
Poprzedni
edytuj- W polu poprzedni (
| poprzedni =
) podany jest link do poprzedniej części utworu, jest on tworzony automatycznie z nazwy (adresu) strony wpisanej w tym polu a widoczny w formie trzech znaków mniejsze (<<<). - W przypadku tekstu typu I (wg Klasyfikacja tekstów ze względu na strukturę) z pomijane[6]. Nazwa strony poprzedniej przy czytaniu na ekranie komputera lub urządzenia mobilnego jest podawana bez nawiasów kwadratowych. Dla nazw podstron typu Ciekawa książka/Rodział siódmy, gdzie nazwa poprzednika może zostać łatwo wydedukowana, można użyć szablonu {{PoprzedniU}}. Więcej informacji o kolejności stron nawigowalnych można znaleźć w poradniku Nawigacja w przeglądarce między częściami tekstu.
- W polu poprzedni (
Następny
edytuj- W polu następny (
| następny =
) podany jest link do następnej części utworu, jest on tworzony automatycznie z nazwy (adresu) strony wpisanej w tym polu (bez nawiasów kwadratowych) a widoczny w formie trzech znaków większe (>>>). - Zasadniczo wszystkie uwagi jak w argumencie poprzedni. Dla nazw podstron typu Ciekawa książka/Rodział siódmy, gdzie nazwa następnika może zostać łatwo wydedukowana, można użyć szablonu {{NastępnyU}}.
- W polu następny (
Wikipedia
edytuj- W polu wikipedia (
| wikipedia =
) można umieścić nazwę strony na Wikipedii (bez nawiasów kwadratowych).
- W polu wikipedia (
Inne
edytuj- Pole inne (
| inne =
) służy zasadniczo jedynie podaniu linków do pobierania e-booków. Obszerny opis można znaleźć w poradniku Strony całości. Przy użyciu szablonu {{Całość}} tworzony jest link do strony /całości a poniżej linki do e-booka w różnych formatach. Dopóki nie istnieje jeszcze strona całości linki nie są widoczne.
- Pole inne (
Szablon Dane tekstu2
edytujSzablon {{Dane tekstu2}} pozwala na automatyzację i centralne przechowywanie danych na poziomie tekstu podzielonego na części. Można obserwować, że pola szablonu {{Dane tekstu}} w ramach jakiegoś tekstu się pokrywają. (Na przykład wszystkie rozdziały książki Ciekawa książka będą miały te same dane w takich polach jak tytuł, autor, tłumacz, wydawca, druk, rok wydania, miejsce wydania itd. Zakładając użycie dedykowanych szablonów {{PoprzedniU}} i {{NastępnyU}} będzie to również dotyczyło większości rozdziałów.[7]
Technicznie rzecz biorąc, szablon {{Dane tekstu2}} wywoływany bez argumentu | referencja = ...
zachowuje się jak szablon {{Dane tekstu}}. Podanie w parametrze referencja strony, z której jest pobierana („zaciągana”) zawartość poszczególnych pól (argumenty szablonu {{Dane tekstu}}) pozwala na przechowywanie danych w jednym miejscu i uproszczenie kodu.
Logikę działania szablonu można zobrazować następującym przykładem:
- Na stronie Ciekawa książka/Rozdział siódmy mamy następujący kod:
{{Dane tekstu2 | referencja = Ciekawa książka ⋮ }}
- jeśli na stronie Ciekawa książka/Rozdział siódmy podany jest argument
| tytuł = XY
, to jest on używany jako tytuł XY - jeśli na stronie Ciekawa książka/Rozdział siódmy podany jest argument
| referencja = Ciekawa książka
, to szablon szuka odpowiedniej wartości na stronie określonej przez argument| referencja = ...
(a więc Ciekawa książka )- jeśli na stronie Ciekawa książka podany jest argument
| _tytuł = YX
, to YX jest używane jako argument tytuł na stronie Ciekawa książka/Rozdział siódmy - jeśli na stronie Ciekawa książka nie ma argumentu
| _tytuł = ...
, jest natomiast| tytuł = XX
, to XX jest używane jako tytuł na stronie Ciekawa książka/Rozdział siódmy - jeśli nie ma na stronie Ciekawa książka ani
| _tytuł = ...
, ani| tytuł = ...
, to jest on przyjmowany jako argument pusty.
- jeśli na stronie Ciekawa książka podany jest argument
Szablon Nagłówek
edytujSzablon {{Nagłówek}} jest przestarzały. Nie stosujemy go już w nowych projektach. Stare wystąpienia w miarę możliwości zmieniamy na {{Dane tekstu}}/{{Dane tekstu2}} (modernizujemy).
W praktyce
edytujNajłatwiej zacząć biorąc za przykład układ jakiejś innej strony zawierającej szablon {{Dane tekstu}}/{{Dane tekstu2}}. Niniejszy tekst jest pomyślany bardziej w charakterze referencji – miejsca, gdzie można znaleźć informacje w przypadku wątpliwości.
Dobrym punktem wyjścia dla znalezienia przykładów utworów o podobnym układzie jest poradnik Klasyfikacja tekstów ze względu na strukturę.
Szablon {{Dane tekstu2}} w stosunku do {{Dane tekstu}} stanowi jedynie techniczne ułatwienie i może być stosowany zamiennie.
Przykłady:
- Kochanek Alicyi – typ II
- Pani de Monsoreau (Dumas, 1893) – typ III
- Baśnie (Andersen, oprac. Niewiadomska, 1899) – typ V
- Osaczona i inne nowele – typ VI/V
- Pomarańcze i daktyle – typ VI
- Czyhanie na Boga – typ IX
- ↑ Na przykład, gdy tekst jest sygnowany pseudonimem.
- ↑ Więcej o magicznych słowach i podstronach można znaleźć w poradniku Podstrony, aspekty techniczne.
- ↑ Więcej informacji i podobne konstrukcje można znaleźć w poradniku Podstrony, aspekty techniczne.
- ↑ A więc w przypadku periodyków wpiszemy zwykły tekst a nie link w nawiasach kwadratowych.
- ↑ Więcej informacji o przestrzeniach nazw można znaleźć w poradniku Przestrzeń nazw.
- ↑ Może jednak być potrzebne w przypadku wstępów itp., co jednak przesuwa tekst formalnie kierunku tupu II.
- ↑ Na stronie Ciekawa książka/Rozdział siódmy szablon {{PoprzedniU}} generuje nazwę Ciekawa książka/Rozdział szósty zaś szablon {{NastępnyU}} generuje oczywiście nazwę Ciekawa książka/Rozdział ósmy .