More minor updates per Fabian's suggestions. Now have two distinct categories
[privoxy.git] / doc / source / contacting.sgml
1 <!--
2  File        :  $Source: /cvsroot/ijbswa/current/doc/source/contacting.sgml,v $
3
4  Purpose     :  Entity included in other project documents.
5                 
6  $Id: contacting.sgml,v 2.4 2006/08/27 15:04:14 hal9 Exp $
7
8  Copyright (C) 2001 - 2006 Privoxy Developers <developers@privoxy.org>
9  See LICENSE.
10
11  ======================================================================
12   This file used for inclusion with other documents only.
13  ======================================================================
14
15  This file is included into:
16
17   faq
18   developer-manual
19   README
20   user-manual
21   webserver/index.sgml
22   announce.sgml
23
24 -->
25
26 <!-- READ: -->
27 <!-- Careful of the literallayout tags and finished formatting -->
28
29 <para>
30  We value your feedback. In fact, we rely on it to improve
31  <application>Privoxy</application> and its configuration.
32  However, please note the following hints, so we can 
33  provide you with the best support:
34 </para>
35
36 <sect2 id="contact-support"><title>Get Support</title>
37 <para>
38  For casual users, our 
39  <ulink url="http://sourceforge.net/tracker/?group_id=11118&#38;atid=211118">support forum at SourceForge</ulink>
40  is probably best suited:
41  <ulink url="http://sourceforge.net/tracker/?group_id=11118&#38;atid=211118">http://sourceforge.net/tracker/?group_id=11118&#38;atid=211118</ulink>
42 </para>
43
44 <para>
45  All users are of course welcome to discuss their issues on the <ulink
46  url="http://lists.sourceforge.net/lists/listinfo/ijbswa-users">users
47  mailing list</ulink>, where the developers also hang around.
48 </para>
49
50 </sect2>
51
52 <sect2 id="reporting"><title>Reporting Problems</title>
53 <para>
54 <quote>Problems</quote> for our purposes, come in two forms:
55 </para>
56  <itemizedlist>
57
58   <listitem>
59    <para>
60     Configuration issues, such as ads that slip through, or sites that 
61     don't function properly due to one <application>Privoxy</application> 
62     <quote>action</quote> or another being turned <quote>on</quote>.
63    </para>
64   </listitem> 
65
66   <listitem>
67    <para>
68     <quote>Bugs</quote> in the programming code that makes up 
69     <application>Privoxy</application>, such as that might cause a crash.
70    </para>
71   </listitem> 
72 </itemizedlist>
73
74
75 <sect3 id="contact-ads"><title>Reporting Ads or Other Configuration Problems</title>
76 <para>
77  Please send feedback on ads that slipped through, innocent images that were
78  blocked, and any other configuration related problem of 
79  <filename>default.action</filename> file, to the 
80  <ulink url="mailto:ijbswa-developers@lists.sourceforge.net">developers mailing 
81  list</ulink>.
82 </para> 
83
84 <para>
85  New, improved <filename>default.action</filename> files may occasionally be made
86  available based on your feedback. These will be announced on the <ulink
87  url="http://lists.sourceforge.net/lists/listinfo/ijbswa-announce">ijbswa-announce</ulink>
88  list and available from our the <ulink
89  url="http://sourceforge.net/project/showfiles.php?group_id=11118">files section</ulink> of
90  our <ulink url="http://sf.net/projects/ijbswa/">project page</ulink>.
91 </para>
92 </sect3>
93
94
95 <sect3 id="contact-bugs"><title>Reporting Bugs</title>
96 <para>
97  Please report all bugs <emphasis>only</emphasis> through our
98  bug tracker: 
99  <ulink url="http://sourceforge.net/tracker/?group_id=11118&#38;atid=111118">http://sourceforge.net/tracker/?group_id=11118&#38;atid=111118</ulink>. 
100 </para>
101
102 <para>
103   Before doing so, please make sure that the bug has <emphasis>not already been submitted</emphasis>
104   and observe the additional hints at the top of the <ulink
105   url="http://sourceforge.net/tracker/?func=add&amp;group_id=11118&amp;atid=111118">submit
106   form</ulink>.
107 </para>
108
109 <para> 
110   Please try to verify that it is a <application>Privoxy</application> bug,
111   and not a browser or site bug first. If unsure,
112   try <ulink url="javascript:void(window.open('http://config.privoxy.org/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());">toggling
113   off</ulink> <application>Privoxy</application>, and see if the problem persists.
114   If you are using your own custom configuration, please try
115   the stock configs to see if the problem is configuration related.
116 </para>
117
118 <para>
119   If not using the latest version, the bug may have been found
120   and fixed in the meantime. We would appreciate if you could take the time
121   to <ulink url="http://www.privoxy.org/user-manual/installation.html">upgrade
122   to the latest version</ulink> (or  even the latest CVS snapshot) and verify
123   your bug.
124 </para>
125 <para>
126 Please be sure to provide the following information:
127 </para>
128 <para>
129  <itemizedlist>
130
131   <listitem>
132    <para>
133     The exact <application>Privoxy</application> version of the proxy software
134 (if you got the source from CVS, please also give the date).
135    </para>
136   </listitem> 
137
138   <listitem>
139    <para>
140     The operating system and verions you run
141     <application>Privoxy</application> on, (e.g. <application>Windows
142     XP</application>).
143    </para>
144   </listitem> 
145
146   <listitem>
147    <para>
148     The name, platform, and version of the <application>browser</application> 
149     you were using (e.g. <application>Internet Explorer v5.5</application> for Mac).
150    </para>
151   </listitem>
152
153   <listitem>
154    <para>
155     The URL where the problem occurred, or some way for us to duplicate the
156     problem (e.g. <literal>http://somesite.example.com?somethingelse=123</literal>). 
157    </para>
158   </listitem> 
159
160   <listitem>
161    <para>
162     Whether your version of <application>Privoxy</application> is one supplied
163     by the developers of <application>Privoxy</application> via SourceForge,
164     or somewhere else.
165    </para>
166   </listitem> 
167
168   <listitem>
169    <para>
170     Whether you are using <application>Privoxy</application> in tandem with 
171     another proxy such as <application>TOR</application>. If so, please try 
172     disabling the other proxy.
173    </para>
174   </listitem> 
175
176   <listitem>
177    <para>
178     Whether you are using a personal firewall product. If so, does 
179     <application>Privoxy</application> work without it?
180    </para>
181   </listitem> 
182
183   <listitem>
184    <para>
185     Any other pertinent information to help identify the problem such as config
186     or log file excerpts (yes, you should have log file entries for each
187     action taken).
188    </para>
189   </listitem> 
190
191   <listitem>
192    <para>
193     <emphasis>Please provide your SF login, or email address</emphasis>, in case we 
194     need to contact you.
195    </para>
196   </listitem> 
197
198 </itemizedlist>
199 </para>
200 <para>
201   The <ulink url="http://www.privoxy.org/user-manual/appendix.html#ACTIONSANAT">appendix
202   of the user manual</ulink> also has helpful information 
203   on understanding <literal>actions</literal>, and <literal>action</literal> debugging. 
204 </para>
205 </sect3>
206 </sect2>
207
208 <sect2 id="contact-feature"><title>Request New Features</title>
209 <para>
210  You are welcome to submit ideas on new features or other proposals
211  for improvement through our feature request tracker at
212  <ulink url="http://sourceforge.net/tracker/?atid=361118&#38;group_id=11118">http://sourceforge.net/tracker/?atid=361118&#38;group_id=11118</ulink>.
213 </para>
214 </sect2>
215
216 <sect2 id="contact-other"><title>Other</title>
217 <para>
218 For any other issues, feel free to use the mailing lists. Technically interested users
219 and people who wish to contribute to the project are also welcome on the developers list!
220 You can find an overview of all <application>Privoxy</application>-related mailing lists,
221 including list archives, at:
222 <ulink url="http://sourceforge.net/mail/?group_id=11118">http://sourceforge.net/mail/?group_id=11118</ulink>.
223 </para>
224 </sect2>