| 1 |
#!/bin/bash |
| 2 |
#this script converts the langref.tex source for the Language Reference Guide into |
| 3 |
#DocBook XML. the conversion is done thru latexml, a utility that comes with dblatex-0.2.7. |
| 4 |
#the output xml file of latexml is pretty dirty, so this script is needed to further clean it up. |
| 5 |
|
| 6 |
#copy latex file to here |
| 7 |
cp ../langref.tex . |
| 8 |
|
| 9 |
#convert it to raw xml |
| 10 |
latexml langref.tex --dest=Language_Reference_Guide.xml |
| 11 |
|
| 12 |
#remove excess whitespace |
| 13 |
sed -i -e 's/^\s*//g' Language_Reference_Guide.xml |
| 14 |
|
| 15 |
sed -i -e 's/<!--\ %\*\*\*\* langref.tex Line [0-9]* \*\*\*\* -->//g' Language_Reference_Guide.xml |
| 16 |
|
| 17 |
cat Language_Reference_Guide.xml | |
| 18 |
perl -p -e 'undef $/;s|<!-- %SystemTap Language Reference -->\n<\?latexml options="twoside,english" class="article"\?>\n<\?latexml package="geometry"\?>\n<\?latexml RelaxNGSchema="LaTeXML"\?>\n<\?latexml RelaxNGSchema="LaTeXML"\?>\n<document xmlns="http://dlmf.nist.gov/LaTeXML">\n<title>SystemTap Language Reference</title>|<\!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ |
| 19 |
]>\n<book>\n<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />|msg' | |
| 20 |
perl -p -e 'undef $/;s|<para xml:id="p1a">\n<p>This document was derived from other documents contributed to the SystemTap project by employees of Red Hat, IBM and Intel.</p>\n</para>\n<para xml:id="p2">\n<p>Copyright © 2007 Red Hat Inc.\nCopyright © 2007 IBM Corp.\nCopyright © 2007 Intel Corporation.</p>\n</para>\n<para xml:id="p3">\n<p>Permission is granted to copy, distribute and/or modify this document\nunder the terms of the GNU Free Documentation License, Version 1.2\nor any later version published by the Free Software Foundation;\nwith no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.</p>\n</para>\n<para xml:id="p4">\n<p>The GNU Free Documentation License is available from\n<ref class="url" href="http://www.gnu.org/licenses/fdl.html"><text font="typewriter">http://www.gnu.org/licenses/fdl.html</text></ref> or by writing to\nthe Free Software Foundation, Inc., 51 Franklin Street,\nFifth Floor, Boston, MA 02110-1301, USA.</p>\n</para>||msg' | |
| 21 |
#fix up screens |
| 22 |
perl -p -e 'undef $/;s|<itemize>\n<item>\n<verbatim font="typewriter">|<screen>|msg' | |
| 23 |
perl -p -e 'undef $/;s|<itemize>\n<item>\n\n<verbatim font="typewriter">|<screen>|msg' | |
| 24 |
perl -p -e 'undef $/;s|</verbatim>\n</item>\n</itemize>|</screen>|msg' | |
| 25 |
perl -p -e 'undef $/;s|</verbatim>\n\n</item>\n</itemize>|</screen>|msg' | |
| 26 |
#fix up index tags |
| 27 |
perl -p -e 'undef $/;s|<index xml:id="idx">\n<title>Index</title>\n</index>|<index/>|msg' | |
| 28 |
#needed later, for TABLES! |
| 29 |
perl -p -e 'undef $/;s|</text>\n</td>|</entry>|msg' > clean.xml |
| 30 |
|
| 31 |
#further fix up headers! |
| 32 |
perl -p -i -e 's|<\?latexml searchpaths="[^>]*>\n||g' clean.xml |
| 33 |
|
| 34 |
|
| 35 |
#change main tags |
| 36 |
sed -i -e 's/<\/document>/<\/book>/g' clean.xml |
| 37 |
|
| 38 |
#more fixup for screen tags |
| 39 |
perl -p -i -e 's|<verbatim font="[^"]*">|<screen>|g' clean.xml |
| 40 |
perl -p -i -e 's|</verbatim>|</screen>|g' clean.xml |
| 41 |
|
| 42 |
#clean section tags |
| 43 |
sed -i -e 's/<section refnum="[0-9]*"/<section/g' clean.xml |
| 44 |
sed -i -e 's/<section xml:id="[0-9S]*"/<section/g' clean.xml |
| 45 |
sed -i -e 's/<section labels="LABEL:sec:/<section id="/g' clean.xml |
| 46 |
|
| 47 |
#clean subsection tags |
| 48 |
sed -i -e 's/<subsection refnum="[0-9]*.[0-9]*"/<subsection/g' clean.xml |
| 49 |
sed -i -e 's/<subsection xml:id="[S.0-9]*"/<subsection/g' clean.xml |
| 50 |
sed -i -e 's/<subsection labels="LABEL:sub:/<subsection id="/g' clean.xml |
| 51 |
|
| 52 |
#clean subsubsection tags |
| 53 |
sed -i -e 's/<subsubsection refnum="[S.0-9]*"/<subsubsection/g' clean.xml |
| 54 |
sed -i -e 's/<subsubsection xml:id="[S.0-9]*"/<subsubsection/g' clean.xml |
| 55 |
sed -i -e 's/<subsubsection labels="LABEL:sub:/<subsubsection id="/g' clean.xml |
| 56 |
|
| 57 |
#change section tags to chapter, yay |
| 58 |
sed -i -e 's/<section/<chapter/g' clean.xml |
| 59 |
sed -i -e 's/<\/section>/<\/chapter>/g' clean.xml |
| 60 |
|
| 61 |
#change subsection and subsubsection tags to section |
| 62 |
sed -i -e 's/<subsection/<section/g' clean.xml |
| 63 |
sed -i -e 's/<\/subsection>/<\/section>/g' clean.xml |
| 64 |
sed -i -e 's/<subsubsection/<section/g' clean.xml |
| 65 |
sed -i -e 's/<\/subsubsection>/<\/section>/g' clean.xml |
| 66 |
|
| 67 |
#remove <para, then replace <p> with <para> |
| 68 |
sed -i -e 's/<para xml:id="[pS.0-9]*"/<para/g' clean.xml |
| 69 |
sed -i -e 's/<para>//g' clean.xml |
| 70 |
sed -i -e 's/<\/para>//g' clean.xml |
| 71 |
sed -i -e 's/<p>/<para>/g' clean.xml |
| 72 |
sed -i -e 's/<\/p>/<\/para>/g' clean.xml |
| 73 |
|
| 74 |
#properly convert xrefs |
| 75 |
sed -i -e 's/<ref labelref="LABEL:sub:/<xref linkend="/g' clean.xml |
| 76 |
sed -i -e 's/<ref labelref="LABEL:sec:/<xref linkend="/g' clean.xml |
| 77 |
|
| 78 |
#convert indexterms |
| 79 |
sed -i -e 's/indexmark>/indexterm>/g' clean.xml |
| 80 |
perl -p -i -e 's/<indexphrase key="[^"]*">/<primary>/g' clean.xml |
| 81 |
sed -i -e 's/<indexphrase>/<primary>/g' clean.xml |
| 82 |
sed -i -e 's/<\/indexphrase>/<\/primary>/g' clean.xml |
| 83 |
|
| 84 |
#convert <emph>s |
| 85 |
sed -i -e 's/emph>/emphasis>/g' clean.xml |
| 86 |
|
| 87 |
#convert itemizedlists and listitems, dependent on successful exec of "fix up screens" perl routines |
| 88 |
sed -i -e 's/<itemize xml:id="[Ii,0-9]*">/<itemizedlist>/g' clean.xml |
| 89 |
sed -i -e 's/<item xml:id="[Ii.0-9]*">/<listitem>/g' clean.xml |
| 90 |
sed -i -e 's/<\/itemize>/<\/itemizedlist>/g' clean.xml |
| 91 |
sed -i -e 's/<\/item>/<\/listitem>/g' clean.xml |
| 92 |
|
| 93 |
#convert orderedlists and their respective listitems |
| 94 |
perl -p -i -e 's|<enumerate xml:id="[^"]*">|<orderedlist>|g' clean.xml |
| 95 |
perl -p -i -e 's|</enumerate>|</orderedlist>|g' clean.xml |
| 96 |
perl -p -i -e 's|<item refnum="[^"]*" xml:id="[^"]*">|<listitem>|g' clean.xml |
| 97 |
|
| 98 |
#TRICKY: this perl expression takes all occurences of |
| 99 |
# <ref class="url" href="http://sourceware.org/systemtap/wiki/HomePage"><text |
| 100 |
# font="typewriter">http://sourceware.org/systemtap/wiki/HomePage</text></ref> |
| 101 |
# and replaces the <text font=...</ref> string with "/>". from jfearn |
| 102 |
# note: [^"]* means "any number of occurences of characters that are NOT quotes |
| 103 |
# note: () groups strings/an expression together, which can be called later as $1 when replacing |
| 104 |
perl -p -i -e 's|(<ref class="url" href="[^"]*")><text font="typewriter">[^<]*</text></ref>|$1/>|g' clean.xml |
| 105 |
|
| 106 |
#now, convert <ref class="url" to <ulink>s |
| 107 |
sed -i -e 's/<ref class="url" href=/<ulink url=/g' clean.xml |
| 108 |
|
| 109 |
#TRICKY again: convert <text font=[var]> accordingly; bold is <computeroutput>, typewriter is <command> |
| 110 |
perl -p -i -e 's|(<text font="bold">[^<]*)</text>|$1</computeroutput>|g' clean.xml |
| 111 |
sed -i -e 's/<text font="bold">/<computeroutput>/g' clean.xml |
| 112 |
perl -p -i -e 's|(<text font="typewriter">[^<]*)</text>|$1</command>|g' clean.xml |
| 113 |
sed -i -e 's/<text font="typewriter">/<command>/g' clean.xml |
| 114 |
|
| 115 |
#weird remainders, defaulting them to command |
| 116 |
perl -p -i -e 's|(<text font="typewriter bold">[^<]*)</text>|$1</command>|g' clean.xml |
| 117 |
sed -i -e 's/<text font="typewriter bold">/<command>/g' clean.xml |
| 118 |
perl -p -i -e 's|(<text font="smallcaps">[^<]*)</text>|$1</emphasis>|g' clean.xml |
| 119 |
sed -i -e 's/<text font="smallcaps">/<emphasis>/g' clean.xml |
| 120 |
|
| 121 |
#TABLES! |
| 122 |
#the first expression is quite dirty, since it assumes that all tables have 3 columns. dunno yet how to |
| 123 |
#automagicize this, since the orig XML doesn't have any attribute that specifies columns per table |
| 124 |
sed -i -e 's/<tabular>/<tgroup cols="3">/g' clean.xml |
| 125 |
sed -i -e 's/tabular>/tgroup>/g' clean.xml |
| 126 |
perl -p -i -e 's|<table placement="[^"]*" refnum="[^"]*" xml:id="([^"]*">)|<table id="$1|g' clean.xml |
| 127 |
sed -i -e 's/caption>/title>/g' clean.xml |
| 128 |
sed -i -e 's/tr>/row>/g' clean.xml |
| 129 |
perl -p -i -e 's|<td[^>]*>||g' clean.xml |
| 130 |
sed -i -e 's/<text>/<entry>/g' clean.xml |
| 131 |
|
| 132 |
#this is needed because some indexterms have been nested inside commands *sigh* |
| 133 |
perl -p -i -e 's|(<command>[^<]*<indexterm><primary>[^<]*</primary></indexterm>)</text>|$1</command>|g' clean.xml |
| 134 |
#this is needed because some closer tags for <text> are on new lines; is a dirty hack since we simply |
| 135 |
#assume that all of them are </command> |
| 136 |
sed -i -e 's/<\/text>/<\/command>/g' clean.xml |
| 137 |
|
| 138 |
#clean up error tags |
| 139 |
perl -p -i -e 's|<ERROR [^/]*/ERROR>|<!-- ERROR TAG REMOVED -->|g' clean.xml |
| 140 |
#clean up "Math" tags (like, wtf) |
| 141 |
perl -p -i -e 's|<Math [^>]*><XMath><XMApp>|<command>|g' clean.xml |
| 142 |
perl -p -i -e 's|<XMTok [^>]*>||g' clean.xml |
| 143 |
perl -p -i -e 's|</XMTok>||g' clean.xml |
| 144 |
perl -p -i -e 's|</XMApp>||g' clean.xml |
| 145 |
perl -p -i -e 's|</XMath>||g' clean.xml |
| 146 |
perl -p -i -e 's|</Math>|</command>|g' clean.xml |
| 147 |
|
| 148 |
#remove "About this guide" section |
| 149 |
#perl -p -i -e 'undef $/;s|<section>\n<title>About this guide</title>||msg' clean.xml |
| 150 |
|
| 151 |
#finalize: copy clean.xml to en-US, then deletes it |
| 152 |
cp clean.xml en-US/Language_Reference_Guide.xml |
| 153 |
|
| 154 |
#delete excess files |
| 155 |
rm langref.tex |
| 156 |
rm clean.xml |
| 157 |
rm Language_Reference_Guide.xml |