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 proxy 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 Privoxy project, which maintains this software.
  48 #
  49 #  file-description:
  50 #    A descriptive name for the file being shown
  51 #  contents:
  52 #    The contents of the file being shown
  53 #  filepath
  54 #    The complete filename of the file being shown
  55 #
  56 #
  57 # CONDITIONAL SYMBOLS FOR THIS TEMPLATE AND THEIR DEPANDANT SYMBOLS:
  58 # ------------------------------------------------------------------
  59 #
  60 #  unstable:
  61 #    This is an alpha or beta release of the proxy software
  62 #  have-adminaddr-info:
  63 #    An e-mail address for the local Privoxy administrator has
  64 #    been specified and is available through the "admin-address"
  65 #    symbol
  66 #  have-proxy-info:
  67 #    A URL for online documentation about this proxy has been
  68 #    specified and is available through the "proxy-info-url"
  69 #    symbol
  70 #  have-help-info:
  71 #    If either have-proxy-info is true or have-adminaddr-info is
  72 #    true, have-help-info is true.  Used to conditionally include
  73 #    a grey box for any and all help info.
  74 #
  75 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
  76 <html>
  77
  78 <head>
  79   <title>Privoxy@@my-hostname@: Contents of @file-description@</title>
  80   <meta http-equiv="Content-Style-Type" content="text/css">
  81   <meta http-equiv="Content-Script-Type" content="text/javascript">
  82   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  83   <meta name="robots" content="noindex,nofollow">
  84   <link rel="stylesheet" type="text/css" href="@default-cgi@send-stylesheet">
  85   <link rel="shortcut icon" href="@default-cgi@favicon.ico" type="image/x-icon">
  86 </head>
  87
  88 <body>
  89
  90   <table cellpadding="20" cellspacing="10" border="0" width="100%">
  91     <tr>
  92       <td class="title">
  93
  94 #include mod-title
  95
  96       </td>
  97     </tr>
  98
  99 <!-- @if-unstable-start -->
 100 # This will only appear if CODE_STATUS is "alpha" or "beta". See configure.in
 101     <tr>
 102       <td class="warning">
 103
 104 #include mod-unstable-warning
 105
 106       </td>
 107     </tr>
 108 <!-- if-unstable-end@ -->
 109
 110     <tr>
 111       <td class="box">
 112         <h2>Contents of @file-description@ @filepath@</h2>
 113         <pre>@contents@</pre>
 114       </td>
 115     </tr>
 116
 117     <tr>
 118       <td class="box">
 119         <h2>More Privoxy:</h2>
 120         <ul>@menu@<li><a href="@user-manual@">Documentation</a></li></ul>
 121       </td>
 122     </tr>
 123
 124 <!-- @if-have-help-info-start -->
 125     <tr>
 126       <td class="info">
 127
 128 #include mod-local-help
 129
 130       </td>
 131     </tr>
 132 <!-- if-have-help-info-end@ -->
 133
 134     <tr>
 135       <td class="info">
 136
 137 #include mod-support-and-service
 138
 139       </td>
 140     </tr>
 141
 142   </table>
 143
 144 </body>
 145 </html>