Šablona:TODO/doc

Toto je dokumentační podstránka šablony Šablona:TODO.

Vedle návodu k použití obsahuje kategorie, odkazy interwiki a další obsah, který není součástí kódu šablony.

Substituční šablona {{TODO}} byla vytvořena pro zjednodušené vkládání poznámek typu ToDo (nutné dodělat) do obsahu stránek. Při substituci využívá substituční šablonu {{+}}, která vloží do stránky pomocnou šablonu {{do}}. Jako první parametr této šablony použije uživatelské jméno toho, kdo provede substituci šablony a ve druhém zkombinuje do jednoho řetězce aktuální čas v okamžiku substituce a text, který byl předán jako parametr šablony {{TODO}}

Postup pro zakládání TODO položek, jejich řešení a likvidace

1. Vytvoření poznámky je popsáno níže v ukázkovém příkladu použití šablony {{TODO}}
2. Poté máte několik možností:

• Buď v případě dílčí změny text poznámky, upravíte.
• Nebo ji odstraníte a založíte přes šablonu {{TODO}} novou, s jiným textem.
• Nebo, je-li vyřešená šablonu {{do}} přepíšete na {{done}}.

Nezapomínejte, že jde o nástroj pro zadání úkolu, který je potřeba co nejřív vyřešit. Takže pokud nemá být vložená poznámka trvalou součástí stránky měla by se po po vyřešení z obsahu stránky co nejrychleji odstranit.

Šablona {{do}} byla vytvořená speciálně pro to, aby bylo možné automaticky generovat tabulku s úkoly co čekají na zpracování, přes tabulky včetně uvedení jména uživatele, který je zadal. O jaké stránky se jedná lze zjistit přes Special:WhatLinksHere/Šablona:do

Použití

Šablona {{TODO}} by se neměla používat uprostřed textu, ale buď před, nebo za textem, kterého se týká.

{{subst:TODO|Opravit velikost ilustračního obrázku}}

Po uložení stránky s výše uvedeným kódem, proběhne substituce, a výsledek bude vypadat takto:

ToDo Keny (diskuse), 11. 6. 2022, 15:25 (CEST) – Opravit velikost ilustračního obrázku

A při editaci kódu této stránky byste mohli viděn v kódu tohle:

:{{do|[[Uživatel:Keny|Keny]] ([[Diskuse s uživatelem:Keny|diskuse]]), |11. 6. 2022, 15:25 (CEST) – Opravit velikost ilustračního obrázku}}

Pokud zapomenete použít subst:, před názvem šablony hned při prvním použití šablony, nic se neděje. Akorát nedojde ke vložení aktuálního času a vašeho jména. Substituci můžete udělat dodatečně, tím že před TODO připíšete subst:TODO. Mezi tím si můžete alespoň rozmyslet, jestli je text poznámky ok.

Jak bude vypadat výsledek, změníte-li šablonu {{do}} na {{done}}, demonstruje následující příklad:

:{{done|[[Uživatel:Keny|Keny]] ([[Diskuse s uživatelem:Keny|diskuse]]), |11. 6. 2022, 15:25 (CEST) – Opravit velikost ilustračního obrázku}}

Done Keny (diskuse), 11. 6. 2022, 15:25 (CEST) – Opravit velikost ilustračního obrázku