kaobook

Description

This template is designed for writing books and graduate-level theses and provides numerous examples and documentation to enable complex requirements. The design features a relatively narrow main text column with an adjacent wide margin to house notes, figures, tables, citations and captions. The narrow text column facilitates faster reading by reducing horizontal eye movement distance and makes reading less fatiguing. Content can be split into the standard section types of parts, chapters, sections, subsections, subsubsections and paragraphs with examples of all of these provided. Several chapter styles are available depending on your requirements, ranging from text only to including the chapter number to including a full-width background image.

The front matter of the template includes a title page, copyright page, quote/dedication page, preface, table of contents and lists of tables and figures. Each is populated with example content to get you started and can be removed easily if it is not needed. The back matter of the template includes an appendix, bibliography, notation (a.k.a. nomenclature), greek letters example table, glossary and index. These can be moved to the front matter or removed easily and are provided as examples if these features are required.

The template body includes numerous examples of how to make use of the large margin for all kinds of content. The main text column contains examples of coloured boxes, lists, code listings, figures, tables, equations, referencing, theorems and more to serve as a reference to cover every possible use case for your own content. You can simply copy/paste one of the examples from the template when you require it.

The text of the template first expertly describes the logic behind the template and then moves on to an overview of the template structure and how it is split into directories and files. It goes on to document template options and packages used, then provides examples of all the elements discussed above. It’s important to read this information carefully if you are going to write a substantial work using the template, this template is not for LaTeX beginners and requires some LaTeX knowledge to make full use of it.

Authors

The main author of this template is Federico Marotta. It was based on the doctoral thesis of Ken Arroyo Ohori and on the Tufte-LaTeX class. The template code was modified for LaTeX templates by Vel.

Issues and Development Version

LaTeX Templates provides stable but older versions of templates as a general rule. For the latest development version of this template, or to report an issue, visit the template’s home on GitHub.

License

The kaobook class files are licensed under the LaTeX Project Public License v1.3 or later. Examples and documentation are licensed under CC0 1.0 Universal. See the MANIFEST.md file included with the template for a breakdown of files covered under each license.

Preview

Usage Guide

Compilation

As the template contains multiple elements that require independent compilation, it can be tricky to compile correctly the first time and keep each element updated. The template comes with a shell script called compileall.sh that can be executed from the command line in the template directory to perform a full compilation of every element in the template in the correct order. After you have successfully compiled the document to obtain an equivalent PDF to the one in the preview below, you can continue to compile each element independently as you update them and require them refreshed.

The following lists the commands to run to compile each part of the template separately. Your LaTeX editor may be able to run some of these from the GUI, for the rest you will need to navigate to the template directory using your terminal and run them there.

Compile template: pdflatex main
Compile nomenclature: makeindex main.nlo -s nomencl.ist -o main.nls
Compile index: makeindex main
Compile bibliography: biber main
Compile glossary: makeglossaries main

For the first document compilation after downloading the template, you may need to skip some errors after which time the template will compile without errors and you can run the remaining commands. Recompile the document again twice afterwards to update all references and positions of elements in the document.

Open Template for Free Editing Online:

Open in Overleaf

Download Template

{ Download .zip } { Preview PDF }

Have a Question or Comment About This Template?

{ Ask a Question }