Zobrazení zdroje stránky Šablona:Diff/doc

{{Podstránka s dokumentací}}<!--  KATEGORIE PROSÍM PŘIDÁVEJTE AŽ NA KONEC STRÁNKY  -->
Šablona '''diff''' slouží k vytváření odkazů na zvláštní stránky Wikipedie, pro zobrazování historických verzí obsahů stránek.

== Použití ==
Šablona sestavuje URL ze zadaných hodnot ID verzí stránek a sestavenou zobrazí jako klikatelný link na speciální stránky systému Wikipedie:
* pro zobrazení a porovnání změn mezi nějakými dvěma historicky uloženými verzemi, buď stejné stránky, nebo i dvou různých stránek.
:: <code><nowiki>{{Diff||ID nové verze|ID staré verze|popisek}}</nowiki></code> - Porovnání. Ručně zmiňovat název stránky je zbytečné: Dourčí se přes ID verze, ta už tuto informaci obsahuje.
:: <code><nowiki>{{Diff||ID nové verze|ID staré verze}}</nowiki></code> - Porovnání. Vytvoří stejný odkaz, jen ho zobrazí s vlastním základním popiskem.
* pro zobrazení přímo dané jedné historické verze.
:: <code><nowiki>{{Diff|||ID staré verze}}</nowiki></code> - Zobrazení staré verze. Vytvoří odkaz na danou verzi dané stránky.
:: <code><nowiki>{{Diff|oldid=ID staré verze}}</nowiki></code> - Zobrazení staré verze. Kvůli množství svislítek raději přes pojmenovaný parametr.

K obdobným výsledkům se lze proklikat skrze historii dané stránky. A to včetně relativních hodnot typu "proti hned předešlé verzi" apod: Ať už URL sestavuje tato šablona, nebo se k nim uživatel prokliká, z pohledu serveru a webaplika<!--???--> Wikipedie jde o stále stejnou úlohu, o volání stejného API.

=== Dvě stránky podle NULL diff ===
Pro určení, která ze dvou speciálních stránek Wikipedie se zobrazí (porovnávací, či historická), je rozhodující {{zvýrazňovač|1=parametr <tt>diff=</tt>}}: Už i pouhá jeho přítomnost v URL.
* Už sama jeho přítomnost v URL má vliv, byť by třeba ani neměl žádnou hodnotu, jen prázdný String, už {{zvýrazňovač|není [[NULL]]}} a zobrazí se dva panely porovnávání verzí.
* Naopak bez <code>diff=</code> se zobrazí stránka historické verze.

=== Relativní vazby k ID verze ===
Pro porovnávání se připouští tyto vzájemné vztahy: {{zvýrazňovač|''předešlá'', ''současná'', nebo ''následující'' verze}}. Opět se tyto příznaky zadávají pomocí <code>diff</code>, místo hodnoty novějšího ID.

