Skip to content

Campaign book placeholder template#5

Merged
klanderfri merged 40 commits intomainfrom
campaign-book
Mar 23, 2025
Merged

Campaign book placeholder template#5
klanderfri merged 40 commits intomainfrom
campaign-book

Conversation

@klanderfri
Copy link
Copy Markdown
Owner

  • A placeholder template book for writing new adventure campaigns.
  • A YAML workflow for compiling campaign books.

I intend to write the documents in this project using LaTex. In this commit I therefore
* Added a new folder for documents
* Added a .gitignore, from https://github.com/github/gitignore/blob/main/TeX.gitignore, in said folder.
It seems like the upload step looks at the current work folder, causing the rendered PDFs to not be found. In this commit I attempt to fix that.
Having comments on a command line in the YAML-file seems to break it. Moved the comments in an attempt to fix this.
It seems like the comments were innocent. Trying to fix the workflow error by adding a pipe to the command line.
I grew tired of having rendered previews of the PDF files being added for upload to the repository. I therefore added ignored all PDF files in the .gitignore-file.
The Mysteriet på Mälaröarna document was a little boring due to my limited experience of LaTeX, so I stole a template and upgraded the document using it.
GitHub Actions didn't like the path to the local options.sty package (could not find it) so I changed the path in an attempt to see if this one works better.
Trying to make GitHub Actions run successfully by putting the options.sty package next to the main.tex-file.
My local TeXstudio prefers to have ./ before the path. Will GitHub Action accept it?
This is so work on the documents will be evaluated by GitHub. True, any work, even unrelated to the documents, will cause the renderer to run but I know no easy way to make the renderer run only for document changes, and I could commit about 1000 commits each month before running out of server run-time.
By using a wildcard (*) I hope to make the GitHub Action find all documents (one folder in the Documents folder equals 1 document to render).
From here, each document should
* Be contained in its own root-folder inside the Documents folder.
* Have 1 .TEX-file that is its main file.
* The main file should be the only .TEX-file on the document root level.
* The folder and the main file should have the same name, i.e the document name.
* The document name should be unique.
The GitHub Action seems to handle multiple documents properly. I therefore remove the extra document (jarnvagen-till-saltsjobaden) as it was only for testing, and it's unnecessary to leave it taking up server run-time when rendered.

Revert "Testing if the GitHub Action handles multiple documents."
This reverts commit 98f5a4f.
The changes in commit 4cb4e25 removed all contents from the table of content (ToC). In this commit I add the chapters back to the ToC.
* Removing it from ToC.
* Shortening it to two pages.
* Removing \cleardoublepage. ToC may start straight after.
LaTeX did NOT like that whitespace apparently. It was added in 9a26171 and while TeXstudio managed to render a PDF despite of the problem, it did raise an error that I missed.
The template had it's functional code structured in a way different from what I prefer. Moved it around to clean it up. This commit should NOT contain any functional changes.
@klanderfri klanderfri merged commit 944b10d into main Mar 23, 2025
2 checks passed
@klanderfri klanderfri deleted the campaign-book branch March 23, 2025 00:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant