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 colored 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 chapters in the template first expertly describe the logic and structure of the template, then move on to detailed explanations of each available document element with examples and descriptions for how to use and modify them. 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.

Preview

Authorship

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. For the latest development version of this template, or to report an issue, visit the template’s home on GitHub.

Current Version

v1.3 (December 9, 2021)

License

This template is licensed under a LaTeX Project Public License v1.3 or later license.

Usage Guide

Compilation

This template compiles with standard pdflatex. However, you will need to compile the bibliography, index and glossary separately to the template itself. It's best to compile in a specific order so that the document correctly updates these elements in turn. To facilitate this, a compileall.sh file is provided with the template which you can run from the command line after navigating to the template directory. This file runs the correct sequence of commands to compile the document, assuming you do not change the filename of the template from main.tex.

If you would like to compile the template manually, this is the series of commands you will need to run from the command line or your LaTeX editor:

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