== Parametry ==
Pro některé účely a jejich kombinace parametrů některé hodnoty nemusí být použity, nebo dokonce ani nesmí, aby byl v daném případě dodržen účel.
* {{para|1|}} {{param|1|{{param|title|{{param|page||nocode=nocode|bold1=bold}} |nocode=nocode|barva=#beb|bold1=bold}}|bold1=bold}} název stránky na Wikipedii. Zbytečný.
* {{para|2|}} {{param|2|{{param|diff||nocode=nocode|barva=#beb|bold1=bold}}|bold1=bold}} ID jedné verze stránky, novější.
* {{para|3|}} {{param|3|{{param|oldid||nocode=nocode|barva=#beb|bold1=bold}}|bold1=bold}} ID staré verze stejné (anebo i jiné) stránky.
* {{para|4|}} {{param|4|{{param|label||nocode=nocode|barva=#beb|bold1=bold}}|bold1=bold}} popisek přes odkaz.
* {{para|diffonly|}} přepínač pro kompaktnější zobrazení na porovnávací stránce: bez náhledu obsahu pod porovnáním a s omezennou nabídkou menu nalevo.

== Příklady použití ==
=== Obecné chování ===
==== Popisek odkazu ====
Lze zadat popisek pro odkaz.
: <code><nowiki>{{Diff|Šablona:Diff/doc|16152757|16152756|popisek}}</nowiki></code> - {{Diff|Šablona:Diff/doc|16152757|16152756|popisek}}
Ten pak vypadá jako běžný link.

==== Strojový popisek linku ====
Popisek pro odkaz není vyžadován.
: <code><nowiki>{{Diff|Šablona:Diff/doc|16152757|16152756}}</nowiki></code> - {{Diff|Šablona:Diff/doc|16152757|16152756}}
Link se zobrazí nadepsaný číslem: Jde o obdobu mechanismu inkrementálního číslování referencí ve článku.

=== Bez názvu stránky ===
Parametr <tt>title</tt> pro {{zvýrazňovač|název je zbytečný}} a zadávat ho není třeba.
: <code><nowiki>{{Diff||16152757|16152756|popisek}}</nowiki></code> - {{Diff||16152757|16152756|popisek}}
Funkce zůstává stejná i tak, na titulku stránky nezávislá.

Všimněte si dvojitého [[Svislá čára|svislítka]]: Pro číslované parametry platí, že musí být až za svým svislítkem, druhý parametr až za druhým svislítkem.

==== Neexistující ID ====
Lze zadat i {{případ chybný|neexistující ID}}:
: <code><nowiki>{{Diff||16152758|16152756|neexistující ID}}</nowiki></code> - {{Diff||16152758|16152756|neexistující ID}}
Link se sice vytvoří, ale po kliku na něj Wikipedie hlásí chybu: "Jedna z revizí k požadovanému porovnání (16152758) neexistuje."

Z například desetinných IDček se k porovnávání berou jen celé části čísel, resp. se string rozdělí na souvislé bloky číslic a jako vstup se použije jen první z nich.

==== Řetězec do ID ====
Při chybném zadání ID, kdy je zadán {{případ chybný|string místo čísla}}, Wikipedie nezhavaruje.
: <code><nowiki>{{Diff||e|g|řetězce}}</nowiki></code> - {{Diff||e|g|řetězce}}
Link se sice vytvoří, ale po kliku na něj se porovnávací stránka snaží porovnávat nějaké historické verze úvodní stránky české Wikipedie.

=== Režim porovnávání ===
Systém speciálních stránek Wikipedie (script <tt>/index.php?</tt>) pro aktivaci režimu porovnávání požaduje přítomnost parametru <tt>&diff=</tt> v URL.

Zda se dole pod dvěma panely porovnávání zobrazí i náhled obsahu, to záleží na osobním uživatelském nastavení.

==== Relativní určení verze ====
Oproti parametru <tt>&oldid</tt>, který má být vždy určen výslovně, konkrétní číselnou hodnotou, parametr <tt>&diff</tt> umožňuje používat k relativnímu či abstraktnímu určení hodnoty i vybraná klíčová slova:
* <tt>&diff=cur</tt> - current, současná verze; Žádné takové klíčové slovo pravděpodobně implemenované ani není: Proti aktuální verzi se porovnává při jakémkoli (nerozpoznaném) stringu.
*: <code><nowiki>{{Diff|oldid=16152756|diff=cur}}</nowiki></code> - {{Diff|oldid=16152756|diff=cur}}
* <tt>&diff=next</tt> - další verze, následující po <tt>&oldid</tt>; 
*: <code><nowiki>{{Diff|oldid=16152756|diff=next}}</nowiki></code> - {{Diff|oldid=16152756|diff=next}}
* <tt>&diff=prev</tt> - previous, předešlé verze; Zde se sice porovnává oproti <tt>&oldid</tt>, která má být menší, jenže implementace na tento případ pamatuje, vnitřně si je prohodí, takže pořadí IDček podle velikosti čísel se neporuší.
*: <code><nowiki>{{Diff|oldid=16152757|diff=prev}}</nowiki></code> - {{Diff|oldid=16152757|diff=prev}}
*: Pokud je <tt>&oldid</tt> sama již první, žádná předešlá pro danou stránku neexistuje, hlásí porovnávač "Žádný rozdíl".
*: <code><nowiki>{{Diff|oldid=16152756|diff=prev}}</nowiki></code> - {{Diff|oldid=16152756|diff=prev}}
Opět jde o obdobu ovládacích prvků ze stránky "historie stránky", kterou takto lze zavolat a využít i jinde na stránkách.

==== Mezi dvěma různými stránkami ====
Lze zadat i taková ID, že každé patří do historie jiné stránky:
: <code><nowiki>{{Diff||16152756|16152749|mezi dvěma stránkami}}</nowiki></code> - {{Diff||16152756|16152749|mezi dvěma stránkami}}
Po kliku na vytvořený odkaz se zobrazí [[diff]] {{zvýrazňovač|mezi dvěma stránkami}}, místo dvou {{případ správný|verzí jediné stránky}}. Tedy i toto lze: Například pro ověření, jak se přenášel obsah jedná stránky na nový název. Sice jde o složitější případ, který může být matoucí, přesto je porovnávací stránka připravena i na takovéto použití: V titulku se výslovně zmiňuje "Porovnání stránek".

==== Přehozená IDčka ====
IDčka verzí se podaří zadat {{případ chybný|i v obráceném pořadí}}, obslužné funkci na pořadí (celých) čísel podle velikosti nezáleží.
: <code><nowiki>{{Diff||16152756|16152757|přehozená}}</nowiki></code> - {{Diff||16152756|16152757|přehozená}}
Výsledné URL v odkazu sice opravdu obsahuje obě IDčka přehozená, ale pak jsou prohozené i panely při porovnání: Novější panel je vlevo. Jde o snadný zdroj zmatení uživatele.

==== Nejkratší URL pro Diff ====
Nejprimitivnější URL, aby se porovnávací funkce ''diff'' ještě aktivovala:
: http://cs.wikipedia.org/?diff
Porovnání opět zapadne do porovnávání těch samých historických verzí úvodní stránky české Wikipedie.

==== Kompaktní zobrazení ====
Přepínačem <tt>&diffonly=yes</tt> lze potlačit zobrazení zbytných částí stránky:
* a) položek v levém menu a interwiki,
* b) dokonce i uživatelská nastavení, že se pod dvěma panely porovnání již nezobrazí náhled obsahu.
: <code><nowiki>{{Diff|diff=16152757|oldid=16152756|diffonly=yes}}</nowiki></code> - {{Diff|diff=16152757|oldid=16152756|diffonly=yes}}
Asi jde o funcionalitu pro odkazy na Wikipedii z veřejného webu, očištěné zobrazení do prezentací.

Samotné porovnávací funkci, stránce Wikipedie, stačí k aktivaci tohoto potlačování jakákoli hodnota odlišná od hodnoty "<tt>&diffonly=0</tt>" v URL. Jde tedy o prostou dvojhodnotovou logiku. Ovšem v šabloně je zavedena vlastní logika: Šablona reaguje na hodnotu {{para|diffonly|yes}}, sama však do URL do nastavuje hodnotu "<tt>&diffonly=1</tt>".

=== Režim historické verze ===
Bez parametru <tt>&diff=</tt> v URL se zobrazí historická verze, pracuje se s jen jednou verzí. Ovšem parametr <tt>diff</tt> v URL vůbec nesmí být: Jde tu o [[tříhodnotová logika|tříhodnotovou logiku]], o případ [[NULL]], už sama přítomnost by toto porušila, bez ohledu na hodnotu, třeba i prázdnou.
: <code><nowiki>{{Diff|oldid=16152757|label=oldversion}}</nowiki></code> - {{Diff|oldid=16152757|label=oldversion}}
Jde o ukázku jen pro úplnost dokumentace.

== Data šablony ==
{{TemplateDataHeader}}
<templatedata>
{
	"description": "Účel této šablony je poskytnout standardizovaný formát pro označení oficiálních stránek.",
	"params": {
		"1": {
			"aliases": ["title", "page"],
			"label": "titulek",
			"description": "Název stránky na Wikipedii. Zbytečný: Dourčí se přes ID verze, ta už tuto informaci obsahuje.",
			"type": "string/wiki-page-name",
			"required": false,
			"suggested": false
		},
		"2": {
			"aliases": ["diff"],
			"label": "diff",
			"description": "ID novější verze nějaké stránky.",
			"required": true,
			"example": "16152757",
			"type": "string/line"
		},
		"3": {
			"aliases": ["oldid"],
			"label": "oldid",
			"description": "ID staré verze stejné (anebo i jiné) stránky.",
			"required": true,
			"example": "16152756",
			"type": "number"
		},
		"4": {
			"aliases": ["label"],
			"label": "popisek",
			"description": "Text ke zobrazení nad adresou URL. Není-li uveden, šablona zobrazí přednastavený popisek.",
			"type": "string/line",
			"required": false,
			"suggested": true,
			"example": "porovnání",
			"autovalue": "1"
		},
		"diffonly": {
			"aliases": [],
			"label": "skrýt náhled",
			"description": "Přepínač v rámci režimu porovnávní: Mění zobrazení, skrývá náhled obsahu pod porovnáním a také interviki nalevo.\n\n\nPři zobrazení v rámci režimu historické verze: Přepínač nemá vliv, ani na interwiki.",
			"example": "yes",
			"type": "string/line",
			"required": false,
			"suggested": false
		}
	},
	"format": "inline"
}
</templatedata><!--
Text "description" na vícero řádků: Newlines jsou požírány, zafunguje mi až trojice \n.
https://de.wikipedia.org/w/index.php?title=Wikipedia:Lua/Modul/TemplateData/Wikitext/en&oldid=176574682
-->

== Související šablony ==
;pro diff
* [[Speciální:Rozdíl]]&nbsp;– Slouží k podobnému účelu; pro konstrukci URL s funkcí <code>/diff</code> viz [[:en:Help:Wiki markup#Linking to old revisions of pages, diffs, and specific history pages]].

;pro oldid
* [[Speciální:Permalink]]&nbsp;– Slouží k podobnému účelu; pro konstrukci URL s funkcí <code>/oldid</code>, pro zobrazení historické verze stránky.
* {{šablona|Oldid}}&nbsp;– Zjednodušuje vytváření odkazů na známé staré verze, ze známého oldID.
* {{šablona|Oldid2}}&nbsp;– Umí volitelné popisy nad URL odkazu.

== Související články ==
* [[Nápověda:Rozdíl verzí]]
* [[diff]]&nbsp;– zvýrazňování [[syntax]] na wiki stránkách pomocí [[:mw:Extension:SyntaxHighlight GeSHi]]
* [[:mw:Manual:Parameters to index.php#User preference overriding]] - diffonly, cur
* [[:mw:Help:Diff]] - o hodnotách pro {Diff}, zmíněna i "cur"
* [[:meta:Help:Diff]]
* [[:en:Help:Diff#Linking to a diff]] - o "diffonly", "cur"
* [[:en:User:Scottywong/diffconverter]]&nbsp;– nástroj ke konverzi syrových dat; JavaSciprt k vložení do prohlížeče.

<includeonly><!--  KATEGORIE PŘIDÁVEJTE SEM, DĚKUJEME  -->
[[Kategorie:Šablony:Vnitřní odkazy]]
[[Kategorie:Šablony:Používající oldid revizí]]
</includeonly>