Native
To use the BFH LaTeX Classes you have to follow the OS dependent installation procedure.
Warning
If you are using Docker this section can be skipped, please continue here.
Note
If you are a newbie in using LaTeX. It is a good idea to read the sections Tools, Editors and Configuration and Beginner’s Guide after installing the BFH LaTeX CI. For more information about how to use the BFH LaTeX classes and packages read the BFHClasses and User Documentation sections after installing the packages as described below.
Warning
Check if your system fully meets the requirements of the basic LaTeX Installation needed for the BFH LaTeX Classes. E.g if required default font nunito is installed. Otherwise, follow the installation guidelines for the basic LaTeX installation.
Prerequisites
Before you can use the BFH LaTeX packages, you have to install the required packages
Todo
Remove once DEPENDS.txt works. See this issue
Download
tex-requirements.txtOpen a terminal (Bash/PowerShell/…) in the download directory as an administrator.
Install the additional packages listed in
tex-requirements.txt# tlmgr install $(cat tex-requirements.txt) # tlmgr path add
BFH LaTeX Installation
Note
The BFH LaTeX framework consists of three packages (see packages). Make sure all of them are installed for the best experience.
Note
Should the installation/removal of any of the packages fail for any reason, head to fallback installation and fallback removal respectively.
Fresh installation
Note
It’s best to store the downloaded zip archives into a well-known directory. You may need to use them again for uninstalling the packages.
We recommend using a dist directory inside your texmf installation.
$ mkdir -p $(kpsewhich --var-value TEXMFHOME)/dist
BFH CI
The BFH CI is on CTAN, thus one can install it directly via the TeX Live package manager.
# tlmgr install bfh-ci
BFH Logo
Warning
The BFH Logo package is available for BFH members only.
Warning
To install as described here l3build is required. If you installed the
most recent requirements above this should already be installed. Else run
tlmgr install l3build && tlmgr path add first.
Download the latest BFH Logo ZIP archive
Extract the ZIP archive
$ unzip bfh-logo_<VERSION>.zip -d $(kpsewhich --var-value TEXMFHOME)/dist/bfh-logo
Install the BFH Logo package
$ cd $(kpsewhich --var-value TEXMFHOME)/dist/bfh-logo $ l3build install
BFH Fonts
Warning
The BFH Fonts package is available for BFH members only.
Warning
As the BFH Font is an OTF Font, the LaTeX engine must be LuaTeX for them to work.
Warning
To install as described here l3build is required. If you installed the
most recent requirements above this should already be installed. Else run
tlmgr install l3build && tlmgr path add first.
Download the latest BFH Fonts ZIP archive
Extract the ZIP archive
$ unzip bfh-fonts_<VERSION>.zip -d $(kpsewhich --var-value TEXMFHOME)/dist/bfh-fonts
Install the BFH Fonts package
$ cd $(kpsewhich --var-value TEXMFHOME)/dist/bfh-fonts $ l3build install
Updating
BFH CI
# tlmgr update bfh-ci
BFH Logo
Follow the installation manual
BFH Fonts
Follow the installation manual
Uninstalling
BFH CI
# tlmgr remove bfh-ci
BFH Logo
If you still have the downloaded zip archive you may use the l3build uninstall command
$ cd $(kpsewhich --var-value TEXMFHOME)/dist/bfh-logo
$ l3build uninstall
BFH Fonts
If you still have the downloaded zip archive you may use the l3build uninstall command
$ cd $(kpsewhich --var-value TEXMFHOME)/dist/bfh-fonts
$ l3build uninstall
Note
Since the procedure is the exact same, follow the Linux installation path by switching the tab to Linux.
Fresh Installation
Note
It’s best to store the downloaded zip archives into a well-known directory. You may need to use them again for uninstalling the packages.
We recommend using a dist directory inside your texmf installation.
mkdir "$(kpsewhich --var-value TEXMFHOME)\dist"
BFH CI
The installation can be done either via PowerShell or the TeX Live Manager GUI.
Show Terminal
Open PowerShell as administrator and execute the following:
tlmgr install bfh-ci
Show GUI
Press the Windows key and search for “TeX Live Manager” to open it.
On status, select “All”
If an additional window opens, wait for it to finish and then close it.
Search and install “bfh-ci”
Make sure the tick mark is set on the packages you want to install. If a window pops up saying “nothing to do”, the package is already installed.
BFH Logo
Warning
The BFH Logo package is available for BFH members only.
Warning
To install as described here l3build is required. If you installed the
most recent requirements above this should already be installed. Else run
tlmgr install l3build && tlmgr path add first.
Download the latest BFH Logo ZIP archive
Extract the ZIP archive in the File Explorer and open the Folder
Show screenshot
Right click and select extract
Select a persistent extract location
Install the BFH Logo Package by double-clicking
install-user.batShow screenshot
Double click the
install-user.bat
Wait for the installation to finish
BFH Fonts
Warning
The BFH Fonts package is available for BFH members only.
Warning
To install as described here l3build is required. If you installed the
most recent requirements above this should already be installed. Else run
tlmgr install l3build && tlmgr path add first.
Download the latest BFH Fonts ZIP archive
Extract the ZIP archive in the File Explorer and open the Folder
Show screenshot
Right click and select extract
Select a persistent extract location
Install the BFH Fonts Package by double-clicking
install-user.batShow screenshot
Double click the
install-user.batWait for the installation to finish
Update
BFH CI
The installation can be done either via PowerShell or the TeX Live Manager GUI.
Show Terminal
Open PowerShell as administrator and execute the following:
tlmgr update bfh-ci
Show GUI
BFH Logo
Follow the installation manual
BFH Fonts
Follow the installation manual
Uninstall
BFH CI
The removal can be done either via PowerShell or the TeX Live Manager GUI.
Show Terminal
Open PowerShell as administrator and execute the following:
tlmgr remove bfh-ci
Show GUI
BFH Logo
If you still have the downloaded zip archive you may use the l3build uninstall command.
Open the folder in the File Explorer, right click and select “Open in terminal”:
Show screenshot
Then run the following command
l3build uninstall
BFH Fonts
If you still have the downloaded zip archive you may use the l3build uninstall command.
Open the folder in the File Explorer, right click and select “Open in terminal”:
Show screenshot
Then run the following command
l3build uninstall
Fallback Installation
Use this only if the above installation methods failed. We will document only the terminal approach here. It is almost the same for all operating systems.
BFH CI
Download the latest BFH CI ZIP archive
Find the default location for the TeX compiler
$ kpsewhich --var-value TEXMFHOME /home/user/texmf # Linux /Users/user/texmf # macOS C:\Users\user\texmf # Windows
Create the
TEXMFHOMEanddistdirectory$ mkdir "$(kpsewhich --var-value TEXMFHOME)" $ mkdir "$(kpsewhich --var-value TEXMFHOME)/dist"
Copy the ZIP archive into a subdirectory of
TEXMFHOMEcalleddist$ cp bfh-ci_<VERSION>.zip "$(kpsewhich --var-value TEXMFHOME)/dist"
Change into the dist folder
$ cd "$(kpsewhich --var-value TEXMFHOME)/dist"
Extract the ZIP archive
$ unzip -d $(kpsewhich --var-value TEXMFHOME) bfh-ci_<VERSION>.zip
Register the files in the database
$ mktexlsr
BFH Logo
Download the latest BFH Logo ZIP archive
Find the default location for the TeX compiler
$ kpsewhich --var-value TEXMFHOME /home/user/texmf # Linux /Users/user/texmf # macOS C:\Users\user\texmf # Windows
Create the
TEXMFHOMEand required directories$ mkdir "$(kpsewhich --var-value TEXMFHOME)" $ mkdir "$(kpsewhich --var-value TEXMFHOME)/dist" $ mkdir "$(kpsewhich --var-value TEXMFHOME)/tex" $ mkdir "$(kpsewhich --var-value TEXMFHOME)/tex/latex" $ mkdir "$(kpsewhich --var-value TEXMFHOME)/tex/latex/bfh-logo"
Copy the ZIP archive into a subdirectory of
TEXMFHOMEcalleddist$ cp bfh-logo_<VERSION>.zip "$(kpsewhich --var-value TEXMFHOME)/dist"
Change into the dist folder
$ cd "$(kpsewhich --var-value TEXMFHOME)/dist"
Extract the ZIP archive
$ unzip -d $(kpsewhich --var-value TEXMFHOME)/tex/bfh-logo bfh-logo_<VERSION>.zip
Register the files in the database
$ mktexlsr
BFH Fonts
Download the latest BFH Fonts ZIP archive
Find the default location for the TeX compiler
$ kpsewhich --var-value TEXMFHOME /home/user/texmf # Linux /Users/user/texmf # macOS C:\Users\user\texmf # Windows
Create the
TEXMFHOMEand required directories$ mkdir "$(kpsewhich --var-value TEXMFHOME)" $ mkdir "$(kpsewhich --var-value TEXMFHOME)/dist" $ mkdir "$(kpsewhich --var-value TEXMFHOME)/fonts" $ mkdir "$(kpsewhich --var-value TEXMFHOME)/fonts/opentype" $ mkdir "$(kpsewhich --var-value TEXMFHOME)/fonts/opentype/FontFont"
Copy the ZIP archive into a subdirectory of
TEXMFHOMEcalleddist$ cp bfh-fonts_<VERSION>.zip "$(kpsewhich --var-value TEXMFHOME)/dist"
Change into the dist folder
$ cd "$(kpsewhich --var-value TEXMFHOME)/dist"
Extract the ZIP archive
$ unzip -d $(kpsewhich --var-value TEXMFHOME)/fonts/opentype/FontFont bfh-fonts_<VERSION>.zip
Update the font cache
$ luaotfload-tool --update --force
Register the files in the database
$ mktexlsr
Fallback Removal
Head to the TEXMFHOME directory and remove the target folders for the respective package:
cd $(kpsewhich --var-value TEXMFHOME)
BFH CI:
tex/latex/bfh-ciBFH Logo:
tex/latex/bfh-logoBFH Fonts:
fonts/opentype/FontFont