From: Thérèse Godefroy <godef.th@free.fr>
Date: Fri, 8 Aug 2014 22:47:18 +0000 (+0200)
Subject: fr/kitchen/assemble-all-pages: close terminal by hand; reword the explanations.
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=4f8bf1ae93b4ac0bfd698b13a9786ae51f2a3d43;p=enc.git

fr/kitchen/assemble-all-pages: close terminal by hand; reword the explanations.
---

diff --git a/fr/kitchen/assemble-all-pages b/fr/kitchen/assemble-all-pages
index 0b1dc43a..702aced8 100755
--- a/fr/kitchen/assemble-all-pages
+++ b/fr/kitchen/assemble-all-pages
@@ -1,6 +1,11 @@
 #!/bin/bash
 
-# assemble-all-pages: generates a set of HTML pages with variable parts.
+## assemble-all-pages -- generate a set of HTML pages with variable parts
+#                        for emailselfdefense.fsf.org
+
+## Synopsis:             assemble-all-pages
+
+## Overview
 
 # Each page is built from a template and one or several includes, as usual;
 # in addition, several versions of a page can be built from a single
@@ -12,17 +17,12 @@
 # inserted, and deletion markers to identify the borders of each deletion
 # and indicate which page(s) the text between those borders belongs to.
 
-# The script processes all the templates in the working directory. The
+# The script processes all the templates in the working directory and the
 # pages are created in the parent directory.
 
 # Ideally, any modifications should be done to the templates or includes,
 # not to the final pages.
 
-
-# All the ingredients are in [...]/enc/[lang]/kitchen/.
-
-# Script:     assemble-all-pages
-
 # Templates:  confirmation.t.html
 #             index.t.html  (contains variable parts for mac and windows)
 #             infographic.t.html
@@ -33,30 +33,35 @@
 #             javascript.html
 #             translist.html
 
-# To generate the pages in [...]/enc/[lang]/:
-# - in the terminal, cd to [...]/enc/[lang]/kitchen/ and enter
-#                     $ ./assemble-all-pages
-# - alternatively, display the kitchen/ directory in the file browser
-#   (not the parent directory) and double-click on the script.
+## Graphic-user-interface howto
+
+# - Place the script in the same directory as the templates.
+# - Display this directory in the file browser (do not just unfold the parent
+#   directory) and double-click on the script.
 
 # And if anything goes wrong, you can do a git reset, right?    ;-)
 
-# ==========================================================================
+# ===========================================================================
 
 set -e
 
+close_term () {
+  printf '\n%s' '*** Close the terminal window or press Return.'; read OK
+  test -z "$OK" && exit $1
+}
+
 # Create temporary files.
-names=$(mktemp -t aap.XXXXXX) || exit 1
-list=$(mktemp -t aap.XXXXXX) || exit 1
-before=$(mktemp -t aap.XXXXXX) || exit 1
-after=$(mktemp -t aap.XXXXXX) || exit 1
+names=$(mktemp -t aap.XXXXXX)  || close_or_exit 1
+list=$(mktemp -t aap.XXXXXX)   || close_or_exit 1
+before=$(mktemp -t aap.XXXXXX) || close_or_exit 1
+after=$(mktemp -t aap.XXXXXX)  || close_or_exit 1
 trap 'rm -f "$names" "$list" "$before" "$after"' EXIT
 
 # List all the templates in the working directory.
 if ls *.t.html > $names  2>/dev/null; then
   sed -i 's,\.t\.html$,,' $names
 else
-  echo "There is no template in this directory." && exit 1
+  echo "*** There is no template in this directory." && close_term 1
 fi
 
 ## Add the includes to the templates.
@@ -107,4 +112,4 @@ while read name ; do
   sed -i ':a /^\n*$/ {$d; N; ba}' ../$name.html
 done < $names
 
-exit 0
+close_term 0