Correct HTML, external Stylesheets, eye candy, some fixes
[privoxy.git] / templates / show-status-file
index 2d2e18d..4b17a8d 100644 (file)
 ##########################################################
 #
 ##########################################################
 #
-# CGI-Output template for the junkbuster.
+# Show-Status-CGI Output template for Privoxy.
+# (Variant for the show-file mode)
 #
 #
-# Lines *starting* with '#' are ignored.
-# Symbols are enclosed in @ characters.
+# USING HTML TEMPLATES:
+# ---------------------
 #
 #
-# Usable symbols in this file: filename, contents, 
-# filepath
+# Template files are written win plain HTML, with a few
+# additions:
+# 
+# - Lines that start with a '#' character like this one
+#   are ignored
+#
+# - Each item in the below list of exported symbols will
+#   be replaced by dynamically generated text, if they
+#   are enclosed in '@'-characters. E.g. The string @version@
+#   will be replaced by the version number of Privoxy.
+#
+# - One special application of this is to make whole blocks
+#   of the HTML template disappear if the condition <name>
+#   is not given. Simply enclose the block between the two
+#   strings @if-<name>start and if-<name>-end@. The strings
+#   should be placed in HTML comments (<!-- -->), so the
+#   html structure won't be messed when the magic happens.
+#   
+# USABLE SYMBOLS IN THIS TEMPLATE:
+# --------------------------------
+#
+#  my-ip-addr:
+#    The IP-address that the client used to reach this proxy
+#  my-hostname:
+#    The hostname associated with my-ip-addr
+#  admin-address:
+#    The email address of the pxoxy's administrator, as configured
+#    in the config file
+#  default-cgi:
+#    The URL for the "main menu" builtin CGI of this proxy
+#  menu:
+#    List of <li> elements linking to the other available CGIs
+#  version:
+#    The version number of the proxy software
+#  code-status:
+#    The development status of the proxy software: "alpha", "beta",
+#    or "stable".
+#  homepage:
+#    The URL of the SourceForge ijbswa project, who maintains this
+#    software.
+#
+#  file-description:
+#    A descriptive name for the file being shown
+#  contents:
+#    The contents of the file being shown
+#  filepath
+#    The complete filename of the file being shown
+#
+#  
+# CONDITIONAL SYMBOLS FOR THIS TEMPLATE AND THEIR DEPANDANT SYMBOLS:
+# ------------------------------------------------------------------
+#
+#  unstable:
+#    This is an alpha or beta release of the proxy software
+#  have-adminaddr-info:
+#    An e-mail address for the local Privoxy adminstrator has
+#    been specified and is available through the "admin-address"
+#    symbol
+#  have-proxy-info:
+#    A URL for online documentation about this proxy has been
+#    specified and is available through the "proxy-info-url"
+#    symbol
+#  have-help-info:
+#    If either have-proxy-info is true or have-adminaddr-info is
+#    true, have-help-info is true.  Used to conditionally include
+#    a grey box for any and all help info.
+#
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
 <html>
 
 <head>
 <html>
 
 <head>
-  <title>Internet Junkbuster Status - @filename@</title>
+  <title>Privoxy@@my-hostname@: Contents of @file-description@</title>
+  <meta http-equiv="Content-Style-Type" content="text/css">
+  <meta http-equiv="Content-Script-Type" content="text/javascript">
+  <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+  <meta name="robots" content="noindex,nofollow">
+  <link rel="stylesheet" type="text/css" href="@default-cgi@send-stylesheet">
 </head>
 
 </head>
 
-<body bgcolor="#ffffff">
+<body>
+
+  <table cellpadding="20" cellspacing="10" border="0" width="100%">
+    <tr>
+      <td class="title">
+        <h1>
+          This is <a href="@homepage@">Privoxy</a> @version@ on @my-hostname@ (@my-ip-address@), port @my-port@,
+          @if-enabled-display-then@Enabled@else-not-enabled-display@Disabled@endif-enabled-display@
+        </h1>
+      </td>
+    </tr>
+
+<!-- @if-unstable-start -->
+# This will only appear if CODE_STATUS is "alpha" or "beta". See configure.in
+    <tr>
+      <td class="warning">
+        <h2>Warning:</h2>
+          <p>
+            <b>Please note that this <em class="warning">@code-status@</em> release
+            of the proxy software is not intended for production systems!
+            <br>Use at your own risk. See the <a href="http://www.gnu.org/copyleft/gpl.html">license</a> for details.</b>
+          </p>
+      </td>
+    </tr>
+<!-- if-unstable-end@ -->
 
 
-  <h1>Internet J<small>UNK<i><font color="red">BUSTER</font></i></small>:
-      Contents of @filename@</h1>
+    <tr>
+      <td class="box">
+        <h2>Contents of @file-description@ (@filepath@)</h2>
+        <pre>@contents@</pre>
+      </td>
+    </tr>
+    <tr>
+      <td class="box">
+        <h2>More Privoxy:</h2>
+        <ul>@menu@</ul>
+      </td>
+    </tr>
 
 
-  
+    <tr>
+      <td class="info">
+        <h2>Support and Service via Sourceforge:</h2>
+        <p>
+          We value your feedback. To provide you with the best support,
+          we ask that you:
+        </p>
+        <ul>
+          <li>
+            use the <a href="http://sourceforge.net/tracker/?group_id=11118&amp;atid=211118">support forum</a> or (better) the
+            <a href="http://sourceforge.net/mail/?group_id=11118">mailing lists</a> to get help.
+          </li>
+          <li>
+            submit banners and all problems with the actions file only through the
+            <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
+            file feedback system</a>.
+          </li>
+          <li>
+            submit bugs only through our <a href="http://sourceforge.net/tracker/?group_id=11118&amp;atid=111118">bug tracker</a>.
+            Make sure that the bug has not yet been submitted.
+          </li>
+          <li>
+            submit feature requests only through our <a href="http://sourceforge.net/tracker/?atid=361118&amp;group_id=11118&amp;func=browse">feature
+            request tracker</a>.
+          </li>
+        </ul>
+      </td>
+    </tr>
 
 
-  <h2>Contents of @filepath@</h2>
+<!-- @if-have-help-info-start -->
+    <tr>
+      <td class="info">
+        <h2>Local Privoxy support:</h2>
 
 
-  <pre>
-@contents@
-  </pre>
+<!-- @if-have-proxy-info-start -->
+        <p>
+          You can consult the <a href="@proxy-info-url@">online documentation</a> for more information
+           about this Privoxy installation.
+        </p>
+<!-- if-have-proxy-info-end@ -->
 
 
-  <p><a href="/config/show-status">Back to the general status page</a></p>
+<!-- @if-have-adminaddr-info-start -->
+        <p>Address e-mail questions about this service to
+          <a href="mailto:@admin-address@"><code>@admin-address@</code></a>,
+          who will be glad to help you.
+        </p>
+<!-- if-have-adminaddr-info-end@ -->
+      </td>
+    </tr>
+<!-- if-have-help-info-end@ -->
 
 
-  <p>Please feel free to mail <a href=mailto:ijbswa-developers@lists.sourceforge.net>the developers</a>
-     with any problems you might have</p>
+     <tr>
+      <td>
+        <p class="small">Valid <a href="http://validator.w3.org/">HTML 4.01 Strict</a></p>
+      </td>
+    </tr>       
+  </table>
 
 </body>
 
 </body>
-</html>
\ No newline at end of file
+</html>