Documentation Source Text

Check-in [6f74e2171b]
Login

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Update the comment on the output_list proc. Use the output_list proc from capi3ref.in to process session.in.
Timelines: family | ancestors | descendants | both | mobile-friendly
Files: files | file ages | folders
SHA1: 6f74e2171b8f1870aa532b42989bf8afe0f52b6a
User & Date: drh 2016-09-01 00:54:41
Context
2016-09-01
01:30
Modify the output of the "search" script so that it works better on mobile screens. check-in: a4e77179b1 user: drh tags: mobile-friendly
00:54
Update the comment on the output_list proc. Use the output_list proc from capi3ref.in to process session.in. check-in: 6f74e2171b user: drh tags: mobile-friendly
00:48
Reformat the core and aggregate function descriptions in a way that works better on mobile. Use the "output_list" proc for the lists of pragma and aggregate and core functions. check-in: fc4a66aa03 user: drh tags: mobile-friendly
Changes
Hide Diffs Side-by-Side Diffs Ignore Whitespace Patch

Changes to pages/capi3ref.in.

   253    253     }
   254    254     hd_putsnl "\];"
   255    255   }
   256    256   
   257    257   # Output HTML/JS that displays the list $lx in multiple columns
   258    258   # under the assumption that each column is $w pixels wide.
   259    259   #
   260         -# $lx is a list of triples.  Each triple is {KEYWORD LABEL S} where
   261         -# S is an integer between 0 and 2.  1 means add the "(exp)" suffix
   262         -# and 2 means strike-through.  0 is a no-op.
          260  +# $lx is a list of triples.  Each triple is {KEYWORD LABEL S}.  The
          261  +# S determines a suffix added to each list element:
          262  +#
          263  +#    0:     Add nothing (the default and common case)
          264  +#    1:     Add the "(exp)" suffix
          265  +#    2:     Strike through the text and do not hyperlink
          266  +#    3:     Strike through the text and add &sup1
          267  +#    4:     Add &sup2
          268  +#    5:     Add &sup3
          269  +#
          270  +# This routine is used to generate lists in other modules as well:
          271  +# lang.in, pragma.in, session.in.
   263    272   #
   264    273   proc output_list {title w lx} {
   265    274     global listcount hd
   266    275     if {![info exists listcount]} {
   267    276       set listcount 1
   268    277     } else {
   269    278       incr listcount

Changes to pages/session.in.

   188    188   proc convert_keyword_to_filename {oldname} {
   189    189     set oldname [string tolower $oldname]
   190    190     regsub {^sqlite_} $oldname {c_} oldname
   191    191     regsub {^sqlite3_} $oldname {} name
   192    192     return $name.html
   193    193   }
   194    194   
   195         -# Output HTML that displays the list $lx in $N columns
   196         -#
   197         -proc output_list {N lx} {
   198         -  hd_putsnl {<table width="100%" cellpadding="5"><tr>}
   199         -  set len [llength $lx]
   200         -  set n [expr {($len + $N - 1)/$N}]
   201         -  for {set i 0} {$i<$N} {incr i} {
   202         -    set start [expr {$i*$n}]
   203         -    set end [expr {($i+1)*$n}]
   204         -    hd_puts {<td valign="top"><ul>}
   205         -    for {set j $start} {$j<$end} {incr j} {
   206         -      set entry [lindex $lx $j]
   207         -      if {$entry!=""} {
   208         -        foreach {link label s} $entry break
   209         -        if {$s==1} {
   210         -          hd_resolve "<li>\[$link|$label\]&nbsp;&nbsp;"
   211         -          hd_resolve "\[experimental | <small><i>(exp)</i></small>\]</li>"
   212         -        } elseif {$s==2} {
   213         -          hd_resolve "<li>\[$link|$label\]&nbsp;&nbsp;"
   214         -          hd_resolve "\[deprecated | <small><i>(obs)</i></small>\]</li>"
   215         -        } else {
   216         -          hd_resolve "<li>\[$link|$label\]</li>"
   217         -        }
   218         -        hd_puts \n
   219         -      }
   220         -    }
   221         -    hd_putsnl {</ul></td>}
   222         -  }
   223         -  hd_putsnl {</tr></table>}
   224         -}
   225    195   
   226    196   hd_open_aux session/intro.html
   227    197   hd_header Introduction
   228    198   hd_enable_main 0
   229    199   hd_keywords *session-capi {Session Extension C-language Interface}
   230    200   </tcl>
   231    201   
................................................................................
   315    285   hd_header {List Of SQLite Objects}
   316    286   hd_enable_main 0
   317    287   hd_putsnl {<a href="intro.html"><h2>Session Module C Interface</h2></a>}
   318    288   hd_enable_main 1
   319    289   </tcl>
   320    290   <h2>Objects:</h2>
   321    291   <tcl>
   322         -output_list 3 [lsort $objlist]
          292  +output_list {} 300 [lsort $objlist]
   323    293   hd_enable_main 0
   324    294   hd_putsnl {<p>Other lists:
   325    295   <a href="constlist.html">Constants</a> and
   326    296   <a href="funclist.html">Functions</a>.}
   327    297   hd_close_aux
   328    298   hd_enable_main 1
   329    299   hd_putsnl {<hr>}
................................................................................
   348    318   hd_enable_main 0
   349    319   hd_putsnl {<a href="intro.html"><h2>Session Module C Interface</h2></a>}
   350    320   hd_enable_main 1
   351    321   </tcl>
   352    322   <h2>Constants:</h2>
   353    323   <tcl>
   354    324   set clist [lsort -index 1 $clist]
   355         -output_list 2 $clist
          325  +output_list {} 400 $clist
   356    326   hd_enable_main 0
   357    327   hd_putsnl {<p>Other lists:
   358    328   <a href="objlist.html">Objects</a> and
   359    329   <a href="funclist.html">Functions</a>.</p>}
   360    330   hd_enable_main 1
   361    331   hd_close_aux
   362    332   hd_putsnl {<hr>}
................................................................................
   383    353   hd_enable_main 0
   384    354   hd_putsnl {<a href="intro.html"><h2>Session Module C Interface</h2></a>}
   385    355   hd_enable_main 1
   386    356   </tcl>
   387    357   <h2>Functions:</h2>
   388    358   <tcl>
   389    359   set funclist [lsort -index 1 $funclist]
   390         -output_list 3 $funclist
          360  +output_list {} 300 $funclist
   391    361   hd_enable_main 0
   392    362   hd_putsnl {<p>Other lists:
   393    363   <a href="constlist.html">Constants</a> and
   394    364   <a href="objlist.html">Objects</a>.</p>}
   395    365   hd_enable_main 1
   396    366   hd_close_aux
   397    367   hd_putsnl {<hr>}