Initial work removing PCRE from dist. Documentation needs to be updated. Related...

[users/heiko/exim.git] / doc / doc-docbook / Tidytxt

diff --git a/doc/doc-docbook/Tidytxt b/doc/doc-docbook/Tidytxt
index 02bf9dbd4cee59575f4810f9bcdf6fb11206074e..bdec3d73f638e7fa86cccad88ac05bad38f85ae6 100755 (executable)
--- a/doc/doc-docbook/Tidytxt
+++ b/doc/doc-docbook/Tidytxt
@@ -1,21 +1,76 @@
 #! /usr/bin/perl
 
 #! /usr/bin/perl
 

-# $Cambridge: exim/doc/doc-docbook/Tidytxt,v 1.1 2005/06/16 10:32:31 ph10 Exp $
+# $Cambridge: exim/doc/doc-docbook/Tidytxt,v 1.3 2007/08/29 13:37:28 ph10 Exp $

 
 

-# Script to tidy up the output of w3m when it makes a text file. We convert
-# sequences of blank lines into a single blank line.
+# Script to tidy up the output of w3m when it makes a text file. First we
+# convert sequences of blank lines into a single blank line, to get everything
+# uniform. Then we go through and insert blank lines before chapter and
+# sections, also converting chapter titles to uppercase.

 
 

-$blanks = 0;
-while (<>)
+# We also have to do some character translation in the first pass. It seems
+# that xmlto now generates Unicode in its HTML pages. This gives three problems:
+# (1) It inserts the byte sequence C2 A0 (U+00A0) as a fixed-width space;
+# (2) It inserts a whole slew of "box drawing" characters round the heading.
+# (3) It uses U+25CF as its bullet character.
+
+@lines = <>;
+
+$lastwasblank = 0;
+foreach $line (@lines)

   {
   {

-  if (/^\s*$/)
+  $line =~ s/\x{c2}\x{a0}/ /g;
+  $line =~ s/\x{e2}\x{94}[\x{80}-\x{bf}]/-/g;
+  $line =~ s/\x{e2}\x{97}\x{8f}/*/g;
+
+  if ($line =~ /^\s*$/)

     {
     {

-    $blanks++;
+    $line = "" if $lastwasblank;
+    $lastwasblank = 1;

     next;
     }
     next;
     }

-  print "\n" if $blanks > 0;
-  $blanks = 0;
-  print;
+  $lastwasblank = 0;
+  }
+
+# Find start of TOC, uppercasing its title
+
+for ($i = 0; $i < scalar @lines; $i++)
+  {
+  $lines[$i] = "TABLE OF CONTENTS\n" if $lines[$i] =~ /^Table of Contents/;
+  last if $lines[$i] =~ /^1\. /;
+  }
+
+# Find start of first chapter
+
+for ($i++; $i < scalar @lines; $i++)
+  { last if $lines[$i] =~ /^1\. /; }
+
+# Process the body. We can detect the starts of chapters and sections by
+# looking for preceding and following blank lines, and then matching against
+# the numbers.
+
+$chapter = 0;
+for (; $i < scalar @lines; $i++)
+  {
+  next if $lines[$i-1] !~ /^$/ || $lines[$i+1] !~ /^$/;
+
+  # Start of chapter
+
+  if ($lines[$i] =~ /^(\d+)\. / && $1 == $chapter + 1)
+    {
+    $chapter++;
+    $section = 0;
+    $lines[$i] = "\n\n" . ("=" x 79) . "\n" . uc($lines[$i]);
+    }
+
+  # Start of next section
+
+  elsif ($lines[$i] =~ /^(\d+)\.(\d+) / && $1 == $chapter && $2 == $section + 1)
+    {
+    $section++;
+    $lines[$i] = "\n$lines[$i]" . "-" x (length($lines[$i]) - 1) . "\n";
+    }

   }
 
   }
 

+print @lines;
+

 # End
 # End