From 373a745ca88b463e96f9257ea6588a409243b2ba Mon Sep 17 00:00:00 2001 From: swa Date: Wed, 31 Oct 2001 18:16:52 +0000 Subject: [PATCH] documentation added: howto generate docs in text and html format, howto move stuff to the webserver. --- doc/source/developer-manual.sgml | 59 ++++++++++++++++---------------- doc/text/developer-manual.txt | 25 +++++--------- 2 files changed, 39 insertions(+), 45 deletions(-) diff --git a/doc/source/developer-manual.sgml b/doc/source/developer-manual.sgml index e63237da..a2430d27 100644 --- a/doc/source/developer-manual.sgml +++ b/doc/source/developer-manual.sgml @@ -7,7 +7,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: developer-manual.sgml,v 1.3 2001/09/13 15:27:40 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 @@ -21,7 +21,7 @@ Junkbuster Developer Manual - $Id: developer-manual.sgml,v 1.3 2001/09/13 15:27:40 swa Exp $ + $Id: developer-manual.sgml,v 1.4 2001/09/23 10:13:48 swa Exp $ @@ -65,31 +65,27 @@ Please see the Contact section in the user-manual if you want to contact the dev Documentation Guidelines -All docs should be ... - - - in a format that is widely used. I propose HTML. - - - - we either - - - generate man pages from the documentation (let's _NOT_ -write them manually), or - - we have a man page that points to the - documentation (I propose this option) - - - have a consistent layout - have a link to the latest version of the document (i.e. point to a URL at sf) - 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) - started from scratch but recycle parts from the original junkbuster documents - - - + All docs are in SGML format and located in the doc/source directory. + + + How do you update the webserver (i.e. the pages on sourceforge)? + + + Run make dok (which uses the documents in doc/source to update all + text files in doc/text and to update +all web documents in doc/webserver. + + + Run make webserver which copies all files from +doc/webserver to the sourceforge webserver +via scp. + + + + + + + Coding Guidelines @@ -1218,7 +1214,7 @@ static void unload_re_filterfile( void *f ) { ... } Example for file comments: -const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.3 2001/09/13 15:27:40 swa Exp $"; +const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.4 2001/09/23 10:13:48 swa Exp $"; /********************************************************************* * * File : $Source$ @@ -1278,7 +1274,7 @@ const char FILENAME_h_rcs[] = FILENAME_H_VERSION; #ifndef _FILENAME_H #define _FILENAME_H -#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.3 2001/09/13 15:27:40 swa Exp $" +#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.4 2001/09/23 10:13:48 swa Exp $" /********************************************************************* * * File : $Source$ @@ -1475,6 +1471,11 @@ at sourceforge. Three simple steps: 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 diff --git a/doc/text/developer-manual.txt b/doc/text/developer-manual.txt index 06030c27..e1a249b4 100644 --- a/doc/text/developer-manual.txt +++ b/doc/text/developer-manual.txt @@ -57,22 +57,15 @@ Junkbuster Developer Manual 3. Documentation Guidelines - All docs should be ... - - * in a format that is widely used. I propose HTML. - * we either - + generate man pages from the documentation (let's _NOT_ write - them manually), or - + we have a man page that points to the documentation (I - propose this option) - * have a consistent layout - * have a link to the latest version of the document (i.e. point to a - URL at sf) - * 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) - * started from scratch but recycle parts from the original - junkbuster documents + All docs are in SGML format and located in the doc/source directory. + + How do you update the webserver (i.e. the pages on sourceforge)? + + 1. Run make dok (which uses the documents in doc/source to update all + text files in doc/text and to update all web documents in + doc/webserver. + 2. Run make webserver which copies all files from doc/webserver to + the sourceforge webserver via scp. _________________________________________________________________ 4. Coding Guidelines -- 2.39.2