c60e0c131fa54740ee7bbaa55a54e19c114b7bbc
[privoxy.git] / templates / toggle
1 ##########################################################
2 #
3 # Toggle 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 <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 # CONDITIONAL SYMBOLS FOR THIS TEMPLATE AND THEIR DEPANDANT SYMBOLS:
51 # ------------------------------------------------------------------
52 #
53 #  unstable:
54 #    this is an alpha or beta release of the proxy software
55 #  have-adminaddr-info:
56 #    An e-mail address for the local Privoxy adminstrator has
57 #    been specified and is available through the "admin-address"
58 #    symbol
59 #  have-proxy-info:
60 #    A URL for online documentation about this proxy has been
61 #    specified and is available through the "proxy-info-url"
62 #    symbol
63 #  have-help-info:
64 #    If either have-proxy-info is true or have-adminaddr-info is
65 #    true, have-help-info is true.  Used to conditionally include
66 #    a grey box for any and all help info.
67 #  @if-enabled-display-then@ on @else-not-enabled-display@ off @endif-enabled-display@
68 #
69 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
70 <html>
71
72 <head>
73   <title>@if-enabled-display-then@Enabled@else-not-enabled-display@Disabled@endif-enabled-display@ - Privoxy@@my-hostname@</title>
74   <meta http-equiv="Content-Style-Type" content="text/css">
75   <meta http-equiv="Content-Script-Type" content="text/javascript">
76   <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
77   <meta name="robots" content="noindex,nofollow">
78   <link rel="stylesheet" type="text/css" href="@default-cgi@send-stylesheet">
79 </head>
80
81 <body>
82
83   <table cellpadding="20" cellspacing="10" border="0" width="100%">
84     <tr>
85       <td class="title">
86
87 #include mod-title
88
89       </td>
90     </tr>
91
92 <!-- @if-unstable-start -->
93 # This will only appear if CODE_STATUS is "alpha" or "beta". See configure.in
94     <tr>
95       <td class="warning">
96
97 #include mod-unstable-warning
98
99       </td>
100     </tr>
101 <!-- if-unstable-end@ -->
102
103     <tr>
104       <td class="box">
105         <h2>Privoxy is @if-enabled-display-then@Enabled@else-not-enabled-display@Disabled@endif-enabled-display@</h2>
106           <p>When enabled, Privoxy performs its magic - blocking
107             adverts, filtering cookies, regex-filtering, etc.</p>
108           <p>When disabled, Privoxy behaves as a normal HTTP proxy,
109             and will not affect your web browsing.</p>
110           <p><a href="@default-cgi@toggle?set=@if-enabled-display-then@disable@else-not-enabled-display@enable@endif-enabled-display@">Click
111             here</a> to @if-enabled-display-then@disable@else-not-enabled-display@enable@endif-enabled-display@ Privoxy.</p>
112       </td>
113     </tr>
114
115     <tr>
116       <td class="box">
117         <h2>Bookmarklets</h2>
118           <p>Here are some bookmarklets to allow you to easily access a
119             "mini" version of this page.  They are known to work with MS 
120             Internet Explorer, Netscape and Mozilla, but should work equally
121             well in other browsers which support JavaScript.  They are designed
122             to run directly from your bookmarks - <b>not</b> by clicking the
123             links below (although that will work for testing).
124           </p>
125           <p>To save them, right-click the link and choose
126             "Add to Favorites" (IE) or "Add Bookmark" (Netscape).  You
127             will get a warning that the bookmark "may not be safe" - just
128             click OK.  Then you can run the Bookmarklet directly from your
129             favourites/bookmarks.  For even faster access, you can put
130             them on the "Links" bar (IE) or the "Personal Toolbar"
131             (Netscape), and run them with a single click.
132           </p>
133
134           <ul>
135             <li><a href="javascript:void(window.open('@default-cgi@toggle?mini=y&amp;set=enabled','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Privoxy - Enable</a></li>
136             <li><a href="javascript:void(window.open('@default-cgi@toggle?mini=y&amp;set=disabled','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Privoxy - Disable</a></li>
137             <li><a href="javascript:void(window.open('@default-cgi@toggle?mini=y&amp;set=toggle','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Privoxy - Toggle Privoxy</a>
138                   (Toggles between enabled and disabled)</li>
139             <li><a href="javascript:void(window.open('@default-cgi@toggle?mini=y','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Privoxy - View Status</a></li>
140           </ul>
141
142           <p>
143             <b>Credit:</b> The site which gave us the general idea for these
144             bookmarklets is <a href="http://www.bookmarklets.com/">www.bookmarklets.com</a>.
145             They have <a href="http://www.bookmarklets.com/about/">more information</a> about them.
146           </p>
147       </td>
148     </tr>
149
150     <tr>
151       <td class="box">
152         <h2>More Privoxy:</h2>
153         <ul>@menu@<li><a href="@user-manual@">Documentation</a></li></ul>
154       </td>
155     </tr>
156
157     <tr>
158       <td class="info">
159
160 #include mod-support-and-service
161
162       </td>
163     </tr>
164
165 <!-- @if-have-help-info-start -->
166     <tr>
167       <td class="info">
168
169 #include mod-local-help
170
171       </td>
172     </tr>
173 <!-- if-have-help-info-end@ -->
174     
175
176      <tr>
177       <td>
178         <p class="small">Valid <a href="http://validator.w3.org/">HTML 4.01 Strict</a></p>
179       </td>
180     </tr>   
181   </table>
182
183 </body>
184 </html>
185