Syncing with 3.0. This should be it for doc sources. Not all builds tested yet.
[privoxy.git] / doc / source / webserver / index.sgml
index eb42413..46fa09b 100644 (file)
@@ -5,23 +5,22 @@
 <!entity history SYSTEM "history.sgml">
 <!entity copyright SYSTEM "copyright.sgml">
 <!entity license SYSTEM "license.sgml">
-<!entity p-version "2.9.15">
-<!entity p-status "beta">
-<!entity % p-not-stable "INCLUDE">
+<!entity p-version SYSTEM "doc_version.tmp">
+<!entity p-status SYSTEM "doc_status.tmp">
+<!entity % p-not-stable "IGNORE">
 <!entity % p-stable "IGNORE">
-<!entity % p-text "IGNORE">        <!-- define we are not a text only doc -->
-<!entity % p-doc "INCLUDE">        <!-- and we are a formal doc           -->
-<!entity % p-readme "IGNORE">
 <!entity  my-copy "&copy;">        <!-- kludge for docbook2man            -->
+<!entity % p-homepage "IGNORE">    <!-- toggle for webserver index.html   -->
+<!entity % p-index "IGNORE">       <!-- toggle for local doc index        -->
 ]>
 <!--
  File        :  $Source: /cvsroot/ijbswa/current/doc/source/webserver/index.sgml,v $
 
- Purpose     :  Index file of the project's homepage
+ Purpose     :  Index file of the project's homepage and also documentation index
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
                 
- $Id: index.sgml,v 1.13 2002/05/05 20:29:59 hal9 Exp $
+ $Id: index.sgml,v 1.16.2.8 2002/08/16 03:05:42 hal9 Exp $
 
  Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
  See LICENSE.
  anything in this, or other Privoxy documentation. 
  ========================================================================
 
- Note: This is the privoxy home page. The Makefile is adding additional
- meta data and content via perl.
+ Note: This is the Privoxy home page *and* builds a page that can be 
+ used with local documentation as a focal point for docs or other points
+ of interest. The Makefile is adding additional meta data and content via
+ perl.
 
+ Generates: index.html, for webserver home page.
+            privoxy-index.html, for packaging with docs
 -->
 
 <article id="index">
-
 <artheader>
-<title>Privoxy - Homepage</title>
+ <title>Privoxy - <![%p-homepage;[Home Page]]><![%p-index;[The Privacy Enhancing Proxy]]></title>
+ <![%p-index;[<subtitle>Project Index Page v&p-version;</subtitle>]]>
 
 <!-- copyright is at bottom of page -->
 
-<keywordset>
- <Keyword>stop, junk, privoxy, ad, advertisement, werbung, busters, junkbusters, junkbuster, mail, email, e-mail, direct, spam, spamoff, declare, telemarketing, telemarketers, privacy, sharing, names, renting, direct, marketing, database, databases, junk mail, lists, environment, conservation, recycling, catalogs, consumer, sending, opt out</Keyword>
-</keywordset>
-
-<abstract>
-<![%dummy;[
- <para>
- <comment>
-  This is here to keep vim syntax file from breaking :/
-  If I knew enough to fix it, I would.
-  PLEASE DO NOT REMOVE! HB: hal@foobox.net
- </comment>
- </para>
-]]>
+ <keywordset>
+  <keyword>privoxy</keyword> <keyword>HTTP</keyword> <keyword>proxy</keyword> <keyword>privacy</keyword>
+  <keyword>popups</keyword>  <keyword>po-ups</keyword> <keyword>HTML</keyword> <keyword>JavaScript</keyword>
+  <keyword>cleaning</keyword> <keyword>blocking</keyword> <keyword>cleaner</keyword> <keyword>blocker</keyword>
+  <keyword>filter</keyword> <keyword>proxy</keyword> <keyword>junk</keyword> <keyword>ad</keyword>
+  <keyword>advertisement</keyword> <keyword>banner</keyword> <keyword>webbugs</keyword>
+  <keyword>web-bugs</keyword> <keyword>werbung</keyword> <keyword>junkbusters</keyword>
+  <keyword>junkbuster</keyword>
+ </keywordset>
 
-</abstract>
+ <abstract>
 
-</artheader>
 
-<!--   ~~~~~       New section      ~~~~~     -->
-<sect1 id="intro" label="">
-<title>Introduction</title>
 <!-- Include privoxy.sgml boilerplate: -->
- &p-intro;
 &p-intro;
 <!-- end boilerplate -->
-</sect1>
 
-<sect1 id="moreinfo" label="">
-<title>More info</title>
+<![%p-homepage;[
+  <para>
+   The most recent release is &p-version; (&p-status;). 
+  </para>
+]]>
+
+ </abstract>
+</artheader>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+
+
+<sect1 renderas="sect2" id="download" label=""><title>Download</title>
 <para>
