Define entities to include boilerplate text. See doc/source/*.
[privoxy.git] / templates / show-url-info
index 1c96a96..76fc5f0 100644 (file)
+##########################################################
+#
+# Show-Url-Info-CGI Output template for Privoxy.
+#
+#
+# USING HTML TEMPLATES:
+# ---------------------
+#
+# 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.
+#
+# 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.
+#  url-given:
+#    The CGI was called with a url parameter. In that case, the
+#    following symbols are available:
+#    url:
+#      The given URL
+#    default:
+#      The system default for actions
+#    matches:
+#      The list of all matches in the actions file that this URL
+#      produced, along with the actions that were triggered by
+#      these matches
+#    final:
+#      The actions that are associated with the URL at the end of
+#      the matching process
+#
 <html>
 
 <head>
-  <title>Internet Junkbuster: URL Info</title>
+  <title>Privoxy@@my-hostname@ URL Info</title>
+  <style type="text/css">
+    BODY, P, H1, H2, UL, OL, LI { font-family: Helvetica, Helv, Arial, Sans-Serif, sans-serif }
+  </style>
 </head>
 
 <body bgcolor="#ffffff">
 
-  <h1>Internet J<small>UNK<i><font color="red">BUSTER</font></i></small></h1>
+  <table cellpadding=20 cellspacing=10 border=0 width=100%>
+    <tr>
+      <td bgcolor=#dddddd>
+        <p><big><big><b>This is Privoxy (privacy enhancing proxy) @version@ on @my-hostname@ (@my-ip-address@), port @my-port@, @if-enabled-display-then@Enabled@else-not-enabled-display@Disabled@endif-enabled-display@</b></big></big></p>
+      </td>
+    </tr>
 
-  <p>Information for: <a href="http://@url@">http://@url@</a></p>
+<!-- @if-url-given-start -->
+    <tr>
+      <td bgcolor=#eeeeee>
+<!-- @if-https-start -->
+        <h2>NOTE:</h2>
+        <p>This is a secure (https:) URL, so the part after the "/" is ignored.
+          This is a feature of the HTTPS protocol - the exact address of the
+          page you're visiting is hidden.  Privoxy can only detect the host
+          part of the URL.</p>
+        <p>&nbsp;</p>
+<!-- if-https-end@ -->
+        <h2>Matches for <a href="@url@">@url@</a>:</h2>
+        <p>@matches@</p>
+      </td>
+    </tr>
 
-<h3>Default settings:</h3>
-<p><b>{@default@}</b></p>
+    <tr>
+      <td bgcolor=#eeeeee>
+        <h2>Final results:</h2>
+        <p><b>@final@</b></p>
+      </td>
+    </tr>
+<!-- if-url-given-end@ -->
 
-<h3>Matches:</h3>
-<p>@matches@</p>
+    <tr>
+      <td bgcolor=#eeeeee>
+        <h2>Look up the actions for a 
+<!-- @if-url-given-start -->new<!-- if-url-given-end@ -->
+          URL:</h2>
+        <form method="GET" action="@default-cgi@show-url-info">
+          <input type="text" name="url" size="80" value="@url@"> 
+          <input type="submit" value="Go">
+        </form>
+      </td>
+    </tr>
 
-<h3>Final settings:</h3>
-<p><b>{@final@}</b></p>
+    <tr>
+      <td bgcolor=#dddddd>
+        <h2>More Privoxy:</h2>
+        <ul>@menu@</ul>
+      </td>
+    </tr>
 
-<p>&nbsp;</p>
+<!-- @if-unstable-start -->
+# This will only appear if CODE_STATUS is "alpha" or "beta". See configure.in
+    <tr>
+      <td bgcolor=#ffdddd>
+        <p><b>Please note that this <font color=red>@code-status@</font> 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>
+       <p>
+<h2>Support and Service via Sourceforge</h2>
+<p>
+We value your feedback. However, to provide you with the best support,
+please note:
+<ul>
+  <li>Use the <a href="http://sourceforge.net/tracker/?group_id=11118&atid=211118">support forum</a> to get
+  help.</li>
+  <li>Submit bugs only thru our <a href="http://sourceforge.net/tracker/?group_id=11118&atid=111118">bug
+      forum</a>. Make sure that the bug has not yet been submitted.</li>
+  <li>Submit feature requests only thru our <a
+      href="http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse">feature request forum</a>.</li>
+</ul>
+</p>
+<p>
+For any other issues, feel free to use the <a
+href="http://sourceforge.net/mail/?group_id=11118">mailing lists</a>.
+</p>
+      </td>
+    </tr>
+<!-- if-unstable-end@ -->
 
-<p>Back to <a href="http://i.j.b/">JunkBuster front page</a></p>
+<!-- @if-have-help-info-start -->
+    <tr>
+      <td bgcolor=#dddddd>
+        <h2>Local Privoxy support:</h2>
 
-<p>Or look up another URL, (don't enter the leading &quot;http://&quot;):<br>
-<form method="GET" action="http://i.j.b/show-url-info">
-<input type="text" name="url" size="80" value="@url@"> 
-<input type="submit" value="Info">
-</form>
-</p>
+<!-- @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.         
+<!-- if-have-proxy-info-end@ -->
+
+<!-- @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.
+<!-- if-have-adminaddr-info-end@ -->
 
+        </p>
+      </td>
+    </tr>
+<!-- if-have-help-info-end@ -->
+    
+  </table>
 
 </body>
 </html>