Stručný návod na prácu s wiki

Z RoboCupTP wiki
Prejsť na: navigácia, hľadanie

Táto wiki je založená na softvéri MediaWiki, dokumentácia tohto softvéru sa preto vzťahuje aj na ňu. Editor obsahuje lištu s nástrojmi, ktoré uľahčujú používanie najbežnejších prvkov.

Obsah

Vytváranie stránok

Vytvoriť stránku znamená dostať sa na ešte neexistujúcu stránku. Môžete to spraviť hľadaním požadovaného názvu novej stránky vyhľadávačom v bočnom paneli. Stránky sa najjednoduchšie vytvárajú zadaním neexistujúceho názvu podstránky wiki. Následne wiki automaticky ponúkne vytvrenie takejto Vytvorenie stránky wikiNávod.png

Formátovanie textu

Dodržiavajte formátovanie, ktoré môžete odsledovať z už existujúcich stránkach.

Jednotlivé formátovanie si najľahšie osvojíte otvorením stránky: šablónova strana. Obsahuje najbežnejšie formátovania.

Všetky funkcie formátovania textu nájdete na stránke: Wiki formátovanie

Texty sa formátujú bežne až na niekoľko špeciálnych funkcií wiki:

  • Pre písanie do nového riadku treba vynechať jeden prázdny riadok
  • Pre vypnutie formátovanie wiki treba zadať text medzi tagy <nowiki>, </nowiki >
  • Zdrojový kód sa zadáva medzi tagy <code>, </code>. Zdrojové kódy je dobré oddeliť aj do zvlášť sekcií písaním medzery na začiatok každého riadku

Používajte potrebné značenia počas editácie a po vytvorení nového obsahu:

Značky

Pre upútanie pozornosti na dôležitý alebo nový dokument je možné označiť link na neho červeným textom. K tomuto bolo vytvorených niekoľko šablón. Značky NEW by mali byť odstránené po uplynnutí celého šprintu od ich pridania.

Šablóny pre značky

  • {{New}} - NEW
  • {{Important}} - DÔLEŽITÉ
  • {{Todo}} - TODO:
Čas poslednej úpravy

Na hlavnú stránku a iné stránky, ktoré slúžia ako zbierky linkov, je vhodné k niektorým linkom pridať aj čas ich poslednej úpravy, toto sa dá spraviť automaticky vložením

({{#ask: [[Názov stránky]] |?Modification date#MEDIAWIKI = |mainlabel=-}})

Tento čas sa bude automaticky updatovať na aktuálnu hodnotu.

Toto je vhodné používať skôr na stránky ktoré sa často menia, na ostatné stačí značka NEW

Všetky príspevky by mali tiež byť podpísané.

Podpisy a timestampy

Na stránke Požiadavky a otázky je vhodné k vlastným komentárom pridať aj svoje meno s časom úpravy, to sa automaticky spraví použitím ~~~~

Nahrávanie súborov

Súbory sa môžu priložiť buď nahratím na wiki, alebo uploadnutím na virtuálny stroj tímu a pripojením externého odkazu. Používanie nahratých súborov a obrázkov je opísané v kapitole Linkovanie obsahu. Nahrávanie súboru Špeciálne:NahranieSúboru

Nahraté súbory sú dostupné na stránke: Špeciálne:ZoznamSúborov

Stránka na nahranie súboru je prístupná aj z bočnej lišty nástroje.

Používanie nahratých súborov a obrázkov je ukázané na stránke: šablónova strana

Linkovanie obsahu

Linkovať môžeme externé a interné stránky, ďalej nahraté súbory.

Externý link
[http://www.example.com názov odkazu]
Interné linky na stránky
[[názov strany na wiki]]
Link na obrázok (vloženie obrázku do textu)
[[Súbor:nahratý obrázok.png]]

</nowiki>

Ďalšie bežné činnosti

  • Úprava bočného menu - treba upraviť stránku MediaWiki:Sidebar TODO: Nefunguje. Doriešiť
  • Vypnutie obsahu -ak stránka obsahuje viacero nadpisov rôznych úrovní, automaticky sa na jej vrchu vygeneruje obsah s linkami na jednotlivé časti. Toto môže byť nevhodné pre krátke stránky, kde každá sekcia obsahuje len veľmi málo textu. V takom prípade sa to dá vypnúť vložením textu __NOTOC__ na začiatok kódu stránky.
Osobné nástroje
Menné priestory

Varianty
Operácie
Navigácia
Nástroje