Show enablement/disablement status in almost all templates.
[privoxy.git] / templates / show-status-file
1 ##########################################################
2 #
3 # Show-Status-CGI Output template for junkbuster 2.9.x
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 Junkbuster.
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 Junkbuster 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 <html>
77
78 <head>
79   <title>Junkbuster@@my-hostname@: Contents of @file-description@</title>
80   <style type="text/css">
81     BODY, P, H1, H2, UL, OL, LI { font-family: Helvetica, Helv, Arial, Sans-Serif, sans-serif }
82   </style>
83 </head>
84
85 <body bgcolor="#ffffff">
86
87   <table cellpadding=20 cellspacing=10 border=0 width=100%>
88     <tr>
89       <td bgcolor=#dddddd>
90         <p><font size=+2><b>This is the Internet J</b></font><font size=+1><b>UNK<i></font><font color="red">BUSTER</font></i></b>
91           <font size=+2><b> @version@ on @my-hostname@ (@my-ip-address@), port @my-port@, @if-enabled-display-then@Enabled@else-not-enabled-display@Disabled@endif-enabled-display@</b></font></p>
92       </td>
93     </tr>
94
95 <!-- @if-unstable-start -->
96 # This will only appear if CODE_STATUS is "alpha" or "beta". See configure.in
97     <tr>
98       <td bgcolor=#ffdddd>
99         <p><b>Please note that this <font color=red>@code-status@</font> release
100           of the proxy software is not intended for production systems!
101           <br>Use at your own risk. See the <a href="http://www.gnu.org/copyleft/gpl.html">license</a> for details.</b>
102         </p>
103
104         <p>Feel free to <a href=mailto:ijbswa-developers@lists.sourceforge.net>mail the developers</a>
105           with any problems you encounter.
106         </p>
107       </td>
108     </tr>
109 <!-- if-unstable-end@ -->
110
111     <tr>
112       <td bgcolor=#eeeeee>
113         <h2>Contents of @file-description@ (@filepath@)</h2>
114         <blockquote><pre>@contents@</pre></blockquote>
115       </td>
116     </tr>
117  
118 <!-- @if-have-help-info-start -->
119     <tr>
120       <td bgcolor=#dddddd>
121         <h2>Local Junkbuster support:</h2>
122
123 <!-- @if-have-proxy-info-start -->
124         <p>You can consult the <a href="@proxy-info-url@">online documentation</a> for more information about this Junkbuster installation.         
125 <!-- if-have-proxy-info-end@ -->
126
127 <!-- @if-have-adminaddr-info-start -->
128         <p>Address e-mail questions about this service to
129           <a href=mailto:@admin-address@><code>@admin-address@</code></a>,
130           who will be glad to help you.
131 <!-- if-have-adminaddr-info-end@ -->
132
133         </p>
134       </td>
135     </tr>
136 <!-- if-have-help-info-end@ -->
137
138   </table>
139
140 </body>
141 </html>