diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..d0ce8958365c34107214f3494e1969a894932eb6 --- /dev/null +++ b/.gitignore @@ -0,0 +1,304 @@ +# This gitignore is based on Martin Isaksson template found in +# https://gitlab.com/martisak/latex-pipeline/ +# +# which is itself is a derivative of the recommended gitignore by github +# https://github.com/github/gitignore/ + +## Core latex/pdflatex auxiliary files: +*.aux +*.lof +*.log +*.lot +*.fls +*.out +*.toc +*.fmt +*.fot +*.cb +*.cb2 +.*.lb + +## Intermediate documents: +*.dvi +*.xdv +*-converted-to.* +# these rules might exclude image files for figures etc. +# *.ps +# *.eps +*.pdf + +## Generated if empty string is given at "Please type another file name for output:" +.pdf + +## Bibliography auxiliary files (bibtex/biblatex/biber): +*.bbl +*.bcf +*.blg +*-blx.aux +*-blx.bib +*.run.xml + +## Build tool auxiliary files: +*.fdb_latexmk +*.synctex +*.synctex(busy) +*.synctex.gz +*.synctex.gz(busy) +*.pdfsync + +## Build tool directories for auxiliary files +# latexrun +latex.out/ + +## Auxiliary and intermediate files from other packages: +# algorithms +*.alg +*.loa + +# achemso +acs-*.bib + +# amsthm +*.thm + +# beamer +*.nav +*.pre +*.snm +*.vrb + +# changes +*.soc + +# comment +*.cut + +# cprotect +*.cpt + +# elsarticle (documentclass of Elsevier journals) +*.spl + +# endnotes +*.ent + +# fixme +*.lox + +# feynmf/feynmp +*.mf +*.mp +*.t[1-9] +*.t[1-9][0-9] +*.tfm + +#(r)(e)ledmac/(r)(e)ledpar +*.end +*.?end +*.[1-9] +*.[1-9][0-9] +*.[1-9][0-9][0-9] +*.[1-9]R +*.[1-9][0-9]R +*.[1-9][0-9][0-9]R +*.eledsec[1-9] +*.eledsec[1-9]R +*.eledsec[1-9][0-9] +*.eledsec[1-9][0-9]R +*.eledsec[1-9][0-9][0-9] +*.eledsec[1-9][0-9][0-9]R + +# glossaries +*.acn +*.acr +*.glg +*.glo +*.gls +*.glsdefs +*.lzo +*.lzs + +# uncomment this for glossaries-extra (will ignore makeindex's style files!) +# *.ist + +# gnuplottex +*-gnuplottex-* + +# gregoriotex +*.gaux +*.gtex + +# htlatex +*.4ct +*.4tc +*.idv +*.lg +*.trc +*.xref + +# hyperref +*.brf + +# knitr +*-concordance.tex +# TODO Uncomment the next line if you use knitr and want to ignore its generated tikz files +# *.tikz +*-tikzDictionary + +# listings +*.lol + +# luatexja-ruby +*.ltjruby + +# makeidx +*.idx +*.ilg +*.ind + +# minitoc +*.maf +*.mlf +*.mlt +*.mtc[0-9]* +*.slf[0-9]* +*.slt[0-9]* +*.stc[0-9]* + +# minted +_minted* +*.pyg + +# morewrites +*.mw + +# nomencl +*.nlg +*.nlo +*.nls + +# pax +*.pax + +# pdfpcnotes +*.pdfpc + +# sagetex +*.sagetex.sage +*.sagetex.py +*.sagetex.scmd + +# scrwfile +*.wrt + +# sympy +*.sout +*.sympy +sympy-plots-for-*.tex/ + +# pdfcomment +*.upa +*.upb + +# pythontex +*.pytxcode +pythontex-files-*/ + +# tcolorbox +*.listing + +# thmtools +*.loe + +# TikZ & PGF +*.dpth +*.md5 +*.auxlock + +# todonotes +*.tdo + +# vhistory +*.hst +*.ver + +# easy-todo +*.lod + +# xcolor +*.xcp + +# xmpincl +*.xmpi + +# xindy +*.xdy + +# xypic precompiled matrices and outlines +*.xyc +*.xyd + +# endfloat +*.ttt +*.fff + +# Latexian +TSWLatexianTemp* + +## Editors: +# WinEdt +*.bak +*.sav + +# Texpad +.texpadtmp + +# LyX +*.lyx~ + +# Kile +*.backup + +# gummi +.*.swp + +# KBibTeX +*~[0-9]* + +# TeXnicCenter +*.tps + +# auto folder when using emacs and auctex +./auto/* +*.el + +# expex forward references with \gathertags +*-tags.tex + +# standalone packages +*.sta + +# Makeindex log files +*.lpz + +# xwatermark package +*.xwm + +# REVTeX puts footnotes in the bibliography by default, unless the nofootinbib +# option is specified. Footnotes are the stored in a file with suffix Notes.bib. +# Uncomment the next line to have this generated file ignored. +#*Notes.bib + +# Glossaries +*.slo + +# Makeindex + +*.slg +*.sls +*.ist + +# Other + +.bash_history + diff --git a/README.md b/README.md index 37ea87a37fafab799eddd580572c010b3badd143..875004f45cc0e432e572d2305846f4125605932c 100644 --- a/README.md +++ b/README.md @@ -40,24 +40,29 @@ Latex (if not, just update your system and install the package through your package manager). -### ULiege-komathesis -This package customizes the Scrbook class (from the -[KOMA-script](https://www.ctan.org/tex-archive/macros/latex/contrib/koma-script)) -package in order to make nice looking, modern thesis. +### ULiege-KOMAthesis +This package customizes the `scrbook` document class (provided by the +[KOMA-script](https://www.ctan.org/tex-archive/macros/latex/contrib/koma-script) +package) in order to make nice looking, modern thesis. This package is largly +inspired by the excellent [cleanthesis package](http://cleanthesis.der-ric.de/) +by Ricardo Langner. _As the graphical guidelines of the University do not explicitly mention theses, -some deviations of the true guidelines were made (fonts, headers, margins,...) . -I may add a `strict` option in the future in order to implement more closely the -guidelines if I have some time._ +some compromises regarding the exact graphical guidelines were made (fonts, +headers, margins,...). Moreover, I do not really feel that these guidelines are +really approriate for long scientific documents anyway (such as theses). If I +have some spare time at some point, I may check with the communication +department how to improve the style to match closely the official guidelines. +But this is not a priority as of today._ ### To be determined -I also plan to create the following packages whenever I find some time (or when -I will need them): -- Short reports -- Long reports (likely inspired from the ULiege-komathesis) -- Posters -- Letters +I also plan to create the following packages if I find some free time (or when I +will need them): +- Short reports (based on scrreprt) +- Long reports (based on scrreprt, very similar to ULiege-KOMAthesis) +- Posters (no idea yet) +- Letters (based on scrlttr2) ## Installation @@ -69,8 +74,6 @@ any other one ```latex \usepackage{uliege-colors} \usepackage{uliege-trigon} -... - ``` ## Documentation