Documentation Source Text

Artifact [24ea78a20f]

Artifact 24ea78a20f01744bfb82c90919d72073fe60aa20:

# This script processes raw page text into its final form for display.
# Invoke this command as follows:
#       tclsh wrap.tcl $(DOC) $(SRC) $(DEST) ...
# The $(DOC) and $(SRC) values are the names of directories containing
# the documentation source and program source.  $(DEST) is the name of
# of the directory where generated HTML is written. is the
# input file to be processed.  The output is sourceN.html in the
# local directory.
# Changes made to the source files:
#     *  An appropriate header is prepended to the file.  
#     *  Any <title>...</title> in the input is moved into the prepended
#        header.
#     *  An appropriate footer is appended.
#     *  Scripts within <tcl>...</tcl> are evaluated.  Output that
#        is emitted from these scripts by "puts" appears in place of
#        the original script.

source [file join [file dirname [info script]] sitemap.tcl]

set DOC [lindex $argv 0]
set SRC [lindex $argv 1]
set DEST [lindex $argv 2]
set HOMEDIR [pwd]            ;# Also remember our home directory.

# We are going to overload the puts command, so remember the
# original puts command using an alternative name.
rename puts real_puts
proc puts {text} {
  real_puts $::OUT $text
  flush $::OUT
# putsin4 is like puts except that it removes the first 4 indentation
# characters from each line.  It also does variable substitution in
# the namespace of its calling procedure.
proc putsin4 {text} {
  regsub -all "\n    " $text \n text
  real_puts $::OUT [uplevel 1 [list subst -noback -nocom $text]]
  flush $::OUT

# A procedure to write the common header found on every HTML file on
# the SQLite website.
proc PutsHeader {title {path {}}} {
  puts {<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "">}
  puts {<html><head>}
  puts "<title>$title</title>"
  putsin4 {<style type="text/css">
    body {
        margin: auto;
        font-family: "Verdana" "sans-serif";
        line-height: 1.5em;
        padding: 8px 1%;
    a { color: #45735f }
    a:visited { color: #734559 }
    .logo { position:absolute; margin:3px; }
    .tagline {
    .toolbar {
      text-align: center;
      line-height: 1.6em;
      margin: 0;
      padding:1px 8px;
    .toolbar a { color: white; text-decoration: none; padding: 2px 12px 6px; }
    .toolbar a:visited { color: white; }
    .toolbar a:hover { 
       color: #80a796; background: white; text-decoration: underline
    .toolbar a:active { color: blue }
    .content    { margin: 5%; }
    .content dt { font-weight:bold; }
    .content dd { margin-bottom: 25px; margin-left:20%; }
    .content ul { padding:0px; padding-left: 15px; margin:0px; }
    /* rounded corners */
    .se  { background: url(${path}images/se.png) 100% 100% no-repeat #80a796}
    .sw  { background: url(${path}images/sw.png) 0% 100% no-repeat }
    .ne  { background: url(${path}images/ne.png) 100% 0% no-repeat }
    .nw  { background: url(${path}images/nw.png) 0% 0% no-repeat }

    /* CSS for drop down menus */
    .menu {
    .pulldown {
      font-size: 0.8em;
      line-height: 1.0;
      display: none;
      position: absolute;
      z-index: 1;
      border: 2px solid #80a796;
      background: #80a796;
      text-align: left;

      border-left-color: #607d71;
      border-right-color: #607d71;
      border-bottom-color: #607d71;

    .pulldown a { display: block; white-space: nowrap; }
    .toolbar table, .toolbar tbody, .toolbar tr, .toolbar td { 
      padding: 0; border-spacing: 0
    .rel {position: relative}

    .over .pulldown, .menu:hover .pulldown { display: block; }
    .over .pulldown, .menu:hover .pulldown { display: block; }

    .advertisement {
      font-style: italic;
      color: #80a796;
      color: #607d71;
      color: #45735f;
    .advertisement a {
      color: black;

    <meta http-equiv="content-type" content="text/html; charset=UTF-8">

    <script type="text/javascript">

      var current_menu_id = null
      var current_timeout = null

      function menu_mouseover () {
        this.className += " over"
        current_menu_id =
      function menu_mouseout () {
        current_timeout = window.setTimeout('menu_mouseout_delayed()', 500)
      function menu_mouseout_delayed (id) {
        var elem = document.getElementById(current_menu_id)
        if (elem) {
          elem.className = elem.className.replace(" over", "")
        if (current_timeout) {
        current_menu_id = null
        current_timeout = null

      window.onload = function() {
        var collection = document.getElementsByTagName("div")
        var ii
        for (ii = 0; ii < collection.length; ii++) {
          var span = collection.item(ii)
          if (span.className == "menu") {
            span.onmouseover = menu_mouseover
            span.onmouseout  = menu_mouseout
    = "menu" + ii
  puts {</head>}
  putsin4 {<body>
    <div><!-- container div to satisfy validator -->
    <a href="${path}index.html">
    <img class="logo" src="${path}images/SQLite.gif" alt="SQLite Logo"
    <div><!-- IE hack to prevent disappearing logo--></div>
    <div class="tagline">Small, Fast, Reliable.<br>Choose any three.</div>
    <table width=100% style="clear:both"><tr><td>
      <div class="se"><div class="sw"><div class="ne"><div class="nw">
      <div class="toolbar">
        <table style="margin:auto"><tr><td>
  create_menubar $path
  putsin4 {

# A procedure to write the common footer found at the bottom of
# every HTML file.  $srcfile is the name of the file that is the
# source of the HTML content.  The modification time of this file
# is used to add the "last modified on" line at the bottom of the
# file.
proc PutsFooter {srcfile} {
  puts {<hr><small><i>}
  set mtime [file mtime $srcfile]
  set date [clock format $mtime -format {%Y/%m/%d %H:%M:%S UTC} -gmt 1]
  puts "This page last modified $date"
  puts {</i></small></div></body></html>}

# The following proc is used to ensure consistent formatting in the 
# HTML generated by lang.tcl and pragma.tcl.
proc Syntax {args} {
  puts {<table cellpadding="10" class=pdf_syntax>}
  foreach {rule body} $args {
    puts "<tr><td align=\"right\" valign=\"top\">"
    puts "<i><font color=\"#ff3434\">$rule</font></i>&nbsp;::=</td>"
    regsub -all < $body {%LT} body
    regsub -all > $body {%GT} body
    regsub -all %LT $body {</font></b><i><font color="#ff3434">} body
    regsub -all %GT $body {</font></i><b><font color="#2c2cf0">} body
    regsub -all {[]|[*?]} $body {</font></b>&<b><font color="#2c2cf0">} body
    regsub -all "\n" [string trim $body] "<br>\n" body
    regsub -all "\n  *" $body "\n\\&nbsp;\\&nbsp;\\&nbsp;\\&nbsp;" body
    regsub -all {[|,.*()]} $body {<big>&</big>} body
    regsub -all { = } $body { <big>=</big> } body
    regsub -all {STAR} $body {<big>*</big>} body
    ## These metacharacters must be handled to undo being
    ## treated as SQL punctuation characters above.
    regsub -all {RPPLUS} $body {</font></b>)+<b><font color="#2c2cf0">} body
    regsub -all {LP} $body {</font></b>(<b><font color="#2c2cf0">} body
    regsub -all {RP} $body {</font></b>)<b><font color="#2c2cf0">} body
    ## Place the left-hand side of the rule in the 2nd table column.
    puts "<td><b><font color=\"#2c2cf0\">$body</font></b></td></tr>"
  puts {</table>}

proc process_infile {in infile outfile} {
  set title {No Title}
  regexp {<title>([^\n]*)</title>} $in all title
  regsub {<title>[^\n]*</title>} $in {} in
  set ::OUT [open $::DEST/$outfile w]

  set path [string repeat ../ [expr {[llength [file split $outfile]]-1}]]
  PutsHeader $title $path

  regsub -all {<tcl>} $in "\175; eval \173" in
  regsub -all {</tcl>} $in "\175; puts \173" in
  uplevel #0 "puts \173$in\175"
  cd $::HOMEDIR
  PutsFooter $infile
  close $::OUT

# Loop over all input files and process them one by one
foreach infile [lrange $argv 3 end] {
  real_puts "Processing $infile"
  set fd [open $infile r]
  set in [read $fd]
  close $fd
  set outfile [file root [file tail $infile]].html
  process_infile $in $infile $outfile

process_infile [create_sitemap] [info script] sitemap.html