Add end-user manual in PDF

gbv / cocoda

A web-based tool for creating mappings between knowledge organization systems.

https://coli-conc.gbv.de/cocoda/

MIT License

39 stars 5 forks source link

Add end-user manual in PDF #435

Closed nichtich closed 4 years ago

nichtich commented 5 years ago

This is already implemented (run make pdf in docs/*/), but

[x] layout needs to be adjusted
[ ] does not run on travis because it takes too long (see #337)
[x] split end-user manual from the rest of documentation (#349)

nichtich commented 4 years ago

We could make the travis job only run on releases although this adds another fragile step to the release process. At least Pandoc 2.7 is required which may require different setup at travis.

German end-user manual is already finished, see https://coli-conc.gbv.de/cocoda/dev/user-manual-de.html.

nichtich commented 4 years ago

The PDF manual is only build if the docs/ folder was modified.

[x] This should be extended to tagged commit (releases) ~and to changes in the public/img/ folder.~
[x] Installation of LaTeX could be cached as described here to save 30s-60s build time
[ ] pdfbook is not available at travis (should be part of texlive package pdfjam)

nichtich commented 4 years ago

I've set up cached LaTeX installation on the travis branch. The PDF should be build when the docs/ folder was changed and on tagged commits. It looks like there is a new cache for each tag (?), so releases would need longer. Build still fails because pdfbook is missing (should be part of texlive package pdfjam)