Uživatelské nástroje

Nástroje pro tento web


wiki:struktura

ještě budu pokračovat

Struktura wiki

Teprve preneseno z MDV wiki. Musi se upravit!

Tento dokument obsahuje popis základních prvků struktury wiki http://wiki.mandrivalinux.cz.

Namespace

NameSpace (dále jen N.S.) je nástroj pro tvorbu struktury v ploše wiki. Na wiki bude existovat sada pevně daných N.S. a v některých případech jejich pevný obsah.

Každý N.S. bude obsahovat stránku :N.S.:start používanou jako rozcestník. Budou tak sjednocena jména a uživateli bude jasné, kde se nachází.

:X:

Pro každé vydání Mageie bude vytvořen vlastní N.S. Ten bude mít podobu :X: (například :1: pro vydání Mageia 1) a každý z nich bude mít pevně daný obsah. Všechny odkazy jsou funkční a pro příklad vedou na verzi MGA1, ale dle stejného systému budou vypadat i další (a předešlá) vydání).

Bude jím

Všechny ostatní informace o softwaru budou v NS :software.

:software

Tento N.S. bude obsahovat další N.S. dle kategorií do které daný software náleží. Je možné se inspirovat v tom, kam v Mandriva menu se zařadí ikona programu. Tyto další N.S: tedy jsou:

:hardware

:system

Zde budou obecné systémové návody, jako například MCC, příkazový řádek a nebo nastavení plymouthu

:wiki

Namespace obsahující všechny informace okolo naší wiki, jako kodex wikerů, kontakty a další.

FIXME Prakticky: do N.S. :wiki: se přesune vše, co je na :rozcesti_wikeru (neboli :rozcesti_wikeru se přejmenuje na :wiki:start, případně se může nechat redirekt z :rozcesti_wikeru ⇒ :wiki:start).

:faq

  • :faq - FAQ: často kladené dotazy

:srazy

Pojmenování a množství N.S.

Není nutné hnát použití N.S. do krajností. Píši-li text o programu Kopete, je zbytečné vytvářet :software:kde4:internet:im-komunikace:kopete:4.3.5:start s tím, že stejný text bude i v :software:kde4:internet:im-komunikace:kopete:4.4.5:start, ba je to přímo kontraproduktivní. Uživatel by se musel proklikat obrovským množstvím nabídek a voleb, cestou zjistit jakou má verzi programu Kopete, aby se k textu dostal. Další problém je v případě, že uživatel použije funkci hledání, která vypíše X podobných textů. V neposlední řadě by při rozšiřování textu musel autor upravovat X různých stránek o (z 99 %) stejný text.

Oproti tomu adresa :software:internet:kopete (příp. :software:internet:im:kopete) je ideální, protože nestaví uživateli do cesty pokud možno žádné překážky – minimum rozcestí, kterými musí z titulky projít. Nemusí vědět, že Kopete je součástí KDE4 (může jej přeci používat i v GNOME, Xfce a nebo BlackBoxu). Výsledek hledání bude je jen jeden – na stránku o IM komunikátoru Kopete. A nakonec autor v případě, že chce doplnit některé informace, upravuje vždy jen jednu stránku.

Jak tedy na případné rozdíly mezi verzemi v programech? Ovládání programů se až na detaily neliší, stejně jako návod na instalaci. Případné rozdíly ve verzi X.X oproti všem ostatním proto elegantně vyřešíte přidáním podkapitoly, že:

==== Verze X.Y ==== 
Používáte-li verzi X.Y (a/nebo vydání Mandriva Linuxu 20xx.x), tak se chování liší následovně: blablabla

a nebo

==== Při použití starší verze než X.Y ==== 
Používáte-li starší verzi než X.Y (a/nebo vydání Mandriva Linuxu starší než 20xx.x), tak se chování liší následovně: nefunguje to a to, a je třeba ono abyste program spustili.

Neustále tedy mějte na paměti, že není třeba vytvářet nový N.S. pro drobnost typu „jiné jméno balíčku ve verzi X oproti X-1“ – dobrou inspirací je stránka pro stahování, kde jsou odlišnosti typu jiné médium prostě odděleny pomocí jiné kapitoly.

Pevné stránky

