#!/bin/bash
-# "assemble-all-pages" inserts the constant parts into all HTML templates
-# in the working directory and creates the OS-specific pages by removing
-# the irrelevant text from a common file which contains the OS-variable
-# parts.
+## assemble-all-pages -- generate a set of HTML pages with variable parts
+# for emailselfdefense.fsf.org
-# The page is NAME.html and the template is NAME.t.html. The template has
-# inclusion markers (similar to SSI directives, except for the lack of "#")
-# to indicate where the constant parts are to be inserted, and deletion
-# markers to identify the borders of each deletion and indicate which
-# page(s) the text between them belongs to.
+## Synopsis: assemble-all-pages
-# All the ingredients are is in [...]/enc/[lang]/kitchen/:
+## Overview
-# Script: assemble-all-pages
+# 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
+# template which contains all the variable parts, by deleting irrelevant
+# text.
+
+# The templates have inclusion markers (similar to SSI directives, except
+# for the lack of "#") to indicate where the constant parts are to be
+# 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 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.
# Templates: confirmation.t.html
# index.t.html (contains variable parts for mac and windows)
# javascript.html
# translist.html
-# To regenerate the pages in [...]/enc/[lang]/:
-# - in the terminal, cd to [...]/enc/[lang]/kitchen/ and enter:
-# $ ./assemble-all-pages
-# - alternatively, display the directory [...]/kitchen/ 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.
sed -i ':a /^\n*$/ {$d; N; ba}' ../$name.html
done < $names
-exit 0
+close_term 0