-<itemizedlist>
-       <listitem>
-       <literallayout class="normal">
-       The <ulink url="http://sourceforge.net/projects/ijbswa/">project
-page</ulink> on Sourceforge
-       </literallayout>
-       </listitem>
-       <listitem>
-       <literallayout>
-       A list of <ulink url="user-manual/introduction.html#AEN37">features</ulink>
-       </literallayout>
-       </listitem>
-       <listitem>
-       <literallayout class="normal">
-       <ulink url="http://www.waldherr.org/junkbuster/">Stefan Waldherr's site</ulink>
-       </literallayout>
-       </listitem>
-       <listitem>
-       <literallayout class="normal">
-       <ulink url="http://www.junkbusters.com/ht/en/ijbfaq.html">Junkbusters Corporation</ulink>
-       </literallayout>
-       </listitem>
-<!--   <listitem> -->
-<!--   <literallayout class="normal"> -->
-<!--   Take a look at the <ulink url="team/">Privoxy team</ulink> -->
-<!--   </literallayout> -->
-<!--   </listitem> -->
+ <itemizedlist>
+  <listitem>
+   <para>
+    <ulink url="http://sourceforge.net/project/showfiles.php?group_id=11118">Download recent releases</ulink>
+   </para>
+  </listitem>
+  <listitem>
+   <para>
+    <ulink url="http://cvs.sourceforge.net/cvstarballs/ijbswa-cvsroot.tar.gz">Download the latest CVS snapshot (source tarball)</ulink>
+   </para>
+  </listitem>
+  <listitem>
+   <para>
+    <ulink url="user-manual/quickstart.html">Quickstart after installation</ulink>
+   </para>
+  </listitem>
  </itemizedlist>
 </para>
 </sect1>
 
-<sect1 id="download" label="">
-<title>Download</title>
+<sect1 renderas="sect2" id="docs" label=""><title>Documentation</title>
 <para>
-<itemizedlist>
-       <listitem>
-       <literallayout class="normal">
-       <ulink url="http://sourceforge.net/project/showfiles.php?group_id=11118">Download recent releases</ulink>
-       </literallayout>
-       </listitem>
-       <listitem>
-       <literallayout class="normal">
-       <ulink url="user-manual/quickstart.html">Quickstart after installation</ulink>
-       </literallayout>
-       </listitem>
-       <listitem>
-       <literallayout class="normal">
-       <ulink url="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/current/">Browse our CVS repository</ulink>
-       </literallayout>
-       </listitem>
+ <itemizedlist>
+  <listitem>
+   <para>
+    <ulink url="user-manual/index.html">User manual</ulink>
+   </para>
+  </listitem>
+  <listitem>
+   <para>
+    <ulink url="faq/index.html">Frequently Asked Questions</ulink>
+   </para>
+  </listitem>
+  <listitem>
+   <para>
+    <ulink url="developer-manual/index.html">Developer Manual</ulink>
+   </para>
+  </listitem>
+<![%p-homepage;[
+<!-- not included for local installation index page -->
+  <listitem>
+   <para>
+    <ulink url="pdf/privoxy-pdf-docs.zip">The above docs as PDF in Zip archive</ulink>
+   </para>
+  </listitem> ]]>
+  <listitem>
+   <para>
+    <ulink url="man-page/privoxy-man-page.html">Classic Man Page</ulink>
+   </para>
+  </listitem>
  </itemizedlist>
 </para>
 </sect1>
 
-<sect1 id="docs" label="">
-<title>Documentation</title>
+<sect1 renderas="sect2" id="moreinfo" label=""><title>More information</title>
 <para>
-<itemizedlist>
-       <listitem>
-       <literallayout class="normal">
-       <ulink url="user-manual/index.html">User manual</ulink>
-       </literallayout>
-       </listitem>
-       <listitem>
-       <literallayout class="normal">
-       <ulink url="faq/index.html">Frequently Asked Questions</ulink>
-       </literallayout>
-       </listitem>
-       <listitem>
-       <literallayout class="normal">
-       <ulink url="man-page/privoxy-man-page.html">Classic Man Page</ulink>
-       </literallayout>
-       </listitem>
-       <listitem>
-       <literallayout class="normal">
-       <ulink url="team/index.html">Pictures of the Privoxy Team</ulink>
-       </literallayout>
-       </listitem>
-       <listitem>
-       <literallayout class="normal">
-       <ulink url="developer-manual/index.html">Developer Manual</ulink>
-<!--   ,alternatively as a pdf file: <ulink url="">developer-manual.pdf</ulink>. -->
-       </literallayout>
-       </listitem>
+ <itemizedlist>
+  <listitem>
+   <para>
+    <ulink url="user-manual/contact.html">Support &amp; Service</ulink>
+   </para>
+  </listitem>
+  <listitem>
+   <para>
+    <ulink url="user-manual/copyright.html">Copyright, License, History & Authors</ulink>
+   </para>
+  </listitem>
+  <listitem>
+   <para>
+    <ulink url="user-manual/introduction.html#FEATURES">List of (new) Features</ulink>
+   </para>
+  </listitem>
+  <listitem>
+   <para>
+    <ulink url="http://sourceforge.net/projects/ijbswa/">The project page</ulink> at <ulink url="http://sourceforge.net/">SourceForge</ulink>
+   </para>
+  </listitem>
+  <listitem>
+   <para>
+    <ulink url="user-manual/seealso.html">Related links</ulink>
+   </para>
+  </listitem>
+  <listitem>
+   <para>
+    <!-- please leave this link absolute so this file can be bundled with -->
+    <!-- documentation and still used locally -->
+    <ulink url="http://privoxy.org/team/index.html">Pictures of the Privoxy Team</ulink>
+   </para>
+  </listitem>
  </itemizedlist>
 </para>
 </sect1>
 
