Znalostní Báze

Informace o sdružení vpsFree.cz, návody a nejčastější dotazy.

Uživatelské nástroje

Nástroje pro tento web


informace:jak_psat

Jak přispívat do Znalostní Báze

Jako všechno na vpsFree, i KB bude fungovat pouze pokud se zapojí komunita.

Do KB může pṙispět kterýkoliv člen vpsFree. Fungují zde přihlašovací údaje z vpsAdminu.

Překlady a prolinkování stránek

Naše KB zatím existuje ve dvou jazykových verzích, anglické a české. Pro prolinkování stejných stránek v různých jazycích máme vlastní plugin. Ten umožnuje stránky označit pomocí tagu <page>nazev stranky</page>. Stránky se stejným jménem jsou pak navzájem propojeny. Jména stránek se řídí podle anglické KB.

Například, pokud je v anglické KB stránka information:association a chceme ji propojit s českou stránkou informace:sdruzeni, přidáme kdekoli do české stránky následující tag:

<page>information:association</page>

... text stránky ...

Pro přehlednost přidávejte tag prosím vždy na první řádek. Anglická KB se považuje za hlavní, takže tam se tento tag nikde psát nemusí.

Média

Všechny obrázky a jiné datové soubory jsou sdílené pro obě KB. Jinými slovy, nahrajeme-li soubor do jedné KB, objeví se i ve všech ostatních překladech KB. Pokud je potřeba mít pro různé jazykové verze jiné média (zejména obrázky), umístěte je do adresáře pojmenovaného kódem jazyka, tj. např. en, cs, apod.

Maintaineři

Každá stránka může mít přiřazeno jednoho čí více maintainerů. Maintainer je člověk, který se stará o to, že je obsah na dané stránce aktuální a jsou tam ověřené informace.

V KB mají maintaineří pouze informační hodnotu, tzn. na koho se obrátit v případě dotazu či nápadu na vylepšení. Drobné změny, opravy či přidávání dalších informací můžete samozřejmě provádět přímo. Pokud sem napíšeš nějaký návod a měl bys čas se o něj starat, zapiš se u něj prosím jako maintainer.

Náš IRC bot pravidelně kontroluje změny v KB a informuje o nich na IRC. Pokud má maintainer v KB vyplněn nick na IRC, bot ho při změně stránky na IRC pingne.

Na stránce se maintaineři nastavují pomocí tagu <maintainers>:

<maintainers>
aither
nick2 (prvni sekce)
nick3 (druha sekce)
</maintainers>

První slovo na každém řádku je nick maintainera, z kterého se udělá odkaz na stránku uzivatele:<nick>. Tu si musí každý maintainer sám vytvořit. Na těchto stránkách jsou uloženy profily maintainerů, specifikují se tagem <maintainer>:

<maintainer name="Moje Jmeno">
irc nick_na_irc
mail nekdo@domena.tld
</maintainer>

irc i mail jsou nepovinné. Z tohoto profilu si IRC bot vytáhne nick maintainera na IRC a pingne ho při změně nějaké z jeho stránek.

informace/jak_psat.txt · Poslední úprava: 2016/12/05 19:48 autor: Aither