#!/bin/bash
-# "assemble-all-pages" inserts the constant parts into all the HTML
-# templates in the working directory and creates the OS-specific pages by
-# removing the irrelevant text from a common file which contains all the
-# OS-variable parts.
+# "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.
# The page is NAME.html and the template is NAME.t.html. The template has
-# inclusion markers (similar to SSI directives, except for the "#") to
-# indicate where the constant parts are to be inserted, and deletion
+# 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 in between belongs to.
+# page(s) the text between them belongs to.
-# All the ingredients are is in enc/[lang]/kitchen/:
+# All the ingredients are is in [...]/enc/[lang]/kitchen/:
-# Script: assemble-all-pages
+# Script: assemble-all-pages
-# Templates: confirmation.t.html
-# index.t.html
-# infographic.t.html
-# next_steps.t.html
+# Templates: confirmation.t.html
+# index.t.html (contains variable parts for mac and windows)
+# infographic.t.html
+# next_steps.t.html
-# Includes: footer.html
-# head1.html
-# head2.html
-# javascript.html
-# translist.html
+# Includes: footer.html
+# head1.html
+# head2.html
+# javascript.html
+# translist.html
-# To regenerate the pages in enc/[lang]/:
-# - In the terminal, cd to enc/[lang]/kitchen/ and enter:
+# To regenerate the pages in [...]/enc/[lang]/:
+# - In the terminal, cd to [...]/enc/[lang]/kitchen/ and enter:
# $ ./assemble-all-pages
-# - In the file browser, display this directory (not its parent) and
-# double-click on the script.
+# - Or, in the file browser, display the directory [...]/kitchen/ (not its
+# parent) and double-click on the script.
# And if anything goes wrong, you can do a git reset, right? ;-)