Add Documentation Link to menu.
[privoxy.git] / templates / show-url-info
1 ##########################################################
2 #
3 # Show-Url-Info-CGI Output template for Privoxy.
4 #
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 
41          <li> elements linking to the other available CGIs
42 #  version:
43 #    The version number of the proxy software
44 #  code-status:
45 #    The development status of the proxy software: "alpha", "beta",
46 #    or "stable".
47 #  homepage:
48 #    The URL of the SourceForge ijbswa project, who maintains this
49 #    software.
50 #
51 # CONDITIONAL SYMBOLS FOR THIS TEMPLATE AND THEIR DEPANDANT SYMBOLS:
52 # ------------------------------------------------------------------
53 #
54 #  unstable:
55 #    this is an alpha or beta release of the proxy software
56 #  have-adminaddr-info:
57 #    An e-mail address for the local Privoxy adminstrator has
58 #    been specified and is available through the "admin-address"
59 #    symbol
60 #  have-proxy-info:
61 #    A URL for online documentation about this proxy has been
62 #    specified and is available through the "proxy-info-url"
63 #    symbol
64 #  have-help-info:
65 #    If either have-proxy-info is true or have-adminaddr-info is
66 #    true, have-help-info is true.  Used to conditionally include
67 #    a grey box for any and all help info.
68 #  url-given:
69 #    The CGI was called with a url parameter. In that case, the
70 #    following symbols are available:
71 #    url:
72 #      The given URL
73 #    default:
74 #      The system default for actions
75 #    matches:
76 #      The list of all matches in the actions file that this URL
77 #      produced, along with the actions that were triggered by
78 #      these matches
79 #    final:
80 #      The actions that are associated with the URL at the end of
81 #      the matching process
82 #
83 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
84 <html>
85
86 <head>
87   <title>Privoxy@@my-hostname@ URL Info</title>
88   <meta http-equiv="Content-Style-Type" content="text/css">
89   <meta http-equiv="Content-Script-Type" content="text/javascript">
90   <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
91   <meta name="robots" content="noindex,nofollow">
92   <link rel="stylesheet" type="text/css" href="@default-cgi@send-stylesheet">
93 </head>
94
95 <body>
96
97   <table cellpadding="20" cellspacing="10" border="0" width="100%">
98     <tr>
99       <td class="title">
100
101 #include mod-title
102
103       </td>
104     </tr>
105
106 <!-- @if-unstable-start -->
107 # This will only appear if CODE_STATUS is "alpha" or "beta". See configure.in
108     <tr>
109       <td class="warning">
110
111 #include mod-unstable-warning
112
113       </td>
114     </tr>
115 <!-- if-unstable-end@ -->
116
117 <!-- @if-url-given-start -->
118     <tr>
119       <td class="box">
120 <!-- @if-https-start -->
121         <h2>NOTE:</h2>
122         <p>This is a secure (https:) URL, so the part after the "/" is ignored.
123           This is a feature of the HTTPS protocol - the exact address of the
124           page you're visiting is hidden.  Privoxy can only detect the host
125           part of the URL.</p>
126         <p>&nbsp;</p>
127 <!-- if-https-end@ -->
128         <h2>Matches for <a href="@url@">@url@</a>:</h2>
129         <p>@matches@</p>
130       </td>
131     </tr>
132
133     <tr>
134       <td class="box">
135         <h2>Final results:</h2>
136         <p><b>@final@</b></p>
137       </td>
138     </tr>
139 <!-- if-url-given-end@ -->
140
141     <tr>
142       <td class="box">
143         <h2>Look up the actions for a 
144 <!-- @if-url-given-start -->new<!-- if-url-given-end@ -->
145           URL:</h2>
146         <form method="GET" action="@default-cgi@show-url-info">
147           <p>
148             <input type="text" name="url" size="80" value="@url@"> 
149             <input type="submit" value="Go">
150           </p>
151         </form>
152       </td>
153     </tr>
154
155     <tr>
156       <td class="box">
157         <h2>More Privoxy:</h2>
158         <ul>@menu@
159          <li><a href="@user-manual@">Documentation</a></li>
160         </ul>
161       </td>
162     </tr>
163
164     <tr>
165       <td class="info">
166
167 #include mod-support-and-service
168
169       </td>
170     </tr>
171
172 <!-- @if-have-help-info-start -->
173     <tr>
174       <td class="info">
175
176 #include mod-local-help
177
178       </td>
179     </tr>
180 <!-- if-have-help-info-end@ -->
181     
182
183      <tr>
184       <td>
185         <p class="small">Valid <a href="http://validator.w3.org/">HTML 4.01 Strict</a></p>
186       </td>
187     </tr>   
188   </table>
189
190 </body>
191 </html>