Navod

Z WikiSkripta FJFI ČVUT v Praze
Přejít na: navigace, hledání

Návod k editaci

Editace skript se provádí v jazyce LaTEX. Výsledný dokument je ve formátu PDF (ke stažení v menu na začátku příslušné stránky). Případné chyby při překladu je nutné ve zdrojovém kódu odstranit. Při potížích kontaktujte správce.

Se systémem LaTEX se seznamte zde:

Struktura WikiSkripta

Každé WikiSkriptum musí být definováno pomocí klíčového slova, které musí být shodné s názvem kořenové stránky daného skripta - například WikiSkriptum z matematické analýzy 3 má kořenovou stránku 01MAA3 a klíčové slovo 01MAA3. Klíčové slovo musí být zadáno v každé části (hlavičkovém souboru, kapitole, referencích, atp.) daného wikiskripta příkazem \wikiskriptum{klíčové slovo}

Jakmile se v daném dokumentu vyskytuje příkaz \wikiskriptum{klíčové slovo}, systém vyhodnotí stránku jako součást WikiSkripta a vytvoří v záhlaví odkaz na řídící stránku, která má tvar "klíčové slovo:ControlFile", tedy např. "01MAA3:ControlFile". Toto je jediná stránka, kam se vkládají informace o kapitolách a vložených souborech pro překlad systémem LaTeX.

Struktura řídící stránky

Řídící stránka obsahuje nejprve odkaz na kořenový dokument (tedy vlastně klíčové slovo)

\wikiskriptum {klíčové slovo}

Dále následuje seznam jednotlivých částí WikiSkripta pomocí příkazu

\wikichapter{číslo}{název_pro_latex}{popisek}

kde číslo určuje název dané kapitoly v systému MediaWiki takto: "klíčové slovo:Kapitolačíslo", tedy například "01MAA3:Kapitolačíslo". Položka název_pro_latex slouží k vytvoření souboru název_pro_latex.tex, který bude k dispozici pro LaTeX při překladu - udává tedy jméno souboru, který se vloží ve zdrojovém kódu LaTeXu příkazem \input{název_pro_latex}. Konečně popisek slouží jen k pojmenování jednotlivých kapitol v menu každé části WikiSkripta, které se generuje automaticky. Pořadí v jakém uvedete příkazy \wikichapter{}{}{} určují pořadí, v kterém se budou vypisovat v menu.

Příklad

\wikichapter{1}{kapitola1}{Definice funkce}
\wikichapter{2}{reference}{Literatura}

bude odkazovat na MediaWiki stránky "klíčové slovo:Kapitola1" a "klíčové slovo:Kapitola2", přičemž při překladu pro LaTeX se vytvoří soubory "kapitola1.tex" a "reference.tex".

Hlavičkový soubor

Hlavičkový soubor má pevný název "klíčové slovo:Header" a pro LaTeX se vždy generuje jako "header.tex", tj. do kořenové stránky se vloží jako

\input{header}

Hlavičkový soubor se v řídící stránce nedefinuje (změna oproti verzi 1.2009.09).

Vkládání obrázků

Obrázky je nutné nahrát pomocí nástroje načíst soubor, pojmenovat např. soubor.png. Pak stačí jen do řídící stránky "klíčové slovo:ControlFile" vložit

\wikifile{Image:soubor.png}{soubor.png}

Obrázek se poté vloží kamkoliv do textu pomocí LaTeXového příkazu

\includegraphics[formát]{soubor} 

Založení nového skripta

  1. Zvolte jednoznačné klíčové slovo (např. 01MAA3cviceni pro zápisky ze cviceni 01MAA3), přičemž raději nepoužívejte diakritiku.
  2. Dejte vyhledat klíčové slovo a v případě neúspěchu se Vám ukáže odkaz na založení nové stránky s názvem klíčového slova - tímto vytvoříte kořenovou stránku nového WikiSkripta
  3. Do prázdné stránky napište %\wikiskriptum{klíčové slovo} a uložte
  4. V horním menu se objeví odkaz na řídící stránku, přes který vytvořte řídící stránku (soubor) s obsahem viz výše
  5. Řídící stránku uložte a vraťte se na kořenovou stránku - zde je nutné dát stránku editovat + uložit, aby se projevily změny provedené v řídícím souboru. Toto je způsobeno cacheováním stránek na cestě ze serveru k Vašemu počítači.
  6. Dále už stačí kliknout na vytvořené odkazy na jednotlivé kapitoly a v záhlaví každé kapitoly nezapomenout napsat %\wikiskriptum{klíčové slovo}. Tímto způsobem se propojí jednotlivé části WikiSkripta.
  7. Pokud chcete vložit kamkoliv do daného dokumentu obrázek, stačí umístit příkaz \wikifile{}{} do řídící stránky
  8. Příklad viz Hřiště a pokyny v komentářích.


Vyzkoušejte si práci se systémem LaTEX

Na stránce Hřiště si můžete vyzkoušet práci se systémem LaTEX dřív, než se pustíte do editování skript.