Softwarová podpora

Software helpdesk

Kontakt / Contact: doc. RNDr. Stanislav Hledík, Ph.D.

sh_Aid_1.gif

ΤeΧWindowsWL & MathematicaC/C++GNU, Linux, …

ΤeΧ

Sazba kvalifikačních prací

Balíček ‘ipothes’ (akronym “Institute of Physics in Opava THESis”) je určen k sazbě všech typů kvalifikačních prací (bakalářských, diplomových, rigorosních, doktorských), případně i jiných typů prací (ročníkových, semestrálních, seminárních), pomocí typografického systému LaΤeΧ. Odkazy ke stažení a instalační instrukce najdete v Kapitole 1: “Instalace” hypertextového manuálu vzorova_prace.pdf.

Verze ke stažení odpovídá položce na nejhořejším místě v seznamu Release Notes níže; starší verze v něm uvedené nejsou k dispozici. Přecházíte-li z verze ipothes-22.04.08 nebo starší na jakoukoli novější, doporučuji použít všechny soubory z novější verze s výjimkou vašich vlastních obrázků v adresáři ‘manual/images’ a vašich vlastních zdrojových textů kapitol v adresáři ‘manual/include’, znovu vyplnit hlavní LaΤeΧový zdrojový soubor ‘manual/vzorova_prace.tex’, a případně doplnit vaše vlastní editace do souborů ‘manual/hyperref.cfg’ a ‘manual/ipothes.cfg’, pokud jste nějaké dělali.

Dočasná poznámka: Na maketě zadání v manuálu je uvedeno, že instrukce k výměně této makety za skutečné zadání jsou v Kapitole 3, která však nyní patří až do Části II a zabývá se něčím zcela odlišným (po doplnění všech kapitol budou skutečně v Kapitole 3). Instrukce proto dočasně hledejte přímo v hlavním LaΤeΧovém zdrojovém souboru ‘manual/vzorova_prace.tex’ ve formě komentáře zdrojového kódu.

Pozn.: Balíček ‘ipothes’ je dosud v procesu testování, takže každá zpětná vazba od jeho uživatelů je ceněna. Vítáni jsou TeXisté jak zkušení, tak začátečníci. Jelikož jsem balíček vyvíjel pomocí distribuce MiKTeX pod Windows 10, potřeboval bych hlavně pomoc s testováním pod jinými OS a distribucemi ΤeΧu. Základní test je popsán v manuálu, Sekce 1.4 “Testování” Kapitoly 1 “Instalace”. Pro Vaše připomínky a hlášení chyb využijte laskavě některý z kontaktů odkázaných v hlavičce stránky. Viz též Seznam ověřených distribucí a OS, pod nimiž byl ‘ipothes’ testován.

Balíček ‘ipothes’ je freeware. Omezení: kýmkoli (kromě autora) provedená jakákoli úprava nesmí být distribuována pod stejným jménem, včetně jmen adresářů, souborů s dokumentní třídou, bibliografickým stylem, a všech výskytů retězce “ipothes” v nich a ve zdrojových, konfiguračních a ostatních textových souborech knihovny a manuálu.

Subsekce Seznam ověřených distribucí, Poznámky k vydání, Zásluhy, Seznam známých chyb, Literatura a zdroje a Často kladené dotazy jsou k dispozici pouze v angličtině (viz níže).

Final Thesis typesetting

The ‘ipothes’ (an acronym for “Institute of Physics in Opava THESis”) package is intended for typesetting of all types of Final Theses (Bachelor’s, Diploma, Rigorous, Doctoral), possibly other kinds of projects (year, semester, seminar) as well, using the typographic system LaΤeΧ.  Download links and installation instructions can be found in Chapter 1: “Installation” of the sample_thesis.pdf hypertext manual.

The downloadable version corresponds to the topmost item in the Release Notes below; older versions listed are not available. If you are migrating from version ipothes-22.04.08 or older to any later version, I recommend using all files from the newer version except your own images in the ‘manual/images’ directory and your own chapter source texts in the ‘manual/include’ directory, filling in again the required data in the master LaΤeΧ file ‘manual/sample_thesis.tex’, and possibly adding your own edits to the ‘manual/hyperref.cfg’ and ‘manual/ipothes.cfg’ files, if any.

