Merge branch 'master' of ssh://git.exim.org/home/git/exim
[users/jgh/exim.git] / doc / doc-docbook / Tidytxt
1 #! /usr/bin/perl
2
3 # Script to tidy up the output of w3m when it makes a text file. First we
4 # convert sequences of blank lines into a single blank line, to get everything
5 # uniform. Then we go through and insert blank lines before chapter and
6 # sections, also converting chapter titles to uppercase.
7
8 # We also have to do some character translation in the first pass. It seems
9 # that xmlto now generates Unicode in its HTML pages. This gives three problems:
10 # (1) It inserts the byte sequence C2 A0 (U+00A0) as a fixed-width space;
11 # (2) It uses U+25CF as its bullet character.
12 # (3) It inserts a whole slew of "box drawing" characters round the heading.
13
14 @lines = <>;
15
16 $lastwasblank = 0;
17 foreach $line (@lines)
18   {
19   # (1) non-break space -> normal space
20   $line =~ s/\x{c2}\x{a0}/ /g;
21   # (2) bullet -> asterisk
22   $line =~ s/\x{e2}\x{97}\x{8f}/*/g;
23   # (3a) horizontal box drawing -> hyphen
24   $line =~ s/\x{e2}\x{94}[\x{80}\x{81}\x{84}\x{85}\x{88}\x{89}]/-/g;
25   $line =~ s/\x{e2}\x{95}[\x{8c}\x{8d}\x{90}]/-/g;
26   $line =~ s/\x{e2}\x{95}[\x{b4}\x{b6}\x{b8}\x{ba}\x{bc}\x{be}]/-/g;
27   # (3b) vertical box drawing -> bar
28   $line =~ s/\x{e2}\x{94}[\x{82}\x{83}\x{86}\x{87}\x{8a}\x{8b}]/|/g;
29   $line =~ s/\x{e2}\x{95}[\x{8e}\x{8f}\x{91}]/|/g;
30   $line =~ s/\x{e2}\x{95}[\x{b5}\x{b7}\x{b9}\x{bb}\x{bd}\x{bf}]/|/g;
31   # (3c) corner box drawing -> plus
32   $line =~ s/\x{e2}\x{94}[\x{8c}-\x{bf}]/+/g;
33   $line =~ s/\x{e2}\x{95}[\x{80}-\x{8b}\x{92}-\x{b0}]/+/g;
34   # other
35   $line =~ s/\x{e2}\x{95}\x{b1}/\//g;
36   $line =~ s/\x{e2}\x{95}\x{b2}/\\/g;
37   $line =~ s/\x{e2}\x{95}\x{b3}/X/g;
38
39   # w3m rendering issue apparently only seen by pdp
40   # affects section numbers after the ToC, some info on spool-file -lines, etc
41   # always appears to be a spurious extra character, safely just dropped.
42   $line =~ s/\x{c2}//g;
43
44   if ($line =~ /^\s*$/)
45     {
46     $line = "" if $lastwasblank;
47     $lastwasblank = 1;
48     next;
49     }
50   $lastwasblank = 0;
51   }
52
53 # Find start of TOC, uppercasing its title
54
55 for ($i = 0; $i < scalar @lines; $i++)
56   {
57   $lines[$i] = "TABLE OF CONTENTS\n" if $lines[$i] =~ /^Table of Contents/;
58   last if $lines[$i] =~ /^1\. /;
59   }
60
61 # Find start of first chapter
62
63 for ($i++; $i < scalar @lines; $i++)
64   { last if $lines[$i] =~ /^1\. /; }
65
66 # Process the body. We can detect the starts of chapters and sections by
67 # looking for preceding and following blank lines, and then matching against
68 # the numbers.
69
70 $chapter = 0;
71 for (; $i < scalar @lines; $i++)
72   {
73   next if $lines[$i-1] !~ /^$/ || $lines[$i+1] !~ /^$/;
74
75   # Start of chapter
76
77   if ($lines[$i] =~ /^(\d+)\. / && $1 == $chapter + 1)
78     {
79     $chapter++;
80     $section = 0;
81     $lines[$i] = "\n\n" . ("=" x 79) . "\n" . uc($lines[$i]);
82     }
83
84   # Start of next section
85
86   elsif ($lines[$i] =~ /^(\d+)\.(\d+) / && $1 == $chapter && $2 == $section + 1)
87     {
88     $section++;
89     $lines[$i] = "\n$lines[$i]" . "-" x (length($lines[$i]) - 1) . "\n";
90     }
91   }
92
93 print @lines;
94
95 # End