Generate ePub files of documentation.

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

diff --git a/doc/doc-docbook/Tidytxt b/doc/doc-docbook/Tidytxt
index 5e19c37f4e1370fac9f8f3e149d982ac5b2f31fc..d218189ea065d509b210104ace0f2f25649b26de 100755 (executable)
--- a/doc/doc-docbook/Tidytxt
+++ b/doc/doc-docbook/Tidytxt
@@ -1,17 +1,46 @@
 #! /usr/bin/perl
 
 #! /usr/bin/perl
 

-# $Cambridge: exim/doc/doc-docbook/Tidytxt,v 1.2 2006/02/01 11:01:01 ph10 Exp $
-

 # 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.
 
 # 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.
 

+# 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 uses U+25CF as its bullet character.
+# (3) It inserts a whole slew of "box drawing" characters round the heading.
+

 @lines = <>;
 
 $lastwasblank = 0;
 foreach $line (@lines)
   {
 @lines = <>;
 
 $lastwasblank = 0;
 foreach $line (@lines)
   {

+  # (1) non-break space -> normal space
+  $line =~ s/\x{c2}\x{a0}/ /g;
+  # (2) bullet -> asterisk
+  $line =~ s/\x{e2}\x{97}\x{8f}/*/g;
+  # (3a) horizontal box drawing -> hyphen
+  $line =~ s/\x{e2}\x{94}[\x{80}\x{81}\x{84}\x{85}\x{88}\x{89}]/-/g;
+  $line =~ s/\x{e2}\x{95}[\x{8c}\x{8d}\x{90}]/-/g;
+  $line =~ s/\x{e2}\x{95}[\x{b4}\x{b6}\x{b8}\x{ba}\x{bc}\x{be}]/-/g;
+  # (3b) vertical box drawing -> bar
+  $line =~ s/\x{e2}\x{94}[\x{82}\x{83}\x{86}\x{87}\x{8a}\x{8b}]/|/g;
+  $line =~ s/\x{e2}\x{95}[\x{8e}\x{8f}\x{91}]/|/g;
+  $line =~ s/\x{e2}\x{95}[\x{b5}\x{b7}\x{b9}\x{bb}\x{bd}\x{bf}]/|/g;
+  # (3c) corner box drawing -> plus
+  $line =~ s/\x{e2}\x{94}[\x{8c}-\x{bf}]/+/g;
+  $line =~ s/\x{e2}\x{95}[\x{80}-\x{8b}\x{92}-\x{b0}]/+/g;
+  # other
+  $line =~ s/\x{e2}\x{95}\x{b1}/\//g;
+  $line =~ s/\x{e2}\x{95}\x{b2}/\\/g;
+  $line =~ s/\x{e2}\x{95}\x{b3}/X/g;
+
+  # w3m rendering issue apparently only seen by pdp
+  # affects section numbers after the ToC, some info on spool-file -lines, etc
+  # always appears to be a spurious extra character, safely just dropped.
+  $line =~ s/\x{c2}//g;
+

   if ($line =~ /^\s*$/)
     {
     $line = "" if $lastwasblank;
   if ($line =~ /^\s*$/)
     {
     $line = "" if $lastwasblank;


@@ -26,13 +55,13 @@ foreach $line (@lines)
 for ($i = 0; $i < scalar @lines; $i++)
   {
   $lines[$i] = "TABLE OF CONTENTS\n" if $lines[$i] =~ /^Table of Contents/;
 for ($i = 0; $i < scalar @lines; $i++)
   {
   $lines[$i] = "TABLE OF CONTENTS\n" if $lines[$i] =~ /^Table of Contents/;

-  last if $lines[$i] =~ /^1. /;
+  last if $lines[$i] =~ /^1\. /;

   }
 
 # Find start of first chapter
 
 for ($i++; $i < scalar @lines; $i++)
   }
 
 # Find start of first chapter
 
 for ($i++; $i < scalar @lines; $i++)

-  { last if $lines[$i] =~ /^1. /; }
+  { 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
 
 # Process the body. We can detect the starts of chapters and sections by
 # looking for preceding and following blank lines, and then matching against