README.md (3708B)
1 # How to use this template 2 This is a template for creating a thesis document (BSc or MSc) based on the bfh-ci package using the bfhthesis class. It helps to get started quickly. Problems and improvements can be reported via our issue tracker. Any kind of improvement is welcome, also other templates that cover a use case based on bfhthesis or bfhpub class. 3 4 ## Installing the dependencies 5 Install a recent LaTeX distribution and the latest version of the LaTeX package bfh-ci. How to do this is described in detail in the online manual. Follow the instructions for your operating system. 6 * https://latex.ti.bfh.ch 7 8 ## Information about the structure 9 The "*.tex" is a LaTeX document with a preamble and a LaTeX body with placeholder text. We recommend that you use this example as a quick introduction to writing short reports, such as a lab report. For an example of how to insert citations to online articles, books, etc., we recommend using biblatex. The bibliography database is stored in a ".bib" file. The content of such a file follows the definitions described in the biblatex user manual. Use the sample.bib file to get started. 10 11 ## Parameterization 12 There is a local `latexmk` configuration file called ".latexmkrc". This file contains some pre-configurations like the name of the output directory ("_build") and the default latex compiler ("lualatex"). Modify or delete this file. 13 14 ## Note 15 We recommend using Git for version control. If you are using Git, create a gitignore file with a good set of ignore patterns. For a quick start, we recommend the following patterns. 16 * Get a general set of ignore patterns 17 * https://www.toptal.com/developers/gitignore?templates=latex,windows,linux,vim,emacs,osx 18 ``` 19 curl -L -o .gitignore https://www.toptal.com/developers/gitignore/api/latex,windows,linux,vim,emacs,osx 20 ``` 21 * Ignore all directories that start with an underscore '_*/' 22 ``` 23 echo '_*/' >> .gitignore 24 ``` 25 26 ## Compiling 27 To compile the LaTeX document, use your favorite LaTeX editor together with the TeX compiler (xelatex and lualatex are supported). Thre is no support for pdflatex compiler. 28 29 If you use latexmk on the command line, the following command will do the compilation. 30 31 #### Running Latexmk 32 * In the simplest case you just have to type 33 ```bash 34 latexmk -lualatex 35 ``` 36 *This runs LaTeX on all .tex files in the current directory using the output format specified by the configuration files.* 37 38 * If you want to make sure to get a .pdf file as output, just mention it: 39 ```bash 40 latexmk -pdflua 41 ``` 42 * If you want to compile only one specific .tex file in the current directory, just provide the file name: 43 ```bash 44 latexmk -lualatex myfile.tex 45 ``` 46 * If you want to preview the resulting output file(s), just use 47 ```bash 48 latexmk -pv -lualatex 49 ``` 50 * And now the killer feature: If you want LaTeXmk to continuously check all input files for changes and re-compile the whole thing if needed and always display the result, type 51 ```bash 52 latexmk -pvc -lualatex -interaction=nonstopmode 53 ``` 54 Then, whenever you change something in any of your source files and save your changes, the preview is automatically updated. But: This doesn’t work with all viewers, especially not with Adobe Reader. See the section about configuration files below for setting a suitable viewer application. 55 56 * Of course, options can be combined, e.g. 57 ```bash 58 latexmk -outdir=_build -pdf -pv myfile.tex 59 ``` 60 61 #### Cleanup 62 * After running LaTeX, the current directory is contaminated with a myriad of temporary files; you can get rid of them with 63 ```bash 64 latexmk -c 65 ``` 66 * Previous command doesn’t delete the final .pdf/.ps/.dvi files. If you want to delete those too, use 67 ```bash 68 latexmk -C 69 ```