[Cpan-forum-commit] rev 19 - in trunk: . lib/CPAN lib/CPAN/Forum

[svn at pti.co.il]

Author: gabor
Date: 2005-01-15 19:43:58 +0200 (Sat, 15 Jan 2005)
New Revision: 19

Modified:
   trunk/META.yml
   trunk/lib/CPAN/Forum.pm
   trunk/lib/CPAN/Forum/DBI.pm
Log:
some documentation changes

Modified: trunk/META.yml
===================================================================
--- trunk/META.yml	2005-01-15 17:29:09 UTC (rev 18)
+++ trunk/META.yml	2005-01-15 17:43:58 UTC (rev 19)
@@ -1,9 +1,9 @@
 --- #YAML:1.0
 name: CPAN-Forum
-version: 0.09_02
+version: 0.09_03_dev
 author:
   - Gabor Szabo <gabor at pti.co.il>
-abstract: Web forum appliation to discuss CPAN modules
+abstract: Web forum application to discuss CPAN modules
 license: perl
 requires:
   CGI: 0
@@ -25,7 +25,7 @@
 provides:
   CPAN::Forum:
     file: lib/CPAN/Forum.pm
-    version: 0.09_02
+    version: 0.09_03_dev
   CPAN::Forum::Build:
     file: lib/CPAN/Forum/Build.pm
   CPAN::Forum::Configure:

Modified: trunk/lib/CPAN/Forum/DBI.pm
===================================================================
--- trunk/lib/CPAN/Forum/DBI.pm	2005-01-15 17:29:09 UTC (rev 18)
+++ trunk/lib/CPAN/Forum/DBI.pm	2005-01-15 17:43:58 UTC (rev 19)
@@ -18,11 +18,7 @@
 our %group_types;
 $group_types{$group_types[$_]} = $_ for (0..$#group_types);
 
-=head2 init_db
-
-Initialize the database
-
-=cut
+# Initialize the database
 sub init_db {
 	my $class = shift;
 	my $dbfile = shift;

Modified: trunk/lib/CPAN/Forum.pm
===================================================================
--- trunk/lib/CPAN/Forum.pm	2005-01-15 17:29:09 UTC (rev 18)
+++ trunk/lib/CPAN/Forum.pm	2005-01-15 17:43:58 UTC (rev 19)
@@ -28,7 +28,7 @@
 
 =head1 NAME
 
-CPAN::Forum - Web forum appliation to discuss CPAN modules
+CPAN::Forum - Web forum application to discuss CPAN modules
 
 =head1 SYNOPSIS
 
@@ -117,16 +117,16 @@
 
 =head2 Install the perl code
 
-perl Build.PL
-./Build
-./Build test
-./Build install dir=/path/to/install
-cd /path/to/install
+ perl Build.PL
+ ./Build
+ ./Build test
+ ./Build install dir=/path/to/install
+ cd /path/to/install
 
-chmod a+x www/cgi/index.pl  (needed only if you work out of the repository)
-chmod a+x db/forum.db       (or whatever you need to make sure the database is writable by the web server.
+ chmod a+x www/cgi/index.pl  (needed only if you work out of the repository)
+ chmod a+x db/forum.db       (or whatever you need to make sure the database is writable by the web server.
 
-manually edit the www/cgi/index.pl file and set the sh-bang to the correct one
+ manually edit the www/cgi/index.pl file and set the sh-bang to the correct one
 
 
 =head2 Setup the database
@@ -134,31 +134,34 @@
 In the directory where you installed the modules create
 a file called CONFIG (see t/CONFIG for an example). 
 Having the following fileds:
-username=        the user name of the administrator
-email=           of the administrator
-password=        the password of the administrator
-from=            email address to be used as the from address in the messages sent
-                 by the system
 
+ username=        the user name of the administrator
+ email=           of the administrator
+ password=        the password of the administrator
+ from=            email address to be used as the from address in the messages sent
+                  by the system
+
 You will be able to change all these values later from the web interface but we need
 to have the first values.
 
-perl bin/setup.pl 
+ perl bin/setup.pl 
 
-    (you can now delete the CONFIG file)
+(you can now delete the CONFIG file)
 
-perl bin/populate.pl    (this will fetch a file from www.cpan.org and 
-                        might take a few minutes to run)
+ perl bin/populate.pl    (this will fetch a file from www.cpan.org and 
+                         might take a few minutes to run)
 
 
 
-CPAN_FORUM_URL
----------------
+=head2 CPAN_FORUM_URL
+
 For some of the tests you'll have to set the CPAN_FORUM_URL environment variable 
 to the URL where you installed the forum.
 
 =head2 Changes
 
+Will come here after we start to accumulate them
+
 =head2 TODO Critical for launching
 
 - Basic Markup language:
@@ -202,7 +205,7 @@
 - Finalize markup
 
   Subject field:
-  -  <= 70 chars
+  -  <= 50 chars
   -  Can contain any characters, we'll escape them when showing on the web site
  
   Text field: