mirror of
https://github.com/freedoom/freedoom.git
synced 2025-09-01 13:25:46 -04:00
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
This commit is contained in:
parent
518dbc4298
commit
8350df1711
5 changed files with 30 additions and 18 deletions
23
Makefile
23
Makefile
|
@ -13,6 +13,8 @@ NODE_BUILDER=ZenNode
|
||||||
NODE_BUILDER_LEVELS=e?m? dm?? map??
|
NODE_BUILDER_LEVELS=e?m? dm?? map??
|
||||||
LEGACY_TRANSPARENCY_INDEX=255
|
LEGACY_TRANSPARENCY_INDEX=255
|
||||||
LEGACY_TRANSPARENCY_REPLACEMENT=133
|
LEGACY_TRANSPARENCY_REPLACEMENT=133
|
||||||
|
MANUAL_ADOC_FILES=$(wildcard manual/freedoom-manual-??.adoc)
|
||||||
|
MANUAL_PDF_FILES=$(subst .adoc,.pdf,$(MANUAL_ADOC_FILES))
|
||||||
|
|
||||||
FREEDOOM1=$(WADS)/freedoom1.wad
|
FREEDOOM1=$(WADS)/freedoom1.wad
|
||||||
FREEDOOM2=$(WADS)/freedoom2.wad
|
FREEDOOM2=$(WADS)/freedoom2.wad
|
||||||
|
@ -101,8 +103,8 @@ $(FREEDOOM2): wadinfo_phase2.txt subdirs
|
||||||
%.html: %.adoc
|
%.html: %.adoc
|
||||||
$(ASCIIDOC) $(ADOCOPTS) $<
|
$(ASCIIDOC) $(ADOCOPTS) $<
|
||||||
|
|
||||||
manual/freedoom-manual.pdf: manual/manual.adoc
|
manual/freedoom-manual-%.pdf: manual/freedoom-manual-%.adoc
|
||||||
$(MAKE) -C manual
|
$(MAKE) -C manual $(subst manual/,,$@)
|
||||||
|
|
||||||
COPYING.txt: COPYING.adoc
|
COPYING.txt: COPYING.adoc
|
||||||
unix2dos --add-bom --newfile $< $@
|
unix2dos --add-bom --newfile $< $@
|
||||||
|
@ -115,7 +117,7 @@ CREDITS-MUSIC.txt: CREDITS-MUSIC
|
||||||
|
|
||||||
HTMLDOCS=NEWS.html README.html
|
HTMLDOCS=NEWS.html README.html
|
||||||
TEXTDOCS=COPYING.txt CREDITS.txt CREDITS-MUSIC.txt
|
TEXTDOCS=COPYING.txt CREDITS.txt CREDITS-MUSIC.txt
|
||||||
DISTDOCS=$(HTMLDOCS) $(TEXTDOCS) manual/freedoom-manual.pdf
|
DISTDOCS=$(HTMLDOCS) $(TEXTDOCS) $(MANUAL_PDF_FILES)
|
||||||
|
|
||||||
dist: $(OBJS) $(DISTDOCS)
|
dist: $(OBJS) $(DISTDOCS)
|
||||||
LC_ALL=C VERSION=$(VERSION) scripts/makepkgs freedm $(FREEDM) $(DISTDOCS)
|
LC_ALL=C VERSION=$(VERSION) scripts/makepkgs freedm $(FREEDM) $(DISTDOCS)
|
||||||
|
@ -249,7 +251,7 @@ mandir?=/share/man
|
||||||
waddir?=/share/games/doom
|
waddir?=/share/games/doom
|
||||||
target=$(DESTDIR)$(prefix)
|
target=$(DESTDIR)$(prefix)
|
||||||
|
|
||||||
install-freedm: $(FREEDM) $(HTMLDOCS) manual/freedoom-manual.pdf \
|
install-freedm: $(FREEDM) $(HTMLDOCS) $(MANUAL_PDF_FILES) \
|
||||||
freedm.6 io.github.freedoom.FreeDM.png
|
freedm.6 io.github.freedoom.FreeDM.png
|
||||||
install -Dm 644 dist/io.github.freedoom.FreeDM.desktop \
|
install -Dm 644 dist/io.github.freedoom.FreeDM.desktop \
|
||||||
-t "$(target)/share/applications"
|
-t "$(target)/share/applications"
|
||||||
|
@ -262,10 +264,10 @@ install-freedm: $(FREEDM) $(HTMLDOCS) manual/freedoom-manual.pdf \
|
||||||
-t "$(target)/share/icons"
|
-t "$(target)/share/icons"
|
||||||
install -Dm 644 CREDITS NEWS.html README.html -t "$(target)$(docdir)/freedm"
|
install -Dm 644 CREDITS NEWS.html README.html -t "$(target)$(docdir)/freedm"
|
||||||
install -Dm 644 COPYING.adoc "$(target)$(docdir)/freedm/COPYING"
|
install -Dm 644 COPYING.adoc "$(target)$(docdir)/freedm/COPYING"
|
||||||
-install -Dm 644 manual/freedoom-manual.pdf -t "$(target)$(docdir)/freedm"
|
-install -Dm 644 $(MANUAL_PDF_FILES) -t "$(target)$(docdir)/freedm"
|
||||||
|
|
||||||
install-freedoom: $(FREEDOOM1) $(FREEDOOM2) $(HTMLDOCS) \
|
install-freedoom: $(FREEDOOM1) $(FREEDOOM2) $(HTMLDOCS) \
|
||||||
manual/freedoom-manual.pdf freedoom1.6 freedoom2.6 \
|
$(MANUAL_PDF_FILES) freedoom1.6 freedoom2.6 \
|
||||||
io.github.freedoom.Phase1.png \
|
io.github.freedoom.Phase1.png \
|
||||||
io.github.freedoom.Phase2.png
|
io.github.freedoom.Phase2.png
|
||||||
install -Dm 644 dist/io.github.freedoom.Phase1.desktop \
|
install -Dm 644 dist/io.github.freedoom.Phase1.desktop \
|
||||||
|
@ -288,7 +290,10 @@ install-freedoom: $(FREEDOOM1) $(FREEDOOM2) $(HTMLDOCS) \
|
||||||
install -Dm 644 CREDITS NEWS.html README.html \
|
install -Dm 644 CREDITS NEWS.html README.html \
|
||||||
-t "$(target)$(docdir)/freedoom"
|
-t "$(target)$(docdir)/freedoom"
|
||||||
install -Dm 644 COPYING.adoc "$(target)$(docdir)/freedoom/COPYING"
|
install -Dm 644 COPYING.adoc "$(target)$(docdir)/freedoom/COPYING"
|
||||||
-install -Dm 644 manual/freedoom-manual.pdf -t "$(target)$(docdir)/freedoom"
|
-install -Dm 644 $(MANUAL_PDF_FILES) -t "$(target)$(docdir)/freedoom"
|
||||||
|
|
||||||
|
# For the following uninstall targets the manual arguments are intentionally
|
||||||
|
# not quoted since they are wildcards.
|
||||||
|
|
||||||
uninstall-freedm:
|
uninstall-freedm:
|
||||||
$(RM) \
|
$(RM) \
|
||||||
|
@ -302,7 +307,7 @@ uninstall-freedm:
|
||||||
"$(target)$(docdir)/freedm/COPYING" \
|
"$(target)$(docdir)/freedm/COPYING" \
|
||||||
"$(target)$(docdir)/freedm/NEWS.html" \
|
"$(target)$(docdir)/freedm/NEWS.html" \
|
||||||
"$(target)$(docdir)/freedm/README.html" \
|
"$(target)$(docdir)/freedm/README.html" \
|
||||||
"$(target)$(docdir)/freedm/freedoom-manual.pdf"
|
$(target)$(docdir)/freedm/freedoom-manual-??.pdf
|
||||||
-rmdir -p "$(target)/share/applications" \
|
-rmdir -p "$(target)/share/applications" \
|
||||||
"$(target)/share/metainfo" "$(target)/share/icons" \
|
"$(target)/share/metainfo" "$(target)/share/icons" \
|
||||||
"$(target)$(bindir)" "$(target)$(mandir)/man6" \
|
"$(target)$(bindir)" "$(target)$(mandir)/man6" \
|
||||||
|
@ -326,7 +331,7 @@ uninstall-freedoom:
|
||||||
"$(target)$(docdir)/freedoom/COPYING" \
|
"$(target)$(docdir)/freedoom/COPYING" \
|
||||||
"$(target)$(docdir)/freedoom/NEWS.html" \
|
"$(target)$(docdir)/freedoom/NEWS.html" \
|
||||||
"$(target)$(docdir)/freedoom/README.html" \
|
"$(target)$(docdir)/freedoom/README.html" \
|
||||||
"$(target)$(docdir)/freedoom/freedoom-manual.pdf"
|
$(target)$(docdir)/freedoom/freedoom-manual-??.pdf
|
||||||
-rmdir -p "$(target)/share/applications" \
|
-rmdir -p "$(target)/share/applications" \
|
||||||
"$(target)/share/metainfo" "$(target)/share/icons" \
|
"$(target)/share/metainfo" "$(target)/share/icons" \
|
||||||
"$(target)$(bindir)" "$(target)$(mandir)/man6" \
|
"$(target)$(bindir)" "$(target)$(mandir)/man6" \
|
||||||
|
|
|
@ -1,14 +1,21 @@
|
||||||
|
# Generate the Freedoom manual PDF files based on ADOC files. Each translation
|
||||||
|
# has a two character code. Adding a new translation does not require any
|
||||||
|
# makefile changes, but it would be nice to keep the following table up to date:
|
||||||
|
#
|
||||||
|
# Two Character Code Language
|
||||||
|
# ------------------ --------
|
||||||
|
# en English
|
||||||
|
# es Spanish
|
||||||
|
# fr French
|
||||||
|
|
||||||
ASCIIDOCTOR_FLAGS = -a pdf-page-size=A5
|
ASCIIDOCTOR_FLAGS = -a pdf-page-size=A5
|
||||||
all: freedoom-manual.pdf freedoom-manual-es.pdf freedoom-manual-fr.pdf
|
MANUAL_ADOC_FILES=$(wildcard freedoom-manual-??.adoc)
|
||||||
|
MANUAL_PDF_FILES=$(subst .adoc,.pdf,$(MANUAL_ADOC_FILES))
|
||||||
|
|
||||||
freedoom-manual.pdf: manual.adoc
|
all: $(MANUAL_PDF_FILES)
|
||||||
-asciidoctor-pdf $(ASCIIDOCTOR_FLAGS) manual.adoc -o $@
|
|
||||||
|
|
||||||
freedoom-manual-es.pdf: manual-es.adoc
|
freedoom-manual-%.pdf: freedoom-manual-%.adoc
|
||||||
-asciidoctor-pdf $(ASCIIDOCTOR_FLAGS) manual-es.adoc -o $@
|
-asciidoctor-pdf $(ASCIIDOCTOR_FLAGS) $< -o $@
|
||||||
|
|
||||||
freedoom-manual-fr.pdf: manual-fr.adoc
|
|
||||||
-asciidoctor-pdf $(ASCIIDOCTOR_FLAGS) manual-fr.adoc -o $@
|
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
$(RM) freedoom-manual.pdf freedoom-manual-es.pdf freedoom-manual-fr.pdf
|
$(RM) $(MANUAL_PDF_FILES)
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue