template-ebook/README.md

153 lines
4.1 KiB
Markdown
Raw Normal View History

2025-05-21 22:28:40 +02:00
# eBook Vorlage
2025-05-18 19:33:42 +02:00
2025-05-21 22:32:46 +02:00
![Buch-Logo](./media/logo/logo_256x256.png)
2025-05-18 19:33:42 +02:00
## Inhalt
2025-05-21 22:28:40 +02:00
- [eBook Vorlage](#ebook-vorlage)
2025-05-18 19:33:42 +02:00
- [Inhalt](#inhalt)
- [Infos](#infos)
- [Struktur](#struktur)
- [Installation und Build](#installation-und-build)
- [Nötige Software für den Build](#nötige-software-für-den-build)
- [Templates](#templates)
- [PDF](#pdf)
- [eBook (epub)](#ebook-epub)
- [DOCX (Office/ Word)](#docx-office-word)
- [Build](#build)
- [Lizenz](#lizenz)
---
## Infos
---
## Struktur
```plaintext
book/
├── manuscript/ # Hauptinhalt in Markdown-Dateien
│ ├── 00_vorwort.md
│ ├── 01_einleitung.md
│ ├── 02_kapitel1.md
│ ├── ...
│ └── 99_anhang.md
├── media/ # Bilder, Grafiken, Diagramme usw.
│ ├── kapitel1/
│ │ └── bild1.png
│ └── kapitel2/
│ └── diagramm.svg
├── styles/ # Pandoc-Templates, LaTeX-Vorlagen, CSS
│ ├── ebook-template.tex
│ ├── ebook.css
│ └── print-template.tex
2025-05-21 22:28:40 +02:00
├── build/ # Ausgabeordner (wird vom Build-Prozess befüllt)
2025-05-18 19:33:42 +02:00
2025-05-21 22:28:40 +02:00
├── metadata/ # Metadaten für eBook, Titelblatt, Autoreninfo
2025-05-18 19:33:42 +02:00
│ ├── title.txt
│ ├── author.txt
│ └── ebook.yaml
2025-05-21 22:28:40 +02:00
├── Makefile # Automatisierter Build-Prozess mit Pandoc etc.
2025-05-18 19:33:42 +02:00
├── README.md # Projektdokumentation
└── LICENSE # Lizenz für das Buch (z.B. CC-BY)
```
---
## Installation und Build
### Nötige Software für den Build
**Hinweis: TeX unter Windows?**
Obwohl es grundsätzlich möglich ist, TeX unter Windows zu installieren und auch entsprechende Distributionen wie MiKTeX oder TeX Live für Windows existieren rate ich dringend davon ab, auf diesem Weg zu starten.
Für einen stabilen und reproduzierbaren Build-Prozess empfiehlt sich stattdessen der Einsatz eines Linux-Systems. Wenn du kein dediziertes Linux verwendest, ist das Windows Subsystem for Linux (WSL) eine ausgezeichnete Alternative.
>Voraussetzung:
>Du solltest mit `apt` umgehen können und wissen, dass ein `update` vor dem `install` obligatorisch ist.
Falls der Build trotzdem scheitert oder du dir den Aufwand sparen möchtest, lade dir einfach die fertige PDF-Version herunter oder bestelle dir direkt ein gedrucktes Exemplar des Buchs.
- **✅ Pandoc installieren:**
```sh
sudo apt install pandoc
```
- **✅ Empfohlene Installation: TeX Live Full** (ca.8GB)
```sh
sudo apt install texlive-full
```
Wenn NICHT `texlive-full`, dann aber:
- Zusätzlich deutsche Sprache (falls babel fehlt):
```bash
sudo apt install texlive-lang-german
```
Ich empfehle aber dringend `texlive-full` zu installieren da man erfahrungsgemäss am Anfang auf viele Fehler mit fehlenden Abhängigkeiten stößt wenn man Templates testet.
- **✅ Make installieren:**
Make oder besser die Anwendung `make` wird benötigt um die Erstellung der Ziele wie PDF zu automatisiern.
Dafür liegt auch das vorbereitete Skript `Makefile` im Hauptverzeichnis. Die ist nur optional und man kann es selbstverständlich auch manuell durchführen.
```sh
sudo apt install make
```
Ich verwende Version:
```sh
> make -v
GNU Make 4.3
Built for x86_64-pc-linux-gnu
```
### Templates
2025-05-21 22:28:40 +02:00
Informationen zu den Templates und ihre Konfiguration
2025-05-18 19:33:42 +02:00
#### PDF
2025-05-21 22:28:40 +02:00
- [x] Konfigurationsfile für die PDF-Aussgabe ist die [./styles/print-template.tex](./styles/print-template.tex)
- Dateiname für Einbandlogo erfolgt aus dieser Datei:
```tex
\includegraphics[width=0.3\textwidth]{media/logo/logo-einband.png} \\[2em]
````
2025-05-18 19:33:42 +02:00
#### eBook (epub)
#### DOCX (Office/ Word)
### Build
Schau mal ins [`Makefile`](./Makefile), dort findest Du einige Kandidaten um aus dem vorliegenden Markdown Manuskript eine entsprechende Version zu konvertieren. Es stehen zum aktuellen Zeitpunkt folgende zur Verfügung:
```sh
make pdf
make epub
make docx
```
---
## Lizenz
**(C) 2025 - Adam Skotarczak**
---