doc/doc-docbook/Tidytxt

   1 #! /usr/bin/perl
   2
   3 # $Cambridge: exim/doc/doc-docbook/Tidytxt,v 1.3 2007/08/29 13:37:28 ph10 Exp $
   4
   5 # Script to tidy up the output of w3m when it makes a text file. First we
   6 # convert sequences of blank lines into a single blank line, to get everything
   7 # uniform. Then we go through and insert blank lines before chapter and
   8 # sections, also converting chapter titles to uppercase.
   9
  10 # We also have to do some character translation in the first pass. It seems
  11 # that xmlto now generates Unicode in its HTML pages. This gives three problems:
  12 # (1) It inserts the byte sequence C2 A0 (U+00A0) as a fixed-width space;
  13 # (2) It inserts a whole slew of "box drawing" characters round the heading.
  14 # (3) It uses U+25CF as its bullet character.
  15
  16 @lines = <>;
  17
  18 $lastwasblank = 0;
  19 foreach $line (@lines)
  20   {
  21   $line =~ s/\x{c2}\x{a0}/ /g;
  22   $line =~ s/\x{e2}\x{94}[\x{80}-\x{bf}]/-/g;
  23   $line =~ s/\x{e2}\x{97}\x{8f}/*/g;
  24
  25   if ($line =~ /^\s*$/)
  26     {
  27     $line = "" if $lastwasblank;
  28     $lastwasblank = 1;
  29     next;
  30     }
  31   $lastwasblank = 0;
  32   }
  33
  34 # Find start of TOC, uppercasing its title
  35
  36 for ($i = 0; $i < scalar @lines; $i++)
  37   {
  38   $lines[$i] = "TABLE OF CONTENTS\n" if $lines[$i] =~ /^Table of Contents/;
  39   last if $lines[$i] =~ /^1\. /;
  40   }
  41
  42 # Find start of first chapter
  43
  44 for ($i++; $i < scalar @lines; $i++)
  45   { last if $lines[$i] =~ /^1\. /; }
  46
  47 # Process the body. We can detect the starts of chapters and sections by
  48 # looking for preceding and following blank lines, and then matching against
  49 # the numbers.
  50
  51 $chapter = 0;
  52 for (; $i < scalar @lines; $i++)
  53   {
  54   next if $lines[$i-1] !~ /^$/ || $lines[$i+1] !~ /^$/;
  55
  56   # Start of chapter
  57
  58   if ($lines[$i] =~ /^(\d+)\. / && $1 == $chapter + 1)
  59     {
  60     $chapter++;
  61     $section = 0;
  62     $lines[$i] = "\n\n" . ("=" x 79) . "\n" . uc($lines[$i]);
  63     }
  64
  65   # Start of next section
  66
  67   elsif ($lines[$i] =~ /^(\d+)\.(\d+) / && $1 == $chapter && $2 == $section + 1)
  68     {
  69     $section++;
  70     $lines[$i] = "\n$lines[$i]" . "-" x (length($lines[$i]) - 1) . "\n";
  71     }
  72   }
  73
  74 print @lines;
  75
  76 # End