Ne všechny stránky mohou být v N.S. Těmito jsou:

:start

neboli titulka celé wiki.mandrivalinux.cz FIXME -ted je to jiná, opravit

Odkazy na aktuální vydání by měly být pouze relativní přes :download odkazy, resp. přesměrování (viz dále). Odkazy na verzi „o jednu starší“ budou nahrazeny odkazem na „informace o starších verzích“, tedy na rozcestník vydání MDV

Titulní stránka se tak nebude přesouvat do různých N.S. dle vydání, pouze se na několika místech přepíše 20xx.x na 20xx.x+1 ⇒ odkazy na verze budou řešeny relativně (:download, nikoli na :20xx.x:download!), není tedy nutná úprava cíle, pouze textu!!

:vydani

Seznam jednotlivých vydání s odkazy do :start stránek k nim. Bude tedy obsahovat odkazy do jednotlivých N.S. k jednotlivým vydáním:

Smyslem je odstranit nutnost vytváření odkazů typu Errata k minulé verzi jsou «odkaz na verzi 20xx.x -1» a ještě starší «odkaz na verzi 20xx.x -2» kde se musí vždy ručně upravit správný odkaz. Místo toho bude pouze ''Informace ke starším verzím jsou v příslušné stránce starších vydání (nebo něco podobného, méně blbého FIXME)

Redirekty

Některé stránky budou složit jen jako redirekt na stránky jiné. Snahou je vytvořit pokud možno jednoduchou a přitom funkční orientaci pro uživatele. Stránky :download, :notes či :errata ukazují do stejnojmenných stránek v N.S. nejnovějšího vydání (aktualni) :x: Ve správě wiki tak ihned opravit všechny odkazy pro stažení/nastavení zdrojů a další pro nejnovější verzi. Pokud se bude odkazovat na „obecné“ stažení verze, odkáže se tak pouze na :download, nikoli do :x:download. Je samozřejmé, že pokud se bude popisovat konkrétní vydání, odkaz bude do konkrétního N.S., ale ve většině případů by mělo stačit odkazovat do :download místo :x:download.

Budou jimi:

  • :download ⇒ :x:download
  • :zdroje ⇒ :x:zdroje
  • :notes ⇒ :x:notes
  • :tour ⇒ :x:tour
  • :errata ⇒ :x:errata
  • :instalace-dvd ⇒ :x:instalace:dvd
  • :instalace-cd_live ⇒ :x:instalace:cd_live
  • :aktualni_vydani ⇒ :x:start

FIXME: musí se vytvořit stránky k :redirektovaným odkazům, jinak odkaz vypadá, že neexistuje (je červený).

Obrázky

Vytvoření adresáře na serveru

V případě, že na serveru není adresář odpovídajícího jména, do kterého chcete nahrát Váš obrázek, tak postup je stejný jako při nahrávání obrázku, avšak do políčka označeného jako Wiki jméno (volitelné): dopiště před název nahrávaného souboru (obrázku) jméno nového adresáře oddělené dvojtečkou.

Z důvodu přehlednosti obrázky důsledně nahrávejte do adresáře, mající stejné jméno jako název vytvářené stránky (včetně všech N.S.), a který bude na stejné úrovni jako vytvářená stránka. Jméno adresáře volte bez diakritických znamének či mezer v jeho názvu.

příklad struktury:

2010.1:instalace:cd_live:mandriva-one-01...19.png - obrázky v adresáři
2010.1:instalace:cd_live - stránka s návodem (stejný název jako adresář s obrázky)

Vložení obrázku do wiki

Pokud již máte nahraný obrázek na MandrivaWiki serveru, tak vložení obrázku do Vámi psaného textu provedete kliknutím na požadovaný obrázek. Do wiki se poté vloží kód v tomto tvaru

{{:2010.1:instalace-live-cd:mandriva-one-01.png|}}

v tomto konkrétním případě je obrázek na serveru v adresáři 2010.1, umístěném v podadresáři instalace-live-cd, jméno souboru je mandriva-one-01.png a stránka, kde se vyskytuje, má adresu :2010.1:instalace-live-cd.

wiki/struktura.txt · Poslední úprava: 2014/10/25 13:04 (upraveno mimo DokuWiki)