Move all doc build stuff to doc/source/GNUmakefile, leaving a 'make dok'
[privoxy.git] / templates / show-request
1 ##########################################################
2 #
3 # Show-Request-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 <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 #  client-request:
50 #    The request and headers that the client sent.
51 #  processed-request:
52 #    What we would have rewritten this request to, if this had not
53 #    been intercepted.
54 #
55 # CONDITIONAL SYMBOLS FOR THIS TEMPLATE AND THEIR DEPANDANT SYMBOLS:
56 # ------------------------------------------------------------------
57 #
58 #  unstable:
59 #    this is an alpha or beta release of the proxy software
60 #  have-adminaddr-info:
61 #    An e-mail address for the local Privoxy adminstrator has
62 #    been specified and is available through the "admin-address"
63 #    symbol
64 #  have-proxy-info:
65 #    A URL for online documentation about this proxy has been
66 #    specified and is available through the "proxy-info-url"
67 #    symbol
68 #  have-help-info:
69 #    If either have-proxy-info is true or have-adminaddr-info is
70 #    true, have-help-info is true.  Used to conditionally include
71 #    a grey box for any and all help info.
72 #
73 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
74 <html>
75
76 <head>
77   <title>Privoxy@@my-hostname@</title>
78   <meta http-equiv="Content-Style-Type" content="text/css">
79   <meta http-equiv="Content-Script-Type" content="text/javascript">
80   <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
81   <meta name="robots" content="noindex,nofollow">
82   <link rel="stylesheet" type="text/css" href="@default-cgi@send-stylesheet">
83 </head>
84
85 <body>
86
87   <table cellpadding="20" cellspacing="10" border="0" width="100%">
88     <tr>
89       <td class="title">
90
91 #include mod-title
92
93       </td>
94     </tr>
95
96 <!-- @if-unstable-start -->
97 # This will only appear if CODE_STATUS is "alpha" or "beta". See configure.in
98     <tr>
99       <td class="warning">
100
101 #include mod-unstable-warning
102
103       </td>
104     </tr>
105 <!-- if-unstable-end@ -->
106
107     <tr>
108       <td class="box">
109         <h2>Show-Request</h2>
110           <p>
111             Here you see the original headers that your client sent when requesting this page, along with
112             the headers that Privoxy would have sent to the remote server if this request hadn't been
113             intercepted. 
114           </p>
115
116         <h3>Original Client Request:</h3>
117         <pre>@client-request@</pre>
118
119         <h3>Processed Request:</h3>
120        <pre>@processed-request@</pre>
121
122       </td>
123     </tr>
124
125      <tr>
126       <td class="box">
127         <h2>More Privoxy:</h2>
128         <ul>@menu@</ul>
129       </td>
130     </tr>
131
132     <tr>
133       <td class="info">
134
135 #include mod-support-and-service
136
137       </td>
138     </tr>
139
140 <!-- @if-have-help-info-start -->
141     <tr>
142       <td class="info">
143
144 #include mod-local-help
145
146       </td>
147     </tr>
148 <!-- if-have-help-info-end@ -->
149
150      <tr>
151       <td>
152         <p class="small">Valid <a href="http://validator.w3.org/">HTML 4.01 Strict</a></p>
153       </td>
154     </tr>   
155   </table>
156
157 </body>
158 </html>