Commit 15c5cbfe authored by Vít Novotný's avatar Vít Novotný
Browse files

Additional information were inserted into the guide and to the

example files.
parent 70116a4f
Loading
Loading
Loading
Loading
+10 −9
Original line number Diff line number Diff line
@@ -29,8 +29,9 @@ USEREXAMPLES=example/mu/econ-lualatex.pdf \
	example/mu/phil-pdflatex.pdf example/mu/sci-lualatex.pdf \
	example/mu/sci-pdflatex.pdf
DEVEXAMPLES=guide/EXAMPLE/DESCRIPTION guide/mu/DESCRIPTION \
	guide/DESCRIPTION locale/DESCRIPTION locale/EXAMPLE.dtx \
	locale/EXAMPLE.ins logo/EXAMPLE/DESCRIPTION logo/mu/DESCRIPTION \
	guide/mu/resources/DESCRIPTION guide/DESCRIPTION \
	locale/DESCRIPTION locale/EXAMPLE.dtx locale/EXAMPLE.ins \
	logo/EXAMPLE/DESCRIPTION logo/mu/DESCRIPTION \
	logo/DESCRIPTION style/EXAMPLE/DESCRIPTION style/mu/DESCRIPTION \
	style/DESCRIPTION test/DESCRIPTION example/EXAMPLE/DESCRIPTION \
	example/mu/DESCRIPTION example/DESCRIPTION
@@ -71,13 +72,13 @@ all: $(SUBMAKES_REQUIRED)
complete: all
	make $(PDFS) clean

# This pseudo-target calls a submakefile
# This pseudo-target calls a submakefile.
$(SUBMAKES_REQUIRED):
	make -C $@ all

# This pseudo-target performs the unit tests
# This pseudo-target performs the unit tests.
test: all
	make -C test
	make -C test all

# This pseudo-target creates the distribution archive.
dist: dist-implode complete
@@ -99,14 +100,14 @@ $(MANUAL): $(DTXFILES)
	pdflatex $<
	pdflatex $<

# This target generates a TeX directory structure file
# This target generates a TeX directory structure file.
$(TDSARCHIVE):
	DIR=`mktemp -d` && \
	make install to="$$DIR" nohash=true && \
	(cd "$$DIR" && zip -r -v -nw $@ *) && \
	mv "$$DIR"/$@ $@ && rm -rf "$$DIR"

# This target generates a distribution file
# This target generates a distribution file.
$(DISTARCHIVE): $(SOURCES) $(LATEXFILES) $(MAKES) $(TESTS) \
	$(DOCS) $(PDFSOURCES) $(MISCELLANEOUS) $(EXAMPLES) $(VERSION)
	DIR=`mktemp -d` && \
@@ -115,7 +116,7 @@ $(DISTARCHIVE): $(SOURCES) $(LATEXFILES) $(MAKES) $(TESTS) \
	(cd "$$DIR" && zip -r -v -nw $@ *) && \
	mv "$$DIR"/$@ . && rm -rf "$$DIR"

# This target generates a CTAN distribution file
# This target generates a CTAN distribution file.
$(CTANARCHIVE): $(SOURCES) $(MAKES) $(TESTS) $(EXAMPLES) \
	$(MISCELLANEOUS) $(EPSLOGOS) $(DOCS) $(VERSION)
	DIR=`mktemp -d` && mkdir -p "$$DIR/fithesis" && \
