Since these will be printed on real dead paper and sent out in the
world, it seems like it may be a very good idea if we can identify what
version they were built from.
Specifying `media=print` changes Asciidoctor so that URLs are included
inline in a way that can be read in printed media. For printed manuals
this is obviously what we want, though we should still keep the regular
version around for the binary distributions, since they retain the
internal links.
This required some adjustment of the template to increase the size of
the box on the rear cover containing the text.
Text was translated by Google Translate; I have not yet had native
speakers verify the accuracy of the translations.
We generate the previous SVG by doing sed substitutions to insert the
front cover and spine titles, plus the rear cover text. A follow-up
commit will generate the French and Spanish covers as well.
This is not invoked as part of the normal build process, and shouldn't
be: we only ever want to build the cover PDFs when we're uploading them
for printing, and don't want everyone who wants to build Freedoom to
have to install Inkscape. However, we should nonetheless include it in
the CI to check that the build step works.
Having this will allow us to put up printed Freedoom manuals for sale.
The SVG here is compatible with the template provided by lulu.com, which
is where I'm planning to put up the online store. Lulu expects a PDF, so
there's a Makefile target that uses Inkscape to convert the SVG to PDF
format.
The cover artwork here is by Reddit user Illustrious-Gift4206 who
created fanart of many of the Freedoom monsters. Ony my request he has
graciously agreed to donate his artwork to the project for use.
Currently this is just the English version of the manual cover. I'm
planning in a follow-up commit to convert the SVG into a template, so
that we can autogenerate covers for all the different translations.
The following changes should make the manual more available, and easier
to understand:
1) "make dist" and "make install" will now include all translations of
the manual.
1) A "freedoom-" prefix will be used in all cases in place of just
"manual".
2) All languages will have a two letter suffix, so English is now
"-en".
3) Only the PDF specified will be built when invoked in the top level
directory. For example:
make manual/freedoom-manual-en.pdf
Some of the table columns were not large enough to fit the text, or the words themselves were too big when smaller words would have done.
Lots of single-word lines at the ends of paragraphs.
Removed a bit of redundant information.
Vital links in the submitting/visiting sections needed to have visible URLs in case one really did print them out.
Added a copy of the BSD licence and a link to the website.
This seems like a better choice for the manual since it is a "booklet"
size similar to the original Doom manual, rather than a "full page"
size that is rather unusual for a book.
Several changes are needed to allow asciidoctor to successfully produce
a PDF. The main change is to set a bunch of images to 100% width,
especially in tables where this means "100% of cell width". This allows
the tables to scale down successfully to the smaller size. I have also
adjusted the column widths of various tables to accommodate the smaller
size without the text wrapping awkwardly.