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 <li> elements linking to the other available CGIs
  41 #  version:
  42 #    The version number of the proxy software
  43 #  code-status:
  44 #    The development status of the proxy software: "alpha", "beta",
  45 #    or "stable".
  46 #  homepage:
  47 #    The URL of the SourceForge ijbswa project, who maintains this
  48 #    software.
  49 #
  50 #  file-description:
  51 #    A descriptive name for the file being shown
  52 #  contents:
  53 #    The contents of the file being shown
  54 #  filepath
  55 #    The complete filename of the file being shown
  56 #
  57 #
  58 # CONDITIONAL SYMBOLS FOR THIS TEMPLATE AND THEIR DEPANDANT SYMBOLS:
  59 # ------------------------------------------------------------------
  60 #
  61 #  unstable:
  62 #    This is an alpha or beta release of the proxy software
  63 #  have-adminaddr-info:
  64 #    An e-mail address for the local Privoxy adminstrator has
  65 #    been specified and is available through the "admin-address"
  66 #    symbol
  67 #  have-proxy-info:
  68 #    A URL for online documentation about this proxy has been
  69 #    specified and is available through the "proxy-info-url"
  70 #    symbol
  71 #  have-help-info:
  72 #    If either have-proxy-info is true or have-adminaddr-info is
  73 #    true, have-help-info is true.  Used to conditionally include
  74 #    a grey box for any and all help info.
  75 #
  76 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
  77 <html>
  78
  79 <head>
  80   <title>Privoxy@@my-hostname@: Contents of @file-description@</title>
  81   <meta http-equiv="Content-Style-Type" content="text/css">
  82   <meta http-equiv="Content-Script-Type" content="text/javascript">
  83   <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  84   <meta name="robots" content="noindex,nofollow">
  85   <link rel="stylesheet" type="text/css" href="@default-cgi@send-stylesheet">
  86 </head>
  87
  88 <body>
  89
  90   <table cellpadding="20" cellspacing="10" border="0" width="100%">
  91     <tr>
  92       <td class="title">
  93         <h1>
  94           This is <a href="@homepage@">Privoxy</a> @version@ on @my-hostname@ (@my-ip-address@), port @my-port@,
  95           @if-enabled-display-then@Enabled@else-not-enabled-display@Disabled@endif-enabled-display@
  96         </h1>
  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         <h2>Warning:</h2>
 105           <p>
 106             <b>Please note that this <em class="warning">@code-status@</em> release
 107             of the proxy software is not intended for production systems!
 108             <br>Use at your own risk. See the <a href="http://www.gnu.org/copyleft/gpl.html">license</a> for details.</b>
 109           </p>
 110       </td>
 111     </tr>
 112 <!-- if-unstable-end@ -->
 113
 114     <tr>
 115       <td class="box">
 116         <h2>Contents of @file-description@ (@filepath@)</h2>
 117         <pre>@contents@</pre>
 118       </td>
 119     </tr>
 120
 121     <tr>
 122       <td class="box">
 123         <h2>More Privoxy:</h2>
 124         <ul>@menu@</ul>
 125       </td>
 126     </tr>
 127
 128     <tr>
 129       <td class="info">
 130         <h2>Support and Service via Sourceforge:</h2>
 131         <p>
 132           We value your feedback. To provide you with the best support,
 133           we ask that you:
 134         </p>
 135         <ul>
 136           <li>
 137             use the <a href="http://sourceforge.net/tracker/?group_id=11118&amp;atid=211118">support forum</a> or (better) the
 138             <a href="http://sourceforge.net/mail/?group_id=11118">mailing lists</a> to get help.
 139           </li>
 140           <li>
 141             submit banners and all problems with the actions file only through the
 142             <a href="javascript:void(window.open('http://www.privoxy.org/actions','Feedback','width=600,scrollbars=yes,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">actions
 143             file feedback system</a>.
 144           </li>
 145           <li>
 146             submit bugs only through our <a href="http://sourceforge.net/tracker/?group_id=11118&amp;atid=111118">bug tracker</a>.
 147             Make sure that the bug has not yet been submitted.
 148           </li>
 149           <li>
 150             submit feature requests only through our <a href="http://sourceforge.net/tracker/?atid=361118&amp;group_id=11118&amp;func=browse">feature
 151             request tracker</a>.
 152           </li>
 153         </ul>
 154       </td>
 155     </tr>
 156
 157 <!-- @if-have-help-info-start -->
 158     <tr>
 159       <td class="info">
 160         <h2>Local Privoxy support:</h2>
 161
 162 <!-- @if-have-proxy-info-start -->
 163         <p>
 164           You can consult the <a href="@proxy-info-url@">online documentation</a> for more information
 165            about this Privoxy installation.
 166         </p>
 167 <!-- if-have-proxy-info-end@ -->
 168
 169 <!-- @if-have-adminaddr-info-start -->
 170         <p>Address e-mail questions about this service to
 171           <a href="mailto:@admin-address@"><code>@admin-address@</code></a>,
 172           who will be glad to help you.
 173         </p>
 174 <!-- if-have-adminaddr-info-end@ -->
 175       </td>
 176     </tr>
 177 <!-- if-have-help-info-end@ -->
 178
 179      <tr>
 180       <td>
 181         <p class="small">Valid <a href="http://validator.w3.org/">HTML 4.01 Strict</a></p>
 182       </td>
 183     </tr>
 184   </table>
 185
 186 </body>
 187 </html>