<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
File : $Source: /cvsroot/ijbswa/current/doc/source/developer-manual.sgml,v $
- Purpose : FAQ
+ Purpose : developer manual
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: developer-manual.sgml,v 1.1 2001/09/12 15:36:41 swa Exp $
+ $Id: developer-manual.sgml,v 1.4 2001/09/23 10:13:48 swa Exp $
Written by and Copyright (C) 2001 the SourceForge
IJBSWA team. http://ijbswa.sourceforge.net
<artheader>
<title>Junkbuster Developer Manual</title>
- <pubdate>$Id: developer-manual.sgml,v 1.1 2001/09/12 15:36:41 swa Exp $</pubdate>
+ <pubdate>$Id: developer-manual.sgml,v 1.4 2001/09/23 10:13:48 swa Exp $</pubdate>
<authorgroup>
<author>
</para>
<para>
You can find the latest version of the user manual at <ulink
-url="http://ijbswa.sourceforge.net/doc/developer-manual/">http://ijbswa.sourceforge.net/doc/developer-manual/</ulink>.
+url="http://ijbswa.sourceforge.net/developer-manual/">http://ijbswa.sourceforge.net/developer-manual/</ulink>.
Please see the Contact section in the user-manual if you want to contact the developers.
</para>
<!-- ~~~~~ New section ~~~~~ -->
<sect1 id="documentation"><title>Documentation Guidelines</title>
<para>
-All docs should be ...
-<ItemizedList>
- <ListItem>
- <Para>in a format that is widely used. I propose HTML.
- </Para>
- </ListItem>
- <ListItem>
- <Para>we either
- <ItemizedList>
- <ListItem>
- <Para>generate man pages from the documentation (let's _NOT_
-write them manually), or</Para>
- </ListItem>
- <ListItem><Para>we have a man page that points to the
- documentation (I propose this option)
- </Para></ListItem>
- </ItemizedList></Para></ListItem>
- <ListItem><Para>have a consistent layout</Para></ListItem>
- <ListItem><Para>have a link to the latest version of the document (i.e. point to a URL at sf)</Para></ListItem>
- <ListItem><Para>be consistent with the redirect script (i.e. the junkbuster program
- points via the redirect URL at sf to valid end-points in the document)</Para></ListItem>
- <ListItem><Para>started from scratch but recycle parts from the original junkbuster documents</Para></ListItem>
- </ItemizedList>
- </para>
- </sect1>
+ All docs are in SGML format and located in the <computeroutput>doc/source</computeroutput> directory.
+ </para>
+ <para>
+ How do you update the webserver (i.e. the pages on sourceforge)?
+ <OrderedList Numeration="Arabic">
+ <ListItem><Para>
+ Run <computeroutput>make dok</computeroutput> (which uses the documents in <computeroutput>doc/source</computeroutput> to update all
+ text files in <computeroutput>doc/text</computeroutput> and to update
+all web documents in <computeroutput>doc/webserver</computeroutput>.
+ </Para></ListItem>
+ <ListItem><Para>
+ Run <computeroutput>make webserver</computeroutput> which copies all files from
+<computeroutput>doc/webserver</computeroutput> to the sourceforge webserver
+via scp.
+ </Para></ListItem>
+ </OrderedList>
+
+ </sect1>
+
+<!-- <ListItem><Para>be consistent with the redirect script (i.e. the junkbuster program -->
+<!-- points via the redirect URL at sf to valid end-points in the document)</Para></ListItem> -->
<!-- ~~~~~ New section ~~~~~ -->
<sect1 id="coding"><title>Coding Guidelines</title>
<para><emphasis>Example for file comments:</></para>
<programlisting>
-const char FILENAME_rcs[] = "$Id: standards.html,v 1.1 2001/09/10 19:00:25 jongfoster Exp $";
+const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.4 2001/09/23 10:13:48 swa Exp $";
/*********************************************************************
*
* File : $S<!-- Break CVS Substitution -->ource$
<programlisting>
#ifndef _FILENAME_H
#define _FILENAME_H
-#define FILENAME_H_VERSION "$Id: standards.html,v 1.1 2001/09/10 19:00:25 jongfoster Exp $"
+#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.4 2001/09/23 10:13:48 swa Exp $"
/*********************************************************************
*
* File : $S<!-- Break CVS Substitution -->ource$
</para>
</sect1>
- <!-- hhmts end -->
<!--
- Tue 09/11/01 06:38:14 PM EST: Test SGML doc by Hal Burgiss.
-
- Last modified: Mon Sep 10 19:22:09 CEST 2001
-
+
This program is free software; you can redistribute it
and/or modify it under the terms of the GNU General
Public License as published by the Free Software
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: developer-manual.sgml,v $
+ Revision 1.4 2001/09/23 10:13:48 swa
+ upload process established. run make webserver and
+ the documentation is moved to the webserver. documents
+ are now linked correctly.
+
+ Revision 1.3 2001/09/13 15:27:40 swa
+ cosmetics
+
+ Revision 1.2 2001/09/13 15:20:17 swa
+ merged standards into developer manual
+
Revision 1.1 2001/09/12 15:36:41 swa
source files for junkbuster documentation
projects / privoxy.git / blobdiff