From: Thérèse Godefroy <godef.th@free.fr>
Date: Thu, 17 Jul 2014 20:23:39 +0000 (+0200)
Subject: fr: rewrite the script explanations.
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=d39837fa5ac336bd575ec3ac231786f75255fecb;p=enc.git

fr: rewrite the script explanations.
---

diff --git a/fr/kitchen/assemble-all-pages b/fr/kitchen/assemble-all-pages
index a3728d5e..0b1dc43a 100755
--- a/fr/kitchen/assemble-all-pages
+++ b/fr/kitchen/assemble-all-pages
@@ -1,17 +1,25 @@
 #!/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: generates a set of HTML pages with 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 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.
+# 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.
 
-# All the ingredients are is in [...]/enc/[lang]/kitchen/:
+# 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. 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
 
@@ -25,10 +33,10 @@
 #             javascript.html
 #             translist.html
 
-# To regenerate the pages in [...]/enc/[lang]/:
-# - in the terminal, cd to [...]/enc/[lang]/kitchen/ and enter:
+# To generate 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
+# - alternatively, display the kitchen/ directory in the file browser
 #   (not the parent directory) and double-click on the script.
 
 # And if anything goes wrong, you can do a git reset, right?    ;-)