feat: Merge changes from pandoc 3.5 LaTeX template (#407)

* feat: Merge changes from pandoc 3.5 LaTeX template
* feat: create single file templates (latex and beamer)
* feat: use `sed` differently on macOS than on other systems
* feat: update copyright year
* feat: release compressed archives without version number
* docs: explain versions of the template (the different files)
* ci: build with pandoc 3.5
* chore: add changelog for version 3.0.0

.github/workflows/build-examples.yml

@@ -11,7 +11,7 @@ jobs:
         fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository.
     - name: Setup pandoc
       env:
-        PANDOC_VERSION: "3.4"
+        PANDOC_VERSION: "3.5"
       run: |
         wget -qO- https://github.com/jgm/pandoc/releases/download/${PANDOC_VERSION}/pandoc-${PANDOC_VERSION}-linux-amd64.tar.gz | sudo tar xzf - --strip-components 1 -C /usr/local/
     - name: Setup TexLive
@@ -53,6 +53,8 @@ jobs:
         tlmgr install awesomebox fontawesome5
         # packages only needed for some examples (example boxes-with-pandoc-latex-environment-and-tcolorbox)
         tlmgr install tcolorbox pgf etoolbox environ trimspaces
+    - name: Generate a temporary release with single file template versions
+      run: bash ./tools/release.sh 0.0.0
     - name: Build examples
       run: cd examples && bash build-examples.sh && cd ..
     - name: Add generated example files

CHANGELOG.md

@@ -2,6 +2,28 @@
 
 All notable changes to this project are documented in this file. On the [releases page](https://github.com/Wandmalfarbe/pandoc-latex-template/releases/) you can see all released versions of the Eisvogel template and download the [latest version](https://github.com/Wandmalfarbe/pandoc-latex-template/releases/latest).
 
+## [3.0.0] - 2025-01-11
+
+**This release contains breaking changes.**
+
+- Merge changes from the pandoc default LaTeX template from version 3.5 ([1cbd2d1](https://github.com/jgm/pandoc-templates/commit/1cbd2d185efa262c35bd0c0c37f9692905231bf9)).
+
+  Since commit [2a6268d](2a6268de67b883cd814358111d764d330f100d9b) the default pandoc template has been split into
+  multiple files (partials). The default LaTeX template has also been split into `default.latex` and `default.beamer`.
+
+  For easy integration of upstream changes, the Eisvogel template has also been split and resides in the
+  folder `template-multi-file`
+
+  - `template-multi-file/eisvogel.latex` corresponds to `default.latex`
+  - `template-multi-file/eisvogel.beamer` corresponds to `default.beamer`
+
+  Upon release of the Eisvogel template, standalone (one-file) versions are created for LaTeX and Beamer. Refer to the readme section [Eisvogel versions](https://github.com/Wandmalfarbe/pandoc-latex-template?tab=readme-ov-file#eisvogel-versions) for more information.
+
+- The released compressed archives (`.zip` and `.tar.gz`) always contain a root folder that is named after the template
+  and the version number e.g. `Eisvogel-3.0.0`.
+
+- The single file version of the template (`eisvogel.tex`) is no longer part of this repository
+
 ## [2.5.0] - 2024-10-03
 
 - Merge changes from the pandoc default LaTeX template from version 3.4 ([7e8aafa](https://github.com/jgm/pandoc-templates/commit/7e8aafa049700a849b41c53cf1afeb17324040c7)).
@@ -65,7 +87,7 @@ the [documentation on docker hub](https://hub.docker.com/r/pandoc/extra).
 
 ## [2.0.0] - 2021-01-31
 
-**This release includes breaking changes.**
+**This release contains breaking changes.**
 
 - Merged changes from the pandoc default LaTeX template.
 - Fix broken travis build by modifying the `--resource-path`
@@ -179,6 +201,7 @@ the [documentation on docker hub](https://hub.docker.com/r/pandoc/extra).
 
 - First release of the template as a ZIP file with the examples.
 
+[3.0.0]: https://github.com/Wandmalfarbe/pandoc-latex-template/compare/v2.5.0...v3.0.0
 [2.5.0]: https://github.com/Wandmalfarbe/pandoc-latex-template/compare/v2.4.2...v2.5.0
 [2.4.2]: https://github.com/Wandmalfarbe/pandoc-latex-template/compare/v2.4.1...v2.4.2
 [2.4.1]: https://github.com/Wandmalfarbe/pandoc-latex-template/compare/v2.4.0...v2.4.1

README.md

@@ -15,12 +15,35 @@ A clean **pandoc LaTeX template** to convert your markdown files to PDF or LaTeX
 1.  Install pandoc from <http://pandoc.org/>. You also need to install [LaTeX](https://en.wikibooks.org/wiki/LaTeX/Installation#Distributions).
 2.  Download the latest version of the Eisvogel template from [the release page](https://github.com/Wandmalfarbe/pandoc-latex-template/releases/latest).
 3.  Extract the downloaded ZIP archive and open the folder.
-4.  Move the template `eisvogel.latex` to your pandoc templates folder. The location of the templates folder depends on your operating system:
+4.  Move the two template files `eisvogel.latex` and `eisvogel.beamer` to your
+    pandoc templates folder. The location of the templates folder depends on your operating system:
       - Unix, Linux, macOS: `/Users/USERNAME/.local/share/pandoc/templates/` or `/Users/USERNAME/.pandoc/templates/`
       - Windows Vista or later: `C:\Users\USERNAME\AppData\Roaming\pandoc\templates\`
 
-    If there are no folders called `templates` or `pandoc` you need to create them and put the template `eisvogel.latex` inside. You can find the default user data directory on your system by looking at the output of `pandoc --version`.
+    If there are no folders called `templates` or `pandoc` you need to create them and put the two template files inside. You can find the default user data directory on your system by looking at the output of `pandoc --version`.
 
+## Eisvogel versions
+
+The Eisvogel template is distributed in three different versions inside the compressed archives:
+
+1. `eisvogel.latex`
+
+    A standalone single file version for normal documents (articles, books, notes). The LaTeX and beamer templates used to be in a single file but are now separated.
+
+    > [!IMPORTANT]  
+    > This file is NOT present in this Git repository and has to be obtained from a released version of the template.
+
+2. `eisvogel.beamer`
+
+    A standalone single file version for use with *beamer* to produce slides. The LaTeX and beamer templates used to be in a single file but are now separated.
+
+    > [!IMPORTANT]  
+    > This file is NOT present in this Git repository and has to be obtained from a released version of the template.
+
+3. `template-multi-file`
+
+    This folder contains the original template (LaTeX and Beamer), split into several files. At release, the one-file versions are
+    generated from this folder.
 
 ### Docker image