scripts/README-jon.txt

   1 This file describes how to use the scripts included in this archive.
   2 Yes, it desperately needs updating and expansion.
   3
   4 corrtohtml.pl: translates the standard Project Aon correction report
   5 format into HTML corresponding to the changes log used with the
   6 Editor's Companion.
   7
   8   corrtohtml.pl [correctionFile1 [correctionFile2 . . .]]
   9
  10 create-css.pl: used by gbtoxhtml.pl to create a CSS file for use by
  11 the XHTML files.
  12
  13   [not used from the command line]
  14
  15 create-css-xhtml-single.pl: used by gbtoxhtml-single.pl to create a
  16 CSS file for use by the single file version of the XHTML.
  17
  18   [not used from the command line]
  19
  20 create-pdacss.pl: used by gbtopdaxhtml.pl to create a CSS file for
  21 use by the PDA version of the XHTML.
  22
  23   [not used from the command line]
  24
  25 frontfilter.pl: filters frontmatter files for links and common
  26 characters.
  27
  28   frontfilter.pl frontmatterFile1 [frontmatterFile2 . . .]
  29
  30 gbfixencoding.pl: interactively fix encoding errors in gamebook XML
  31   (requires ANSI escape sequences - tested on CYGWIN)
  32
  33   gbfixencoding.pl inputXML outputXML
  34
  35 gbfixquotes.pl: interactively encode quotation marks
  36   (requires ANSI escape sequences - tested on CYGWIN)
  37
  38   gbfixquotes.pl inputXML outputXML
  39
  40 gblint.pl: find common errors in gamebook XML - does not validate XML
  41
  42   gblint.pl inputXML > errorList
  43     -s LINES         skip first LINES
  44     -e MAX_ERRORS
  45
  46 gbtodot.pl: converts an XML file to DOT graph representation of the
  47 choices.
  48
  49   gbtodot.pl inputXML outputDOT baseURL
  50
  51 gbtolatex.pl: creates a LaTeX file for conversion to PDF using
  52 pdflatex.
  53
  54   gbtolatex.pl bookCode
  55
  56 gbtopdaxhtml.pl: creates simplified XHTML for use by PDA utilities.
  57
  58   gbtopdaxhtml.pl bookCode
  59
  60 gbtopml.pl: creates PML version of the XML.
  61
  62   gbtopml.pl bookCode
  63
  64 gbtoxhtml.pl: processes an XML file into XHTML.
  65
  66   gbtoxhtml.pl bookCode
  67
  68 gbtoxhtml-all.pl: creates all of the books in XHTML. Uses
  69 gbtoxhtml.pl.
  70
  71   gbtoxhtml-all.pl
  72
  73 gbtoxhtml-single.pl: creates a single XHTML file.
  74
  75   gbtoxhtml-single.pl bookCode
  76
  77 mergecorrhtml.pl: merges correction log HTML into a preexisting file.
  78
  79   mergecorrhtml.pl [options] inputHTML [correctionFiles]
  80     -b    bookCode
  81     -u    include corrections with unspecified title
  82
  83 sortcorrhtml.pl: sorts correction log HTML into book order.
  84
  85   sortcorrhtml.pl [correctionFiles]
  86
  87 xmlize.pl: converts the proofread text format into a gamebook XML file.
  88
  89   xmlize.pl numberOfSections