Project:PD help
 Project:Nápověda PD je projekt na vytvoření sady stručných stránek uživatelské nápovědy pro uživatele MediaWiki, tzn. pro návštěvníky webových stránek, které využívají MediaWiki. Projekt pokrývá veškerý obsah jmenného prostoru Help (nápověda). Hlavním vstupním bodem je stránka Nápověda:Obsah. Tato dokumentace nápovědy je oddělena od Příruček (příručky správce MediaWiki s licencí GFDL a CC BY-SA). Přispěvatelé, ujasněte si prosím rozdíly! Stránky nápovědy PD neobsahují informace pro správce serveru o tom, jak nainstalovat, nakonfigurovat nebo udržovat software MediaWiki. Podrobné prohlášení o tom, čeho se snažíme dosáhnout, naleznete níže v části 'Goal' (cíl).
|
Cíl
Cílem je poskytnout soubor stránek, které lze zkopírovat do nové instalace wiki nebo zahrnout do distribuce MediaWiki. To bude zahrnovat přiměřené stručné informace o základních uživatelských informacích a dalších informacích Meta. Základním konceptem je vytvoření komprimované "uživatelské příručky", nikoli referenční práce. Měl by se zaměřit na to, co uživatelé chtějí, a ne vysvětlovat jiné funkce.
Licence
Příspěvky do PD Help jsou uvolněny jako veřejná doména (public domain) prostřednictvím CC0 waiver. To je nezbytné, aby uživatelé mohli snadno kopírovat text do svých vlastních instalací wiki. Před přispěním se, prosím, ujistěte, že rozumíte následujícímu:
- Každá stránka v nápovědě PD musí obsahovat řádek
{{PD Help Page}}s označením licence. - Na tyto stránky nelze kopírovat žádný obsah odjinud. Jedinými výjimkami jsou:
- Kopírovaný obsah je váš osobní (např. jste autor) nebo máte zdokumentované povolení od původního autora (autorů).
- Obsah, který je již ve veřejné doméně, sem lze zkopírovat. Toto však NEzahrnuje většinu publikovaných webových stránek!
- Vzdáváte se všech práv na informace, kterými zde přispíváte. I když budete i nadále mít své příspěvky uvedené a přiřazené na této stránce, ostatní mohou kopírovat text bez uvedení autora a mohou jej upravovat, jak uznají za vhodné.
Cílový čtenář: Normální uživatel
Stránky nápovědy jsou velmi cíleny na běžné návštěvníky webových stránek wiki.
Ne správci serveru
Naším cílem není duplikovat úplnou dokumentaci MediaWiki. Informace zaměřené na správce serveru, podrobně popisující instalaci, konfiguraci nebo údržbu MediaWiki, patří do příruček projektu.
Jedinou malou výjimkou jsou políčka "Tipy pro správce" (admin tips) (popsáno níže).
Informace pro uživatele sysop nebo byrokrat jsou zde méně důležité
Stránky nápovědy by nebyly kompletní bez popisu toho, co mohou uživatelé 'sysop' dělat. Tyto pokročilé funkce však nejsou dostupné většině cílového publika (většina uživatelů wiki). Tyto informace jako takové musí být lehce odděleny od většiny obsahu, aby běžní uživatelé nebyli konfrontováni s informacemi, které pro ně nejsou relevantní.
Na většině stránek nápovědy mohou být stručné zmínky o akcích, které vyžadují oprávnění sysop, a jsou považovány za nezbytné. Ale podrobné popisy procedur sysop by měly být převedeny na méně nápadné stránky nebo by měly být zcela vynechány ze stránek nápovědy.
Tato sekce je v diskusi
Redakční pokyny
- Vytvářejte odkazy mezi stránkami, ale vyhněte se odkazování na jiné jmenné prostory na MediaWiki.org. Ponechte interní odkazy na stránky nápovědy ve veřejné doméně nebo vytvořte externí odkazy (úplné URL) na relevantní zdroje, např. na meta.wikimedia.org. To má usnadnit snadnější kopírování textu do nových instalací wiki. Nepoužívejte odkazy interwiki, protože v cílové wiki nemusí existovat.
- Pravděpodobně nechceme nikde přehazovat v syntaxi {{SITENAME}}. MediaWiki je název softwaru, který popisujeme. Toto je Content Management Software (CMS), který umožňuje spuštění cílové wiki, takže kdekoli, kde náš text odkazuje na software (všude v nápovědě), by měl být ponechán jako doslovný řetězec "MediaWiki". Pokud z nějakého důvodu text nápovědy zmiňuje název webu, pak by se jednalo o vhodnou výjimku (použijte {{SITENAME}}). Nicméně to nebudeme zaměňovat všude, kde zmíníme slovo MediaWiki.
- Překlady by měly být provedeny poté, co anglická verze stránky dosáhla stabilního stavu. Konvence pojmenování je
Název stránky/kód-jazyka(např. Nápověda:Editace/cs). - Pokud se dokonale neorientujete v této příručce, zdržte se prosím vytváření navigačních šablon a zaměřte se nejprve na vytváření obsahu.
- Nepoužívejte rozšíření jako Cite, protože nejsou nainstalována na všech instalacích MediaWiki.
Formátování
- Formátování by mělo být konzistentní. Použijte
class="wikitable"pro všechny tabulky, které vytvoříte, zvýrazněte buňky nebo řádky pomocí{{Hl1}}atd. - Všechny značky a kód wiki by měly být vloženy do značek
<code>nebo<pre>. Nápověda pro vložení:{{subst:nw|text}}. - Všechny odkazy na texty nabídek a popisy by měly být uvedeny kurzívou.
Snímky obrazovky
Snímky obrazovky jsou užitečné. Stránky nápovědy PD by měly obsahovat pouze snímky obrazovky z veřejné domény. Vyhněte se zahrnutí jakýchkoli log na snímky obrazovky a nahrajte je na Commons pomocí licenčních šablon {{MediaWiki screenshot}} (pro GPL) a {{CC-zero}} (pro práci uživatele).
Obrázky jsou dodávány s dokumentací nebo jsou přístupné z Commons pomocí InstantCommons.
Tipy pro administrátory
Pokud něco v Nápovědě (help) může být konfigurováno administrátorem serveru, můžete vložit 'admin tip' pomocí {{Admin tip}}.
Kategorie
Všechny stránky ve jmenném prostoru "Help:" jsou podle definice součástí tohoto projektu dokumentace nápovědy veřejné domény a měly by být zařazeny do kategorie Kategorie:Nápověda. Stránky nápovědy pro rozšíření MediaWiki by měly být zařazeny do podkategorie Kategorie:Nápověda k rozšíření.
Dřívější kategorie pro stránky ve jmenném prostoru "Help:" tohoto projektu dokumentace nápovědy ve veřejné doméně, byla Category:PD help. V souladu se zjednodušováním je kategorie nyní Kategorie:Nápověda a všechny stránky byly aktualizovány.
Související odkazy
- Project:Jazyková pravidla — Pokud máte zájem pracovat na neanglických verzích stránek nápovědy.
- Project:PD help/export — Popisuje navrhovanou metodu vytváření použitelných výpisů Nápověda: jmenný prostor. Toto je stále ve fázi diskuse a zatím není funkční.