doc: Move English manual to manual/en directory

Signed-off-by: Joseph Nuthalapati <njoseph@riseup.net>
[sunil@medhas.org Have common top level makefile for building manual]
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>

.gitignore

@@ -7,9 +7,10 @@ data/var/lib/plinth/*.sqlite3
 data/var/lib/plinth/sessions/*
 data/var/lib/plinth/.ssh/
 data/var/run/*.pid
-doc/*.pdf
+doc/manual/*/*.pdf
-doc/*.html
+doc/manual/*/*.html
-doc/freedombox-manual.xml
+doc/manual/*/*.xml
+!doc/manual/*/*.raw.xml
 doc/plinth.1
 \#*
 .#*

debian/freedombox.doc-base

@@ -13,5 +13,5 @@ Abstract: easy to manage, privacy oriented home server
 Section: Network/Communication
 
 Format: HTML
-Index: /usr/share/doc/freedombox/freedombox-manual.part.html
+Index: /usr/share/doc/freedombox/manual/en/freedombox-manual.part.html
 Files: /usr/share/doc/freedombox/*

debian/freedombox.docs

@@ -1,5 +1,2 @@
 README.md
 HACKING.md
-doc/*.html
-doc/*.pdf
-doc/images

doc/Makefile

@@ -15,12 +15,21 @@
 # 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
 
+MANUAL_LANGUAGES=en
+
+MANUAL_URL="https://wiki.debian.org/{lang-fragment}FreedomBox/Manual?action=show&mimetype=text%2Fdocbook"
+MANUAL_URL_RAW="https://wiki.debian.org/{lang-fragment}FreedomBox/Manual?action=raw"
+MANUAL_PAGE_URL="https://wiki.debian.org/{lang-fragment}FreedomBox/Manual/{page}?action=show&mimetype=text%2Fdocbook"
+
 SCRIPTS_DIR=scripts
 
+manual-pdfs=$(foreach lang,$(MANUAL_LANGUAGES),manual/$(lang)/freedombox-manual.pdf)
+manual-xmls=$(patsubst %.pdf,%.xml,$(manual-pdfs))
+OUTPUTS=$(manual-pdfs) plinth.1 manual-pages
+
 # In order to debug various problems with the documents especially
 # intermediate LaTeX state, run make as follows:
 #
@@ -33,6 +42,7 @@ ifneq ($(DEBUG),)
 	XMLTO_DEBUG_FLAGS=--noclean -p '--debug'
 endif
 
+.PHONY: all
 all: $(OUTPUTS)
 
 # Do not edit the manual page in this directory.  The manual is
@@ -48,37 +58,62 @@ all: $(OUTPUTS)
 # 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-main-list:=$(foreach lang,$(MANUAL_LANGUAGES),fetch-main-$(lang))
-fetch:
+fetch-pages-list:=$(foreach lang,$(MANUAL_LANGUAGES),fetch-pages-$(lang))
-	wget --quiet -O - $(MANUAL_URL) | \
+
-	  xmllint --format --output freedombox-manual.raw.xml -
+.PHONY: fetch $(fetch-main-list) $(fetch-pages-list)
-	xsltproc $(SCRIPTS_DIR)/fetch-images.xslt freedombox-manual.raw.xml | \
+fetch: $(fetch-main-list) $(fetch-pages-list)
-          sort -u | awk 'NF {print "wget --quiet -O images/" $$1 " " $$2}' | sh
+
-	$(SCRIPTS_DIR)/fetch-manual-pages
+fetch-main-%: lang = $*
+fetch-main-%: lang-fragment = $(subst en/,,$*/)
+$(fetch-main-list): fetch-main-%:
+	MANUAL_URL_LANG=$(subst {lang-fragment},$(lang-fragment),$(MANUAL_URL)) ; \
+	wget --quiet -O - $${MANUAL_URL_LANG} | \
+	  xmllint --format --output manual/$(lang)/freedombox-manual.raw.xml -
+	mkdir -p manual/$(lang)/images/
+	xsltproc $(SCRIPTS_DIR)/fetch-images.xslt manual/$(lang)/freedombox-manual.raw.xml | \
+	  sort -u | \
+	  awk 'NF {print "wget --quiet -O manual/$(lang)/images/" $$1 " " $$2}' | \
+	  sh
+
+fetch-pages-%: lang = $*
+fetch-pages-%: lang-fragment = $(subst en/,,$*/)
+$(fetch-pages-list): fetch-pages-%:
+	MANUAL_URL_LANG=$(subst {lang-fragment},$(lang-fragment),$(MANUAL_URL_RAW)) ; \
+	MANUAL_PAGE_URL_LANG=$(subst {lang-fragment},$(lang-fragment),$(MANUAL_PAGE_URL)) ; \
+	PAGES=$$(wget --quiet -U Firefox -O - $${MANUAL_URL_LANG} | \
+	  sed -n -e "s|.*FreedomBox/Manual/\([a-zA-Z0-9_-]*\).*|\1|p" | sort -u | \
+	  grep -v -e GettingHelp -e Developer -e QuickStart) ; \
+	for PAGE in $${PAGES} ; do \
+	  FILE="manual/$(lang)/$${PAGE}.raw.xml" ; \
+	  URL=$$(echo $${MANUAL_PAGE_URL_LANG} | sed "s/{page}/$${PAGE}/") ; \
+	  echo "Downloading $(lang) $${PAGE}" ; \
+	  wget --quiet --user-agent=Firefox -O $${FILE} $${URL} ; \
+	done
+
+manual-pages-raw:=$(foreach lang,$(MANUAL_LANGUAGES),$(filter-out manual/%/freedombox-manual.raw.xml,$(wildcard manual/$(lang)/*.raw.xml)))
+manual-pages-part-html:=$(patsubst %.raw.xml, %.part.html, $(manual-pages-raw)) $(foreach lang,$(MANUAL_LANGUAGES),manual/$(lang)/freedombox-manual.part.html)
+manual-pages-html:=$(patsubst %.part.html, %.html, $(manual-pages-part-html))
+manual-pages-xml:=$(patsubst %.raw.xml, %.xml, $(manual-pages-raw))
 
 .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
+$(manual-pdfs): %.pdf: %.xml
-	xmlto $(XMLTO_DEBUG_FLAGS) --with-dblatex pdf $<
+	xmlto $(XMLTO_DEBUG_FLAGS) --with-dblatex pdf -o $(dir $@) $<
 
-%.part.html: %.html
+$(manual-pages-part-html): %.part.html: %.html
 	perl -pe 'BEGIN {undef $$/} s/.*<body[^>]*>(.*)<\/body\s*>.*/$$1/si' $< > $@
 
-freedombox-manual.xml: freedombox-manual.raw.xml $(SCRIPTS_DIR)/fixes.xslt
+$(manual-xmls): %.xml: %.raw.xml $(SCRIPTS_DIR)/fixes.xslt
 	xsltproc --output $@ $(SCRIPTS_DIR)/fixes.xslt $<
 
-%.xml: %.raw.xml $(SCRIPTS_DIR)/manual-page-fixes.xslt
+$(manual-pages-xml): %.xml: %.raw.xml $(SCRIPTS_DIR)/manual-page-fixes.xslt
 	xsltproc --output $@ $(SCRIPTS_DIR)/manual-page-fixes.xslt $<
 	$(SCRIPTS_DIR)/post-processor remove-footer $@
 	$(SCRIPTS_DIR)/post-processor fix-wiki-urls $@
 
-%.html: %.xml
+$(manual-pages-html): %.html: %.xml
 	xsltproc --output $@ /usr/share/xml/docbook/stylesheet/docbook-xsl/xhtml5/docbook.xsl $<
 	rm -f $(dir $@)docbook.css
 
@@ -87,5 +122,5 @@ freedombox-manual.xml: freedombox-manual.raw.xml $(SCRIPTS_DIR)/fixes.xslt
 
 .PHONY: clean
 clean:
-	rm -f $(manual-pages-html) $(manual-pages-part-html) $(manual-pages-xml)
+	rm -f $(manual-pages-html) $(manual-pages-part-html) $(manual-pages-xml) $(manual-xmls)
 	rm -f $(OUTPUTS)

doc/manual-pages.list

@@ -1,44 +0,0 @@
-Apache_userdir
-Tor
-Transmission
-Deluge
-Minetest
-Radicale
-ejabberd
-MatrixSynapse
-Roundcube
-Coquelicot
-MLDonkey
-Syncthing
-Infinoted
-Quassel
-TinyTinyRSS
-Repro
-Shadowsocks
-OpenVPN
-Mumble
-Privoxy
-Searx
-MediaWiki
-Ikiwiki
-I2P
-Backups
-Configure
-Cockpit
-DateTime
-Diagnostics
-DynamicDNS
-Firewall
-LetsEncrypt
-Monkeysphere
-NameServices
-Networks
-Power
-PageKite
-SecureShell
-Security
-ServiceDiscovery
-Snapshots
-Storage
-Upgrades
-Users