Commit graph

17 commits

Author SHA1 Message Date
Simon Howard
6772452d6a manual: Embed the build version on the second page
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.
2025-06-03 13:35:54 -04:00
Simon Howard
9979dacb09 manual: Add build targets for printable manual
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.
2025-06-02 23:25:29 -04:00
Simon Howard
de02bcd718 manual: Generate covers for French, Spanish manuals
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.
2025-05-22 15:41:30 -04:00
Simon Howard
868e9fa6c8 manual: Convert cover SVG to a template file
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.
2025-05-22 15:21:34 -04:00
Simon Howard
5b89315bcc manual: Add cover PDF build to CI
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.
2025-05-22 14:01:28 -04:00
Simon Howard
1d701b183f manual: Initial version of manual cover
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.
2025-05-22 11:29:17 -04:00
Steven Elliott
8350df1711 manual: Make the manual more available
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
2024-01-16 11:59:01 -05:00
Oplexitie
759b75eec4
Manual : Add French translation (#1209)
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2023-12-07 13:26:07 -08:00
mc776
3ef1adc78e
manual: optimize for PDF formatting. (#1202)
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.
2023-11-29 08:56:59 -08:00
Simon Howard
c3f55a0734 Merge branch 'master' into a5-manual 2022-06-13 00:01:28 -04:00
Simon Howard
89f918f517 Change manual to build as A5 paper size.
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.
2022-06-09 19:57:37 -04:00
Simon Howard
e054e81500 Add Spanish translation of manual.
Credit goes to CyberSaurus and DoomguyAlighieri on the Freedoom Discord
who translated this in Microsoft .docx format. I think converted it back
into Asciidoc format and added it to the build.
https://discord.com/channels/616148111076884520/857628798921342986/944620737862443019
2022-06-09 18:40:44 -04:00
Mike Swanson
33d2d14cd2 Make: build manual PDF for install and dist targets
This is largely being kept optional due to asciidoctor-pdf’s failure
to actually work on Arch Linux, but if it runs fine, we get a nice PDF
manual!
2019-09-12 16:32:33 -07:00
Simon Howard
5e6e6332cd Merge github.com:freedoom/freedoom 2019-08-28 04:13:55 +01:00
Mike Swanson
1471de203a manual: add clean target to the Makefile 2019-08-23 22:45:10 -07:00
Simon Howard
d86351c56c manual: Fix makefile to output correct filename. 2019-08-19 02:47:53 +01:00
Simon Howard
87c0ea1336 manual: Add README, Makefile. 2019-08-18 23:50:31 +01:00