doc: create the skeleton to have a documentation for Internationalisation

The source of the documentation is in Texinfo format to have the
possibility someday to distribute in more format that just plain text;

There is a new Makefile to generate automatically the plain text file to be
distributed from the source; this doc is also generated by 'autogen.sh'
because a user would expect to find it before compiling the program, so
even before the 'configure' script have been generated, in the case he is
compiling from a git checkout;

There is a new script to generate the documentation, because from the way
we generate it we cannot assume that 'texi2any' is available  and working
on the user's computer; it is also the opportunity to generate a better
looking document (see the description at the beginning of the script);

In this commit, the documentation only contains the base skeleton, it does
not contain yet any useful content because it is worth it's own commit.

Signed-off-by: Christophe CURIS <christophe.curis@free.fr>

.gitignore

@@ -31,6 +31,9 @@ m4/lt~obsolete.m4
 
 src/wconfig.h
 
+# These files are generated by scripts
+README.i18n
+
 # These files are compilation stuff
 *.lo
 *.o

Makefile.am

@@ -34,12 +34,13 @@ SUBDIRS = wrlib WINGs src util po WindowMaker wmlib WPrefs.app doc
 DIST_SUBDIRS = $(SUBDIRS) test
 
 EXTRA_DIST = TODO BUGS BUGFORM FAQ FAQ.I18N INSTALL \
-	INSTALL-WMAKER README.definable-cursor \
+	INSTALL-WMAKER README.i18n README.definable-cursor \
 	The-perfect-Window-Maker-patch.txt \
 	README COPYING.WTFPL autogen.sh \
 	email-clients.txt checkpatch.pl update-changelog.pl \
 	script/check-translation-sources.sh \
 	script/generate-mapfile-from-header.sh \
+	script/generate-txt-from-texi.sh \
 	script/nested-func-to-macro.sh
 
 if USE_LCOV

autogen.sh

@@ -1,5 +1,9 @@
 #!/bin/sh
 
+# Generate the documentation about compiling Window Maker
+./script/generate-txt-from-texi.sh doc/build/Translations.texi > README.i18n
+
+# Generate the configure script from the 'configure.ac'
 autoreconf -vfi -I m4
 
 exit 0

configure.ac

@@ -971,7 +971,8 @@ AC_CONFIG_FILES(
 
     dnl Window Maker's core
     src/Makefile src/wconfig.h po/Makefile
-    doc/Makefile doc/sk/Makefile doc/cs/Makefile doc/ru/Makefile
+    doc/Makefile doc/build/Makefile
+    doc/sk/Makefile doc/cs/Makefile doc/ru/Makefile
     WindowMaker/Makefile WindowMaker/Backgrounds/Makefile
     WindowMaker/Defaults/Makefile WindowMaker/IconSets/Makefile
     WindowMaker/Icons/Makefile WindowMaker/Pixmaps/Makefile

doc/Makefile.am

@@ -1,6 +1,6 @@
 ## Process this file with automake to produce Makefile.in
 
-SUBDIRS = sk cs ru
+SUBDIRS = build sk cs ru
 
 man_MANS = \
 	geticonset.1x \

doc/build/Makefile.am

@@ -0,0 +1,15 @@
+# The list of sources are distributed, but none are to be
+# installed along with Window Maker:
+EXTRA_DIST = Readme \
+	Translations.texi
+
+# How to re-generate automatically the top-level text files
+all-local: $(top_srcdir)/README.i18n
+
+$(top_srcdir)/README.i18n: $(srcdir)/Translations.texi $(top_srcdir)/script/generate-txt-from-texi.sh
+	$(AM_V_GEN)if test -w "$(top_srcdir)/README.i18n" ; then \
+	    $(top_srcdir)/script/generate-txt-from-texi.sh \
+	        $(srcdir)/Translations.texi -o $(top_srcdir)/README.i18n ; \
+	else \
+	    echo "Warning: \"$(top_srcdir)/README.i18n\" is not writeable, not regenerated" ; \
+	fi

doc/build/Readme

@@ -0,0 +1,8 @@
+This directory contains the sources for the documentation about building
+the Window Maker project from sources.
+
+This documentation is meant to go into the distributed sources archive, but
+it is not supposed to be installed as it contains no relevant information.
+
+The documentaion are written in GNU Texinfo format and a script converts
+them into plain text for distribution.

doc/build/Translations.texi

@@ -0,0 +1,86 @@
+\input texinfo   @c -*-texinfo-*-
+@c %**start of header
+@setfilename wmaker_i18n.info
+@settitle Window Maker Internationalisation 1.0
+@c %**end of header
+
+@c This documentation is written in Texinfo format:
+@c   https://www.gnu.org/software/texinfo/manual/texinfo/
+@c
+@c The reference checker is the GNU texi2any tool, which can be invoked like this:
+@c   texi2any --plaintext --no-split --verbose Translations.texi
+@c
+@c If you modify this file, you may want to spell-check it with:
+@c    aspell --lang=en_GB --mode=texinfo check Translations.texi
+@c
+@c The length of lines in this file is set to 100 because it tends to keep sentences together
+@c despite the embedded @commands{};
+@c
+@c It is generally considered good practice for Tex and Texinfo formats to keep sentences on
+@c different lines, using the fact that in the end they will be merged in paragraph anyway, because
+@c it makes the patchs clearer about where the changes actually are.
+
+@finalout
+
+@set version git#next
+
+@c ---------------------------------------------------------------------------------- Title Page ---
+
+@copying
+@noindent
+This manual is for @sc{Window Maker} window manager, version @value{version}.
+
+@noindent Copyright @copyright{} 2015 The Window Maker Team.
+
+@quotation
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 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 General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program, see file COPYING for details.
+@end quotation
+@end copying
+
+@titlepage
+@title Window Maker Internationalisation
+@subtitle A guide to enable support for language translations
+@subtitle in @sc{Window Maker}.
+@author Christophe CURIS
+
+@page
+@vskip 0pt plus 1filll
+@insertcopying
+
+@sp 1
+Published by The Window Maker team on @today{}.
+@end titlepage
+
+@c ---------------------------------------------------------------------------- Table of Content ---
+@node Top
+@ifnottex
+@top Window Maker Internationalisation
+
+A guide to enable support for language translations
+in @sc{Window Maker}.
+@end ifnottex
+
+@contents
+
+@ifnottex
+@sp 1
+This manual is for Window Maker, version @value{version}.
+@end ifnottex
+
+@menu
+@end menu
+
+
+@c ------------------------------------------------------------------------------------- The End ---
+@bye