mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-21 07:55:00 +00:00
4064d6e231
Closes #930 - Make targets to download wiki pages of each service - Add post-processor script for DocBook file processing Signed-off-by: Joseph Nuthalapati <njoseph@thoughtworks.com> Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
89 lines
2.9 KiB
Makefile
89 lines
2.9 KiB
Makefile
#!/usr/bin/make -f
|
|
#
|
|
# This file is part of FreedomBox.
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero General Public License as
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
# License, or (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU Affero General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Affero General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
MANUAL_URL="https://wiki.debian.org/FreedomBox/Manual?action=show&mimetype=text%2Fdocbook"
|
|
|
|
OUTPUTS=freedombox-manual.pdf plinth.1 manual-pages
|
|
|
|
# In order to debug various problems with the documents especially
|
|
# intermediate LaTeX state, run make as follows:
|
|
#
|
|
# $ make DEBUG=true
|
|
# or
|
|
# $ make DEBUG=true <target>
|
|
#
|
|
XMLTO_DEBUG_FLAGS=
|
|
ifneq ($(DEBUG),)
|
|
XMLTO_DEBUG_FLAGS=--noclean -p '--debug'
|
|
endif
|
|
|
|
all: $(OUTPUTS)
|
|
|
|
# Do not edit the manual page in this directory. The manual is
|
|
# maintained as separate pages on the FreedomBox wiki and aggregated
|
|
# into a single page using the MoinMoin include feature. Then it is
|
|
# exported as Docbook format and kept here.
|
|
#
|
|
# It is important to keep a copy of the manual in this source tree
|
|
# because Debian packages promise an entire source tree including the
|
|
# documentation.
|
|
#
|
|
# Use 'make fetch' to retrieve the latest manual from the wiki and
|
|
# commit it to the repository. The wiki page is already reviewed, so
|
|
# commits that update the manual just using the 'fetch' target do not
|
|
# require further reviews.
|
|
.PHONY: fetch
|
|
fetch:
|
|
wget --quiet -O - $(MANUAL_URL) | \
|
|
xmllint --format --output freedombox-manual.raw.xml -
|
|
xsltproc fetch-images.xslt freedombox-manual.raw.xml | sort -u | \
|
|
awk '{print "wget --quiet -O images/" $$1 " " $$2}' | sh
|
|
./fetch-manual-pages
|
|
|
|
.PHONY: manual-pages
|
|
manual-pages-list:=$(shell cat manual-pages.list) freedombox-manual
|
|
manual-pages-part-html:=$(patsubst %, %.part.html, $(manual-pages-list))
|
|
manual-pages-html:=$(patsubst %, %.html, $(manual-pages-list))
|
|
manual-pages-xml:=$(patsubst %, %.xml, $(manual-pages-list))
|
|
|
|
manual-pages: $(manual-pages-part-html)
|
|
|
|
%.pdf: %.xml
|
|
xmlto $(XMLTO_DEBUG_FLAGS) --with-dblatex pdf $<
|
|
|
|
%.part.html: %.html
|
|
perl -pe 'BEGIN {undef $$/} s/.*<body[^>]*>(.*)<\/body\s*>.*/$$1/si' $< > $@
|
|
|
|
freedombox-manual.xml: freedombox-manual.raw.xml fixes.xslt
|
|
xsltproc --output $@ fixes.xslt $<
|
|
|
|
%.xml: %.raw.xml manual-page-fixes.xslt
|
|
xsltproc --output $@ manual-page-fixes.xslt $<
|
|
./post-processor remove-footer $@
|
|
./post-processor fix-wiki-urls $@
|
|
|
|
%.html: %.xml
|
|
docbook2html --nochunks $<
|
|
|
|
%.1: %.xml
|
|
xmlto man $<
|
|
|
|
.PHONY: clean
|
|
clean:
|
|
rm -f $(manual-pages-html) $(manual-pages-part-html) $(manual-pages-xml)
|
|
rm -f $(OUTPUTS)
|