templates/show-status-file

   1 ##########################################################
   2 #
   3 # Show-Status-CGI Output template for Privoxy.
   4 # (Variant for the show-file mode)
   5 #
   6 # USING HTML TEMPLATES:
   7 # ---------------------
   8 #
   9 # Template files are written win plain HTML, with a few
  10 # additions:
  11 #
  12 # - Lines that start with a '#' character like this one
  13 #   are ignored
  14 #
  15 # - Each item in the below list of exported symbols will
  16 #   be replaced by dynamically generated text, if they
  17 #   are enclosed in '@'-characters. E.g. The string @version@
  18 #   will be replaced by the version number of Privoxy.
  19 #
  20 # - One special application of this is to make whole blocks
  21 #   of the HTML template disappear if the condition <name>
  22 #   is not given. Simply enclose the block between the two
  23 #   strings @if-<name>start and if-<name>-end@. The strings
  24 #   should be placed in HTML comments (<!-- -->), so the
  25 #   html structure won't be messed when the magic happens.
  26 #
  27 # USABLE SYMBOLS IN THIS TEMPLATE:
  28 # --------------------------------
  29 #
  30 #  my-ip-addr:
  31 #    The IP-address that the client used to reach this proxy
  32 #  my-hostname:
  33 #    The hostname associated with my-ip-addr
  34 #  admin-address:
  35 #    The email address of the pxoxy's administrator, as configured
  36 #    in the config file
  37 #  default-cgi:
  38 #    The URL for the "main menu" builtin CGI of this proxy
  39 #  menu:
  40 #    List of
  41          <li> elements linking to the other available CGIs
  42 #  version:
  43 #    The version number of the proxy software
  44 #  code-status:
  45 #    The development status of the proxy software: "alpha", "beta",
  46 #    or "stable".
  47 #  homepage:
  48 #    The URL of the SourceForge ijbswa project, who maintains this
  49 #    software.
  50 #
  51 #  file-description:
  52 #    A descriptive name for the file being shown
  53 #  contents:
  54 #    The contents of the file being shown
  55 #  filepath
  56 #    The complete filename of the file being shown
  57 #
  58 #
  59 # CONDITIONAL SYMBOLS FOR THIS TEMPLATE AND THEIR DEPANDANT SYMBOLS:
  60 # ------------------------------------------------------------------
  61 #
  62 #  unstable:
  63 #    This is an alpha or beta release of the proxy software
  64 #  have-adminaddr-info:
  65 #    An e-mail address for the local Privoxy adminstrator has
  66 #    been specified and is available through the "admin-address"
  67 #    symbol
  68 #  have-proxy-info:
  69 #    A URL for online documentation about this proxy has been
  70 #    specified and is available through the "proxy-info-url"
  71 #    symbol
  72 #  have-help-info:
  73 #    If either have-proxy-info is true or have-adminaddr-info is
  74 #    true, have-help-info is true.  Used to conditionally include
  75 #    a grey box for any and all help info.
  76 #
  77 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
  78 <html>
  79
  80 <head>
  81   <title>Privoxy@@my-hostname@: Contents of @file-description@</title>
  82   <meta http-equiv="Content-Style-Type" content="text/css">
  83   <meta http-equiv="Content-Script-Type" content="text/javascript">
  84   <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  85   <meta name="robots" content="noindex,nofollow">
  86   <link rel="stylesheet" type="text/css" href="@default-cgi@send-stylesheet">
  87 </head>
  88
  89 <body>
  90
  91   <table cellpadding="20" cellspacing="10" border="0" width="100%">
  92     <tr>
  93       <td class="title">
  94
  95 #include mod-title
  96
  97       </td>
  98     </tr>
  99
 100 <!-- @if-unstable-start -->
 101 # This will only appear if CODE_STATUS is "alpha" or "beta". See configure.in
 102     <tr>
 103       <td class="warning">
 104
 105 #include mod-unstable-warning
 106
 107       </td>
 108     </tr>
 109 <!-- if-unstable-end@ -->
 110
 111     <tr>
 112       <td class="box">
 113         <h2>Contents of @file-description@ @filepath@</h2>
 114         <pre>@contents@</pre>
 115       </td>
 116     </tr>
 117
 118     <tr>
 119       <td class="box">
 120         <h2>More Privoxy:</h2>
 121         <ul>@menu@
 122          <li><a href="@user-manual@">Documentation</a></li>
 123         </ul>
 124       </td>
 125     </tr>
 126
 127     <tr>
 128       <td class="info">
 129
 130 #include mod-support-and-service
 131
 132       </td>
 133     </tr>
 134
 135 <!-- @if-have-help-info-start -->
 136     <tr>
 137       <td class="info">
 138
 139 #include mod-local-help
 140
 141       </td>
 142     </tr>
 143 <!-- if-have-help-info-end@ -->
 144
 145      <tr>
 146       <td>
 147         <p class="small">Valid <a href="http://validator.w3.org/">HTML 4.01 Strict</a></p>
 148       </td>
 149     </tr>
 150   </table>
 151
 152 </body>
 153 </html>