-<sect1 id="support" label="">
-<title>Support and Service via Sourceforge</title>
-<!-- Include contacting.sgml -->
- &contacting;
-<!-- end include -->
-</sect1>
-
-<sect1 label="">
-<title>License</title>
-<!-- Include copyright.sgml -->
- &copyright;
-<!-- end -->
-<!-- Include license.sgml -->
- &license;
-<!-- end -->
-</sect1>
-
-<sect1 label="">
-<title>History</title>
-<!-- Include history.sgml -->
- &history;
-<!-- end -->
-</sect1>
-
-
+<![%p-homepage;[
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect1 label="">
 <!-- dummy section, for spacing -->
@@ -195,19 +181,22 @@ page</ulink> on Sourceforge
 <informaltable frame=none label="" pgwide="1">
  <tgroup cols=1 align="center" colsep=1 rowsep=1>
   <colspec colname=c1 align="center">
-   <tbody>
-    <row>
-     <entry align="center">
-      <ulink url="http://sourceforge.net/">
-       <inlinegraphic  fileref="http://sourceforge.net/sflogo.php?group_id=11118&#38;type=1&#38;dummy=.gif"></inlinegraphic>
-      </ulink>
+  <tbody>
+   <row>
+    <entry align="center">Privoxy is developed on:</entry>
+   </row>
+   <row>
+    <entry align="center">
+     <ulink url="http://sourceforge.net/">
+      <inlinegraphic  fileref="http://sourceforge.net/sflogo.php?group_id=11118&#38;type=1&#38;dummy=.gif"></inlinegraphic>
+     </ulink>
     </entry>
    </row>
   </tbody>
  </tgroup>
 </informaltable>
 </para>
-
+]]>
 
 <!--
 <informalfigure pgwide="1">
@@ -217,6 +206,12 @@ page</ulink> on Sourceforge
 </informalfigure>
 -->
 
+
+<![%p-index;[
+<sect1 label=""><title></title>
+<!-- dummy section for layout and spacing -->
+]]>
+
 <!-- Formal copyright markup does not work here. HB. -->
 <para>
  <subscript>
@@ -247,6 +242,46 @@ page</ulink> on Sourceforge
  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
  $Log: index.sgml,v $
+ Revision 1.16.2.8  2002/08/16 03:05:42  hal9
+ Put all pdf docs in a zip archive now.
+
+ Revision 1.16.2.7  2002/08/14 16:40:00  hal9
+ Add links to pdf docs.
+
+ Revision 1.16.2.6  2002/07/26 15:22:15  oes
+ Most recent release now inserted automatically (again)
+
+ Revision 1.16.2.5  2002/06/09 18:59:16  hal9
+ Correct typo.
+
+ Revision 1.16.2.4  2002/06/09 16:36:33  hal9
+ Clarifications on filtering and MIME. Hardcode 'latest release' in index.html.
+
+ Revision 1.16.2.3  2002/05/28 02:31:38  hal9
+ New file, privoxy-index.html, for bundling with documentation. Built from
+ index.sgml, like homepage, but with content toggles more suitable for this use.
+
+ Revision 1.16.2.2  2002/05/26 22:04:46  hal9
+ Add several comments, and reworded 'most recent release', ie we don't officially
+ release odd numbered versions.
+
+ Revision 1.16.2.1  2002/05/26 17:40:02  hal9
+ Make team pictures link absolute for docs.
+
+ Revision 1.16  2002/05/24 10:06:31  oes
+ Nit
+
+ Revision 1.15  2002/05/24 00:02:05  oes
+ Tried to make more useful and concise:
+   Reordered, no more TOC, link to instead of include info,
+   added some links. Should we use the free space to better
+   describe what Privoxy is good for?
+
+ Revision 1.14  2002/05/10 01:48:20  hal9
+ This is mostly proposed copyright/licensing additions and changes. Docs
+ are still GPL, but licensing and copyright are more visible. Also, copyright
+ changed in doc header comments (eliminate references to JB except FAQ).
+
  Revision 1.13  2002/05/05 20:29:59  hal9
  Ooops, fixing an accidental delete of title element.