templates: Move the site-specific documentation block before the generic one
[privoxy.git] / templates / show-url-info
index 1acab1c..3210d3f 100644 (file)
@@ -1,14 +1,37 @@
-##########################################################
+########################################################################
 #
-# Show-Url-Info-CGI Output template for Privoxy.
+# File        :  $Source: /cvsroot/ijbswa/current/templates/show-url-info,v $
 #
+# Purpose     :  Template for Privoxy's show-url-info CGI page.
 #
+# Copyright   :  Written by and Copyright (C) 2001-2007 the SourceForge
+#                Privoxy team. http://www.privoxy.org/
+#
+#                This program is free software; you can redistribute it
+#                and/or modify it under the terms of the GNU General
+#                Public License as published by the Free Software
+#                Foundation; either version 2 of the License, or (at
+#                your option) any later version.
+#
+#                This program is distributed in the hope that it will
+#                be useful, but WITHOUT ANY WARRANTY; without even the
+#                implied warranty of MERCHANTABILITY or FITNESS FOR A
+#                PARTICULAR PURPOSE.  See the GNU General Public
+#                License for more details.
+#
+#                The GNU General Public License should be included with
+#                this file.  If not, you can view it at
+#                http://www.gnu.org/copyleft/gpl.html
+#                or write to the Free Software Foundation, Inc., 59
+#                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+#
+#########################################################################
 # 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
 #
 #   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
+#    The IP-address that the client used to reach Privoxy
 #  my-hostname:
 #    The hostname associated with my-ip-addr
 #  admin-address:
-#    The email address of the pxoxy's administrator, as configured
+#    The email address of the Privoxy administrator, as configured
 #    in the config file
 #  default-cgi:
-#    The URL for the "main menu" builtin CGI of this proxy
+#    The URL for Privoxy's "main menu" builtin CGI page
 #  menu:
 #    List of <li> elements linking to the other available CGIs
 #  version:
-#    The version number of the proxy software
+#    Privoxy's version number
 #  code-status:
-#    The development status of the proxy software: "alpha", "beta",
-#    or "stable".
+#    Privoxy's development status: "alpha", "beta", or "stable".
 #  homepage:
-#    The URL of the SourceForge ijbswa project, who maintains this
-#    software.
+#    The Privoxy web site.
 #
 # CONDITIONAL SYMBOLS FOR THIS TEMPLATE AND THEIR DEPANDANT SYMBOLS:
 # ------------------------------------------------------------------
@@ -53,7 +74,7 @@
 #  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
+#    An e-mail address for the local Privoxy administrator has
 #    been specified and is available through the "admin-address"
 #    symbol
 #  have-proxy-info:
 #    final:
 #      The actions that are associated with the URL at the end of
 #      the matching process
+#  no-forwarder: Requests to url will be made directly.
+#  http-forwarder:
+#      Requests to url will be made through a HTTP proxy
+#      forward-host:
+#         The IP address or its hostname
+#      forward-port.
+#         The proxy port
+#  socks-forwarder:
+#      Requests to url will be made through a socks proxy
+#      socks-type:
+#         The socks type: socks4 or socks4a
+#      gateway-host:
+#         The IP address or its hostname
+#      gateway-port:
+#         The proxy port.
 #
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
 <html>
   <title>Privoxy@@my-hostname@ URL Info</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 http-equiv="Content-Type" content="text/html; charset=UTF-8">
   <meta name="robots" content="noindex,nofollow">
   <link rel="stylesheet" type="text/css" href="@default-cgi@send-stylesheet">
+  <link rel="shortcut icon" href="@default-cgi@favicon.ico" type="image/x-icon">
+  <link rel="search" type="application/opensearchdescription+xml" title="Privoxy URL Info" href="/url-info-osd.xml">
 </head>
 
 <body>
 
-  <table cellpadding="20" cellspacing="10" border="0" width="100%">
+  <table summary="" 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>
+
+#include mod-title
+
       </td>
     </tr>
 
 # 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>
+
+#include mod-unstable-warning
+
       </td>
     </tr>
 <!-- if-unstable-end@ -->
 <!-- @if-url-given-start -->
     <tr>
       <td class="box">
