Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/academic-templates/tex-book-template

A template for writing a nice book with LaTeX
https://github.com/academic-templates/tex-book-template

book latex latex-template template

Last synced: 4 months ago
JSON representation

A template for writing a nice book with LaTeX

Host: GitHub
URL: https://github.com/academic-templates/tex-book-template
Owner: academic-templates
License: cc-by-4.0
Created: 2019-05-11T10:19:52.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2023-12-03T19:00:03.000Z (about 1 year ago)
Last Synced: 2023-12-04T15:39:01.720Z (about 1 year ago)
Topics: book, latex, latex-template, template
Language: TeX
Homepage:
Size: 1.38 MB
Stars: 16
Watchers: 4
Forks: 12
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

latex-templates - academic-templates/<br>tex-book-template - templates/tex-book-template?style=flat-square)<br/>![21](https://img.shields.io/github/forks/academic-templates/tex-book-template?style=flat-square)<br/>![2023-12-03](https://img.shields.io/github/last-commit/academic-templates/tex-book-template?style=flat-square) | A template for writing a nice book with LaTeX | (Popular & New LaTeX Templates / Others)

README

## :information_source: Introduction

The goal of this template is to provide a nice-looking book layout, easy to configure and fill in.

Here is an example preview for the table of content, and other main document items:

_{^{Preview image generated with this tool}}

Here is an example preview for chapter items, including the chapter heading, summary and discussion pages:

_{^{Preview image generated with this tool}}

Here is an example preview for appendix items, including the appendix heading with a mini table of content:

_{^{Preview image generated with this tool}}

## :card_file_box: Structure

The template is structured in the following way:

- `main.tex`: This is the main TeX file to be compiled. Here you can include chapters, parts and appendices and also configure some settings (e.g. printable version).
- `appendices`: This folder contains the appendices, one TeX file for each of them, to be included in `main.tex`.
- `chapters`: This folder contains the chapters, one TeX file for each of them, to be included in `main.tex`.
- `figures`: This folder is aimed to contain the figures (that is, the pictures to be captioned that are included in the list of figures).
- `icons`: This folder is aimed to contain icons that are used without captions, e.g. these included with special text boxes (like `tip`).
- `parts`: This folder contains every part other than chapters or appendices (i.e. abstract, foreword, references, acronyms, ...), one TeX file for each of them, to be included in `main.tex`.
- `styles`: This folder contains the available styles. Most of the included one should not be edited.

> This structure follows the same one as for [this master thesis template](https://github.com/academic-templates/tex-book-template).

> This particular template features a style especially designed for publishing at [Lambert Academic Publishing](https://www.lap-publishing.com/), `style/lap-publishing-book.sty`.

## :gear: Compilation

The compilation can easilly be configured in [Texmaker](https://en.wikipedia.org/wiki/Texmaker) by defining a *Quick Build Command*:

1. Go to the menu *Options*
2. Select *Configure Texmaker*
3. Go to tab *Quick Build*
4. In the field *User : (...)*, replace the command with:

5. Then click *OK*

When editing the book with [Texmaker](https://en.wikipedia.org/wiki/Texmaker):

1. Open `main.tex`
2. Go to the menu *Options*
3. Select *Define Current Document as "Master Document"*
4. Open `main.idx` for edition
5. Click on *Quick Build* to compile

This will produce `main.pdf` with all the included chapters, parts and appendices.

## :closed_book: Making your book

### Tuning parts

This template includes multiple pre-filled (self-explanatory) part files of the dissertation, whose some are to be adapted and others should not be modified.

Parts that you should adapt:

- `parts/abstract.tex`
- `parts/acknowledgements.tex`
- `parts/acronyms.tex`
- `parts/bibliography.bib`
- `parts/foreword.tex`
- `parts/glossary.tex`

Parts that you should not adapt:

- `parts/index.tex`
- `parts/lof.tex`
- `parts/references.tex`
- `parts/toc.tex`

### Adding chapters

This template has a particular layout for chapters. Each of them starts with a chapter cover page with:

- Above: the chapter title.
- On the left column: an upper and a lower paragraph.
- On the right column: the mini table of content for the chapter.

In LaTeX, this is structured like the following:

```latex
\begin{chaptercover}%
{Chapter title}%
{Left column upper paragraph}%
{Left column lower paragraph}%
{chapter-reference}

Your chapter content.

\end{chaptercover}
```

Once you have written your new chapter in `chapters/my-chapter.tex`, do not forget to include it in `main.tex` (insert a line `\include{chapters/my-chapter}` where relevant).

### Adding appendices

This template also features a particular layout for appendices. As matters separated from the main thread, they do not have cover pages but a mini table of content as well.

In LaTeX, this is structured like the following:

```latex
\begin{appchaptercover}%
{Appendix title}%
{app:appendix-reference}

Your appendix content.

\end{appchaptercover}
```

## :star: Related Projects