Interim Note: The mock Assignment in the manual states that the instructions for exchanging the mock Assignment for the true Assignment are in Chapter 3, which, however, currently belongs to Part II and deals with something completely different (after completing all the chapters, they will really be in Chapter 3).  Therefore, temporarily look for instructions directly in the master LaΤeΧ file ‘manual/sample_thesis.tex’ in the form of a source code comment.

Note: The ‘ipothes’ package is still in the testing process, so any feedback from its users is appreciated. Both experienced and beginners TeXists are welcome. Since I developed the package using the MiKTeX distribution under Windows 10, I would mainly need help with testing under other OS’s and ΤeΧ distributions. The basic test is described in the manual, Section 1.4 “Testing” of Chapter 1 “Installation”. For your comments and bug reports, please use one of the contacts linked in the page header. See also below for the list of proven distributions and OS’s under which ‘ipothes’ has been tested.

The ‘ipothes’ package is a Freeware. Restriction: any modification made by anyone (except of the author) must not be distributed under the same name, including directory names, document class filename, bibliographic style filename, and all occurrences of the string “ipothes” in them and in the source, configuration, and other text files of the library and the manual.

List of proven distributions

Windows 10 and 11

Last successful test with MiKTeX 22.10: ipothes-22.06.05 on Tue 2022-10-25 by the author.

Last successful test with MiKTeX 22.3: ipothes-22.05.07 on Sat 2022-05-07 by the author.

Last successful test with ΤeΧ Live 2022: ipothes-22.05.07 on Mon 2022-05-09 by the author.

MacOS 10.14.6, 11.6.5

Last successful test with MacΤeΧ-2022: ipothes-22.04.08 on Fri 2022-05-06 by Aleš Ryšavý.

Linux (Mint 20.3 Una, base Ubuntu 20.04 focal)

Last successful test with MiKTeX 22.1: ipothes-22.04.08 on Tue 2022-04-12 by Ondřej Honka and Jan Vlha.

Collaborative cloud LaΤeΧ systems

Last successful test with Overleaf: ipothes-22.05.07 on Sat 2022-05-07 by the author.

Release Notes

ipothes-22.06.05 – 4th pre-release: the manual has expanded to include Chapter ‘Preamble’ and Appendices ‘Page layout positioning’, ‘Configuration file’, ‘The hyperref package configuration’ ● section ‘Dependencies’ added to Appendix ‘Loaded packages’ ● many tiny improvements in text ● ‘etoolbox’ package loaded by class to provide ‘\AtEndPreamble’ hook, a replacement for ‘\AtBeginDocument’ hook to allow ‘hyperref’ to work properly after v7.00q 2022-05-17 ● ‘fancyvrb’ package loaded in preamble to allow verbatim file input from a line to another line (used for master file, ipothes.cfg, hyperref.cfg code snippets input) ● ‘equation’ environment redefined to ‘gather’ provided by the ‘amsmath’ package

ipothes-22.05.07 – 3rd pre-release: bibliographic style improved (now accepts ‘doi’ field) ● custom-bib refactoring and improvement (\bblaccessed introduced among other) ● references.bib file cleaning ● manual split into Czech (vzorova_prace) and English (sample_thesis) ● ipothes.cfg restructured ● class \NeedsTeXFormat{LaTeX2e}[2021/06/01] ● new way of assignment inclusion ● new language support for environments ‘annotation’, ‘keywords’, ‘acknowledgement’, ‘declaration’, ‘dedication’, ‘motto’ ● locales generally improved ● new ‘headfootsans’ option implemented ● hyperref’s \href[]{}{} typesetting imitated (no functionality of course) even without ‘htext’ option switched on ● many other tiny enhancements

ipothes-22.04.08 – 2nd pre-release: new ‘narrowmargin’ option implemented ● front matter images scaled in absolute dimensions to keep their size with ‘narrowmargin’ on ● new \frontispiceimage command simplifying use of the \frontispice command ● usability with Overleaf hopefully solved (\jobname primitive removed from places where it hinders) ● compatibility with the subfigure and subfig packages solved ● pdf compress level explicitly set in class file, controllable from config file ● hyperlink colors fine tuned

ipothes-22.04.01 – 1st pre-release: testing under various OS and distributions commenced

Credits

Martin Petrásek: thanks for testing with MiKΤeΧ under Windows.

Aleš Ryšavý: thanks for testing with MacΤeΧ under MacOS.