+<!-- @if-valid-url-start -->
+        <h2>Forwarding settings:</h2>
+        <p>
+          Requests for <a href="@url@">@url@</a> will be <!--
+
+# "Interesting" formatting to prevent white space at the end of the sentence.
+
+          @if-no-forwarder-start -->
+
+             made <b>directly</b>, no forwarding settings apply<!--
+
+          if-no-forwarder-end@--><!--
+          @if-http-forwarder-start --><!-- @if-socks-forwarder-start -->
+
+             first <!--
+
+          if-socks-forwarder-end@ --><!-- if-http-forwarder-end@ --><!--
+          @if-socks-forwarder-start -->
+
+             forwarded through <b>@socks-type@-proxy @gateway-host@:@gateway-port@</b><!--
+
+          if-socks-forwarder-end@ --><!--
+          @if-http-forwarder-start --><!-- @if-socks-forwarder-start -->
+
+             and then <!--
+
+          if-socks-forwarder-end@ --><!-- if-http-forwarder-end@ --><!--
+          @if-http-forwarder-start -->
+
+             forwarded through <b>HTTP-proxy @forward-host@:@forward-port@</b><!--
+
+          if-http-forwarder-end@ -->.
+      </td>
+    </tr>
+    <tr>
+      <td class="box">
 <!-- @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>
+        <p>This is a HTTPS URL, so the part after the "/" is ignored
+          as Privoxy doesn't see the path for real HTTPS requests either.</p>
 <!-- if-https-end@ -->
+<!-- if-valid-url-end@ -->
         <h2>Matches for <a href="@url@">@url@</a>:</h2>
-        <p>@matches@</p>
+        @matches@
+<!-- @if-valid-url-start -->
+<!-- @if-cgi-editor-is-disabled-start -->
+        <p>
+          The CGI editor is currently disabled, thus no edit buttons are shown.<br>
+          Please have a look at the
+           <a href="@user-manual@config.html#ENABLE-EDIT-ACTIONS">enable-edit-actions documentation</a>
+          to learn how to enable it and what the risks are.
+        </p>
+<!--  if-cgi-editor-is-disabled-end@ -->
+<!-- @if-valid-url-end -->
       </td>
     </tr>
-
+<!-- @if-valid-url-start -->
+<!-- @if-filters-might-be-ineffective-start -->
+    <tr>
+      <td class="warning">
+        <h2>Warning:</h2>
+        <p>
+          This Privoxy version has been built without zlib support,
+          <strong>content filters will not work if the server sends compressed content.</strong>
+          Consider enabling the <a title="prevent-compression documentation"
+           href="@user-manual@actions-file.html#PREVENT-COMPRESSION">prevent-compression</a>
+          action for this URL or rebuild Privoxy with zlib support.
+        </p>
+      </td>
+    </tr>
+<!-- if-filters-might-be-ineffective-end@ -->
     <tr>
       <td class="box">
         <h2>Final results:</h2>
-        <p><b>@final@</b></p>
+        <b>@final@</b>
       </td>
     </tr>
+<!-- if-valid-url-end@ -->
 <!-- if-url-given-end@ -->
 
+<!-- @if-privoxy-is-toggled-off-start -->
+
+    <tr>
+      <td class="warning">
+        <h2>Warning:</h2>
+        <p>
+          <strong>Privoxy is currently toggled off. Matching actions will not apply
+          unless you <a href="@default-cgi@toggle?set=enable">toggle Privoxy on</a> first.</strong>
+        </p>
+      </td>
+    </tr>
+<!-- if-privoxy-is-toggled-off-end@ -->
+
     <tr>
       <td class="box">
-        <h2>Look up the actions for a 
+        <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">
           <p>
-            <input type="text" name="url" size="80" value="@url@"
+            <input type="text" name="url" size="80" value="@url@" class="url">
             <input type="submit" value="Go">
           </p>
         </form>
     <tr>
       <td class="box">
         <h2>More Privoxy:</h2>
-        <ul>@menu@</ul>
+        <ul>@menu@<li><a href="@user-manual@">Documentation</a></li></ul>
       </td>
     </tr>
 
+<!-- @if-have-help-info-start -->
     <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>
+
+#include mod-local-help
+
       </td>
     </tr>
+<!-- if-have-help-info-end@ -->
 
-<!-- @if-have-help-info-start -->
     <tr>
       <td class="info">
-        <h2>Local Privoxy support:</h2>
 
-<!-- @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@ -->
+#include mod-support-and-service
 
-<!-- @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@ -->
-    
 
-     <tr>
-      <td>
-        <p class="small">Valid <a href="http://validator.w3.org/">HTML 4.01 Strict</a></p>
-      </td>
-    </tr>   
   </table>
 
 </body>