summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorBenedikt Peetz <benedikt.peetz@b-peetz.de>2024-03-31 21:44:15 +0200
committerBenedikt Peetz <benedikt.peetz@b-peetz.de>2024-03-31 21:44:15 +0200
commit76084f4a268e2de36c4144e1a8891c038178f8ea (patch)
tree5c474031a5a3aca87b026f242006a8606ac0d214
parentchore(treewide): Update this project to today's standards. (diff)
downloadlpm-76084f4a268e2de36c4144e1a8891c038178f8ea.tar.gz
lpm-76084f4a268e2de36c4144e1a8891c038178f8ea.zip
docs(example): Add an example directory
Diffstat (limited to '')
-rw-r--r--README.md3
-rw-r--r--example/content/static/title.tex0
-rw-r--r--example/headers/preamble.tex0
-rw-r--r--example/headers/preamble_local.tex0
-rw-r--r--example/lpm.toml19
-rw-r--r--example/main.tex21
6 files changed, 42 insertions, 1 deletions
diff --git a/README.md b/README.md
index ae51118..894f67f 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,8 @@ structure and thus facilitates adding new chapters (resp. sections) and sections
 ## Configuration
 
 An example `lpm.toml` config file is to be found in here:
-[`./example/lpm.toml`](./example/lmp.toml).
+[`./example/lpm.toml`](./example/lpm.toml).
+The `example` directory contains an example, how a lpm project might look like.
 
 ## Licence
 
diff --git a/example/content/static/title.tex b/example/content/static/title.tex
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/example/content/static/title.tex
diff --git a/example/headers/preamble.tex b/example/headers/preamble.tex
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/example/headers/preamble.tex
diff --git a/example/headers/preamble_local.tex b/example/headers/preamble_local.tex
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/example/headers/preamble_local.tex
diff --git a/example/lpm.toml b/example/lpm.toml
new file mode 100644
index 0000000..5a3565d
--- /dev/null
+++ b/example/lpm.toml
@@ -0,0 +1,19 @@
+[last_chapter]
+user_name = "static"
+number = 0
+
+[templates]
+section = '''
+%! TEX root = ../../../main.tex
+% LTeX: language=en-GB
+
+\section{REPLACMENT_SECTION_TITLE} % DATE
+This is some text
+'''
+
+chapter = '''
+%! TEX root = ../../main.tex
+% LTeX: language=en-GB
+
+\chapter{REPLACEMENT_CHAPTER}
+'''
diff --git a/example/main.tex b/example/main.tex
new file mode 100644
index 0000000..d5f0d2f
--- /dev/null
+++ b/example/main.tex
@@ -0,0 +1,21 @@
+% LTeX: language=en-GB
+\documentclass[a4paper, 12pt]{report}
+\input{headers/preamble.tex}
+\input{headers/preamble_local.tex}
+
+
+\title{\textbf{Some Title}}
+\author{Some Author}
+\authors{name\inst}
+\years{2024}
+\date{\Today}
+
+\includeonly{}
+
+\begin{document}
+    \input{content/static/title}
+
+    % NEXT_CHAPTER
+
+    \printbibliography\relax
+\end{document}