Ondřej Honka and Jan Vlha: thanks for testing with MiKΤeΧ under Linux.

Santu Mondal: thanks for pointing out problem with the subfigure and subfig packages.

Sudipta Hensh: thanks for introducing me to the Overleaf web distribution and for testing the ‘ipothes’ package with it.

Known bugs

The ‘enumerate’ environment alignment on the 2nd level needs tweak.

Problems with star forms of the ‘enumerate’ and ‘itemize’ environments.

Primitive \jobname works differently on Overleaf, but this is actually a feature of Overleaf, not an ‘ipothes’ bug.

References & Resources

[CTAN]   CTAN: The Comprehensive ΤeΧ Archive Network. Available at https://ctan.org/

[LaΤeΧnet]   LaΤeΧ.net: The LaΤeΧ Network. Available at https://latex.net/

[MacΤeΧ]   MacΤeΧ is a product produced by the MacΤeΧ ΤeΧnical working group of the ΤeΧ Users Group (TUG). It is the Macintosh component of the ΤeΧ Collection DVD, the reference edition of ΤeΧ distributed by ΤeΧ User Groups across the world. Available at https://tug.org/mactex/.

[MiKTeX]   MiKTeX: a modern TeX distribution for Windows, Linux and macOS. Available at https://miktex.org/

[OetNSS]   Oetiker T., Partl H., Hyna I., and Schlegl E.: The Not So Short Introduction to LaΤeΧ 2ε. Available at https://tobi.oetiker.ch/lshort/lshort.pdf

[Overleaf]   The easy to use, online, collaborative LaΤeΧ editor. Available at https://www.overleaf.com/

[PaCoLaS]   Pakin S.: The Comprehensive LaΤeΧ Symbol List. Available at http://tug.ctan.org/info/symbols/comprehensive/symbols-a4.pdf

[PolPSDP]   Polách E.: Pravidla sazby diplomových prací. Jihočeská univerzita v Českých Budějovicích, Pedagogická fakulta, České Budějovice, 1998. Available at http://home.pf.jcu.cz/~edpo/pravidla/pravidla.pdf.

[proTeXt ]   proTeXt: A MiKTeX-based distribution for Windows. Available at https://www.tug.org/protext/. As of 2022, proTeXt is expected to be retired permanently, due to changes in the MiKTeX infrastructure.

[RybDUZP]   Rybička, J.: Doporučení pro úpravu závěrečných prací. Brno, 2006. Available at https://akela.mendelu.cz/~rybicka/dahlia/zpract/dipp.pdf.

[TDS]   Schenk C.: ΤeΧ Directory Structure. Available at https://miktex.org/kb/tds

[ΤeΧLive]   ΤeΧ Live provides a comprehensive ΤeΧ system with binaries for most flavors of Unix, including GNU/Linux and macOS, and also Windows. Available at https://www.tug.org/texlive/

[SETL]   Stack Exchange – ΤeΧ-LaΤeΧ is a question and answer site for users of ΤeΧ, LaΤeΧ, ConΤeΧt, and related typesetting systems. Available at https://tex.stackexchange.com/

[SOLa]   Stack Overflow – LaΤeΧ. Available at https://stackoverflow.com/questions/tagged/latex

Často kladené dotazy / Frequently asked questions

Q: I need the ‘amsmath’ package. Where should I put \usepackage{amsmath}?

A: Do not use this at all. Read the manual appendix ‘Loaded packages’ (‘Načítané balíčky’ in Czech version) for explanation.

Q: Figure numbers referenced using the \label–\ref LaΤeΧ feature are incorrect. For example, when two figures placed on the same page are referenced, \ref will generate the same number N for each of them although they are numbered correctly with N, N+1.

A: Place \label{marker} at the beginning of the mandatory argument arg in \caption[optarg]{arg} without being surrounded with spaces. For example, instead of

\begin{figure}
  \centering
    \includegraphics[width=0.5\linewidth]{gull}
  \caption[A gull]{Close-up of a gull.}
  \label{fig:gull}
\end{figure}
Figure~\ref{fig:gull} shows a photograph of a gull.

use rather

\begin{figure}
  \centering
    \includegraphics[width=0.5\linewidth]{gull}
  \caption[A gull]{\label{fig:gull}Close-up of a gull.}
  \end{figure}
Figure~\ref{fig:gull} shows a photograph of a gull.

