"Fossies" - the Fresh Open Source Software Archive

Member "viewvc-1.2.1/docs/template-authoring-guide.html" (26 Mar 2020, 76018 Bytes) of package /linux/misc/viewvc-1.2.1.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) HTML source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 <html>
    2 <head>
    3 <title>ViewVC 1.2 Template Authoring Guide</title>
    4 <style>
    5 body {
    6   background-color: rgb(180,193,205);
    7   color: black;
    8   font-family: sans-serif;
    9 }
   10 table { margin-left: 1em; }
   11 td, th { padding: 0 0.5em; }
   12 th { 
   13   vertical-align: bottom; 
   14   background: rgb(60%,70%,90%);
   15 }
   16 td { 
   17   vertical-align: top; 
   18 }
   19 .h2, .h3 {
   20   padding: 0.5em 1em;
   21   border-color: black;
   22   border-style: solid;
   23   margin-bottom: 1em;
   24   background: white;
   25 }
   26 .h2 { border-width: 1px 2px 2px 1px; }
   27 .h3 { border-width: 1px 0 0 0; }
   28 .include { background: rgb(55%,80%,55%); font-style: italic; }
   29 .varlevel1 { background: rgb(65%,85%,65%); }
   30 .varlevel2 { background: rgb(70%,90%,70%); }
   31 .varlevel3 { background: rgb(75%,95%,75%); }
   32 .varlevel4 { background: rgb(80%,100%,80%); }
   33 .varlevel5 { background: rgb(85%,100%,85%); }
   34 .varname { font-family: monospace; }
   35 .varlevel1 .varname { padding-left: 0; }
   36 .varlevel2 .varname { padding-left: 2em; }
   37 .varlevel3 .varname { padding-left: 4em; }
   38 .varlevel4 .varname { padding-left: 6em; }
   39 .varlevel5 .varname { padding-left: 8em; }
   40 .toc-list { font-size: 90%; }
   41 </style>
   42 </head>
   43 <body>
   44 
   45 <h1>ViewVC 1.2 Template Authoring Guide</h1>
   46 
   47 <div class="h2">
   48 <h2 id="introduction">Introduction</h2>
   49 
   50 <p>This document represents an (unfinished) attempt at providing
   51    instructions for how to customize ViewVC's HTML output via
   52    modification of its templates.</p>
   53 
   54 </div>
   55 
   56 <div class="h2">
   57 <h2 id="toc">Table of Contents</h2>
   58 <ul class="toc-list">
   59   <li><a href="#introduction">Introduction</a></li>
   60   <li><a href="#ezt">Using EZT</a></li>
   61   <li><a href="#variables">Variables Available to ViewVC Templates</a></li>
   62   <ul class="toc-list">
   63     <li><a href="#variables-common">Common Template Variable Set (COMMON)</a></li>
   64     <li><a href="#variables-pathrev">Path Revision Form Variable Set (PATHREV)</a></li>
   65     <li><a href="#variables-paging">Paging Form Variable Set (PAGING)</a></li>
   66     <li><a href="#variables-properties">Property Listing Variable Set (PROPERTIES)</a></li>
   67     <li><a href="#variables-file">File Contents View (file.ezt)</a></li>
   68     <li><a href="#variables-graph">Revision Graph View (graph.ezt)</a></li>
   69     <li><a href="#variables-diff">File Difference View (diff.ezt)</a></li>
   70     <li><a href="#variables-directory">Directory Listing View (directory.ezt)</a></li>
   71     <li><a href="#variables-error">Error View (error.ezt)</a></li>
   72     <li><a href="#variables-log">Revision Log View (log.ezt)</a></li>
   73     <li><a href="#variables-query_results">Revision History Query Results View (query_results.ezt, rss.ezt)</a></li>
   74     <li><a href="#variables-query_form">Revision History Query Form View (query_form.ezt)</a></li>
   75     <li><a href="#variables-revision">Revision/ChangeSet View (revision.ezt)</a></li>
   76     <li><a href="#variables-roots">Root Listing View (roots.ezt)</a></li>
   77   </ul>
   78 </ul>
   79 </div>
   80 
   81 <div class="h2">
   82 <h2 id="ezt">Using EZT</h2>
   83 
   84 <p>### TODO ###</p>
   85 
   86 </div>
   87 
   88 <div class="h2">
   89 <h2 id="variables">Variables Available to ViewVC Templates</h2>
   90 
   91 <div class="h3">
   92 <h3 id="variables-common">Common Template Variable Set (COMMON)</h3>
   93 <table>
   94 <thead>
   95 <tr>
   96   <th>Variable</th>
   97   <th>Type</th>
   98   <th>Description</th>
   99 </tr>
  100 </thead>
  101 <tbody>
  102 <tr class="varlevel1">
  103   <td class="varname">annotate_href</td>
  104   <td>String</td>
  105   <td>URL of the ViewVC annotation view for the current resource.
  106       Valid only when <var>pathtype</var> is <tt>file</tt>.</td>
  107 </tr>
  108 <tr class="varlevel1">
  109   <td class="varname">cfg</td>
  110   <td>Object</td>
  111   <td>Representation of the object used by ViewVC for runtime
  112       configuration parameters such as those parsed from
  113       <tt>viewvc.conf</tt>.  Dot-qualified children of this object
  114       map to configuration sections and option keys.  For example,
  115       <var>cfg.options.show_logs</var> contains the value of the
  116       <var>show_logs</var> variable in the <var>options</var> section
  117       of the configuration file.</td>
  118 </tr>
  119 <tr class="varlevel1">
  120   <td class="varname">docroot</td>
  121   <td>String</td>
  122   <td>URL of the static documents directory, generally used for
  123       referencing stylesheets and images stored in and under that
  124       directory (which is typically relative to the template 
  125       location).</td>
  126 </tr>
  127 <tr class="varlevel1">
  128   <td class="varname">download_href</td>
  129   <td>String</td>
  130   <td>ViewVC file contents download URL for the current resource.
  131       Valid only when <var>pathtype</var> is <tt>file</tt>.</td>
  132 </tr>
  133 <tr class="varlevel1">
  134   <td class="varname">download_text_href</td>
  135   <td>String</td>
  136   <td>ViewVC file contents as-text download URL for the current resource.
  137       Valid only when <var>pathtype</var> is <tt>file</tt>.</td>
  138 </tr>
  139 <tr class="varlevel1">
  140   <td class="varname">graph_href</td>
  141   <td>String</td>
  142   <td>URL of the ViewVC revision graph view for the current resource.
  143       Valid only when <var>pathtype</var> is <tt>file</tt>.</td>
  144 </tr>
  145 <tr class="varlevel1">
  146   <td class="varname">home_href</td>
  147   <td>String</td>
  148   <td>URL of the root of ViewVC instance.  Depending on configuration,
  149       this could be a link to either the root directory of
  150       the <tt>default_root</tt> or to the roots listing.</td>
  151 </tr>
  152 <tr class="varlevel1">
  153   <td class="varname">kv</td>
  154   <td>Object</td>
  155   <td>Representation of the object used by ViewVC for user-defined
  156       key/value mappings.  Dot-qualified children of this object map
  157       to named key/value files and the sections and keys within
  158       them.  For example, <var>kv.l10n.labels.directory</var>
  159       maps to the value of the <var>directory</var> key under the
  160       <var>labels</var> section of the key/value file whose configured
  161       abstract name is <var>l10n</var>.</td>
  162 </tr>
  163 <tr class="varlevel1">
  164   <td class="varname">lockinfo</td>
  165   <td>String</td>
  166   <td>Information about the lock status of the current resource.</td>
  167 </tr>
  168 <tr class="varlevel1">
  169   <td class="varname">log_href</td>
  170   <td>String</td>
  171   <td>URL of the ViewVC revision log view for the current
  172       resource.  Valid only when <var>pathtype</var> is <tt>file</tt>
  173       or (for Subversion roots) <tt>dir</tt>.</td>
  174 </tr>
  175 <tr class="varlevel1">
  176   <td class="varname">nav_path</td>
  177   <td>List</td>
  178   <td>Ordered list of path components from the repository root to the
  179       current resource.</td>
  180 </tr>
  181 <tr class="varlevel2">
  182   <td class="varname">nav_path.href</td>
  183   <td>String</td>
  184   <td>URL of the default ViewVC view for the path component.</td>
  185 </tr>
  186 <tr class="varlevel2">
  187   <td class="varname">nav_path.name</td>
  188   <td>String</td>
  189   <td>Name of the path component.</td>
  190 </tr>
  191 <tr class="varlevel1">
  192   <td class="varname">pathtype</td>
  193   <td>String</td>
  194   <td>Path kind of the current resource.  Valid values: <tt>file</tt>
  195       (file), <tt>dir</tt> (directory); may be empty.</td>
  196 </tr>
  197 <tr class="varlevel1">
  198   <td class="varname">prefer_markup</td>
  199   <td>Boolean</td>
  200   <td>Indicates whether to make the default file link a link to the markup
  201       page instead of the checkout page.  Valid only when
  202       <var>pathtype</var> is <tt>file</tt>.</td>
  203 </tr>
  204 <tr class="varlevel1">
  205   <td class="varname">queryform_href</td>
  206   <td>String</td>
  207   <td>URL for a query form returning results from this directory.
  208       Valid only when <var>pathtype</var> is <tt>dir</tt>.</td>
  209 </tr>
  210 <tr class="varlevel1">
  211   <td class="varname">rev</td>
  212   <td>String</td>
  213   <td>Revision of the current resource.</td>
  214 </tr>
  215 <tr class="varlevel1">
  216   <td class="varname">revision_href</td>
  217   <td>String</td>
  218   <td>URL of the Subversion revision view for the current revision.</td>
  219 </tr>
  220 <tr class="varlevel1">
  221   <td class="varname">rootname</td>
  222   <td>String</td>
  223   <td>Name of the current repository (root).</td>
  224 </tr>
  225 <tr class="varlevel1">
  226   <td class="varname">roots_href</td>
  227   <td>String</td>
  228   <td>URL of ViewVC root listing view.  Valid only when ViewVC is
  229       configured in roots-as-url-components mode.</td>
  230 </tr>
  231 <tr class="varlevel1">
  232   <td class="varname">rootpath</td>
  233   <td>String</td>
  234   <td>Server-local location of the current repository.  WARNING: Revealing
  235       information to untrusted guests about the details of your server
  236       configuration can have negative security implications.  Use this
  237       token at your own risk.</td>
  238 </tr>
  239 <tr class="varlevel1">
  240   <td class="varname">roottype</td>
  241   <td>String</td>
  242   <td>Version control type of the current repository (root).
  243       Valid values: <tt>cvs</tt> (CVS), <tt>svn</tt> (Subversion).</td>
  244 </tr>
  245 <tr class="varlevel1">
  246   <td class="varname">rss_href</td>
  247   <td>String</td>
  248   <td>URL of RSS feed for current location.</td>
  249 </tr>
  250 <tr class="varlevel1">
  251   <td class="varname">tarball_href</td>
  252   <td>String</td>
  253   <td>URL to download tarball of the current directory.</td>
  254 </tr>
  255 <tr class="varlevel1">
  256   <td class="varname">up_href</td>
  257   <td>String</td>
  258   <td>Link to the current object's parent directory view.</td>
  259 </tr>
  260 <tr class="varlevel1">
  261   <td class="varname">username</td>
  262   <td>String</td>
  263   <td>Authenticated username of the requesting user.</td>
  264 </tr>
  265 <tr class="varlevel1">
  266   <td class="varname">view</td>
  267   <td>String</td>
  268   <td>Name of the current view.  Valid values: <tt>annotate</tt>
  269      (annotation view), <tt>diff</tt> (file difference view),
  270      <tt>roots</tt> (root listing view), <tt>dir</tt> (directory
  271      listing view), <tt>graph</tt> (revision graph view), <tt>log</tt>
  272      (revision log view), <tt>markup</tt> (file contents view),
  273      <tt>query</tt> (revision history query results view),
  274      <tt>queryform</tt> (revision history query form view),
  275      <tt>rev</tt> (revision/changeset view).</td>
  276 </tr>
  277 <tr class="varlevel1">
  278   <td class="varname">view_href</td>
  279   <td>String</td>
  280   <td>URL of the ViewVC file contents view for the current resource.
  281       Valid only when <var>pathtype</var> is <tt>file</tt> or 
  282       <tt>dir</tt>.</td>
  283 </tr>
  284 <tr class="varlevel1">
  285   <td class="varname">vsn</td>
  286   <td>String</td>
  287   <td>ViewVC version identifier.</td>
  288 </tr>
  289 <tr class="varlevel1">
  290   <td class="varname">where</td>
  291   <td>String</td>
  292   <td>Path (relative to the current repository root) of the current
  293       resource.</td>
  294 </tr>
  295 </tbody>
  296 </table>
  297 </div>
  298 
  299 <div class="h3">
  300 <h3 id="variables-pathrev">Path Revision Form Variable Set (PATHREV)</h3>
  301 <table>
  302 <thead>
  303 <tr>
  304   <th>Variable</th>
  305   <th>Type</th>
  306   <th>Description</th>
  307 </tr>
  308 </thead>
  309 <tbody>
  310 <tr class="varlevel1">
  311   <td class="varname">lastrev</td>
  312   <td>String</td>
  313   <td>If the current path is deleted in a future revision, last
  314       revision where the path is available. (Subversion only)</td>
  315 </tr>
  316 <tr class="varlevel1">
  317   <td class="varname">pathrev</td>
  318   <td>String</td>
  319   <td>Current sticky revision (Subversion) or sticky tag (CVS)</td>
  320 </tr>
  321 <tr class="varlevel1">
  322   <td class="varname">pathrev_action</td>
  323   <td>String</td>
  324   <td>Form action URL for the sticky revision/tag selection form.</td>
  325 </tr>
  326 <tr class="varlevel1">
  327   <td class="varname">pathrev_hidden_values</td>
  328   <td>List</td>
  329   <td>Hidden field name/value pairs for the revision/tag selection form.</td>
  330 </tr>
  331 <tr class="varlevel1">
  332   <td class="varname">pathrev_clear_action</td>
  333   <td>String</td>
  334   <td>Form action URL for the path revision clear button.</td>
  335 </tr>
  336 <tr class="varlevel1">
  337   <td class="varname">pathrev_clear_hidden_values</td>
  338   <td>List</td>
  339   <td>Hidden field name/value pairs for the path revision clear button.</td>
  340 </tr>
  341 </tbody>
  342 </table>
  343 </div>
  344 
  345 <div class="h3">
  346 <h3 id="variables-paging">Paging Form Variable Set (PAGING)</h3>
  347 <table>
  348 <thead>
  349 <tr>
  350   <th>Variable</th>
  351   <th>Type</th>
  352   <th>Description</th>
  353 </tr>
  354 </thead>
  355 <tbody>
  356 <tr class="varlevel1">
  357   <td class="varname">picklist</td>
  358   <td>List</td>
  359   <td>List of pages that make up the current directory or log view.</td>
  360 </tr>
  361 <tr class="varlevel2">
  362   <td class="varname">picklist.count</td>
  363   <td>String</td>
  364   <td>Number of the first item on the page (indexed from 0)</td>
  365 </tr>
  366 <tr class="varlevel2">
  367   <td class="varname">picklist.end</td>
  368   <td>String</td>
  369   <td>Name of last item on the page</td>
  370 </tr>
  371 <tr class="varlevel2">
  372   <td class="varname">picklist.more</td>
  373   <td>Boolean</td>
  374   <td>If set, indicates that this picklist item is a placeholder for
  375       an unspecified number of additional pages.  In this case,
  376       <code>picklist.end</code> is undefined.</td>
  377 </tr>
  378 <tr class="varlevel2">
  379   <td class="varname">picklist.page</td>
  380   <td>String</td>
  381   <td>Page number (indexed from 1)</td>
  382 </tr>
  383 <tr class="varlevel2">
  384   <td class="varname">picklist.start</td>
  385   <td>String</td>
  386   <td>Name of first item on the page</td>
  387 </tr>
  388 <tr class="varlevel1">
  389   <td class="varname">picklist_len</td>
  390   <td>String</td>
  391   <td>Number of pages in <var>picklist</var></td>
  392 </tr>
  393 </tbody>
  394 </table>
  395 </div>
  396 
  397 <div class="h3">
  398 <h3 id="variables-properties">Property Listing Variable Set (PROPERTIES)</h3>
  399 <table>
  400 <thead>
  401 <tr>
  402   <th>Variable</th>
  403   <th>Type</th>
  404   <th>Description</th>
  405 </tr>
  406 </thead>
  407 <tbody>
  408 <tr class="varlevel1">
  409   <td class="varname">properties</td>
  410   <td>List</td>
  411   <td>List of item properties set on the current directory, minus
  412       those with undisplayable names.</td>
  413 </tr>
  414 <tr class="varlevel2">
  415   <td class="varname">properties.name</td>
  416   <td>String</td>
  417   <td>Name of an item property.</td>
  418 </tr>
  419 <tr class="varlevel2">
  420   <td class="varname">properties.undisplayable</td>
  421   <td>Boolean</td>
  422   <td>Indicates whether or not the value of this property is
  423       undisplayable (by virtue of not being UTF-8 text).</td>
  424 </tr>
  425 <tr class="varlevel2">
  426   <td class="varname">properties.value</td>
  427   <td>String</td>
  428   <td>Value of this property.</td>
  429 </tr>
  430 </tbody>
  431 </table>
  432 </div>
  433 
  434 <div class="h3">
  435 <h3 id="variables-file">File Contents View (file.ezt)</h3>
  436 <table>
  437 <thead>
  438 <tr>
  439   <th>Variable</th>
  440   <th>Type</th>
  441   <th>Description</th>
  442 </tr>
  443 </thead>
  444 <tbody>
  445 <tr class="include">
  446   <td colspan="3">Includes all variables from the 
  447      <a href="#variables-common">COMMON</a> and
  448      <a href="#variables-properties">PROPERTIES</a> variable sets</td>
  449 </tr>
  450 <tr class="varlevel1">
  451   <td class="varname">ago</td>
  452   <td>String</td>
  453   <td>Text description of the time elapsed since <var>date</var>.</td>
  454 </tr>
  455 <tr class="varlevel1">
  456   <td class="varname">annotation</td>
  457   <td>String</td>
  458   <td>Valid values are "none" (no annotations were attempted),
  459       "annotated" (annotation was successful), "binary" (file contents
  460       are not line-based and human-readable), and "error" (something
  461       went wrong during annotation).</td>
  462 </tr>
  463 <tr class="varlevel1">
  464   <td class="varname">author</td>
  465   <td>String</td>
  466   <td>Author of the revision being viewed.</td>
  467 </tr>
  468 <tr class="varlevel1">
  469   <td class="varname">branch_points</td>
  470   <td>String</td>
  471   <td>List of branch tag names which branch off of the revision being
  472       viewed (CVS only).</td>
  473 </tr>
  474 <tr class="varlevel1">
  475   <td class="varname">branches</td>
  476   <td>List</td>
  477   <td>If revision currently being viewed is on a branch, list of names
  478       for the branch.</td>
  479 </tr>
  480 <tr class="varlevel1">
  481   <td class="varname">changed</td>
  482   <td>String</td>
  483   <td>Numbers of lines added and removed since the previous revision.</td>
  484 </tr>
  485 <tr class="varlevel1">
  486   <td class="varname">date</td>
  487   <td>String</td>
  488   <td>Date (in UTC if not otherwise configured) of the revision currently
  489       being viewed.</td>
  490 </tr>
  491 <tr class="varlevel1">
  492   <td class="varname">image_src_href</td>
  493   <td>String</td>
  494   <td>URL used to display the current revision of the file as an
  495       embedded image.  (Set only if the file is not a web-viewable
  496       image.)</td>
  497 </tr>
  498 <tr class="varlevel1">
  499   <td class="varname">lines</td>
  500   <td>List</td>
  501   <td>Set of objects containing information about the most recent
  502       modification of a single line of file content in the current
  503       resource, naturally ordered by the line numbers they represent.
  504       Every line in the resource is represented in the set.</td>
  505 </tr>
  506 <tr class="varlevel2">
  507   <td class="varname">lines.author</td>
  508   <td>String</td>
  509   <td>Username of the most recent modifier of the line.</td>
  510 </tr>
  511 <tr class="varlevel2">
  512   <td class="varname">lines.date</td>
  513   <td>String</td>
  514   <td>Date (in UTC if not otherwise configured) of the modification of
  515       the line.</td>
  516 </tr>
  517 <tr class="varlevel2">
  518   <td class="varname">lines.diff_href</td>
  519   <td>String</td>
  520   <td>URL of the ViewVC file difference view which displays the
  521       modification of the line.</td>
  522 </tr>
  523 <tr class="varlevel2">
  524   <td class="varname">lines.line_number</td>
  525   <td>String</td>
  526   <td>Line number (1-based) of the line.</td>
  527 </tr>
  528 <tr class="varlevel2">
  529   <td class="varname">lines.prev_rev</td>
  530   <td>String</td>
  531   <td>Youngest revision of the resource prior to the line's
  532       modification.</td>
  533 </tr>
  534 <tr class="varlevel2">
  535   <td class="varname">lines.rev</td>
  536   <td>String</td>
  537   <td>Revision in which the modification of the line occured.</td>
  538 </tr>
  539 <tr class="varlevel2">
  540   <td class="varname">lines.text</td>
  541   <td>String</td>
  542   <td>Textual contents of the line.</td>
  543 </tr>
  544 <tr class="varlevel1">
  545   <td class="varname">log</td>
  546   <td>String</td>
  547   <td>Log message of the revision currently being viewed.</td>
  548 </tr>
  549 <tr class="varlevel1">
  550   <td class="varname">mime_type</td>
  551   <td>String</td>
  552   <td>MIME type of the current file.</td>
  553 </tr>
  554 <tr class="varlevel1">
  555   <td class="varname">orig_path</td>
  556   <td>String</td>
  557   <td>When viewing an old file revision through a copy of the file,
  558       this is the old file revision's original path.</td>
  559 </tr>
  560 <tr class="varlevel1">
  561   <td class="varname">orig_href</td>
  562   <td>String</td>
  563   <td>URL of a ViewVC log view for <code>orig_path</code>.</td>
  564 </tr>
  565 <tr class="varlevel1">
  566   <td class="varname">prev</td>
  567   <td>String</td>
  568   <td>Previous revision number.</td>
  569 </tr>
  570 <tr class="varlevel1">
  571   <td class="varname">size</td>
  572   <td>String</td>
  573   <td>Size of the file revision, in bytes. Subversion only.</td>
  574 </tr>
  575 <tr class="varlevel1">
  576   <td class="varname">state</td>
  577   <td>String</td>
  578   <td>State of the file revision. Possible values: <tt>dead</tt>, and
  579       the empty string.</td>
  580 </tr>
  581 <tr class="varlevel1">
  582   <td class="varname">tags</td>
  583   <td>List</td>
  584   <td>Names of tags that have been applied to the current file
  585       revision.</td>
  586 </tr>
  587 <tr class="varlevel1">
  588   <td class="varname">vendor_branch</td>
  589   <td>Boolean</td>
  590   <td>Indicates whether or not the current file revision is on a vendor
  591       branch.</td>
  592 </tr>
  593 </tbody>
  594 </table>
  595 </div>
  596 
  597 <div class="h3">
  598 <h3 id="variables-graph">Revision Graph View (graph.ezt)</h3>
  599 <table>
  600 <thead>
  601 <tr>
  602   <th>Variable</th>
  603   <th>Type</th>
  604   <th>Description</th>
  605 </tr>
  606 </thead>
  607 <tbody>
  608 <tr class="include">
  609   <td colspan="3">Includes all variables from the 
  610      <a href="#variables-common">COMMON</a> variable set</td>
  611 </tr>
  612 <tr class="varlevel1">
  613   <td class="varname">gbbox</td>
  614   <td>Boolean</td>
  615   <td>Toggle generation of a branch box at the tip of all branches in
  616       the revision graph.</td>
  617 </tr>
  618 <tr class="varlevel1">
  619   <td class="varname">gflip</td>
  620   <td>Boolean</td>
  621   <td>Toggle the direction of the revision graph.</td>
  622 </tr>
  623 <tr class="varlevel1">
  624   <td class="varname">gleft</td>
  625   <td>Boolean</td>
  626   <td>Toggle the orientation of the revision graph.</td>
  627 </tr>
  628 <tr class="varlevel1">
  629   <td class="varname">gmaxtag</td>
  630   <td>String</td>
  631   <td>Number of tags per revision to display in the revision graph.</td>
  632 </tr>
  633 <tr class="varlevel1">
  634   <td class="varname">graph_action</td>
  635   <td>String</td>
  636   <td>Form action URL for the graph customization form.</td>
  637 </tr>
  638 <tr class="varlevel1">
  639   <td class="varname">graph_hidden_values</td>
  640   <td>String</td>
  641   <td>Hidden value name/value pairs for the graph customization form.</td>
  642 </tr>
  643 <tr class="varlevel1">
  644   <td class="varname">gshow</td>
  645   <td>String</td>
  646   <td>Classes of revisions to show in the revision graph.  Valid values
  647       are <tt>all</tt> (all revision), <tt>inittagged</tt> (initial
  648       revision(s) and tagged revisions), and <tt>tagged</tt> (tagged
  649       revisions only).</td>
  650 </tr>
  651 <tr class="varlevel1">
  652   <td class="varname">imagemap</td>
  653   <td>String</td>
  654   <td>HTML markup containing the image map associated with the
  655       revision graph.</td>
  656 </tr>
  657 <tr class="varlevel1">
  658   <td class="varname">imagesrc</td>
  659   <td>String</td>
  660   <td>URL of the ViewVC revision graph image for the current
  661       resource.</td>
  662 </tr>
  663 <tr class="varlevel1">
  664   <td class="varname">opt_gbbox</td>
  665   <td>Boolean</td>
  666   <td>Specifies whether the user is allowed to toggle the generation
  667       of branch boxes at the tip of all branches in the revision
  668       graph.</td>
  669 </tr>
  670 <tr class="varlevel1">
  671   <td class="varname">opt_gflip</td>
  672   <td>Boolean</td>
  673   <td>Specifies whether the user is allowed to toggle the direction
  674       of the revision graph.</td>
  675 </tr>
  676 <tr class="varlevel1">
  677   <td class="varname">opt_gleft</td>
  678   <td>Boolean</td>
  679   <td>Specifies whether the user is allowed to toggle the orientation
  680       of the revision graph.</td>
  681 </tr>
  682 <tr class="varlevel1">
  683   <td class="varname">opt_gmaxtag</td>
  684   <td>Boolean</td>
  685   <td>Specifies whether the user is allowed to configure the maximum
  686       number of tags per revision show in the revision graph.</td>
  687 </tr>
  688 <tr class="varlevel1">
  689   <td class="varname">opt_gshow</td>
  690   <td>Boolean</td>
  691   <td>Specifies whether the user is allowed to configure which
  692       classes of revisions are shown in the revision graph.</td>
  693 </tr>
  694 </tbody>
  695 </table>
  696 </div>
  697 
  698 <div class="h3">
  699 <h3 id="variables-diff">File Difference View (diff.ezt)</h3>
  700 <table>
  701 <thead>
  702 <tr>
  703   <th>Variable</th>
  704   <th>Type</th>
  705   <th>Description</th>
  706 </tr>
  707 </thead>
  708 <tbody>
  709 <tr class="include">
  710   <td colspan="3">Includes all variables from the 
  711      <a href="#variables-common">COMMON</a> variable set</td>
  712 </tr>
  713 <tr class="varlevel1">
  714   <td class="varname">diffs</td>
  715   <td>List</td>
  716   <td>List of all blocks of differences between the two sides, including content
  717       and property differences.</td>
  718 </tr>
  719 <tr class="varlevel2">
  720   <td class="varname">diffs.diff_block_format</td>
  721   <td>String</td>
  722   <td>Indicates the type of this block. One of the <tt>anchor</tt> (no display,
  723       create an anchor), <tt>raw</tt> (non-colored diff, display as produced),
  724       <tt>sidebyside-1</tt> (traditional side-by-side diff),
  725       <tt>sidebyside-2</tt> (newer side-by-side diff with intraline changes),
  726       <tt>unified</tt> (colored unified diff).</td>
  727 </tr>
  728 <tr class="varlevel2">
  729   <td class="varname">diffs.anchor</td>
  730   <td>String</td>
  731   <td>If <var>diffs.diff_block_format</var> is <tt>anchor</tt>, this variable specifies
  732       the anchor name.</td>
  733 </tr>
  734 <tr class="varlevel2">
  735   <td class="varname">diffs.changes</td>
  736   <td>List/Container</td>
  737   <td>Set of objects which contain information about a change in a single
  738       object (file or property). Not present if <var>diffs.diff_block_format</var> is
  739       <tt>anchor</tt>, otherwise has different format depending on
  740       <var>diffs.diff_block_format</var> (applicable as indicated in brackets below).</td>
  741 </tr>
  742 <tr class="varlevel3">
  743   <td class="varname">diffs.changes.raw</td>
  744   <td>String</td>
  745   <td>[raw] Diff text. Valid only if <var>diffs.changes.type</var> is
  746       <tt>raw</tt>.</td>
  747 </tr>
  748 <tr class="varlevel3">
  749   <td class="varname">diffs.changes.type</td>
  750   <td>String</td>
  751   <td>[raw] The type of change. Values: <tt>binary-diff</tt>,
  752       <tt>error</tt>, <tt>no-changes</tt>, <tt>raw</tt>.</td>
  753 </tr>
  754 <tr class="varlevel3">
  755   <td class="varname">diffs.changes.have_left</td>
  756   <td>Boolean</td>
  757   <td>[sidebyside-1] Specifies whether the left file has a line of content relevant
  758       to the difference data line.  Valid only when
  759       <var>changes.type</var> is <tt>change</tt>.</td>
  760 </tr>
  761 <tr class="varlevel3">
  762   <td class="varname">diffs.changes.have_right</td>
  763   <td>Boolean</td>
  764   <td>[sidebyside-1] Specifies whether the right file has a line of content relevant
  765       to the difference data line.  Valid only when
  766       <var>changes.type</var> is <tt>change</tt>.</td>
  767 </tr>
  768 <tr class="varlevel3">
  769   <td class="varname">diffs.changes.left</td>
  770   <td>String</td>
  771   <td>[sidebyside-1] Textual contents of the relevant line in the left file.  Valid
  772       only when <var>changes.type</var> is <tt>change</tt>,
  773       <tt>context</tt>, or <tt>remove</tt>.  When
  774       <var>changes.type</var> is <tt>change</tt>, valid only when
  775       <var>changes.have_left</var> is set (in order to delineate
  776       between missing lines and empty lines, which EZT does not
  777       support).</td>
  778 </tr>
  779 <tr class="varlevel3">
  780   <td class="varname">diffs.changes.right</td>
  781   <td>String</td>
  782   <td>[sidebyside-1] Textual contents of the relevant line in the right file.  Valid
  783       only when <var>changes.type</var> is <tt>add</tt>, <tt>change</tt>, 
  784       or <tt>context</tt>.  When
  785       <var>changes.type</var> is <tt>change</tt>, valid only when
  786       <var>changes.have_left</var> is set (in order to delineate
  787       between missing lines and empty lines, which EZT does not
  788       support).</td>
  789 </tr>
  790 <tr class="varlevel3">
  791   <td class="varname">diffs.changes.line_info_extra</td>
  792   <td>String</td>
  793   <td>[sidebyside-1] Additional line information for the current difference hunk.
  794       Valid only when <var>changes.type</var> is <tt>header</tt>.</td>
  795 </tr>
  796 <tr class="varlevel3">
  797   <td class="varname">diffs.changes.line_info_left</td>
  798   <td>String</td>
  799   <td>[sidebyside-1] First line number represented by the current hunk in the left
  800       file.  Valid only when <var>changes.type</var> is <tt>header</tt>.</td>
  801 </tr>
  802 <tr class="varlevel3">
  803   <td class="varname">diffs.changes.line_info_right</td>
  804   <td>String</td>
  805   <td>[sidebyside-1] First line number represented by the current hunk in the right
  806       file.  Valid only when <var>changes.type</var> is <tt>header</tt>.</td>
  807 </tr>
  808 <tr class="varlevel3">
  809   <td class="varname">diffs.changes.line_number</td>
  810   <td>String</td>
  811   <td>[sidebyside-1] Line number (1-based) of the line.</td>
  812 </tr>
  813 <tr class="varlevel3">
  814   <td class="varname">diffs.changes.type</td>
  815   <td>String</td>
  816   <td>[sidebyside-1] The type of change. Values: <tt>add</tt>, <tt>binary-diff</tt>,
  817       <tt>change</tt>, <tt>context</tt>, <tt>error</tt>, <tt>header</tt>,
  818       <tt>no-changes</tt>, <tt>remove</tt>.</td>
  819 </tr>
  820 <tr class="varlevel3">
  821   <td class="varname">diffs.changes.columns</td>
  822   <td>List</td>
  823   <td>[sidebyside-2] List of two columns for left and right parts of the diff.</td>
  824 </tr>
  825 <tr class="varlevel4">
  826   <td class="varname">diffs.changes.columns.line_number</td>
  827   <td>String</td>
  828   <td>[sidebyside-2] Line number in the left/right column.</td>
  829 </tr>
  830 <tr class="varlevel4">
  831   <td class="varname">diffs.changes.columns.segments</td>
  832   <td>List</td>
  833   <td>[sidebyside-2] Left/right line, broken into change segments.</td>
  834 </tr>
  835 <tr class="varlevel5">
  836   <td class="varname">diffs.changes.columns.segments.text</td>
  837   <td>String</td>
  838   <td>[sidebyside-2] Text of this segment.</td>
  839 </tr>
  840 <tr class="varlevel5">
  841   <td class="varname">diffs.changes.columns.segments.type</td>
  842   <td>String</td>
  843   <td>[sidebyside-2] Not set if the segment is the same in both left and right sides;
  844       otherwise, one of the <tt>add</tt>, <tt>remove</tt> or <tt>change</tt>.</td>
  845 </tr>
  846 <tr class="varlevel3">
  847   <td class="varname">diffs.changes.gap</td>
  848   <td>Boolean</td>
  849   <td>[sidebyside-2] If true, indicates that change blocks are non-contiguous
  850       and that the template should display some sort of ellipsis before the
  851       current block.</td>
  852 </tr>
  853 <tr class="varlevel3">
  854   <td class="varname">diffs.changes.type</td>
  855   <td>String</td>
  856   <td>[sidebyside-2] The type of change. Values: <tt>binary-diff</tt>,
  857       <tt>error</tt>, <tt>intraline</tt>, <tt>no-changes</tt>.</td>
  858 </tr>
  859 <tr class="varlevel3">
  860   <td class="varname">diffs.changes.segments</td>
  861   <td>List</td>
  862   <td>[unified] Left/right line, broken into change segments.</td>
  863 </tr>
  864 <tr class="varlevel4">
  865   <td class="varname">diffs.changes.segments.text</td>
  866   <td>String</td>
  867   <td>[unified] Text of this segment.</td>
  868 </tr>
  869 <tr class="varlevel4">
  870   <td class="varname">diffs.changes.segments.type</td>
  871   <td>String</td>
  872   <td>[unified] Not set if the segment is the same in both left and right sides;
  873       otherwise, one of the <tt>add</tt>, <tt>remove</tt> or <tt>change</tt>.</td>
  874 </tr>
  875 <tr class="varlevel3">
  876   <td class="varname">diffs.changes.type</td>
  877   <td>String</td>
  878   <td>[unified] The type of change. Values: <tt>add</tt>, <tt>binary-diff</tt>,
  879       <tt>error</tt>, <tt>no-changes</tt>, <tt>remove</tt> or empty string
  880       if the line was not changed (context line).</td>
  881 </tr>
  882 <tr class="varlevel2">
  883   <td class="varname">diffs.left</td>
  884   <td>Container</td>
  885   <td>Container object for grouping information about the left file.</td>
  886 </tr>
  887 <tr class="varlevel3">
  888   <td class="varname">diffs.left.ago</td>
  889   <td>String</td>
  890   <td>Text description of the time elapsed since <var>left.date</date>.</td>
  891 </tr>
  892 <tr class="varlevel3">
  893   <td class="varname">diffs.left.annotate_href</td>
  894   <td>String</td>
  895   <td>URL of the ViewVC annotation view for the left file.
  896       Valid only when <var>entries.pathtype</var> is <tt>file</tt>.</td>
  897 </tr>
  898 <tr class="varlevel3">
  899   <td class="varname">diffs.left.author</td>
  900   <td>String</td>
  901   <td>Author of the revision of the left file.</td>
  902 </tr>
  903 <tr class="varlevel3">
  904   <td class="varname">diffs.left.date</td>
  905   <td>String</td>
  906   <td>Date (in UTC if not otherwise configured) in which the left file
  907       revision was created.</td>
  908 </tr>
  909 <tr class="varlevel3">
  910   <td class="varname">diffs.left.download_href</td>
  911   <td>String</td>
  912   <td>URL to download the HEAD revision of the left file.</td>
  913 </tr>
  914 <tr class="varlevel3">
  915   <td class="varname">diffs.left.download_text_href</td>
  916   <td>String</td>
  917   <td>URL to download the HEAD revision of the left file as
  918       <tt>text/plain</tt>.</td>
  919 </tr>
  920 <tr class="varlevel3">
  921   <td class="varname">diffs.left.log</td>
  922   <td>String</td>
  923   <td>Log message of the left file revision.</td>
  924 </tr>
  925 <tr class="varlevel3">
  926   <td class="varname">diffs.left.path</td>
  927   <td>String</td>
  928   <td>Path of the left file.</td>
  929 </tr>
  930 <tr class="varlevel3">
  931   <td class="varname">diffs.left.prefer_markup</td>
  932   <td>Boolean</td>
  933   <td>Indicates whether to make the default file link a link to the markup
  934       page instead of the checkout page.</td>
  935 </tr>
  936 <tr class="varlevel3">
  937   <td class="varname">diffs.left.rev</td>
  938   <td>String</td>
  939   <td>Revision of the left file.</td>
  940 </tr>
  941 <tr class="varlevel3">
  942   <td class="varname">diffs.left.revision_href</td>
  943   <td>String</td>
  944   <td>URL of the Subversion revision view for the left file's
  945       current revision.  Valid only when <var>roottype</var> is
  946       <tt>svn</tt>.</td>
  947 </tr>
  948 <tr class="varlevel3">
  949   <td class="varname">diffs.left.size</td>
  950   <td>String</td>
  951   <td>Size of the left file revision, in bytes. Subversion only.</td>
  952 </tr>
  953 <tr class="varlevel3">
  954   <td class="varname">diffs.left.tag</td>
  955   <td>String</td>
  956   <td>Tag of the left file.</td>
  957 </tr>
  958 <tr class="varlevel3">
  959   <td class="varname">diffs.left.view_href</td>
  960   <td>String</td>
  961   <td>This is a URL for the markup view of the left file.</td>
  962 </tr>
  963 <tr class="varlevel2">
  964   <td class="varname">diffs.right</td>
  965   <td>Container</td>
  966   <td>Container object for grouping information about the right file.</td>
  967 </tr>
  968 <tr class="varlevel3">
  969   <td class="varname">diffs.right.ago</td>
  970   <td>String</td>
  971   <td>Text description of the time elapsed since <var>right.date</var>.</td>
  972 </tr>
  973 <tr class="varlevel3">
  974   <td class="varname">diffs.right.annotate_href</td>
  975   <td>String</td>
  976   <td>URL of the ViewVC annotation view for the right file.
  977       Valid only when <var>entries.pathtype</var> is <tt>file</tt>.</td>
  978 </tr>
  979 <tr class="varlevel3">
  980   <td class="varname">diffs.right.author</td>
  981   <td>String</td>
  982   <td>Author of the revision of the right file.</td>
  983 </tr>
  984 <tr class="varlevel3">
  985   <td class="varname">diffs.right.date</td>
  986   <td>String</td>
  987   <td>Date (in UTC if not otherwise configured) in which the right file
  988       revision was created.</td>
  989 </tr>
  990 <tr class="varlevel3">
  991   <td class="varname">diffs.right.download_href</td>
  992   <td>String</td>
  993   <td>URL to download the HEAD revision of the right file.</td>
  994 </tr>
  995 <tr class="varlevel3">
  996   <td class="varname">diffs.right.download_text_href</td>
  997   <td>String</td>
  998   <td>URL to download the HEAD revision of the right file as
  999       <tt>text/plain</tt>.</td>
 1000 </tr>
 1001 <tr class="varlevel3">
 1002   <td class="varname">diffs.right.log</td>
 1003   <td>String</td>
 1004   <td>Log message of the right file revision.</td>
 1005 </tr>
 1006 <tr class="varlevel3">
 1007   <td class="varname">diffs.right.path</td>
 1008   <td>String</td>
 1009   <td>Path of the right file.</td>
 1010 </tr>
 1011 <tr class="varlevel3">
 1012   <td class="varname">diffs.right.prefer_markup</td>
 1013   <td>Boolean</td>
 1014   <td>Indicates whether to make the default file link a link to the markup
 1015       page instead of the checkout page.</td>
 1016 </tr>
 1017 <tr class="varlevel3">
 1018   <td class="varname">diffs.right.rev</td>
 1019   <td>String</td>
 1020   <td>Revision of the right file.</td>
 1021 </tr>
 1022 <tr class="varlevel3">
 1023   <td class="varname">diffs.right.revision_href</td>
 1024   <td>String</td>
 1025   <td>URL of the Subversion revision view for the right file's
 1026       current revision.  Valid only when <var>roottype</var> is
 1027       <tt>svn</tt>.</td>
 1028 </tr>
 1029 <tr class="varlevel3">
 1030   <td class="varname">diffs.right.size</td>
 1031   <td>String</td>
 1032   <td>Size of the right file revision, in bytes. Subversion only.</td>
 1033 </tr>
 1034 <tr class="varlevel3">
 1035   <td class="varname">diffs.right.tag</td>
 1036   <td>String</td>
 1037   <td>Tag of the right file.</td>
 1038 </tr>
 1039 <tr class="varlevel3">
 1040   <td class="varname">diffs.right.view_href</td>
 1041   <td>String</td>
 1042   <td>This is a URL for the markup view of the right file.</td>
 1043 </tr>
 1044 <tr class="varlevel1">
 1045   <td class="varname">diff_format</td>
 1046   <td>String</td>
 1047   <td>Difference display format:  Valid values are <tt>c</tt>
 1048       (context), <tt>f</tt> (full human-readable),
 1049       <tt>h</tt> (human-readable, or colored), <tt>l</tt> (long
 1050       human-readable), <tt>s</tt> (side-by-side), <tt>u</tt>
 1051       (unified).</td>
 1052 </tr>
 1053 <tr class="varlevel1">
 1054   <td class="varname">diff_format_action</td>
 1055   <td>String</td>
 1056   <td>Form action URL for the diff format selection form.</td>
 1057 </tr>
 1058 <tr class="varlevel1">
 1059   <td class="varname">diff_format_hidden_values</td>
 1060   <td>List</td>
 1061   <td>Hidden field name/value pairs for the diff format selection form.</td>
 1062 </tr>
 1063 <tr class="varlevel1">
 1064   <td class="varname">hide_legend</td>
 1065   <td>Boolean</td>
 1066   <td>Indicates whether the display format requires displaying a legend</td>
 1067 </tr>
 1068 <tr class="varlevel1">
 1069   <td class="varname">patch_href</td>
 1070   <td>String</td>
 1071   <td>URL of the patch view for the file.</td>
 1072 </tr>
 1073 </tbody>
 1074 </table>
 1075 </div>
 1076 
 1077 <div class="h3">
 1078 <h3 id="variables-directory">Directory Listing View (directory.ezt)</h3>
 1079 <table>
 1080 <thead>
 1081 <tr>
 1082   <th>Variable</th>
 1083   <th>Type</th>
 1084   <th>Description</th>
 1085 </tr>
 1086 </thead>
 1087 <tbody>
 1088 <tr class="include">
 1089   <td colspan="3">Includes all variables from the 
 1090      <a href="#variables-common">COMMON</a>,
 1091      <a href="#variables-pathrev">PATHREV</a>,
 1092      <a href="#variables-paging">PAGING</a>, and
 1093      <a href="#variables-properties">PROPERTIES</a> variable sets</td>
 1094 </tr>
 1095 <tr class="varlevel1">
 1096   <td class="varname">attic_showing</td>
 1097   <td>Boolean</td>
 1098   <td>Indicates whether or not the directory list include "dead" files
 1099       (files not available in, perhaps deleted from, the current
 1100       tag).  CVS only.</td>
 1101 </tr>
 1102 <tr class="varlevel1">
 1103   <td class="varname">branch_tags</td>
 1104   <td>List</td>
 1105   <td>Set of branch tag names in use by files in the current directory.
 1106       CVS only.</td>
 1107 </tr>
 1108 <tr class="varlevel1">
 1109   <td class="varname">dir_pagestart</td>
 1110   <td>String</td>
 1111   <td>Item number (zero-based) of the first directory entry requested
 1112       to be shown on the page.  Corresponds to the
 1113       <var>dir_pagestart</var> CGI parameter.</td>
 1114 </tr>
 1115 <tr class="varlevel1">
 1116   <td class="varname">dir_paging_action</td>
 1117   <td>String</td>
 1118   <td>Form action URL for the page selection form.</td>
 1119 </tr>
 1120 <tr class="varlevel1">
 1121   <td class="varname">dir_paging_hidden_values</td>
 1122   <td>List</td>
 1123   <td>Hidden field name/value pairs for the page selection form.</td>
 1124 </tr>
 1125 <tr class="varlevel1">
 1126   <td class="varname">dirs_shown</td>
 1127   <td>String</td>
 1128   <td>Number of directories displayed.</td>
 1129 </tr>
 1130 <tr class="varlevel1">
 1131   <td class="varname">entries</td>
 1132   <td>List</td>
 1133   <td>Set of objects which represent the entries of this directory.</td>
 1134 </tr>
 1135 <tr class="varlevel2">
 1136   <td class="varname">entries.ago</td>
 1137   <td>String</td>
 1138   <td>Textual description of the time since <var>entries.date</var>.</td>
 1139 </tr>
 1140 <tr class="varlevel2">
 1141   <td class="varname">entries.annotate_href</td>
 1142   <td>String</td>
 1143   <td>URL of the ViewVC annotation view for the directory entry.
 1144       Valid only when <var>entries.pathtype</var> is <tt>file</tt>.</td>
 1145 </tr>
 1146 <tr class="varlevel2">
 1147   <td class="varname">entries.author</td>
 1148   <td>String</td>
 1149   <td>Username of the last modifier of the directory entry.</td>
 1150 </tr>
 1151 <tr class="varlevel2">
 1152   <td class="varname">entries.date</td>
 1153   <td>String</td>
 1154   <td>Date (in UTC if not otherwise configured) of the last
 1155       modification of the directory entry.</td>
 1156 </tr>
 1157 <tr class="varlevel2">
 1158   <td class="varname">entries.download_href</td>
 1159   <td>String</td>
 1160   <td>URL to download the HEAD revision of the directory entry.</td>
 1161 </tr>
 1162 <tr class="varlevel2">
 1163   <td class="varname">entries.download_text_href</td>
 1164   <td>String</td>
 1165   <td>URL to download the HEAD revision of the directory entry as
 1166       <tt>text/plain</tt>.</td>
 1167 </tr>
 1168 <tr class="varlevel2">
 1169   <td class="varname">entries.errors</td>
 1170   <td>List</td>
 1171   <td>List of strings containing error messages encountered by the
 1172       version control backend as it attempted to harvest information about
 1173       this directory entry.  At this time the strings are somewhat
 1174       freeform; in the future it would be nice to expose these as 
 1175       testable error code or somesuch.</td>
 1176 </tr>
 1177 <tr class="varlevel2">
 1178   <td class="varname">entries.graph_href</td>
 1179   <td>String</td>
 1180   <td>URL of the ViewVC revision graph view for the directory
 1181       entry.</td>
 1182 </tr>
 1183 <tr class="varlevel2">
 1184   <td class="varname">entries.is_binary</td>
 1185   <td>Boolean</td>
 1186   <td>Indicates whether the file's contents are not deemed to be
 1187       "human-readable".</td>
 1188 </tr>
 1189 <tr class="varlevel2">
 1190   <td class="varname">entries.is_viewable_image</td>
 1191   <td>Boolean</td>
 1192   <td>Indicates whether the file is a web-friendly image that can be
 1193       expected to display in-browser without additional plugins (JPEG,
 1194       GIF, or PNG).</td>
 1195 </tr>
 1196 <tr class="varlevel2">
 1197   <td class="varname">entries.lockinfo</td>
 1198   <td>String</td>
 1199   <td>Information about the lock status of the directory entry.</td>
 1200 </tr>
 1201 <tr class="varlevel2">
 1202   <td class="varname">entries.log</td>
 1203   <td>String</td>
 1204   <td>Log message of last modification to the directory entry.</td>
 1205 </tr>
 1206 <tr class="varlevel2">
 1207   <td class="varname">entries.log_file</td>
 1208   <td>String</td>
 1209   <td>ViewVC optionally calculates the log message of a CVS directory
 1210       as the log message associated with the most recently modified
 1211       file in that directory.  When that occurs, this is the name of
 1212       that file.  Valid only when <var>entries.pathtype</var> is
 1213       <tt>dir</tt>.  See also <var>entries.log_rev</var>.</td>
 1214 </tr>
 1215 <tr class="varlevel2">
 1216   <td class="varname">entries.log_href</td>
 1217   <td>String</td>
 1218   <td>URL of the ViewVC revision log view for the directory
 1219       entry.</td>
 1220 </tr>
 1221 <tr class="varlevel2">
 1222   <td class="varname">entries.log_rev</td>
 1223   <td>String</td>
 1224   <td>ViewVC optionally calculates the log message of a CVS directory
 1225       as the log message associated with the most recently modified
 1226       file in that directory.  When that occurs, this is the revision of
 1227       that file.  Valid only when <var>entries.pathtype</var> is
 1228       <tt>dir</tt>.  See also <var>entries.log_file</var>.</td>
 1229 </tr>
 1230 <tr class="varlevel2">
 1231   <td class="varname">entries.mime_type</td>
 1232   <td>String</td>
 1233   <td>MIME type of the directory entry.</td>
 1234 </tr>
 1235 <tr class="varlevel2">
 1236   <td class="varname">entries.name</td>
 1237   <td>String</td>
 1238   <td>Name of the directory entry.</td>
 1239 </tr>
 1240 <tr class="varlevel2">
 1241   <td class="varname">entries.pathtype</td>
 1242   <td>String</td>
 1243   <td>Path kind of the directory entry.  Valid values: <tt>file</tt>
 1244       (file), <tt>dir</tt> (directory); may be empty.</td>
 1245 </tr>
 1246 <tr class="varlevel2">
 1247   <td class="varname">entries.prefer_markup</td>
 1248   <td>Boolean</td>
 1249   <td>Indicates whether to make the default file link a link to the markup
 1250       page instead of the checkout page. Valid only when
 1251       <var>entries.pathtype</var> is <tt>file</tt>.</td>
 1252 </tr>
 1253 <tr class="varlevel2">
 1254   <td class="varname">entries.rev</td>
 1255   <td>String</td>
 1256   <td>Revision of the directory entry.  For CVS repositories, this is
 1257       a revision at the tip of the selected tag or branch; for
 1258       Subversion, this is the youngest revision as of the revision of
 1259       the directory being viewed.</td>
 1260 </tr>
 1261 <tr class="varlevel2">
 1262   <td class="varname">entries.revision_href</td>
 1263   <td>String</td>
 1264   <td>URL of the Subversion revision view for the directory entry's
 1265       current revision.  Valid only when <var>roottype</var> is
 1266       <tt>svn</tt>.</td>
 1267 </tr>
 1268 <tr class="varlevel2">
 1269   <td class="varname">entries.short_log</td>
 1270   <td>String</td>
 1271   <td>Log message of last modification to the directory entry,
 1272       truncated to contain no more than the number of characters
 1273       specified by the <code>short_log_len</code> configuration option.</td>
 1274 </tr>
 1275 <tr class="varlevel2">
 1276   <td class="varname">entries.size</td>
 1277   <td>String</td>
 1278   <td>Size (in bytes) of the directory entry.  Valid only when
 1279       <var>roottype</var> is <tt>svn</tt> and
 1280       <var>entries.pathtype</var> is <tt>file</tt>.</td>
 1281 </tr>
 1282 <tr class="varlevel2">
 1283   <td class="varname">entries.state</td>
 1284   <td>String</td>
 1285   <td>State of the directory entry.  If the state is uninteresting
 1286       (a typical, versioned object), this field is empty.  Valid,
 1287       non-empty states include:  <tt>dead</tt> (the object is not
 1288       available on, or possible removed from, this branch; CVS only).</td>
 1289 </tr>
 1290 <tr class="varlevel2">
 1291   <td class="varname">entries.view_href</td>
 1292   <td>String</td>
 1293   <td>This is a URL for the markup view if the entry is a file, and a
 1294       URL for a directory listing if the entry is a directory.</td>
 1295 </tr>
 1296 <tr class="varlevel1">
 1297   <td class="varname">files_shown</td>
 1298   <td>String</td>
 1299   <td>Number of files displayed.</td>
 1300 </tr>
 1301 <tr class="varlevel1">
 1302   <td class="varname">hide_attic_href</td>
 1303   <td>String</td>
 1304   <td>URL for the current view, but with "dead" files hidden.
 1305       CVS only.</td>
 1306 </tr>
 1307 <tr class="varlevel1">
 1308   <td class="varname">num_dead</td>
 1309   <td>String</td>
 1310   <td>Number of dead files in the current directory.</td>
 1311 </tr>
 1312 <tr class="varlevel1">
 1313   <td class="varname">plain_tags</td>
 1314   <td>List</td>
 1315   <td>List of tag names in use by files in the current directory.
 1316       CVS only.</td>
 1317 </tr>
 1318 <tr class="varlevel1">
 1319   <td class="varname">search_re</td>
 1320   <td>String</td>
 1321   <td>Current search expression, if any.</td>
 1322 </tr>
 1323 <tr class="varlevel1">
 1324   <td class="varname">search_re_action</td>
 1325   <td>String</td>
 1326   <td>Form action URL for the regular expression search form,
 1327       if searching is available.</td>
 1328 </tr>
 1329 <tr class="varlevel1">
 1330   <td class="varname">search_re_hidden_values</td>
 1331   <td>List</td>
 1332   <td>Hidden field name/value pairs for the regular expression search form.</td>
 1333 </tr>
 1334 <tr class="varlevel1">
 1335   <td class="varname">show_attic_href</td>
 1336   <td>String</td>
 1337   <td>URL for the current view, but with "dead" files shown.
 1338       CVS only.</td>
 1339 </tr>
 1340 <tr class="varlevel1">
 1341   <td class="varname">sortby</td>
 1342   <td>String</td>
 1343   <td>Current sorting mode. Valid values: <tt>file</tt>, <tt>rev</tt>,
 1344       <tt>date</tt>, <tt>author</tt>, and <tt>log</tt>.</td>
 1345 </tr>
 1346 <tr class="varlevel1">
 1347   <td class="varname">sortby_author_href</td>
 1348   <td>String</td>
 1349   <td>URL for the current view, but sorted by author.</td>
 1350 </tr>
 1351 <tr class="varlevel1">
 1352   <td class="varname">sortby_date_href</td>
 1353   <td>String</td>
 1354   <td>URL for the current view, but sorted by date.</td>
 1355 </tr>
 1356 <tr class="varlevel1">
 1357   <td class="varname">sortby_file_href</td>
 1358   <td>String</td>
 1359   <td>URL for the current view, but sorted by filename.</td>
 1360 </tr>
 1361 <tr class="varlevel1">
 1362   <td class="varname">sortby_log_href</td>
 1363   <td>String</td>
 1364   <td>URL for the current view, but sorted by log message.</td>
 1365 </tr>
 1366 <tr class="varlevel1">
 1367   <td class="varname">sortby_rev_href</td>
 1368   <td>String</td>
 1369   <td>URL for the current view, but sorted by revision number.</td>
 1370 </tr>
 1371 <tr class="varlevel1">
 1372   <td class="varname">sortdir</td>
 1373   <td>String</td>
 1374   <td>Current sorting mode. Valid values: <tt>up</tt> (ascending) and
 1375       <tt>down</tt> (descending)</td>
 1376 </tr>
 1377 <tr class="varlevel1">
 1378   <td class="varname">tree_rev</td>
 1379   <td>String</td>
 1380   <td>Last revision number where the current directory (or any path
 1381       underneath it) was modified. Subversion only.</td>
 1382 </tr>
 1383 <tr class="varlevel1">
 1384   <td class="varname">tree_rev_href</td>
 1385   <td>String</td>
 1386   <td>URL for revision view showing information about the 
 1387       <var>tree_rev</var> revision. Subversion only.</td>
 1388 </tr>
 1389 <tr class="varlevel1">
 1390   <td class="varname">youngest_rev</td>
 1391   <td>String</td>
 1392   <td>Last revision number in the repository. Subversion only</td>
 1393 </tr>
 1394 <tr class="varlevel1">
 1395   <td class="varname">youngest_rev_href</td>
 1396   <td>String</td>
 1397   <td>URL for revision view showing information about the
 1398       <var>youngest_rev</var> revision. Subversion only.</td>
 1399 </tr>
 1400 </tbody>
 1401 </table>
 1402 </div>
 1403 
 1404 <div class="h3">
 1405 <h3 id="variables-error">Error View (error.ezt)</h3>
 1406 <table>
 1407 <thead>
 1408 <tr>
 1409   <th>Variable</th>
 1410   <th>Type</th>
 1411   <th>Description</th>
 1412 </tr>
 1413 </thead>
 1414 <tbody>
 1415 <tr class="varlevel1">
 1416   <td class="varname">msg</td>
 1417   <td>String</td>
 1418   <td>Message describing the current error.</td>
 1419 </tr>
 1420 <tr class="varlevel1">
 1421   <td class="varname">stacktrace</td>
 1422   <td>String</td>
 1423   <td>Python stack trace showing where the error occurred.</td>
 1424 </tr>
 1425 <tr class="varlevel1">
 1426   <td class="varname">status</td>
 1427   <td>String</td>
 1428   <td>HTTP status code like "404 Not Found" that was sent to the
 1429       browser with this error message.</td>
 1430 </tr>
 1431 </tbody>
 1432 </table>
 1433 </div>
 1434 
 1435 <div class="h3">
 1436 <h3 id="variables-log">Revision Log View (log.ezt)</h3>
 1437 <table>
 1438 <thead>
 1439 <tr>
 1440   <th>Variable</th>
 1441   <th>Type</th>
 1442   <th>Description</th>
 1443 </tr>
 1444 </thead>
 1445 <tbody>
 1446 <tr class="include">
 1447   <td colspan="3">Includes all variables from the 
 1448      <a href="#variables-common">COMMON</a>,
 1449      <a href="#variables-pathrev">PATHREV</a>, and
 1450      <a href="#variables-paging">PAGING</a> variable sets</td>
 1451 </tr>
 1452 <tr class="varlevel1">
 1453   <td class="varname">branch_tags</td>
 1454   <td>List</td>
 1455   <td>Names of branch tags in the file. CVS only.</td>
 1456 </tr>
 1457 <tr class="varlevel1">
 1458   <td class="varname">default_branch</td>
 1459   <td>List</td>
 1460   <td>Default branch names (CVS only)</td>
 1461 </tr>
 1462 <tr class="varlevel1">
 1463   <td class="varname">diff_format</td>
 1464   <td>String</td>
 1465   <td>Currently selected diff format in the diff selection form. Valid
 1466       values are <tt>c</tt> (context), <tt>h</tt> (human-readable,
 1467       or colored), <tt>l</tt> (long human-readable), <tt>s</tt>
 1468       (side-by-side), <tt>u</tt> (unified).</td>
 1469 </tr>
 1470 <tr class="varlevel1">
 1471   <td class="varname">diff_select_action</td>
 1472   <td>String</td>
 1473   <td>Form action URL for the diff selection form.</td>
 1474 </tr>
 1475 <tr class="varlevel1">
 1476   <td class="varname">diff_select_hidden_values</td>
 1477   <td>List</td>
 1478   <td>Hidden field name/value pairs for the diff selection form.</td>
 1479 </tr>
 1480 <tr class="varlevel1">
 1481   <td class="varname">entries</td>
 1482   <td>List</td>
 1483   <td>List of revisions where the file or directory was modified.</td>
 1484 </tr>
 1485 <tr class="varlevel2">
 1486   <td class="varname">entries.ago</td>
 1487   <td>String</td>
 1488   <td>Text description of the time elapsed since
 1489       <var>entries.date</var>.</td>
 1490 </tr>
 1491 <tr class="varlevel2">
 1492   <td class="varname">entries.annotate_href</td>
 1493   <td>String</td>
 1494   <td>URL for the annotate view of the file revision.</td>
 1495 </tr>
 1496 <tr class="varlevel2">
 1497   <td class="varname">entries.author</td>
 1498   <td>String</td>
 1499   <td>Author of the revision.</td>
 1500 </tr>
 1501 <tr class="varlevel2">
 1502   <td class="varname">entries.branch_names</td>
 1503   <td>List</td>
 1504   <td>If this last revision on a branch, a list of names for that
 1505       branch.</td>
 1506 </tr>
 1507 <tr class="varlevel2">
 1508   <td class="varname">entries.branch_point</td>
 1509   <td>String</td>
 1510   <td>If the revision is on a branch, this is the revision number
 1511       the branch branched off from. CVS only.</td>
 1512 </tr>
 1513 <tr class="varlevel2">
 1514   <td class="varname">entries.branch_points</td>
 1515   <td>String</td>
 1516   <td>List of branch tags which branch off of this revision.
 1517       CVS only.</td>
 1518 </tr>
 1519 <tr class="varlevel3">
 1520   <td class="varname">entries.branch_points.name</td>
 1521   <td>String</td>
 1522   <td>Name of the branch tag.</td>
 1523 </tr>
 1524 <tr class="varlevel3">
 1525   <td class="varname">entries.branch_points.href</td>
 1526   <td>String</td>
 1527   <td>URL for the current view, but with this tag set as the sticky
 1528       tag.</td>
 1529 </tr>
 1530 <tr class="varlevel2">
 1531   <td class="varname">entries.branches</td>
 1532   <td>String</td>
 1533   <td>List of branch tags that include this file revision.
 1534       CVS only.</td>
 1535 </tr>
 1536 <tr class="varlevel3">
 1537   <td class="varname">entries.branches.name</td>
 1538   <td>String</td>
 1539   <td>Name of the branch tag.</td>
 1540 </tr>
 1541 <tr class="varlevel3">
 1542   <td class="varname">entries.branches.href</td>
 1543   <td>String</td>
 1544   <td>URL for the current view, but with this tag set as the sticky
 1545       tag.</td>
 1546 </tr>
 1547 <tr class="varlevel2">
 1548   <td class="varname">entries.changed</td>
 1549   <td>String</td>
 1550   <td>Numbers of lines added and removed since the previous revision.
 1551       CVS only.</td>
 1552 </tr>
 1553 <tr class="varlevel2">
 1554   <td class="varname">entries.copy_href</td>
 1555   <td>String</td>
 1556   <td>URL for log view of <var>entries.copy_path</var>.</td>
 1557 </tr>
 1558 <tr class="varlevel2">
 1559   <td class="varname">entries.copy_path</td>
 1560   <td>String</td>
 1561   <td>If the file revision was copied from somewhere, this is the path it
 1562       was copied from. Subversion only.</td>
 1563 </tr>
 1564 <tr class="varlevel2">
 1565   <td class="varname">entries.copy_rev</td>
 1566   <td>String</td>
 1567   <td>If the file revision was copied from somewhere, this is the revision
 1568       number of the path it was copied from. Subversion only.</td>
 1569 </tr>
 1570 <tr class="varlevel2">
 1571   <td class="varname">entries.date</td>
 1572   <td>String</td>
 1573   <td>Date (in UTC if not otherwise configured) of the revision.</td>
 1574 </tr>
 1575 <tr class="varlevel2">
 1576   <td class="varname">entries.diff_to_branch_href</td>
 1577   <td>String</td>
 1578   <td>URL for a diff view of this file revision showing the changes
 1579       since the branch was created at (<var>entries.branch_point</var>).
 1580       CVS only.</td>
 1581 </tr>
 1582 <tr class="varlevel2">
 1583   <td class="varname">entries.diff_to_main_href</td>
 1584   <td>String</td>
 1585   <td>If this revision is at the tip of a branch, URL for a diff view of
 1586       this file revision showing the differences between it and the latest
 1587       revision on the parent branch
 1588       (<var>entries.next_main</var>). CVS only.</td>
 1589 </tr>
 1590 <tr class="varlevel2">
 1591   <td class="varname">entries.diff_to_prev_href</td>
 1592   <td>String</td>
 1593   <td>URL for a diff view of this file revision showing the changes
 1594       since the previous revision (<var>entries.prev</var>).</td>
 1595 </tr>
 1596 <tr class="varlevel2">
 1597   <td class="varname">entries.diff_to_sel_href</td>
 1598   <td>String</td>
 1599   <td>URL for a diff view of this file revision and the currently
 1600       selected revision (<var>rev_selected</var>).</td>
 1601 </tr>
 1602 <tr class="varlevel2">
 1603   <td class="varname">entries.download_href</td>
 1604   <td>String</td>
 1605   <td>URL to download the file revision.</td>
 1606 </tr>
 1607 <tr class="varlevel2">
 1608   <td class="varname">entries.download_text_href</td>
 1609   <td>String</td>
 1610   <td>URL to download the file revision as <tt>text/plain</tt>.</td>
 1611 </tr>
 1612 <tr class="varlevel2">
 1613   <td class="varname">entries.lockinfo</td>
 1614   <td>String</td>
 1615   <td>Information about the lock status of this revision.</td>
 1616 </tr>
 1617 <tr class="varlevel2">
 1618   <td class="varname">entries.log</td>
 1619   <td>String</td>
 1620   <td>Revision log message.</td>
 1621 </tr>
 1622 <tr class="varlevel2">
 1623   <td class="varname">entries.next_main</td>
 1624   <td>String</td>
 1625   <td>If this revision is on the tip of the branch, this is the latest
 1626       revision of the parent branch, a likely merge candidate.</td>
 1627 </tr>
 1628 <tr class="varlevel2">
 1629   <td class="varname">entries.orig_href</td>
 1630   <td>String</td>
 1631   <td>URL for log view of <var>entries.orig_path</var></td>
 1632 </tr>
 1633 <tr class="varlevel2">
 1634   <td class="varname">entries.orig_path</td>
 1635   <td>String</td>
 1636   <td>If this file revision is located at a different path than the
 1637       newest file revision (because it precedes a copy or move), this
 1638       is the path it was originally located at. Subversion only.</td>
 1639 </tr>
 1640 <tr class="varlevel2">
 1641   <td class="varname">entries.prefer_markup</td>
 1642   <td>Boolean</td>
 1643   <td>Indicates whether to make the default file link a link to the markup
 1644       page instead of the checkout page.</td>
 1645 </tr>
 1646 <tr class="varlevel2">
 1647   <td class="varname">entries.prev</td>
 1648   <td>String</td>
 1649   <td>Previous revision number.</td>
 1650 </tr>
 1651 <tr class="varlevel2">
 1652   <td class="varname">entries.rev</td>
 1653   <td>String</td>
 1654   <td>Revision number.</td>
 1655 </tr>
 1656 <tr class="varlevel2">
 1657   <td class="varname">entries.revision_href</td>
 1658   <td>String</td>
 1659   <td>URL for revision view showing more information about the
 1660       revision.</td>
 1661 </tr>
 1662 <tr class="varlevel2">
 1663   <td class="varname">entries.sel_for_diff_href</td>
 1664   <td>String</td>
 1665   <td>URL for current view, but with this revision selected for
 1666       diffs.</td>
 1667 </tr>
 1668 <tr class="varlevel2">
 1669   <td class="varname">entries.size</td>
 1670   <td>String</td>
 1671   <td>Size of the file revision, in bytes. Subversion only.</td>
 1672 </tr>
 1673 <tr class="varlevel2">
 1674   <td class="varname">entries.state</td>
 1675   <td>String</td>
 1676   <td>State of the file revision. Possible values: <tt>dead</tt>, and
 1677       the empty string.</td>
 1678 </tr>
 1679 <tr class="varlevel2">
 1680   <td class="varname">entries.tag_names</td>
 1681   <td>List</td>
 1682   <td>List of tag names which refer to the revision.</td>
 1683 </tr>
 1684 <tr class="varlevel2">
 1685   <td class="varname">entries.tags</td>
 1686   <td>List</td>
 1687   <td>List of tags which refer to the revision</td>
 1688 </tr>
 1689 <tr class="varlevel3">
 1690   <td class="varname">entries.tags.name</td>
 1691   <td>String</td>
 1692   <td>Name of the tag.</td>
 1693 </tr>
 1694 <tr class="varlevel3">
 1695   <td class="varname">entries.tags.href</td>
 1696   <td>String</td>
 1697   <td>URL for the current page, but with this tag set as the sticky
 1698       tag.</td>
 1699 </tr>
 1700 <tr class="varlevel2">
 1701   <td class="varname">entries.vendor_branch</td>
 1702   <td>Boolean</td>
 1703   <td>Indicates if this revision is on a vendor branch.</td>
 1704 </tr>
 1705 <tr class="varlevel2">
 1706   <td class="varname">entries.view_href</td>
 1707   <td>String</td>
 1708   <td>URL for markup view for a file revision, or directory listing view
 1709       for a directory revision.</td>
 1710 </tr>
 1711 <tr class="varlevel1">
 1712   <td class="varname">head_annotate_href</td>
 1713   <td>String</td>
 1714   <td>URL for annotate view of the HEAD revision of the file.</td>
 1715 </tr>
 1716 <tr class="varlevel1">
 1717   <td class="varname">head_download_href</td>
 1718   <td>String</td>
 1719   <td>URL to download the HEAD revision of the file.</td>
 1720 </tr>
 1721 <tr class="varlevel1">
 1722   <td class="varname">head_download_text_href</td>
 1723   <td>String</td>
 1724   <td>URL to download the HEAD revision of the file as
 1725       <tt>text/plain</tt>.</td>
 1726 </tr>
 1727 <tr class="varlevel1">
 1728   <td class="varname">head_prefer_markup</td>
 1729   <td>Boolean</td>
 1730   <td>Indicates whether to make the default HEAD file link a link to the markup
 1731       page instead of the checkout page.</td>
 1732 </tr>
 1733 <tr class="varlevel1">
 1734   <td class="varname">head_view_href</td>
 1735   <td>String</td>
 1736   <td>URL for markup view of the HEAD revision of the file.</td>
 1737 </tr>
 1738 <tr class="varlevel1">
 1739   <td class="varname">human_readable</td>
 1740   <td>Boolean</td>
 1741   <td>Indicates whether or not currently selected diff format
 1742       (<var>diff_format</var>) is human readable (colored).</td>
 1743 </tr>
 1744 <tr class="varlevel1">
 1745   <td class="varname">log_pagestart</td>
 1746   <td>String</td>
 1747   <td>Item number (zero based) of the first directory entry requested
 1748       to be shown on the page. Corresponds to the
 1749       <var>log_pagestart</var> query parameter.</td>
 1750 </tr>
 1751 <tr class="varlevel1">
 1752   <td class="varname">log_paging_action</td>
 1753   <td>String</td>
 1754   <td>Form action URL for the page selection form.</td>
 1755 </tr>
 1756 <tr class="varlevel1">
 1757   <td class="varname">log_paging_hidden_values</td>
 1758   <td>List</td>
 1759   <td>Hidden field name/value pairs for the page selection form.</td>
 1760 </tr>
 1761 <tr class="varlevel1">
 1762   <td class="varname">logsort</td>
 1763   <td>String</td>
 1764   <td>Current sorting mode. Possible values: <tt>date</tt> and
 1765       <tt>rev</tt>.</td>
 1766 </tr>
 1767 <tr class="varlevel1">
 1768   <td class="varname">logsort_action</td>
 1769   <td>String</td>
 1770   <td>Form action URL for log sort drop down box.</td>
 1771 </tr>
 1772 <tr class="varlevel1">
 1773   <td class="varname">logsort_hidden_values</td>
 1774   <td>List</td>
 1775   <td>Hidden field name/value pairs for the log sort drop down box</td>
 1776 </tr>
 1777 <tr class="varlevel1">
 1778   <td class="varname">mime_type</td>
 1779   <td>String</td>
 1780   <td>MIME type of current file.</td>
 1781 </tr>
 1782 <tr class="varlevel1">
 1783   <td class="varname">plain_tags</td>
 1784   <td>List</td>
 1785   <td>Names of non-branch in the file. CVS only.</td>
 1786 </tr>
 1787 <tr class="varlevel1">
 1788   <td class="varname">rev_selected</td>
 1789   <td>String</td>
 1790   <td>Revision number currently selected for diffs.</td>
 1791 </tr>
 1792 <tr class="varlevel1">
 1793   <td class="varname">tag_annotate_href</td>
 1794   <td>String</td>
 1795   <td>URL for annotate view of the file at currently selected sticky
 1796       tag.</td>
 1797 </tr>
 1798 <tr class="varlevel1">
 1799   <td class="varname">tag_download_href</td>
 1800   <td>String</td>
 1801   <td>URL to download the file at currently selected sticky tag.
 1802       CVS only.</td>
 1803 </tr>
 1804 <tr class="varlevel1">
 1805   <td class="varname">tag_download_text_href</td>
 1806   <td>String</td>
 1807   <td>URL to download the file as <tt>text/plain</tt> at the currently
 1808       selected sticky tag. CVS only</td>
 1809 </tr>
 1810 <tr class="varlevel1">
 1811   <td class="varname">tag_prefer_markup</td>
 1812   <td>Boolean</td>
 1813   <td>Indicates whether to make the default sticky tag file link a
 1814       link to the markup page instead of the checkout page.</td>
 1815 </tr>
 1816 <tr class="varlevel1">
 1817   <td class="varname">tag_view_href</td>
 1818   <td>String</td>
 1819   <td>URL for markup view of the file at the currently selected sticky
 1820       tag. CVS only.</td>
 1821 </tr>
 1822 <tr class="varlevel1">
 1823   <td class="varname">tags</td>
 1824   <td>String</td>
 1825   <td>List of tags that in the current file. CVS only.</td>
 1826 </tr>
 1827 <tr class="varlevel2">
 1828   <td class="varname">tags.rev</td>
 1829   <td>String</td>
 1830   <td>Revision number for a non-branch tag, or the latest revision
 1831       number on the branch for a branch tag.</td>
 1832 </tr>
 1833 <tr class="varlevel2">
 1834   <td class="varname">tags.name</td>
 1835   <td>String</td>
 1836   <td>Tag name</td>
 1837 </tr>
 1838 </tbody>
 1839 </table>
 1840 </div>
 1841 
 1842 <div class="h3">
 1843 <h3 id="variables-query_results">Revision History Query Results View
 1844 (query_results.ezt, rss.ezt)</h3>
 1845 <table>
 1846 <thead>
 1847 <tr>
 1848   <th>Variable</th>
 1849   <th>Type</th>
 1850   <th>Description</th>
 1851 </tr>
 1852 </thead>
 1853 <tbody>
 1854 <tr class="include">
 1855   <td colspan="3">Includes all variables from the 
 1856      <a href="#variables-common">COMMON</a> variable set</td>
 1857 </tr>
 1858 <tr class="varlevel1">
 1859   <td class="varname">backout_href</td>
 1860   <td>String</td>
 1861   <td>URL for a page that shows a list of commands that can be applied
 1862       to a working copy to revert all the changes returned by the
 1863       query.</td>
 1864 </tr>
 1865 <tr class="varlevel1">
 1866   <td class="varname">commits</td>
 1867   <td>List</td>
 1868   <td>List of commits to files under the current directory that meet
 1869       the query criteria.</td>
 1870 </tr>
 1871 <tr class="varlevel2">
 1872   <td class="varname">commits.author</td>
 1873   <td>String</td>
 1874   <td>Author of the commit.</td>
 1875 </tr>
 1876 <tr class="varlevel2">
 1877   <td class="varname">commits.files</td>
 1878   <td>List</td>
 1879   <td>List of files under the current directory affected by the
 1880       commit.</td>
 1881 </tr>
 1882 <tr class="varlevel3">
 1883   <td class="varname">commits.files.author</td>
 1884   <td>String</td>
 1885   <td>Author of the commit.</td>
 1886 </tr>
 1887 <tr class="varlevel3">
 1888   <td class="varname">commits.files.date</td>
 1889   <td>String</td>
 1890   <td>Date (in UTC if not otherwise configured) the change to the file 
 1891      was committed.</td>
 1892 </tr>
 1893 <tr class="varlevel3">
 1894   <td class="varname">commits.files.dir</td>
 1895   <td>String</td>
 1896   <td>Path of the directory containing the file.</td>
 1897 </tr>
 1898 <tr class="varlevel3">
 1899   <td class="varname">commits.files.dir_href</td>
 1900   <td>String</td>
 1901   <td>URL for directory listing of <var>commits.files.dir</var>.</td>
 1902 </tr>
 1903 <tr class="varlevel3">
 1904   <td class="varname">commits.files.file</td>
 1905   <td>String</td>
 1906   <td>File name.</td>
 1907 </tr>
 1908 <tr class="varlevel3">
 1909   <td class="varname">commits.files.rev</td>
 1910   <td>String</td>
 1911   <td>Revision number of the file.</td>
 1912 </tr>
 1913 <tr class="varlevel3">
 1914   <td class="varname">commits.files.branch</td>
 1915   <td>File</td>
 1916   <td>Branch the commit occurred on.</td>
 1917 </tr>
 1918 <tr class="varlevel3">
 1919   <td class="varname">commits.files.diff_href</td>
 1920   <td>String</td>
 1921   <td>URL to diff page showing changes since previous file revision.</td>
 1922 </tr>
 1923 <tr class="varlevel3">
 1924   <td class="varname">commits.files.log_href</td>
 1925   <td>String</td>
 1926   <td>URL for file's log page.</td>
 1927 </tr>
 1928 <tr class="varlevel3">
 1929   <td class="varname">commits.files.minus</td>
 1930   <td>String</td>
 1931   <td>Number of lines removed from the file by the commit.</td>
 1932 </tr>
 1933 <tr class="varlevel3">
 1934   <td class="varname">commits.files.plus</td>
 1935   <td>String</td>
 1936   <td>Number of lines added to the file by the commit.</td>
 1937 </tr>
 1938 <tr class="varlevel3">
 1939   <td class="varname">commits.files.type</td>
 1940   <td>String</td>
 1941   <td>Type of change made to the file by the commit. Possible values:
 1942       <tt>Change</tt>, <tt>Add</tt>, <tt>Remove</tt></td>
 1943 </tr>
 1944 <tr class="varlevel2">
 1945   <td class="varname">commits.log</td>
 1946   <td>String</td>
 1947   <td>Commit log message.</td>
 1948 </tr>
 1949 <tr class="varlevel2">
 1950   <td class="varname">commits.limited_files</td>
 1951   <td>Boolean</td>
 1952   <td>True if files list was cut short due to <tt>limit_changes</tt>.</td>
 1953 </tr>
 1954 <tr class="varlevel2">
 1955   <td class="varname">commits.minus</td>
 1956   <td>String</td>
 1957   <td>Total number of lines removed from files in this commit.</td>
 1958 </tr>
 1959 <tr class="varlevel2">
 1960   <td class="varname">commits.num_files</td>
 1961   <td>String</td>
 1962   <td>Total number of files in the <var>commits.files</var> list.</td>
 1963 </tr>
 1964 <tr class="varlevel2">
 1965   <td class="varname">commits.plus</td>
 1966   <td>String</td>
 1967   <td>Number of lines added to files in this commit.</td>
 1968 </tr>
 1969 <tr class="varlevel2">
 1970   <td class="varname">commits.rev</td>
 1971   <td>String</td>
 1972   <td>Commit revision number. Subversion only.</td>
 1973 </tr>
 1974 <tr class="varlevel2">
 1975   <td class="varname">commits.rss_date</td>
 1976   <td>String</td>
 1977   <td>Date of the commit formatted for RSS.</td>
 1978 </tr>
 1979 <tr class="varlevel2">
 1980   <td class="varname">commits.rss_url</td>
 1981   <td>String</td>
 1982   <td>Absolute URL of the revision page for the commit. Subversion only.</td>
 1983 </tr>
 1984 <tr class="varlevel2">
 1985   <td class="varname">commits.short_log</td>
 1986   <td>String</td>
 1987   <td>Truncated commit log message.</td>
 1988 </tr>
 1989 <tr class="varlevel1">
 1990   <td class="varname">english_query</td>
 1991   <td>String</td>
 1992   <td>Text description of the current query criteria.</td>
 1993 </tr>
 1994 <tr class="varlevel1">
 1995   <td class="varname">limit_changes</td>
 1996   <td>String</td>
 1997   <td>Current <tt>limit_changes</tt> value, maximum number of changed files
 1998       to show per commit.</td>
 1999 </tr>
 2000 <tr class="varlevel1">
 2001   <td class="varname">limit_changes_href</td>
 2002   <td>String</td>
 2003   <td>URL for the current view but with <tt>limit_changes</tt> disabled.</td>
 2004 </tr>
 2005 <tr class="varlevel1">
 2006   <td class="varname">minus_count</td>
 2007   <td>String</td>
 2008   <td>Total number of lines removed from all files across all returned
 2009       commits.</td>
 2010 </tr>
 2011 <tr class="varlevel1">
 2012   <td class="varname">plus_count</td>
 2013   <td>String</td>
 2014   <td>Total number of lines added to all files across all returned
 2015       commits.</td>
 2016 </tr>
 2017 <tr class="varlevel1">
 2018   <td class="varname">querysort</td>
 2019   <td>String</td>
 2020   <td>Indicates how query results are being sorted. Possible values: 
 2021       <tt>date</tt>, <tt>author</tt>, and <tt>file</tt>.</td>
 2022 </tr>
 2023 <tr class="varlevel1">
 2024   <td class="varname">row_limit_reached</td>
 2025   <td>Boolean</td>
 2026   <td>Indicates whether the internal database row limit threshold (set
 2027       via the <code>cvsdb.row_limit</code>
 2028       and <code>cvsdb.rss_row_limit</code> configuration options) was
 2029       reached by the query.</td>
 2030 </tr>
 2031 <tr class="varlevel1">
 2032   <td class="varname">show_branch</td>
 2033   <td>Boolean</td>
 2034   <td>Indicates whether or not to list branch names in the results. True
 2035       when query results can include more than a single branch.</td>
 2036 </tr>
 2037 <tr class="varlevel1">
 2038   <td class="varname">sql</td>
 2039   <td>String</td>
 2040   <td>SQL string used to query database. Included for debugging
 2041       purposes.</td>
 2042 </tr>
 2043 </tbody>
 2044 </table>
 2045 </div>
 2046 
 2047 <div class="h3">
 2048 <h3 id="variables-query_form">Revision History Query Form View (query_form.ezt)</h3>
 2049 <table>
 2050 <thead>
 2051 <tr>
 2052   <th>Variable</th>
 2053   <th>Type</th>
 2054   <th>Description</th>
 2055 </tr>
 2056 </thead>
 2057 <tbody>
 2058 <tr class="include">
 2059   <td colspan="3">Includes all variables from the 
 2060      <a href="#variables-common">COMMON</a> variable set</td>
 2061 </tr>
 2062 <tr class="varlevel1">
 2063   <td class="varname">branch</td>
 2064   <td>String</td>
 2065   <td>Query string for filtering results by branch.</td>
 2066 </tr>
 2067 <tr class="varlevel1">
 2068   <td class="varname">branch_match</td>
 2069   <td>String</td>
 2070   <td>Type of match to perform with <var>branch</var> query string.
 2071       Valid values: <tt>exact</tt>, <tt>like</tt>, <tt>glob</tt>,
 2072       <tt>regex</tt>, <tt>notregex</tt>.</td>
 2073 </tr>
 2074 <tr class="varlevel1">
 2075   <td class="varname">comment</td>
 2076   <td>String</td>
 2077   <td>Query string for filtering results by log message.</td>
 2078 </tr>
 2079 <tr class="varlevel1">
 2080   <td class="varname">comment_match</td>
 2081   <td>String</td>
 2082   <td>Type of match to perform with <var>comment</var> query string. Possible
 2083       values: <tt>exact</tt>, <tt>like</tt>, <tt>glob</tt>, 
 2084       <tt>regex</tt>, <tt>notregex</tt>.</td>
 2085 </tr>
 2086 <tr class="varlevel1">
 2087   <td class="varname">date</td>
 2088   <td>String</td>
 2089   <td>Option for filtering results by date. Possible values:
 2090       <tt>hours</tt>, <tt>day</tt>, <tt>week</tt>, <tt>month</tt>,
 2091       <tt>all</tt>, <tt>explicit</tt>.</td>
 2092 </tr>
 2093 <tr class="varlevel1">
 2094   <td class="varname">dir</td>
 2095   <td>String</td>
 2096   <td>Query string for filtering results by subdirectory.</td>
 2097 </tr>
 2098 <tr class="varlevel1">
 2099   <td class="varname">dir_href</td>
 2100   <td>String</td>
 2101   <td>URL for directory list of current directory.</td>
 2102 </tr>
 2103 <tr class="varlevel1">
 2104   <td class="varname">file</td>
 2105   <td>String</td>
 2106   <td>Query string for filtering results by file name.</td>
 2107 </tr>
 2108 <tr class="varlevel1">
 2109   <td class="varname">file_match</td>
 2110   <td>String</td>
 2111   <td>Type of match to perform with <var>file</var> query string.
 2112       Valid values: <tt>exact</tt>, <tt>like</tt>, <tt>glob</tt>,
 2113       <tt>regex</tt>, <tt>notregex</tt>.</td>
 2114 </tr>
 2115 <tr class="varlevel1">
 2116   <td class="varname">hours</td>
 2117   <td>String</td>
 2118   <td>If <var>date</var> is <tt>hours</tt>, number of hours back to
 2119       include results from.</td>
 2120 </tr>
 2121 <tr class="varlevel1">
 2122   <td class="varname">limit_changes</td>
 2123   <td>String</td>
 2124   <td>Current <tt>limit_changes</tt> value, maximum number of changed files
 2125       to show per commit.</td>
 2126 </tr>
 2127 <tr class="varlevel1">
 2128   <td class="varname">maxdate</td>
 2129   <td>String</td>
 2130   <td>If <var>date</var> is <tt>explicit</tt>, latest date to
 2131       include results from.</td>
 2132 </tr>
 2133 <tr class="varlevel1">
 2134   <td class="varname">mindate</td>
 2135   <td>String</td>
 2136   <td>If <var>date</var> is <tt>explicit</tt>, earliest date to
 2137       include results from.</td>
 2138 </tr>
 2139 <tr class="varlevel1">
 2140   <td class="varname">query_action</td>
 2141   <td>String</td>
 2142   <td>Form action URL for query form.</td>
 2143 </tr>
 2144 <tr class="varlevel1">
 2145   <td class="varname">query_hidden_values</td>
 2146   <td>List</td>
 2147   <td>Hidden field name/value pairs for query form.</td>
 2148 </tr>
 2149 <tr class="varlevel1">
 2150   <td class="varname">querysort</td>
 2151   <td>String</td>
 2152   <td>Option for sorting query results. Possible values: <tt>date</tt>,
 2153       <tt>author</tt>, and <tt>file</tt>.</td>
 2154 </tr>
 2155 <tr class="varlevel1">
 2156   <td class="varname">who</td>
 2157   <td>String</td>
 2158   <td>Query string for filtering results by author.</td>
 2159 </tr>
 2160 <tr class="varlevel1">
 2161   <td class="varname">who_match</td>
 2162   <td>String</td>
 2163   <td>Type of match to perform with <var>who</var> query string. Possible
 2164       values: <tt>exact</tt>, <tt>like</tt>, <tt>glob</tt>, 
 2165       <tt>regex</tt>, <tt>notregex</tt>.</td>
 2166 </tr>
 2167 </tbody>
 2168 </table>
 2169 </div>
 2170 
 2171 <div class="h3">
 2172 <h3 id="variables-revision">Revision/ChangeSet View (revision.ezt)</h3>
 2173 <table>
 2174 <thead>
 2175 <tr>
 2176   <th>Variable</th>
 2177   <th>Type</th>
 2178   <th>Description</th>
 2179 </tr>
 2180 </thead>
 2181 <tbody>
 2182 <tr class="include">
 2183   <td colspan="3">Includes all variables from the 
 2184      <a href="#variables-common">COMMON</a> variable set</td>
 2185 </tr>
 2186 <tr class="varlevel1">
 2187   <td class="varname">ago</td>
 2188   <td>String</td>
 2189   <td>Text description of the time elapsed since <var>date</date>.</td>
 2190 </tr>
 2191 <tr class="varlevel1">
 2192   <td class="varname">author</td>
 2193   <td>String</td>
 2194   <td>Author of the revision.</td>
 2195 </tr>
 2196 <tr class="varlevel1">
 2197   <td class="varname">changes</td>
 2198   <td>List</td>
 2199   <td>List of paths changed in this revision.</td>
 2200 </tr>
 2201 <tr class="varlevel2">
 2202   <td class="varname">changes.action</td>
 2203   <td>String</td>
 2204   <td>Indicates what happened to the path in this revision. Valid
 2205       values are: <tt>added</tt>, <tt>modified</tt>, <tt>replaced</tt>,
 2206       and <tt>deleted</tt>.</td>
 2207 </tr>
 2208 <tr class="varlevel2">
 2209   <td class="varname">changes.copy_path</td>
 2210   <td>String</td>
 2211   <td>Original path if path was copied from somewhere in this
 2212       revision.</td>
 2213 </tr>
 2214 <tr class="varlevel2">
 2215   <td class="varname">changes.copy_rev</td>
 2216   <td>String</td>
 2217   <td>Revision number of original path if path was copied from somewhere
 2218       in this revision</td>
 2219 </tr>
 2220 <tr class="varlevel2">
 2221   <td class="varname">changes.diff_href</td>
 2222   <td>String</td>
 2223   <td>URL for diff of changed path against previous revision.</td>
 2224 </tr>
 2225 <tr class="varlevel2">
 2226   <td class="varname">changes.is_copy</td>
 2227   <td>Boolean</td>
 2228   <td>Indicates whether path was copied from another path in this
 2229       revision.</td>
 2230 </tr>
 2231 <tr class="varlevel2">
 2232   <td class="varname">changes.log_href</td>
 2233   <td>String</td>
 2234   <td>URL for log view of changed path.</td>
 2235 </tr>
 2236 <tr class="varlevel2">
 2237   <td class="varname">changes.path</td>
 2238   <td>String</td>
 2239   <td>Changed path.</td>
 2240 </tr>
 2241 <tr class="varlevel2">
 2242   <td class="varname">changes.pathtype</td>
 2243   <td>String</td>
 2244   <td>Type of changed path. Valid values: <tt>file</tt> or
 2245       <tt>dir</tt></td>
 2246 </tr>
 2247 <tr class="varlevel2">
 2248   <td class="varname">changes.prop_mods</td>
 2249   <td>Boolean</td>
 2250   <td>Indicates whether the path's properties changed in this revision</td>
 2251 </tr>
 2252 <tr class="varlevel2">
 2253   <td class="varname">changes.text_mods</td>
 2254   <td>Boolean</td>
 2255   <td>Indicates whether the path's file contents changed in this
 2256       revision.</td>
 2257 </tr>
 2258 <tr class="varlevel2">
 2259   <td class="varname">changes.view_href</td>
 2260   <td>String</td>
 2261   <td>URL for markup view of changed path.</td>
 2262 </tr>
 2263 <tr class="varlevel1">
 2264   <td class="varname">date</td>
 2265   <td>String</td>
 2266   <td>Revision date (in UTC if not otherwise configured).</td>
 2267 </tr>
 2268 <tr class="varlevel1">
 2269   <td class="varname">first_changes</td>
 2270   <td>String</td>
 2271   <td>Configured value for <tt>limit_changes</tt>.</td>
 2272 </tr>
 2273 <tr class="varlevel1">
 2274   <td class="varname">first_changes_href</td>
 2275   <td>String</td>
 2276   <td>URL for the current view but with <tt>limit_changes</tt> set to the
 2277       configured value.</td>
 2278 </tr>
 2279 <tr class="varlevel1">
 2280   <td class="varname">jump_rev_action</td>
 2281   <td>String</td>
 2282   <td>Form action URL for revision jump form.</td>
 2283 </tr>
 2284 <tr class="varlevel1">
 2285   <td class="varname">jump_rev_hidden_values</td>
 2286   <td>List</td>
 2287   <td>Hidden field name/value pairs for revision jump form.</td>
 2288 </tr>
 2289 <tr class="varlevel1">
 2290   <td class="varname">limit_changes</td>
 2291   <td>String</td>
 2292   <td>Current <tt>limit_changes</tt> value, maximum number of changed files
 2293       to show per commit.</td>
 2294 </tr>
 2295 <tr class="varlevel1">
 2296   <td class="varname">log</td>
 2297   <td>String</td>
 2298   <td>Revision log message.</td>
 2299 </tr>
 2300 <tr class="varlevel1">
 2301   <td class="varname">more_changes</td>
 2302   <td>String</td>
 2303   <td>Number of changes not being shown due to <tt>limit_changes</tt>.</td>
 2304 </tr>
 2305 <tr class="varlevel1">
 2306   <td class="varname">more_changes_href</td>
 2307   <td>String</td>
 2308   <td>URL for the current view but with <tt>limit_changes</tt> disabled.</td>
 2309 </tr>
 2310 <tr class="varlevel1">
 2311   <td class="varname">num_changes</td>
 2312   <td>String</td>
 2313   <td>Number of paths changed in this revision.</td>
 2314 </tr>
 2315 <tr class="varlevel1">
 2316   <td class="varname">next_href</td>
 2317   <td>String</td>
 2318   <td>URL for revision page of the next revision.</td>
 2319 </tr>
 2320 <tr class="varlevel1">
 2321   <td class="varname">prev_href</td>
 2322   <td>String</td>
 2323   <td>URL for revision page of the previous revision.</td>
 2324 </tr>
 2325 <tr class="varlevel1">
 2326   <td class="varname">rev</td>
 2327   <td>String</td>
 2328   <td>Revision number.</td>
 2329 </tr>
 2330 </tbody>
 2331 </table>
 2332 </div>
 2333 
 2334 <div class="h3">
 2335 <h3 id="variables-roots">Root Listing View (roots.ezt)</h3>
 2336 <table>
 2337 <thead>
 2338 <tr>
 2339   <th>Variable</th>
 2340   <th>Type</th>
 2341   <th>Description</th>
 2342 </tr>
 2343 </thead>
 2344 <tbody>
 2345 <tr class="include">
 2346   <td colspan="3">Includes all variables from the 
 2347      <a href="#variables-common">COMMON</a> variable set</td>
 2348 </tr>
 2349 <tr class="varlevel1">
 2350   <td class="varname">roots</td>
 2351   <td>List</td>
 2352   <td>Set of configured viewable repositories.</td>
 2353 </tr>
 2354 <tr class="varlevel2">
 2355   <td class="varname">roots.ago</td>
 2356   <td>String</td>
 2357   <td>Textual description of the time since <var>roots.date</var>.</td>
 2358 </tr>
 2359 <tr class="varlevel2">
 2360   <td class="varname">roots.author</td>
 2361   <td>String</td>
 2362   <td>Username of the last modifier of the root.</td>
 2363 </tr>
 2364 <tr class="varlevel2">
 2365   <td class="varname">roots.date</td>
 2366   <td>String</td>
 2367   <td>Date (in UTC if not otherwise configured) of the last
 2368       modification of the root.</td>
 2369 </tr>
 2370 <tr class="varlevel2">
 2371   <td class="varname">roots.href</td>
 2372   <td>String</td>
 2373   <td>URL of root directory view for a configured repository.</td>
 2374 </tr>
 2375 <tr class="varlevel2">
 2376   <td class="varname">roots.log</td>
 2377   <td>String</td>
 2378   <td>Log message of last modification to the root.</td>
 2379 </tr>
 2380 <tr class="varlevel2">
 2381   <td class="varname">roots.log_href</td>
 2382   <td>String</td>
 2383   <td>URL of log revision view for the top-most (root) directory of
 2384     the root (repository).</td>
 2385 </tr>
 2386 <tr class="varlevel2">
 2387   <td class="varname">roots.name</td>
 2388   <td>String</td>
 2389   <td>Name of a configured repository.</td>
 2390 </tr>
 2391 <tr class="varlevel2">
 2392   <td class="varname">roots.path</td>
 2393   <td>String</td>
 2394   <td>Server-local location of a configured repository.  WARNING:  Revealing
 2395       information to untrusted guests about the details of your server
 2396       configuration can have negative security implications.  Use this
 2397       token at your own risk.</td>
 2398 </tr>
 2399 <tr class="varlevel2">
 2400   <td class="varname">roots.rev</td>
 2401   <td>String</td>
 2402   <td>Youngest revision of the root.</td>
 2403 </tr>
 2404 <tr class="varlevel2">
 2405   <td class="varname">roots.short_log</td>
 2406   <td>String</td>
 2407   <td>Log message of last modification to the root, truncated to
 2408       contain no more than the number of characters specified by
 2409       the <code>short_log_len</code> configuration option.</td>
 2410 </tr>
 2411 <tr class="varlevel2">
 2412   <td class="varname">roots.type</td>
 2413   <td>String</td>
 2414   <td>Version control type of a configured repository.  Valid
 2415       values: <tt>cvs</tt>, <tt>svn</tt>.</td>
 2416 </tr>
 2417 <tr class="varlevel1">
 2418   <td class="varname">roots_shown</td>
 2419   <td>List</td>
 2420   <td>Number of repositories displayed.</td>
 2421 </tr>
 2422 </tbody>
 2423 </table>
 2424 
 2425 </div>
 2426 </body>
 2427 </html>