fr/kitchen/assemble-all-pages

   1 #!/bin/bash
   2
   3 ## assemble-all-pages -- generate a set of HTML pages with variable parts
   4 #                        for emailselfdefense.fsf.org
   5
   6 ## Synopsis:             assemble-all-pages
   7
   8 ## Overview
   9
  10 # Each page is built from a template and one or several includes, as usual;
  11 # in addition, several versions of a page can be built from a single
  12 # template which contains all the variable parts, by deleting irrelevant
  13 # text.
  14
  15 # The templates have inclusion markers (similar to SSI directives, except
  16 # for the lack of "#") to indicate where the constant parts are to be
  17 # inserted, and deletion markers to identify the borders of each deletion
  18 # and indicate which page(s) the text between those borders belongs to.
  19
  20 # The script processes all the templates in the working directory and the
  21 # pages are created in the parent directory.
  22
  23 # Ideally, any modifications should be done to the templates or includes,
  24 # not to the final pages.
  25
  26 # Templates:  confirmation.t.html
  27 #             index.t.html  (contains variable parts for mac and windows)
  28 #             infographic.t.html
  29 #             next_steps.t.html
  30
  31 # Includes:   footer.html
  32 #             head.html  (contains 2 alternate sets of keywords)
  33 #             javascript.html
  34 #             translist.html
  35
  36 ## Graphic-user-interface howto
  37
  38 # - Place the script in the same directory as the templates.
  39 # - Display this directory in the file browser (do not just unfold the parent
  40 #   directory) and double-click on the script.
  41
  42 # And if anything goes wrong, you can do a git reset, right?    ;-)
  43
  44 # ===========================================================================
  45
  46 set -e
  47
  48 close_term () {
  49   printf '\n%s' '*** Close the terminal window or press Return.'; read OK
  50   test -z "$OK" && exit $1
  51 }
  52
  53 # Create temporary files.
  54 names=$(mktemp -t aap.XXXXXX)  || close_or_exit 1
  55 list=$(mktemp -t aap.XXXXXX)   || close_or_exit 1
  56 before=$(mktemp -t aap.XXXXXX) || close_or_exit 1
  57 after=$(mktemp -t aap.XXXXXX)  || close_or_exit 1
  58 trap 'rm -f "$names" "$list" "$before" "$after"' EXIT
  59
  60 # List all the templates in the working directory.
  61 if ls *.t.html > $names  2>/dev/null; then
  62   sed -i 's,\.t\.html$,,' $names
  63 else
  64   echo "*** There is no template in this directory." && close_term 1
  65 fi
  66
  67 ## Add the includes to the templates.
  68
  69 while read name; do
  70   # Make sure there is a blank line before the first include, otherwise
  71   # it will not be added properly.
  72   sed '1i\\n' $name.t.html > ../$name.html
  73   # List the includes.
  74   grep '^<!-- include virtual="' ../$name.html |
  75   sed 's%^.*include virtual="\([^"]\+\).*$%\1%' > $list
  76   # Add the includes.
  77   while read include; do
  78     sed "1,/^<!-- include virtual=\"$include\"/!d" ../$name.html > $before
  79     sed "1,/^<!-- include virtual=\"$include\"/d" ../$name.html > $after
  80     if [ -f "$include" ]; then
  81       cat $before $include $after > ../$name.html
  82     else
  83       echo "$include is missing." && exit 1
  84     fi
  85     sed -i "/^<!-- include virtual=\"$include\"/d" ../$name.html
  86   done < $list
  87 done < $names
  88
  89 ## Create mac.html and windows.html from index.html.
  90
  91 cp ../index.html ../mac.html
  92 cp ../index.html ../windows.html
  93 # add them to the list of page names.
  94 echo 'mac' >> $names
  95 echo 'windows' >> $names
  96
  97 ## Remove the irrelevant parts.
  98
  99 while read name ; do
 100   # Find out which deletions apply.
 101   grep '^<!-- START DELETION' ../$name.html \
 102   | grep -v "$name" \
 103   | sed 's%^<!-- START DELETION \([0-9][0-9]\),.*$%\1%' > $list
 104   echo $name
 105   # Make the deletions.
 106   while read deletion; do
 107     sed -i "/^<!-- START DELETION $deletion/, \
 108     /^<!-- END DELETION $deletion/d" ../$name.html
 109   done < $list
 110   # Delete the markers and any extra blank lines at the end of the page.
 111   sed -i '/^<!-- [A-Z]* DELETION/d' ../$name.html
 112   sed -i ':a /^\n*$/ {$d; N; ba}' ../$name.html
 113 done < $names
 114
 115 close_term 0