[Webnotes-cvs] webnotes/doc INSTALL,1.4,1.5

[<vb...@us...>]

Update of /cvsroot/webnotes/webnotes/doc
In directory usw-pr-cvs1:/tmp/cvs-serv10100/doc

Modified Files:
	INSTALL 
Log Message:
- Added url field into page table.
- Added code to auto-set the url when the page is viewed.
- Some updates to the installation document (still needs a lot of work).
- Added some images to the phpnet theme (previous, next, spacer)
- Started working on the support for previous / next page.
- Started the implementation of the Manage Notes page.
- Removed the admin menu link to the admin_pending.php (will be removed soon).
- Removed theme_note_add_page.php (never used)
- Removed theme_note_preview_page.php (never used)

Index: INSTALL
===================================================================
RCS file: /cvsroot/webnotes/webnotes/doc/INSTALL,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- INSTALL	9 Sep 2002 11:24:30 -0000	1.4
+++ INSTALL	19 Sep 2002 21:51:02 -0000	1.5
@@ -20,13 +20,18 @@
 
 mysql -u<username> -p<password> <databasename> < db_generate.sql
 
+Then you will need to upgrade the db to the latest (that's only needed if you have
+downloaded a CVS version).
+
+mysql -u<username> -p<password> <databasename> < db_upgrade.sql
+
 You could also cut and paste the sql statements from db_generate.sql into a
 package like phpMyAdmin.  You will need to have created the database ahead of
 time.
 
 4. Create core/custom_config_inc.php which overrides the default values in
-config_inc.php.  You can edit directly the config_inc.php but this will make it
-harder to upgrade to future releases of phpWebNotes.  In particular you
+config_defaults_inc.php.  You can edit directly the config_defaults_inc.php but 
+this will make it harder to upgrade to future releases of phpWebNotes.  In particular you
 will want to set the database variables:  hostname, username, password, and
 database name.  These must be set to match the configuration of your webserver and mysql
 database.  Also, don't forget to input the correct directory paths.
@@ -46,25 +51,34 @@
 
 &lt;?
 	require_once("/mypath/api.php"); # replace with actual path
-	print_web_notes( __FILE__, $PHP_SELF );
+	print_web_notes( 'my-page-logical-name', $PHP_SELF );
 ?&gt;
 
-The include argument should be the absolute path to your installation of
+You can replace the 'my-page-logical-name' with __FILE__ if you don't want to 
+assign ids to the pages.
+
+The require_once argument should be the absolute path to your installation of
 phpWebNotes.  It should not be relative to what your browser would see.
 This way if you have lots of files in different directories you will always
 be able to add the web note functionality to each page.
 
-7.  You will need to index the files in your website.  Open up the phpWebNotes
+7. If you want the pages to auto-index (register themselves) in the database
+(default) then skip the next step.
+
+8.  You will need to index the files in your website.  Open up the phpWebNotes
 directory in your web browser and login.  The default username and password is
 administrator / root.  You should change this later on!  Open up the "File
 Index" page.  Select the root directory and then choose the Index button.  It
 indexes all files in the directory it is located in and all subdirectories.
 
-8.  Notes will be added to a queue.  They need to be approved by the
+9. If you need the notes to be moderated before they appear on the webpage then
+leave $g_auto_accept_notes = OFF, otherwise set it to ON and go to step 11.
+
+10.  Notes will be added to a queue.  They need to be approved by the
 administrator before they will become visible.  You can do this from the admin
 section by choosing "View Queue".
 
-9.  You can edit or delete notes later on by going to the page and selecting
+11.  You can edit or delete notes later on by going to the page and selecting
 Manage.  This option will only be available if you have logged in as an
 administrator.