All \label{marker} within your Thesis are recommended to be placed this way. See also the next question.

Q: I prefer centered equations to “flush left” equations.  How to achieve this?

A: Equations aligned to the left edge of the text (so called “flush left” equations) are an integral part of the ‘ipothes’ document class. The main reason is to provide as much room as possible for long equations without having to break them – they can have a length equal to the width of the text minus the width of the numbering, while centered equations would only allow a length of the width of the text minus twice the width of the numbering. The associated reason is that this equation style harmonizes better with the overall typographical style of the ‘ipothes’ document class. For these reasons, no user option is provided to enable the centered equation style. However, if you still insist on centering the equations, here’s how to do it:  in the ‘ipothes.cls’  file, change the line “\RequirePackage[fleqn]{amsmath}” to “\RequirePackage{amsmath}” and remove (by deleting or commenting out) the line “\setlength{\mathindent}{\z@} ”. However, keep in mind that the document class modified in this way is no longer ‘ipothes’, and that it must be treated according to the restrictions specified in English and in Czech above.

Q: I don’t like centered last line of figure/table captions, would prefer make them flush left.

A: Use the ‘fllastline’ option – see also manual appendix ‘Document class options’ (‘Volby dokumentní třídy’ in Czech).

▲▲  

Windows

Below are some settings I like when working under Microsoft Windows.

GUI Linux-like behavior

The following two features, which I once got accustomed to when working with Linux and the X-Window system, are, in my opinion, quite useful and can easily be turned on in Windows by following these pictorial instructions:

Single-click to open an item (point to select):

sh_Aid_2.gif

Activate a window by hovering over it with the mouse:

sh_Aid_3.gif

Total Commander

Total Commander is an indispensable, absolutely must-have tool for every serious user. I feel helpless on a Windows computer equipped with Windows Explorer only. Having been annoyed by clicking 1, 2, or 3 button, I purchased TC years ago. It’s such an indispensable tool for me that I even have it on my Android phone. Here are my customized horizontal bar and vertical bar (just for inspiration; you will probably need to make some modifications to fit your system):

sh_Aid_4.gif

GNU Emacs & MSYS2: an unbeatable combination

The GNU Emacs text editor is also available for Windows. Coupled with the MSYS2 Software Distribution and Building Platform for Windows it provides an unbeatable development tool. For example, here are screenshots from using these two as a LaΤeΧ development environment (together with the MiKTeX’s YAP previewer):

sh_Aid_5.gif

PDF and PostScript viewers

Ghostscript is an interpreter for the PostScript language and PDF files. GSview 5.0 is a (rather obsolete) graphical interface for Ghostscript under MS-Windows, can be occasionally useful, e.g., for determining an EPS file Bounding Box. (GSview 6.0 availability discontinued.) Tip: set it as a *.ps and *.eps viewer for F3 under the Total Commander menu Configuration ▶ Options… ▶ Edit/View. The file extension association for the Enter key remains untouched, but the F3 key will invoke GSview 5.0.

MuPDF is a lightweight PDF, XPS, and E-book viewer. I enthusiastically recommend it for common reading; it is robust, minimalistic and very fast, contrary to rather cumbersome Adobe Acrobat Reader. Tip: set it as a *.pdf viewer for F3 under the Total Commander menu Configuration ▶ Options… ▶ Edit/View. The file extension association for the Enter key remains untouched, but the F3 key will invoke GSview 5.0. An Android version can be installed from Google Play (recommended, works fine).

Sumatra PDF is a free PDF, eBook (ePub, Mobi), XPS, DjVu, CHM, Comic Book (CBZ and CBR) viewer for Windows. If Ghostscript is installed, PostScript (*.ps, *.eps) and PJL (Printer Job Language) files are supported. Sumatra PDF can be used as a pre-viewer for LaTeX editors. In my experience, Sumatra PDF will also open PDF documents that Adobe Acrobat Reader or MuPDF are unable to open (font issues, etc.).

Často kladené dotazy / Frequently asked questions

▲▲  

Wolfram Language & Mathematica

This content has been moved to a detached dedicated page.

▲▲  

C/C++

This content can be found on the Numerical Methods in Physics course web page.

▲▲  

GNU, Linux, …

This content can partially be found on the Numerical Methods in Physics course web page. More coming soon (hopefully).

▲▲  

Created with the Wolfram Language