/FEIStyle

Upgraded FEIStyle

Primary LanguageTeXMIT LicenseMIT

FEIstyle

Latest Version Software License

Upgraded FEIStyle (original):

  • support for citation standard ISO-690 required by STU FEI, using biber
  • support for acronym glossaries package
  • removed FEIstyle.bst (not needed)
  • added Makefile
  • added seminar paper template (example_paper.tex) example_paper.pdf
  • python script (utils/tree.py) to auto-generate contents of electronic medium (attachmentA.tex)
  • improved contents of electronic medium example, added 2 commands to make it easy to write attachmentA.tex like files

Note: FEIstyle supports only UTF-8 encoding.

Changelog

Change-log is located here.

Note: Minor changes are not noted in change-log.

Usage

  • Download all files from repository, extract to desired folder and enjoy.

Compile chain

In following sub-chapters file is your main file.tex (e.g.: diploma.tex in root folder)

Manual compiling

Following chain should output file.pdf

$ pdflatex file
$ biber file
$ glossary file
$ pdflatex file
$ pdflatex file #not a typo!

Using latexmk

Note: see Hints and Trics section to get information on how to install letexmk

Following command runs necessary compile chain.

$ latexmk -pdf -synctex=1 -interaction=nonstopmode -silent file

Using Makefile (uses latexmk)

Note: make sure to change file-name in Makefile on line #2

Build in .build folder

$ make

Clean .build folder and delete PDF file in parent folder

$ make clean

Combine two commands above

$ make refresh

Read more on how to be even more efficient with latexmk && make.

Sublime-text 3 project file

Repository consists of ST3 project file which includes building your PDF using SUPER+b.

Note: to enable building with short-cut tools->Build System->FEI-LaTeX

You can also install LaTeXTools to make build / debug process even easier. File fei.sublime-project comes with settings set to build your documentation - just edit TEXroot setting.

Hints and trics

search terms:

  • latexmk, CTAN, latex, tex, make, Makefile

humans whom you can ask:

editors and IDEs:

Afraid of losing your work? Use Git.

Counting words, lines and characters

There is a variety of ways to count words and lines (characters are not so important) of compiled PDF file, and none is precise so we list a few and you can compare results yourself.

Using ps2ascii

$ ps2ascii example.pdf |  wc -l -w -c

Using pdftotext

pdftotext example.pdf - | wc -l -w -c

Note: CZRP does word counting differently, for example my thesis using ps2ascii method outputs 4288, 21031, 145198; pdftotext method outputs 7051, 21377, 148535; CZRP word count is 14039 and character count 138687.

Counting words from source file (not recommended, since template does a lot of /includeing and /inputting).

texcount -inc example.tex

Installation on macOS

Note: MacTex installs also BibDesk which can be used to maintain your bibliography in a very nice way.

Updating TeX packages

If you installed MacTex distribution you also have application called TeX Live Utility (it is a front-end for pkmgr program) which is used to upgrade all TeX related packages, open it from time to time and do a full update.

Installation on Ubuntu / Fedora using eitl

Note: biblatex-iso690 is included in 2016 build of texlive

Do following steps only if you have texlive 2015 or less

  • download install script

    $ wget http://mirrors.ctan.org/support/texlive/eitl.zip
    
  • unzip

    $ unzip eitl.zip && cd eitl
    
  • install TexLive

    $ ./eitl /usr/share/texlive
    

TODO

  • working example on Sharelatex.com
    • Sharelatex does not support biblatex-iso690 at this time
  • transform tutorial.pdf to wiki page
  • update read-me to include usage for Windows OS users
  • update csquotes style to Slovak after this PR is merged, (perhaps in 2017)
    • optional since not everyone has up-to-date packages installed
  • auto-generate contents of electronic medium
    • electronic medium should be brief with explanation, see example
  • publish example of electronic medium

Contribution

Any contributions are welcome!