Menu
▾
▴
[Webnotes-cvs] webnotes/doc SCRATCHPAD,NONE,1.1 CREDITS,1.2,1.3 ChangeLog,1.5,1.6 INSTALL,1.2,1.3 README,1.3,1.4 ROADMAP,1.8,1.9
|
From: <vb...@us...> - 2002-09-09 05:10:37
|
Update of /cvsroot/webnotes/webnotes/doc In directory usw-pr-cvs1:/tmp/cvs-serv5331 Modified Files: CREDITS ChangeLog INSTALL README ROADMAP Added Files: SCRATCHPAD Log Message: Updated documents since they are references from the website. --- NEW FILE: SCRATCHPAD --- # phpWebNotes - a php based note addition system # Copyright (C) 2000-2002 Webnotes Team - web...@so... # This program is distributed under the terms and conditions of the GPL # See the files README and LICENSE for details ----------------------------------------- SCRATCH PAD ----------------------------------------- To-Do list: * Index pages by url rather than path, this way hyperlinks to the pages goes through Web/PHP servers rather than directly. * Be able to require user logins (vb: currently login check is disabled) * Be able to reverse the display order (vb: them may already be supported) * Support for user supplied CSS. (vb: value to be confirmed) * Consider re-using some APIs like config_api.php / lang_api.php / database_api.php / php_api.php / gpc_api.php from mantisbt. * Add access_api.php - note_accept() / decline() / update() / delete() should check the access level. * Support displaying queued notes on the page in case of moderators. There should be an accept/reject links on the note and it should be in a different color. * Consider supporting html only pages. This can be done by a php loader page + some other tricks (output buffering?) * Indexing page * Add a link next to each file to open it for viewing. * Differentiate between newly submitted notes, and notes that are hidden by the admin. * API mode for plugability into existing systems. * Add note on how to parse HTML files through the PHP interpreter. Index: CREDITS =================================================================== RCS file: /cvsroot/webnotes/webnotes/doc/CREDITS,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- CREDITS 3 Sep 2002 22:30:08 -0000 1.2 +++ CREDITS 9 Sep 2002 05:10:24 -0000 1.3 @@ -1,6 +1,5 @@ # phpWebNotes - a php based note addition system -# Copyright (C) 2000 Kenzaburo Ito - ke...@30... -# 2002 Webnotes Team - web...@so... +# Copyright (C) 2000-2002 Webnotes Team - web...@so... # This program is distributed under the terms and conditions of the GPL # See the files README and LICENSE for details @@ -11,13 +10,13 @@ Administrators -------------- -Kenzaburo Ito -Victor Boctor +Kenzaburo Ito (prescience) +Victor Boctor (vboctor) Developers ---------- -Remon Metira +Remon Metira (rmetira) Mantis Team (mantisbt.sf.net - some code was re-used from Mantis Bugtracker) Translations Index: ChangeLog =================================================================== RCS file: /cvsroot/webnotes/webnotes/doc/ChangeLog,v retrieving revision 1.5 retrieving revision 1.6 diff -u -d -r1.5 -r1.6 --- ChangeLog 3 Sep 2002 06:59:09 -0000 1.5 +++ ChangeLog 9 Sep 2002 05:10:25 -0000 1.6 @@ -1,6 +1,5 @@ # phpWebNotes - a php based note addition system -# Copyright (C) 2000 Kenzaburo Ito - ke...@30... -# 2002 Webnotes Team - web...@so... +# Copyright (C) 2000-2002 Webnotes Team - web...@so... # This program is distributed under the terms and conditions of the GPL # See the files README and LICENSE for details @@ -12,9 +11,14 @@ * Added directory themes/ to include different themes to be used to view the webnotes. * Added directory lang/ to contain the localisation files. * Added directory doc/ to contain documentation files. + * Added directory sample/ to contain sample files that can be used to test phpWebNotes. + * Cleanup of all files for better readability and complying with coding standards. * Change the extension of the language files to .php rather than .txt. * Moved to XHTML (not tested yet) - * Integrated the Italian/French strings into webnotes. + * Integrated the Italian/French strings into cvs. + * Added support for themes (#2). + * Added the classic theme (#4). + * Added admin_pending.php to allow moderating notes in any order (#10). 03.12.2000 - 1.0.0 Index: INSTALL =================================================================== RCS file: /cvsroot/webnotes/webnotes/doc/INSTALL,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- INSTALL 3 Sep 2002 06:59:09 -0000 1.2 +++ INSTALL 9 Sep 2002 05:10:25 -0000 1.3 @@ -1,6 +1,5 @@ # phpWebNotes - a php based note addition system -# Copyright (C) 2000 Kenzaburo Ito - ke...@30... -# 2002 Webnotes Team - web...@so... +# Copyright (C) 2000-2002 Webnotes Team - web...@so... # This program is distributed under the terms and conditions of the GPL # See the files README and LICENSE for details @@ -8,15 +7,15 @@ ### Installation steps ### ------------------------------------------------------------------------------- -*** REQUIREMENTS: mysql database, php 3.0.7+, a webserver (tested on Apache, -should work with IIS or anything else php will run with). +*** REQUIREMENTS: MySql database, php 4.0.6, a webserver (tested on Apache and IIS, +should work anything else PHP will run with). 1. First, transfer the file to your webserver. You will need to telnet/ssh into -the server for the next stpes. +the server for the next steps. -2. Next, untar/gzip it to the directory that you want. +2. Next, untar/gunzip it to the directory that you want. -3. After that you will need to cd into the lang/ folder under the webnotes +3. After that you will need to cd into the sql/ folder under the webnotes directory and locate the db_generate.sql file. Run the following command: mysql -u<username> -p<password> <databasename> < db_generate.sql @@ -29,7 +28,7 @@ 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 will want to set the database variables: hostname, username, password, and -database name must be set to match the configuration of your webserver and mysql +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. 5. If you require .php3 extensions (instead of .php) run the convertToPHP3 @@ -42,11 +41,11 @@ config_inc.php file and change $g_php = ".php" to be ".php3" 6. For every page that you want notes to be available you will need to convert -their extension to one that is interpreted by php. Then insert these lines -into the bottom of the document: +their extension to one that is interpreted by PHP. Then insert these lines +into the bottom of the document (before the </body> tag): <? - include("/home/www/webnotes/api.php"); # replace with actual path + include("/mypath/api.php"); # replace with actual path print_web_notes( __FILE__, $PHP_SELF ); ?> @@ -75,20 +74,17 @@ * PROBLEM: Warning messages prevent you from viewing or adding notes. -SOLUTION: Your error_level is too high. Open up your php3.ini (or php.ini) +SOLUTION: Your error_level is too high. Open up your php.ini (or php3.ini) and lower it. There should be enough comments around the variable to help you out. -* PROBLEM: Adding notes does nothing. +* PROBLEM: Adding notes does nothing (obsolete since PHP 4.0.6 is the minimum requirement). SOLUTION 1: You may have track_vars set to Off (or 0). Set this to On in your -php3.ini or (php.ini) file. As of version 4.0.3 it is permanently set to On. +php.ini or (php3.ini) file. As of version 4.0.3 it is permanently set to On. ------------------------------------------------------------------------------- ### Useful links ### ------------------------------------------------------------------------------- -http://www.mysql.com/ - good documentation. -http://www.phpwizard.net/ - an excellent web front end to mysql. -http://www.php.net/ - excellent documentation. -http://www.apache.org/ - you should be able to find what you need, I hope. +See http://webnotes.sf.net/links.php for useful links. Index: README =================================================================== RCS file: /cvsroot/webnotes/webnotes/doc/README,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- README 3 Sep 2002 06:59:09 -0000 1.3 +++ README 9 Sep 2002 05:10:25 -0000 1.4 @@ -1,6 +1,5 @@ # phpWebNotes - a php based note addition system -# Copyright (C) 2000 Kenzaburo Ito - ke...@30... -# 2002 Webnotes Team - web...@so... +# Copyright (C) 2000-2002 Webnotes Team - web...@so... # This program is distributed under the terms and conditions of the GPL # See the files README and LICENSE for details @@ -22,22 +21,16 @@ ------------------------------------------------------------------------------- -INSTALL - installation instructions -LICENSE - GPL license -Changelog - List of fixes, additions, and todo items - -------------------------------------------------------------------------------- - phpWebNotes is a PHP based solution to letting users add their own comments to a document. It is heavily modelled after the example set by php.net. This project was originally conceived to help people who maintain technical -help docs and how-tos. It's more direct than searching through a forum and +help docs and how-tos. It is more direct than searching through a forum and less involving for the users than signing up for a mailing list. Of course, it adapts to other uses easily. Updating documents is tedious and documents often lack the real world -examples and experience to make them truly useful. The best help sites I've +examples and experience to make them truly useful. The best help sites we have ever found had not only detailed documentation but lots and lots of examples and problems and quirks that appear in real life. Unfortunately this rules out many man pages (unix help docs). Allowing user comments lets the doc Index: ROADMAP =================================================================== RCS file: /cvsroot/webnotes/webnotes/doc/ROADMAP,v retrieving revision 1.8 retrieving revision 1.9 diff -u -d -r1.8 -r1.9 --- ROADMAP 6 Sep 2002 17:03:37 -0000 1.8 +++ ROADMAP 9 Sep 2002 05:10:25 -0000 1.9 @@ -1,6 +1,5 @@ # phpWebNotes - a php based note addition system -# Copyright (C) 2000 Kenzaburo Ito - ke...@30... -# 2002 Webnotes Team - web...@so... +# Copyright (C) 2000-2002 Webnotes Team - web...@so... # This program is distributed under the terms and conditions of the GPL # See the files README and LICENSE for details @@ -8,45 +7,27 @@ 2.0.0 * General cleanup of the code / rewrite. - * A new administrator interface - * Introduce moderation interface * XHTML compliance - * Support for themes with a php.net theme + * Support for themes + * Implement php.net theme + * Implement classic theme to provide the original look'n'feel of version 1.0.0. + * Email notifications to administrators on the submission of new notes. * Support MD5 password encryption (by default) - * LDAP Support - * Support direct links to specific notes * Database schema modifications - * Indexing page - * Add a link next to each file to open it for viewing. - * Differentiate between newly submitted notes, and notes that are hidden by the admin. - * Explorer look'n'feel. - * Infrastructure: - * A new website with demo for all available themes + admin demo - * API mode for plugability into existing systems. - * Add note on how to parse HTML files through the PHP interpreter. - * Add IP/IP range blocking. + * Update the demo installation that is used from the website. + * A new administrator interface 2.0.1 - * Language Localisation (English, French, Italian, German) + * Language Localisation (English, French, Italian, German). + * Any required bug fixes. 2.1.0 + * Multiple access levels (anonymous, verified, moderator, admin) + * Add IP/IP range blocking. + * LDAP Support * New Manual + * Support direct links to specific notes 3.0.0 * Database abstraction * Logo - ------------------------------------------ -SCRATCH PAD ------------------------------------------ - -To-Do list: - - * Index pages by url rather than path, this way hyperlinks to the pages goes through Web/PHP servers rather than directly. - * Be able to require user logins (vb: currently login check is disabled) - * Be able to reverse the display order (vb: them may already be supported) - * Support for user supplied CSS. (vb: value to be confirmed) - * Consider re-using some APIs like config_api.php / lang_api.php / database_api.php / php_api.php / gpc_api.php from mantisbt. - * Add access_api.php - note_accept() / decline() / update() / delete() should check the access level. - * Support displaying queued notes on the page in case of moderators. There should be an accept/reject links on the note and it should be in a different color. - * Consider supporting html only pages. This can be done by a php loader page + some other tricks (output buffering?) |
