Pomoc:Transkluzja przy pomocy tagu pages
 |
Uwaga! Strona jest w trakcie opracowywania. Niektóre informacje mogą być niepełne, a linki mogą kierować do nieistniejących stron. Strona w opracowaniu zgodnie z ustaleniami w Skryptorium. |
W skrócie transkluzja to prezentacja treści jednej ze stron na innej. Istnieje kilka sposobów transkluzji (patrz poradnik [Pomoc:Sekcje|Sekcje]]). Na Wikiźródłach najistotniejsze jest prezentowanie przepisanego tekstu w przestrzeni głównej. Standardowo używa się wtedy znacznika <pages ... />. Tekst jako taki znajduje się w przestrzeni Strona:.[1]
Mechanizm transkluzji jest zwykłą metodą zamieszczania tekstu w przestrzeni głównej – czyli w sposób dostępny dla użytkownika końcowego tj. czytelnika.
W żargonie Wikiźródeł używane jest powszechnie określenie „przenoszenie do main”, co jest nieścisłe, gdyż tekst w przestrzeni Strona jest transkludowany a nie „przenoszony”. Transkluzja oznacza dynamiczne włączenie tekstu.
W tym dokumencie omówiony jest znacznik <pages … /> jego składnia, działanie i wskazane są różne aspekty z tym związane.
Zakres użycia <pages ... /> edytuj
Znacznik <pages ... /> jest używany do transkluzji tekstu z przestrzeni Strona z reguły do przestrzeni głównej. Poradnik Przestrzeń nazw informuje o przestrzeniach nazw na Wikiźródłach.
Sposób zapisu edytuj
W dokumencie przedstawiany jest sposób transkluzji tekstów z trzech fikcyjnych indeksów:
- Indeks:Jan Nowak Ciekawa książka.djvu
- Indeks:Zabawna książka
- Indeks:Ważne listy
Numery lub nazwy stron są przypadkowe, nazwy sekcji zaczynają się od r_ ale mogą być dowolne i zależą od redaktora opracowującego tekst.
Indeksy edytuj
Strona w przestrzeni Indeks grupuje i jednocześnie porządkuje strony w przestrzeni Strona. Przy pomocy omawianego znacznika <pages … /> mogą zostać transkludowane strony z danego zakresu stron.[2]
Jak wskazano w poradniku Indeksy, używamy na Wikiźródłach dwóch typów indeksów. Rozróżnienie ich jest istotne, ponieważ składnia znacznika <pages … > jest w tych wypadkach różna. W przypadku indeksów nowego typu w polach from, to oraz exclude i include należy podać jedynie numer strony (liczba arabska po ukośniku), zaś w przypadku indeksu starego typu pełną nazwa strony (bez prefiksu określającego przestrzeń nazw). Dodatkowo w indeksach starego typu pola exclude i include nie mogą być używane.
Spośród omawianych przykładów, pierwszy indeks to indeks nowego typu, dwa następne są indeksami starego typu.
Najważniejsze konstrukcje edytuj
W praktyce najczęściej stosujemy składnię:
- from/to – #Transkluzja pełnych stron z danego zakresu
- fromsection, tosection – #Transkluzja od/do środka strony
- onlysection – #Transkluzja jednej sekcji
Pozostałe konstrukcje są mniej istotne.
Parametr index edytuj
Parametr index jest jedynym obowiązkowym parametrem znacznika <pages ... /> . Najprostsza możliwa składnia:
<pages index=nazwa indeksu/>
jednak nie działa.
Możliwe jest pominięcie (choć niezalecane dla jasności kodu) pierwszej lub ostatniej strony.
np.
<pages index="Jan Nowak Ciekawa książka.djvu" from=1 />
co spowoduje transkluzję wszystkich stron od pierwszej do ostatniej.
Zazwyczaj jednak nie transkludujemy razem wszystkich stron z danego indeksu, dlatego stosujemy bardziej rozbudowaną składnię.
Transkluzja pełnych stron z danego zakresu edytuj
Jest to najprostsza sytuacja, gdy chcemy transkludować cały tekst z danego zakresu stron.
<pages index=nazwa indeksu from=strona początkowa to=strona końcowa />
W konkretnych przykładach:
<pages index="Jan Nowak Ciekawa książka.djvu" from=10 to=20 />
Strona: Jan Nowak Ciekawa książka.djvu/10
Strona: Jan Nowak Ciekawa książka.djvu/11
⋮
Strona: Jan Nowak Ciekawa książka.djvu/19
Strona: Jan Nowak Ciekawa książka.djvu/20
Nazwa indeksu jest ujęta w cudzysłów. Jest to konieczne ze względu na spacje występujące w nazwie, jest jednocześnie zalecane dla większej przejrzystości i spójności.
<pages index="Zabawna książka" from="Jan Kowalski – Zabawna książka t1.pdf/10" to="Jan Kowalski – Zabawna książka t1.pdf/20" />
Strona:Jan Kowalski – Zabawna książka t1.pdf/11
Strona:Jan Kowalski – Zabawna książka t1.pdf/12
⋮
Strona:Jan Kowalski – Zabawna książka t1.pdf/18
Strona:Jan Kowalski – Zabawna książka t1.pdf/19
Jednak należy podkreślić, że kontrolę tutaj ma kolejność, w jakiej te strony występują na odpowiedniej stronie w przestrzeni Indeks
<pages index="Ważne listy" from="List do Jana Kowalskiego.png" to="List do Andrzeja Nowaka.png" />
Transkluzja co drugiej strony edytuj
W tekstach dwujęzycznych możemy mieć sytuację, że strony nieparzyste są napisane w jednym języku, parzyste – w drugim. Możliwe są oczywiście również inne warianty.
Gdy chcemy z jakiegoś powodu transkludować co drugą stronę (szerzej co n-tą), można użyć parametru step= w połączeniu ze znanymi już parametrami from= i to= .
<pages index=nazwa indeksu from=strona początkowa to=strona końcowa step=n />
W konkretnym przykładzie:
<pages index="Jan Nowak Ciekawa książka.djvu" from=10 to=20 step=2 />
Strona: Jan Nowak Ciekawa książka.djvu/10
Strona: Jan Nowak Ciekawa książka.djvu/12
Strona: Jan Nowak Ciekawa książka.djvu/14
Strona: Jan Nowak Ciekawa książka.djvu/16
Strona: Jan Nowak Ciekawa książka.djvu/18
Strona: Jan Nowak Ciekawa książka.djvu/20
Nazwa indeksu jest ujęta w cudzysłów. Jest to konieczne ze względu na spacje występujące w nazwie, jest jednocześnie zalecane dla większej przejrzystości i spójności.
Transkluzja jednej pełnej strony edytuj
Gdy zachodzi potrzeba transkluzji jednej całej strony z przestrzeni Strona można użyć składni from=... to=... , jednak lepsze, jeśli to możliwe, jest użycie parametru include=...
W ten sposób idea zawarta w kodzie jest najlepiej czytelna.
<pages index=nazwa indeksu include=strona />
W konkretnym przykładzie:
<pages index="Jan Nowak Ciekawa książka.djvu" include=10 />
Strona: Jan Nowak Ciekawa książka.djvu/10
Transkluzja kilku stron niekoniecznie kolejnych edytuj
Parametr include jest jednak dużo bardziej elastyczny. Umożliwia podanie kilku stron lub nawet zakresu stron.
- include=3,7,9,10,15,18
- include=3,7-10,15
Pominięcie przy transkluzji niektórych stron edytuj
Jeśli jakieś strony są ujęte przez parametry from/to lub include, natomiast z jakiegoś powodu chcemy je przy transkluzji pominąć, można użyć parametru exclude. Składnia jest równie elastyczna, jak w przypadku include.
<pages index=nazwa indeksu from=strona początkowa to=strona końcowa exclude=zbędne strony/>
<pages index=nazwa indeksu include=strona początkowa-strona końcowa exclude=zbędne strony/>
W konkretnych przykładach:
<pages index="Jan Nowak Ciekawa książka.djvu" from=10 to=20 exclude=13,16,17/>
<pages index="Jan Nowak Ciekawa książka.djvu" from=10 to=20 exclude=13-17/>
<pages index="Jan Nowak Ciekawa książka.djvu" include=10,15-20 exclude=16,17/>
<pages index="Jan Nowak Ciekawa książka.djvu" from=10 to=20 include=25,27,29-32 exclude=13-17,30/>
Transkluzja od/do środka strony edytuj
W praktyce dość często zdarza się konieczność rozpoczęcia transkluzji tekstu gdzieś w środku strony – od początku danej sekcji. Analogicznie przebiega zakończenie transkluzji w środku strony – na końcu wskazanej sekcji. Mechanizm ten jest dokładniej opisany dokumencie Sekcje (istotny jest zwłaszcza rozdział Początek lub/i koniec rozdziału na środku strony).
Składnia:
<pages index=nazwa indeksu from=strona początkowa to=strona końcowa fromsection=od sekcji/>
oznacza: transkluduj od strony strona początkowa poczynając od sekcji od sekcji do końca strony strona końcowa.
analogicznie:
<pages index=nazwa indeksu from=strona początkowa to=strona końcowa tosection=do sekcji/>
oznacza: transkluduj od początku strony strona początkowa do sekcji do sekcji na stronie strona końcowa włącznie.
Łącznie:
<pages index=nazwa indeksu from=strona początkowa to=strona końcowa fromsection=od sekcji tosection=do sekcji/>
oznacza: transkluduj od strony strona początkowa poczynając od sekcji od sekcji do sekcji do sekcji na stronie strona końcowa włącznie.
W konkretnych przykładach:
<pages index="Jan Nowak Ciekawa książka.djvu" from=10 to=20 fromsection=r_03 />
<pages index="Jan Nowak Ciekawa książka.djvu" from=10 to=20 tosection=r_04 />
<pages index="Jan Nowak Ciekawa książka.djvu" from=10 to=20 fromsection=r_03 tosection=r_04 />
<pages index="Zabawna książka" from="Jan Kowalski – Zabawna książka t1.pdf/10" to="Jan Kowalski – Zabawna książka t1.pdf/20" fromsection=r_03 />
<pages index="Zabawna książka" from="Jan Kowalski – Zabawna książka t1.pdf/10" to="Jan Kowalski – Zabawna książka t1.pdf/20" tosection=r_04 />
<pages index="Zabawna książka" from="Jan Kowalski – Zabawna książka t1.pdf/10" to="Jan Kowalski – Zabawna książka t1.pdf/20" fromsection=r_03 tosection=r_04 />
<pages index="Ważne listy" from="List do Jana Kowalskiego.png" to="List do Andrzeja Nowaka.png" fromsection=r_03 />
<pages index="Ważne listy" from="List do Jana Kowalskiego.png" to="List do Andrzeja Nowaka.png" tosection=r_04 />
<pages index="Ważne listy" from="List do Jana Kowalskiego.png" to="List do Andrzeja Nowaka.png" fromsection=r_03 tosection=r_04 />
Numery stron w przypadku indeksów nowego typu nie są ujęte w cudzysłów. Ujęcie w cudzysłowy nie jest błędem, jednak moim zdaniem taki zapis (a więc bez spacji) jest tu bardziej przejrzysty i podkreśla charakter indeksu (tj. nowego typu).
Nazwy stron w przypadku indeksów starego typu są ujęte w cudzysłowy. Jest to konieczne ze względu na spacje występujące w nazwie, jest jednocześnie zalecane dla większej przejrzystości i spójności.
Nazwy sekcji muszą być ujęte w cudzysłowy jeśli w nazwie występują spacje. Często są ujmowane dla większej przejrzystości. Ujmowanie lub nieujmowanie można traktować jako sprawę stylu.Jeśli na pierwszej wskazanej stronie jest nieciągła sekcja od_sekcji transkluzja rozpoczyna się od początku pierwszego fragmentu.
Jeśli na ostatniej wskazanej stronie jest nieciągła sekcja do_sekcji transkluzja kończy się na końcu pierwszego fragmentu.
Transkluzja jednej sekcji edytuj
Transkluzję jednej sekcji można uzyskać przy pomocy parametru onlysection. W przypadku sekcji ciągłej (tj. niepodzielonej na fragmenty, nieprzeplatanej tekstem nienależącym do sekcji) jest to po prostu bardzo przejrzysta konstrukcja:
<pages index=nazwa indeksu from=strona początkowa to=strona końcowa onlysection=nazwa sekcji/>
<pages index=nazwa indeksu include=strona onlysection=nazwa sekcji/> (tylko w przypadku indeksów nowego typu ze względu na parametr include)
która może być zastąpiona kodem
... fromsection=nazwa sekcji tosection=nazwa sekcji />
W przypadku nieciągłej sekcji daje to trudny do uzyskania w inny sposób efekt.
Przykłady:
<pages index="Jan Nowak Ciekawa książka.djvu" from=10 to=20 onlysection=r_03 />
<pages index="Zabawna książka" from="Jan Kowalski – Zabawna książka t1.pdf/10" to="Jan Kowalski – Zabawna książka t1.pdf/20" onlysection=r_03 />
<pages index="Ważne listy" from="List do Jana Kowalskiego.png" to="List do Andrzeja Nowaka.png" onlysection=r_03 />
Zastosowanie parametru include jest możliwe w przypadku indeksów nowego typu:
<pages index="Jan Nowak Ciekawa książka.djvu" include=10 onlysection=r_03 />
Konstrukcja zamienna edytuj
Gdy chcemy w formie szablonu wstawiać parametry w znaczniku <pages ... /> zwykła konstrukcja nie działa. Wynika to z kolejności parsowania kodu. Należy zastosować wtedy inną składnię:
{{#tag:pages||index=nazwa indeksu|from=strona początkowa|to=strona końcowa}}
Nie stosujemy wtedy cudzysłowów wokół nazw. Możliwe jest również stosowanie wszystkich innych parametrów (include, exclude, fromsection, tosection, onlysection, step).
Stosowanie tej składni w zwykłych sytuacjach jest niewskazane, ponieważ utrudnia zrozumienie intencji redaktora.
- ↑ Ideę przestrzeni nazw wyjaśnia poradnik Przestrzeń nazw.
- ↑ Do tysiąca stron w ramach jednego tagu.