LaTeX pre bakalársku prácu: Rozdiel medzi revíziami

Z Bakalárska práca
Prejsť na: navigácia, hľadanie
(Kostra práce)
 
(23 intermediate revisions by one other user not shown)
Riadok 1: Riadok 1:
== Základy LaTeXu pre bakalársku prácu ==
+
{{ALL}}
  
Vhodné zdroje informácií o LaTeXu:
+
Informácie pre začiatočníkov nájdete na stránke [[Úvod do LaTeXu]]. Na tejto stránke sa snažíme zhrnúť informácie špecificky potrebné k bakalárskej práci.
* Príručka ''Nie príliš stručný úvod do systému LaTeX2e'' [http://zelmanov.ptep-online.com/ctan/lshort_slovak.pdf staršia verzia v slovenčine], [https://tobi.oetiker.ch/lshort/ novšia verzia v angličtine]
+
* [http://en.wikibooks.org/wiki/LaTeX LaTeX na Wikibooks] obsahuje aj popis mnohých užitočných knižníc makier
+
 
+
Čo ale budete pravdepodobne potrebovať k bakalárskej práci skúsime zhrnúť.
+
 
+
== Potrebný softvér ==
+
 
+
* Unix: [http://en.wikipedia.org/wiki/TeX_Live TeXLive]
+
* Windows: [http://miktex.org/ MikTeX]
+
* Existujú aj grafické a online prostredia na uľahčenie práce, viď [https://en.wikibooks.org/wiki/LaTeX/Installation wikibooks]
+
  
 
== Kostra práce ==
 
== Kostra práce ==
  
Ak chcete použiť LaTex, môžete si stiahnuť [[Media:BakalarskaPraca.zip | kostru bakalárskej práce]], ktorá obsahuje požadovaný formát prvých strán a ukážky užitočných príkazov.
+
Ak chcete použiť LaTeX, môžete si stiahnuť [[Media:praca.zip | kostru bakalárskej práce]], ktorá obsahuje požadovaný formát prvých strán a ukážky užitočných príkazov.
 +
* Ako alternatívu môžete tiež použiť kostru, ktorú spravili nedávni absolventi: https://github.com/davidmisiak/thesis-template
  
 
Kostra obsahuje niekoľko súborov:
 
Kostra obsahuje niekoľko súborov:
 
* súbor main.tex: hlavný súbor, v ktorom je kostra práce  
 
* súbor main.tex: hlavný súbor, v ktorom je kostra práce  
 
* súbor main-en.tex: ukážka, ako adaptovať hlavný súbor pre práce v angličtine
 
* súbor main-en.tex: ukážka, ako adaptovať hlavný súbor pre práce v angličtine
* ďalšie súbory .tex: jednotlivé kapitoly práce - úvod, kapitola, latex, lorem, záver, prílohy
+
* ďalšie súbory .tex: jednotlivé kapitoly práce - úvod, kapitola, latex, záver, prílohy
 
* literatúra.bib: zoznam literatúry v BibTeXu
 
* literatúra.bib: zoznam literatúry v BibTeXu
* adresar images s obrázkami
+
* prečinok images s obrázkami a zadaním v pdf formáte
  
 +
Vytvorenie pdf (ak používate príkazový riadok):
 +
<pre>
 +
pdflatex main.tex  # pri prvom spustení sa uložia potrebné odkazy
 +
bibtex main        # spracovanie literatúry
 +
pdflatex main.tex  # pri druhom spustení sa vytvoria odkazy v texte, ale môžu sa ešte posunúť strany
 +
pdflatex main.tex  # preto pre istotu zopakujeme ešte raz
 +
</pre>
 +
* Informácie o obsahu, odkazoch a podobne si LaTeX ukladá do pomocných súborov, napr. <tt>main.aux</tt>, <tt>main.toc</tt>
 +
* Tento postup je zapísaný v súbore Makefile, stačí teda spustiť príkaz <tt>make</tt>
  
=== Spúšťanie LaTeXu ===
+
== Členenie práce ==
  
Vo vhodnom editore upravujeme zdrojové texty (<tt>priklad.tex</tt>) a následne z nich vytvoríme pdf príkazom
+
Bakalárska práca je vlastne kniha, začína riadkom
:: <tt>pdflatex priklad.tex</tt>
+
* Vytvorí <tt>priklad.pdf</tt> a a pomocné súbory, ktoré udržiavajú informáciu o obsahu, referenciách a pod., napr. <tt>priklad.aux</tt>, <tt>priklad.toc</tt>
+
 
+
* V prípade, že sme robili väčšiu úpravu (referencie, kapitoly, obrázky... ) odporúča sa spustiť príkaz dvakrát
+
* Ak máme viacero súborov, TeXujeme ten, ktorý obsahuje <nowiki>\begin{document}</nowiki> (v našom prípade <tt>main</tt>)
+
* Pekná možnosť je urobiť si <tt>Makefile</tt> s vhodnými nastaveniami a následne používať ten (príklad v kostre práce)
+
 
+
 
+
=== Členenie práce ===
+
 
+
Bakalárska práca je vlastne kniha  
+
 
   
 
   
\documentclass[12pt, oneside]{book}
+
<pre>
 +
\documentclass[12pt, twoside]{book}
 +
</pre>
  
 
a tým pádom sa očakáva členenie na kapitoly, podkapitoly, atď.  
 
a tým pádom sa očakáva členenie na kapitoly, podkapitoly, atď.  
  
* Kapitola <nowiki>\chapter{Nazov}</nowiki> - koniec kapitoly sa nerobí, kapitola skončí, keď začne iná
+
* Kapitola <tt>\chapter{Nazov}</tt>  
* Podkapitola (Section) <nowiki>\section{Nazov}</nowiki>
+
* Podkapitola <tt>\section{Nazov}</tt>
* Ešte podrobnejšie členenie <nowiki>\subsection{Nazov}</nowiki>
+
* Ešte podrobnejšie členenie <tt>\subsection{Nazov}</tt>
* Odstavec s malým nadpisom <nowiki>\paragraph{Nazov}</nowiki>
+
* Odstavec s malým nadpisom <tt>\paragraph{Nazov}</tt>
 
* Ak niečo nechceme číslovať, použijeme *, avšak, ak to chceme v obsahu, musíme to do neho pridať
 
* Ak niečo nechceme číslovať, použijeme *, avšak, ak to chceme v obsahu, musíme to do neho pridať
  
Riadok 55: Riadok 46:
 
</pre>
 
</pre>
  
=== Obrázok, tabuľka ===
+
== Číslovanie a odkazy v rámci textu ==
  
Samotný obrázok sa vkladá pomocou
+
* Latex čísluje kapitoly a podkapitoly, obrázky, tabuľky, vzorce, definície, lemy atď.
+
* Na jednotlivé súčasti textu je vhodné odkazovať sa číslom
\includegraphics[nastavenia veľkosti]{obrazok}
+
* Aby sme nemuseli čísla ručne meniť, požijeme dvojicu príkazov <tt>\label</tt> a <tt>\ref</tt>.
  
Obvykle však chceme obrázok aj s popiskom, preto ho vložíme ako figure, ktorá je vlastne "plávajúcim" objektom a vloží sa do dokumentu podľa nastavenia
+
Časti textu, na ktorú sa chceme odkazovať vytvoríme názov pomocou <tt>\label</tt>:
 +
<pre>
 +
\chapter{Implementácia}
 +
\label{chap:impl}
 +
</pre>
  
\begin{figure}[nastavenia umiestnenia] % ak neviete, vynechajte alebo použite t ako top
+
Ak sa na túto kapitolu teraz chceme odvolať, použijeme <tt>\ref</tt>:
  \centering
+
<pre>
    \includegraphics[width=0.5\textwidth]{obrazok}
+
Ako konkrétne sme algoritmus implementovali, vysvetlíme v kapitole \ref{chap:impl}.
  \caption{Príklad kostry grafu.}\label{fig:kostra}
+
</pre>
\end{figure}
+
  
Tabuľka sa vytvára pomocou
+
== Obrázky, tabuľky ==
  
\begin{tabular}{| l c r |} % tri stĺpce, prvý zarovnaný doľava, druhý vycentrovaný a tretí zarovnaný doprava, medzi stĺpcami nie sú čiary ale na krajoch áno
+
* Obrázky a tabuľky sa vkladajú v "plávajúcich" (floating) prostrediach <tt>figure</tt> a <tt>table</tt>, ktoré LaTeX umiestni na vhodné miesto (vrch aktuálnej strany, prípadne ďalšej strany, alebo aj samostatná strana).
  \hline        % na vrchu tabuľky je čiara
+
* V rámci tohto prostredia vkladáme pod obrázok alebo tabuľku aj popis (caption).
    1 & 2 & 3 \\ % prvý riadok, obsahy stĺpcov sú oddelené & na konci \\
+
* LaTex obrázky a tabuľky čísluje.
    4 & 5 & 6 \\
+
* Na každý obrázok a tabuľku by ste sa mali v texte aspoň raz odkázať (pomocou <tt>\ref</tt>)
    7 & 8 & 9 \\
+
* <tt>\label</tt> dajte až za <tt>\caption</tt>
  \hline        % aj dole je čiara (všimnite si, že medzi riadkami tabušky čiara nebola)
+
  \end{tabular}
+
  
Podobne ako pri obrázku aj tabuľku chceme ako označovaný objekt a tým pádom ju vkladáme do prostredia table
+
<pre>
 +
\begin{figure}
 +
  \begin{center}
 +
    \includegraphics[width=0.5\textwidth]{obrazok.png}
 +
    \caption{Príklad kostry grafu.}\label{fig:kostra}
 +
  \end{center}
 +
\end{figure}
  
\begin{table}[t]
+
\begin{table}
 
   \begin{center}
 
   \begin{center}
 +
    \caption{A simple table}\label{tab:simple}
 
     \begin{tabular}{| l c r |}
 
     \begin{tabular}{| l c r |}
    \hline
+
      \hline
    1 & 2 & 3 \\
+
      1 & 2 & 3 \\
    4 & 5 & 6 \\
+
      4 & 5 & 6 \\
    7 & 8 & 9 \\
+
      7 & 8 & 9 \\
    \hline
+
      \hline
 
     \end{tabular}
 
     \end{tabular}
 
   \end{center}
 
   \end{center}
  \caption{A simple table}\label{tab:simple}
+
\end{table}
\end{table}
+
</pre>
 
+
=== Odkazy v rámci textu (na obrázky a pod.) ===
+
 
+
Keď chceme odkazovať na nejakú kapitolu alebo inú časť knihy je dobré odkazovať na to číslom.
+
Najprv vytvoríme label, na ktorý budeme odkazovať.
+
 
+
\chapter{Implementation}
+
\label{chap:implementation}
+
 
+
Následne sa môžeme odkazovať pomocou referencie, čo bude udržiavať správne číslo aj v prípade zmien v poradí kapitol a pod.
+
 
+
Ako konkrétne sme algoritmus implementovali, vysvetlíme v Kapitole \ref{chap:implementation}
+
 
+
Podobne môžeme vytvoriť dvojicu label-referencia aj pre obrázok, tabuľku a pod. Dôležité je dať label pod popis.
+
  
\begin{figure}
+
==Práca s literatúrou==
\includegraphics[width=0.2\textwidth]{images/cervik}
+
\caption{Červík}\label{obr:cursus}
+
\end{figure}
+
  
===Práca s literatúrou===
+
* Vhodné je použiť systém [http://en.wikipedia.org/wiki/BibTeX BibTeX]
 +
* V .bib súbore si spravíme zoznam použitých zdrojov, každému dáme label
 +
* Záznamy vo formáte pre BibTex si vieme stiahnuť z niektorých stránok (napr. [http://scholar.google.com/ Google scholar]) alebo vytvoriť [[Práca_s_literatúrou#Podporn.C3.BD_softv.C3.A9r|nástrojmi na prácu s literatúrou]]
 +
* V texte odkazujeme na zdroje pomocou <tt>\cite{label}</tt>, každý zdroj by sme mali aspoň raz zacitovať
  
* Vhodné je použiť systém BibTeX
+
Časté chyby:
* viď napr. http://en.wikipedia.org/wiki/BibTeX
+
* BibTeX mení písmená v názve článku na malé, čo je problém pri skratkách a vlastných menách v názvoch. Vložte tieto slová do {}. Napr <tt>title="Theano: a {CPU} and {GPU} math expression compiler"</tt>.  
* v .bib súbore si spravíme zoznam použitých zdrojov, každému dáme label
+
* Mená autorov treba písať v poradí krstné meno priezvisko alebo priezvisko, krstné meno (t.j. Jozef Mrkvička alebo Mrkvička, Jozef).
* v texte odkazujeme na zdroje pomocou \cite{label}
+
* Autorov oddeľujte slovom and, čiarka sa považuje za oddelenie priezviska a mena.
* záznamy vo formáte pre BibTex si vieme stiahnuť z niektorých stránok (napr. [http://scholar.google.com/ Google scholar]) alebo vytvoriť [[Práca_s_literatúrou#Podporn.C3.BD_softv.C3.A9r|nástrojmi na prácu s literatúrou]]
+
* Ak je autorom organizácia s viacslovným názvom, dajte ju do {}, napr  <tt>author="{ENCODE Project Consortium}"</tt>
 +
* Ak je autorov veľa, uveďte prvého a  et al., čo dostanete v BibTeXu pomocou <tt>and others</tt>
  
 
== Zaujímavé balíčky ==
 
== Zaujímavé balíčky ==
  
Tu bude postupne pribúdať zoznam zaujímavých balíčkov v teXu, ktoré nájdeme a budeme považovať za užitočné, alebo ich odporučíte spolužiakom vy.
+
Tu bude postupne pribúdať zoznam zaujímavých balíčkov v LaTeXu, ktoré nájdeme a budeme považovať za užitočné, alebo ich odporučíte spolužiakom vy.
  
* [http://www.codealias.info/technotes/latex_subfigure_example subfigure] urobí do jedného obrázku viac podobrázkov
+
* [https://ctan.org/pkg/subcaption Balíček subcaption] urobí do jedného obrázku viac podobrázkov
* [http://texdoc.net/texmf-dist/doc/latex/listings/listings.pdf listings] highlightovanie a formátovanie zdrojového kódu vkladaného do LaTeXu
+
* [http://texdoc.net/texmf-dist/doc/latex/listings/listings.pdf Balíček listings] highlightovanie a formátovanie zdrojového kódu vkladaného do LaTeXu
* [http://cs.brown.edu/about/system/software/latex/doc/newalg.pdf newalg] pekné ale prácne formátovanie pseudokódu
+
* [https://www.overleaf.com/learn/latex/Algorithms Návod] na formátovanie pseudokódu
 +
* [https://www.tablesgenerator.com/ Table Generator] stránka na generovanie LaTeXových tabuliek prekopírovaním tabuľky z kancelárskeho softvéru
  
 
== Kontrola originality záverečnej práce ==
 
== Kontrola originality záverečnej práce ==

Aktuálna revízia z 06:36, 19. október 2022

Bakalársky seminár 2022/23 · INF (Úvod) · DAV+BIN (Úvod)

Nová stránka predmetu je na adrese https://bbrejova.github.io/bcinf/ pre INF a https://bbrejova.github.io/bcdav/ pre DAV a BIN

Informácie pre začiatočníkov nájdete na stránke Úvod do LaTeXu. Na tejto stránke sa snažíme zhrnúť informácie špecificky potrebné k bakalárskej práci.

Kostra práce

Ak chcete použiť LaTeX, môžete si stiahnuť kostru bakalárskej práce, ktorá obsahuje požadovaný formát prvých strán a ukážky užitočných príkazov.

Kostra obsahuje niekoľko súborov:

  • súbor main.tex: hlavný súbor, v ktorom je kostra práce
  • súbor main-en.tex: ukážka, ako adaptovať hlavný súbor pre práce v angličtine
  • ďalšie súbory .tex: jednotlivé kapitoly práce - úvod, kapitola, latex, záver, prílohy
  • literatúra.bib: zoznam literatúry v BibTeXu
  • prečinok images s obrázkami a zadaním v pdf formáte

Vytvorenie pdf (ak používate príkazový riadok):

pdflatex main.tex   # pri prvom spustení sa uložia potrebné odkazy
bibtex main         # spracovanie literatúry
pdflatex main.tex   # pri druhom spustení sa vytvoria odkazy v texte, ale môžu sa ešte posunúť strany
pdflatex main.tex   # preto pre istotu zopakujeme ešte raz
  • Informácie o obsahu, odkazoch a podobne si LaTeX ukladá do pomocných súborov, napr. main.aux, main.toc
  • Tento postup je zapísaný v súbore Makefile, stačí teda spustiť príkaz make

Členenie práce

Bakalárska práca je vlastne kniha, začína riadkom

\documentclass[12pt, twoside]{book}

a tým pádom sa očakáva členenie na kapitoly, podkapitoly, atď.

  • Kapitola \chapter{Nazov}
  • Podkapitola \section{Nazov}
  • Ešte podrobnejšie členenie \subsection{Nazov}
  • Odstavec s malým nadpisom \paragraph{Nazov}
  • Ak niečo nechceme číslovať, použijeme *, avšak, ak to chceme v obsahu, musíme to do neho pridať
\chapter*{Úvod}
\addcontentsline{toc}{chapter}{Úvod}

Číslovanie a odkazy v rámci textu

  • Latex čísluje kapitoly a podkapitoly, obrázky, tabuľky, vzorce, definície, lemy atď.
  • Na jednotlivé súčasti textu je vhodné odkazovať sa číslom
  • Aby sme nemuseli čísla ručne meniť, požijeme dvojicu príkazov \label a \ref.

Časti textu, na ktorú sa chceme odkazovať vytvoríme názov pomocou \label:

\chapter{Implementácia}
\label{chap:impl}

Ak sa na túto kapitolu teraz chceme odvolať, použijeme \ref:

Ako konkrétne sme algoritmus implementovali, vysvetlíme v kapitole \ref{chap:impl}.

Obrázky, tabuľky

  • Obrázky a tabuľky sa vkladajú v "plávajúcich" (floating) prostrediach figure a table, ktoré LaTeX umiestni na vhodné miesto (vrch aktuálnej strany, prípadne ďalšej strany, alebo aj samostatná strana).
  • V rámci tohto prostredia vkladáme pod obrázok alebo tabuľku aj popis (caption).
  • LaTex obrázky a tabuľky čísluje.
  • Na každý obrázok a tabuľku by ste sa mali v texte aspoň raz odkázať (pomocou \ref)
  • \label dajte až za \caption
\begin{figure}
  \begin{center}
     \includegraphics[width=0.5\textwidth]{obrazok.png}
     \caption{Príklad kostry grafu.}\label{fig:kostra}
  \end{center}
\end{figure} 

\begin{table}
  \begin{center}
    \caption{A simple table}\label{tab:simple}
    \begin{tabular}{| l c r |}
      \hline
      1 & 2 & 3 \\
      4 & 5 & 6 \\
      7 & 8 & 9 \\
      \hline
    \end{tabular}
  \end{center}
\end{table}

Práca s literatúrou

  • Vhodné je použiť systém BibTeX
  • V .bib súbore si spravíme zoznam použitých zdrojov, každému dáme label
  • Záznamy vo formáte pre BibTex si vieme stiahnuť z niektorých stránok (napr. Google scholar) alebo vytvoriť nástrojmi na prácu s literatúrou
  • V texte odkazujeme na zdroje pomocou \cite{label}, každý zdroj by sme mali aspoň raz zacitovať

Časté chyby:

  • BibTeX mení písmená v názve článku na malé, čo je problém pri skratkách a vlastných menách v názvoch. Vložte tieto slová do {}. Napr title="Theano: a {CPU} and {GPU} math expression compiler".
  • Mená autorov treba písať v poradí krstné meno priezvisko alebo priezvisko, krstné meno (t.j. Jozef Mrkvička alebo Mrkvička, Jozef).
  • Autorov oddeľujte slovom and, čiarka sa považuje za oddelenie priezviska a mena.
  • Ak je autorom organizácia s viacslovným názvom, dajte ju do {}, napr author="{ENCODE Project Consortium}"
  • Ak je autorov veľa, uveďte prvého a et al., čo dostanete v BibTeXu pomocou and others

Zaujímavé balíčky

Tu bude postupne pribúdať zoznam zaujímavých balíčkov v LaTeXu, ktoré nájdeme a budeme považovať za užitočné, alebo ich odporučíte spolužiakom vy.

  • Balíček subcaption urobí do jedného obrázku viac podobrázkov
  • Balíček listings highlightovanie a formátovanie zdrojového kódu vkladaného do LaTeXu
  • Návod na formátovanie pseudokódu
  • Table Generator stránka na generovanie LaTeXových tabuliek prekopírovaním tabuľky z kancelárskeho softvéru

Kontrola originality záverečnej práce

Keďže sa práca kontroluje automaticky v centrálnom registri, je potrebné, aby bola vo formáte PDF, ktorý nesmie byť zaheslovaný a musí sa dať previesť na čistý text.

  • prevod na text si môžete otestovať [1]

Rozhodne zatiaľ neodovzdávajte prácu (alebo časti práce) do AISu. Prácu odovzdajte a označte v systéme AiS2 ako finálnu až po ubezpečení sa, že je to konečná verzia a že v nej nebudete robiť ďalšie úpravy. Prácu môže študent označiť ako finálnu IBA 1x.

Najnovšie verzie pdflatex-u by mali vytvoriť pdf súbor, ktorý sa dá dobre previesť na čistý text, avšak pri starších verziách môžete mať problémy s kódovaním diakritiky - výsledok môže byť napr.

  • Kl’uˇov´ slov´: jedno, druh´, tretie (pr´ ´c e a e ıpadne ˇtvrt´, piate) s e
  • Kl ’´uˇcov´e slov´a: jedno, druh´e, tretie (pr´ıpadne ˇstvrt´e, piate)

Pomôcť vám môže nainštalovanie balíčku fontov cm-super.