+64 −66
Original line number Diff line number Diff line
@@ -61,6 +61,7 @@
%%
%% For non-Latin scripts, it may be necessary to load additional
%% fonts:
\usepackage[T1,T2A]{fontenc}
\usepackage{paratype}
\def\textrussian#1{{\usefont{T2A}{PTSerif-TLF}{m}{rm}#1}}
%</pdftex>
@@ -404,6 +405,7 @@
\usepackage{amsthm}
\usepackage{amsfonts}
\usepackage{url}
\usepackage{menukeys}
\begin{document}
%<*econ>
\makeatletter
@@ -732,47 +734,7 @@ fonts will become available: \[
  See \url{http://tex.stackexchange.com/a/58124/70941}.
}.

\chapter{The bibliography and the index}
\section{Inserting the index}
After using the \verb"\makeindex" macro and loading the
\texttt{makeidx} package that provides additional indexing
commands, index entries can be created by issuing the \verb"\index"
command. \index{dummy text|(}It is possible to create ranged index
entries, which will encompass a span of text.\index{dummy text|)}
To insert complex typographic material -- such as $\alpha$
\index{alpha@$\alpha$} or \TeX{} \index{TeX@\TeX} --
into the index, you need to specify a text string, which will
determine how the entry will be sorted. It is also possible to
create hierarchal entries. \index{vehicles!trucks}
\index{vehicles!speed cars}

After the first run of
%<*pdftex>
\texttt{pdflatex \jobname.tex},
%</pdftex>
%<*luatex>
\texttt{lualatex \jobname.tex},
%</luatex>
it is necessary to generate the index by running
\begin{center}%
  \texttt{texindy -I omega -\kern0em-language }$\langle$\textit{locale}%
  $\rangle$\texttt{ \jobname.idx}
\end{center}
where $\langle$\textit{locale}$\rangle$ corresponds to the main
locale of your thesis -- such as \texttt{english}, and then running
%<*pdftex>
\texttt{pdflatex \jobname.tex}
%</pdftex>
%<*luatex>
\texttt{lualatex \jobname.tex}
%</luatex>
again. With online services -- such as Overleaf -- this is
performed automatically, although the locale may be erroneously
detected, leading to ill-sorted index entries. To insert the
generated index into the document, use the \verb"\printindex"
command.

\section{Inserting the bibliography}
\chapter{Inserting the bibliography}
After loading the \texttt{biblatex} package and linking a
bibliography data\-base file to the document using the
\verb"\addbibresource" command, you can start citing the entries.
@@ -787,38 +749,74 @@ or %% Let us define a compound command:
\emph{\fullcite{inbook-full}}. We can easily insert a bibliographic
citation into the footnote\footfullcite{inbook-full}.

The \verb"\nocite" command will not generate any output, but it
will insert its argument into the bibliography. The
\verb"\nocite{*}" command will insert all the records in the
bibliography database file into the bibliography. Try uncommenting
the command
The \verb"\nocite" command will not generate any
output\nocite{booklet-full}, but it will insert its argument into
the bibliography. The \verb"\nocite{*}" command will insert all the
records in the bibliography database file into the bibliography.
Try uncommenting the command
%% \nocite{*}
and watch the bibliography section come apart at the seams.

During the first run of
%<*pdftex>
\texttt{pdflatex \jobname.tex},
%</pdftex>
%<*luatex>
\texttt{lualatex \jobname.tex},
%</luatex>
citing a \texttt{work} will expand to [\textbf{work}] and the
When typesetting the document for the first time, citing a
\texttt{work} will expand to [\textbf{work}] and the
\verb"\printbibliography" command will produce no output. It is now
necessary to generate the bibliography by running \texttt{biber
\jobname.bcf} and then by running
%<*pdftex>
\texttt{pdflatex \jobname.tex}
%</pdftex>
%<*luatex>
\texttt{lualatex \jobname.tex}
%</luatex>
twice. In the first run, the bibliography section is typeset, and
in the second run, the section appears in the Table of Contents.
With online services -- such as Overleaf -- this is performed
automatically.
\jobname.bcf} from the command line and then by typesetting the
document again twice. During the first run, the bibliography
section and the citations will be typeset, and in the second run,
the bibliography section will appear in the table of contents.

The \texttt{biber} command needs to be executed from within the
directory, where the \LaTeX\ source file is located. In Windows,
the command line can be opened in a directory by holding down the
\keys{Shift} key and by clicking the right mouse button while
hovering the cursor over a directory.  Select the \menu{Open
Command Window Here} option in the context menu that opens shortly
afterwards.

With online services -- such as Overleaf -- all commands are
executed automatically.

\printbibliography[heading=bibintoc] %% Print the bibliography.

\chapter{Inserting the index}
After using the \verb"\makeindex" macro and loading the
\texttt{makeidx} package that provides additional indexing
commands, index entries can be created by issuing the \verb"\index"
command. \index{dummy text|(}It is possible to create ranged index
entries, which will encompass a span of text.\index{dummy text|)}
To insert complex typographic material -- such as $\alpha$
\index{alpha@$\alpha$} or \TeX{} \index{TeX@\TeX} --
into the index, you need to specify a text string, which will
determine how the entry will be sorted. It is also possible to
create hierarchal entries. \index{vehicles!trucks}
\index{vehicles!speed cars}

After typesetting the document, it is necessary to generate the
index by running
\begin{center}%
  \texttt{texindy -I latex -C utf8 -L }$\langle$\textit{locale}%
  $\rangle$\texttt{ \jobname.idx}
\end{center}
from the command line, where $\langle$\textit{locale}$\rangle$
corresponds to the main locale of your thesis -- such as
\texttt{english}, and then typesetting the document again.

The \texttt{texindy} command needs to be executed from within the
directory, where the \LaTeX\ source file is located. In Windows,
the command line can be opened in a directory by holding down the
\keys{Shift} key and by clicking the right mouse button while
hovering the cursor over a directory. Select the \menu{Open Command
Window Here} option in the context menu that opens shortly
afterwards.

With online services -- such as Overleaf -- the commands are
executed automatically, although the locale may be erroneously
detected, or the \texttt{makeindex} tool (which is only able to
sort entries that contain digits and letters of the English
alphabet) may be used instead of \texttt{texindy}. In either case,
the index will be ill-sorted.

\makeatletter\thesis@blocks@clear\makeatother
\phantomsection %% Print the index and insert it into the
\addcontentsline{toc}{chapter}{\indexname} %% table of contents.
+5 −3
Original line number Diff line number Diff line
@@ -49,13 +49,15 @@
%<*class>
\NeedsTeXFormat{LaTeX2e}
% Define `\thesis@version` and store it in the `VERSION.tex` file \fi
\def\thesis@version{2015/11/19 v0.3.25 fithesis3 MU thesis class}
\def\thesis@version{2015/11/20 v0.3.25 fithesis3 MU thesis class}
% {\newwrite\f\openout\f=VERSION\write\f{\thesis@version}\closeout\f}
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% 
% \changes{v0.3.25}  {2015/11/19}{The example documents from the
%   \texttt{example} directory are now a part of the CTAN archive.}
% \changes{v0.3.25}  {2015/11/20}{The example documents from the
%   \texttt{example} directory are now a part of the CTAN archive.
%   Additional information were inserted into the guide and to the
%   example files. [VN]}
% \changes{v0.3.24}  {2015/11/17}{Added the \cs{thesis@backend}
%   tunable. The hyphenation pattern switching now uses
%   \textsf{polyglossia} instead of crude \cs{language} switching