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