From 1ab1e75806e72125fbda0bcede39e609e2306d25 Mon Sep 17 00:00:00 2001 From: unknown Date: Fri, 15 Feb 2002 16:14:38 -0700 Subject: [PATCH] Patched conversion system to generate well-formed XML Docs/Support/docbook-fixup.pl: Series of minor changes to convert the output of makeinfo to well-formed XML - Discarded DTD - ORA can add their own appropriate DTD - Added required XML PI - included appropriate character encoding information - Added missing abstract and bookinfo tags - Escaped ampersands in HTML escape sequences to allow validation - need to review Docs/Support/make-docbook: Forced validation of XML document at end of conversion process Removed temporary files - set makeinfo output to stdout BitKeeper/etc/ignore: Added Docs/safe-mysql.xml to the ignore list BitKeeper/etc/logging_ok: Logging to logging@openlogging.org accepted --- .bzrignore | 1 + BitKeeper/etc/logging_ok | 1 + Docs/Support/docbook-fixup.pl | 34 +++++++++++++++++++++++++++++++++- Docs/Support/make-docbook | 9 +++++---- 4 files changed, 40 insertions(+), 5 deletions(-) diff --git a/.bzrignore b/.bzrignore index 6781375218d..319612b83c8 100644 --- a/.bzrignore +++ b/.bzrignore @@ -460,3 +460,4 @@ vio/test-sslserver vio/viotest-ssl Docs/mysql.xml mysql-test/r/rpl000001.eval +Docs/safe-mysql.xml diff --git a/BitKeeper/etc/logging_ok b/BitKeeper/etc/logging_ok index fc2cbd97a56..1667ffe7e9c 100644 --- a/BitKeeper/etc/logging_ok +++ b/BitKeeper/etc/logging_ok @@ -45,3 +45,4 @@ tonu@volk.internalnet tonu@x153.internalnet tonu@x3.internalnet venu@work.mysql.com +zak@linux.local diff --git a/Docs/Support/docbook-fixup.pl b/Docs/Support/docbook-fixup.pl index 1dde06a3074..03a2a29f1e8 100755 --- a/Docs/Support/docbook-fixup.pl +++ b/Docs/Support/docbook-fixup.pl @@ -1,4 +1,6 @@ -#!/usr/bin/perl +#!/usr/bin/perl -w +# 2002-02-15 zak@mysql.com +# Use -w to make perl print useful warnings about the script being run sub fix_underscore { $str = shift; @@ -13,9 +15,39 @@ sub strip_emph { return $str; }; +print STDERR "\n--Post-processing makeinfo output--\n"; +# 2002-02-15 zak@mysql.com +print STDERR "Discard DTD - ORA can add the appropriate DTD for their flavour of DocBook\n"; +; + +print STDERR "Slurp! In comes the rest of the file. :)\n"; $data = join "", ; +# 2002-02-15 zak@mysql.com +print STDERR "Add an XML processing instruction with the right character encoding\n"; +$data = "" . $data; + +# 2002-02-15 zak@mysql.com +# Less than optimal - should be fixed in makeinfo +print STDERR "Put in missing and \n"; +$data =~ s///gs; + +# 2002-02-15 zak@mysql.com +print STDERR "Convert existing ampersands to escape sequences \n"; +$data =~ s/&(?!\w+;)/&/gs; + +# 2002-02-15 zak@mysql.com +# Need to talk to Arjen about what the bits are for +print STDERR "Rework references of the notation ''\n"; +$data =~ s/<(\d)>/[$1]/gs; + +# 2002-02-15 zak@mysql.com +# We might need to encode the high-bit characters to ensure proper representation +# print STDERR "Converting high-bit characters to entities\n"; +# $data =~ s/([\200-\400])/&get_entity($1)>/gs; +# There is no get_entity function yet - no point writing it til we need it :) + print STDERR "Changing @@ to @...\n"; $data =~ s/@@/@/gs; diff --git a/Docs/Support/make-docbook b/Docs/Support/make-docbook index 2904eef4926..ec811030af1 100755 --- a/Docs/Support/make-docbook +++ b/Docs/Support/make-docbook @@ -13,7 +13,8 @@ sed -e 's;MYSQL_TCP_PORT_DEFAULT=;;' >> include.texi # produce DocBook XML - makeinfo --force --no-ifinfo --docbook manual.texi - mv mysql.xml mysql-tmp.xml - Support/docbook-fixup.pl mysql.xml - rm -f mysql-tmp.xml + makeinfo --force --no-ifinfo --docbook -o - manual.texi |\ + Support/docbook-fixup.pl > mysql.xml + + # See if the XML output is well-formed + xmlwf mysql.xml