Menu
▾
▴
[Webnotes-cvs] webnotes/doc CREDITS,NONE,1.1 ROADMAP,NONE,1.1 ChangeLog,1.4,1.5 INSTALL,1.1,1.2 README,1.2,1.3
|
From: <vb...@us...> - 2002-09-03 06:59:12
|
Update of /cvsroot/webnotes/webnotes/doc In directory usw-pr-cvs1:/tmp/cvs-serv16194/doc Modified Files: ChangeLog INSTALL README Added Files: CREDITS ROADMAP Log Message: - Did some updates to the documents and added some extra docs. - Move the db_connect to api.php rather than doing it in all files. - Added the Italian strings from the website - Added the French strings from the website --- NEW FILE: CREDITS --- # phpWebNotes - a php based note addition system # Copyright (C) 2000 Kenzaburo Ito - ke...@30... # 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 *** Please contact Webnotes administrators if you should be on this list! CREDITS Administrators -------------- Kenzaburo Ito Victor Boctor Developers ---------- Remon Metira Translations ------------ Dat-Son Nguyen (French) Luca Pecatore (Italian) --- NEW FILE: ROADMAP --- # phpWebNotes - a php based note addition system # Copyright (C) 2000 Kenzaburo Ito - ke...@30... # 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 phpWebNotes 2.0.0 * General cleanup of the code / rewrite. * XHTML compliance * Support compression / output buffering * Support for themes with a php.net theme * Support MD5 password encryption * Support for cross-reference from one note to the other * Support direct links to specific notes * Database schema modifications * Revise the directory structure * Language Localisation * Infrastructure: * A new website with demo for all available themes + admin demo * Install Mantis Bugtracker (http://mantisbt.sf.net) * Setup webnotes-devel news group * Setup webnotes-cvs news group 2.1.0 * New Manual 3.0.0 * Database abstraction * Logo ----------------------------------------- SCRATCH PAD ----------------------------------------- To-Do list: * Be able to require user logins (vb: currently login check is disabled) * Be able to reverse the display order * 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. * Revisit code to match Mantis standards. For example, change all <? to <?php. * Define ON / OFF for configs * Add note_api.php and rename methods to note_add(), note_update(), note_delete(), note_accept(), note_decline(), ... * Add access_api.php - note_accept() / decline() / update() / delete() should check the access level. Index: ChangeLog =================================================================== RCS file: /cvsroot/webnotes/webnotes/doc/ChangeLog,v retrieving revision 1.4 retrieving revision 1.5 diff -u -d -r1.4 -r1.5 --- ChangeLog 3 Sep 2002 00:10:05 -0000 1.4 +++ ChangeLog 3 Sep 2002 06:59:09 -0000 1.5 @@ -1,22 +1,12 @@ -phpWebNotes - -To-Do list: +# phpWebNotes - a php based note addition system +# Copyright (C) 2000 Kenzaburo Ito - ke...@30... +# 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 - * Be able to require user logins (vb: currently login check is disabled) - * Be able to reverse the display order - * Support themes and provide a php.net theme (including icons). (vb: directory created) - * Support for user supplied CSS. (vb: value to be confirmed) - * Revise the directory structure (webnotes/, webnotes/core/, - webnotes/themes/, webnotes/admin/, webnotes/sql/) (vb: done, still considering admin/ and config/) - * Setup webnotes-cvs mailing list. ( Ken ) - * Setup webnotes-dev mailing list. ( Ken ) - * Consider re-using some APIs like config_api.php / lang_api.php / - database_api.php / php_api.php / gpc_api.php from mantisbt. - * Improve website - * Database abstraction - * Language localization +phpWebNotes -??.??.2002 - ? +??.10.2002 - 2.0.0 * Added directory core/ to include source files that are not accessed directly through the web. * Added directory sql/ to include SQL files to be used to create/upgrade the database. * Added directory themes/ to include different themes to be used to view the webnotes. @@ -24,6 +14,7 @@ * Added directory doc/ to contain documentation files. * 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. 03.12.2000 - 1.0.0 Index: INSTALL =================================================================== RCS file: /cvsroot/webnotes/webnotes/doc/INSTALL,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- INSTALL 2 Sep 2002 12:42:13 -0000 1.1 +++ INSTALL 3 Sep 2002 06:59:09 -0000 1.2 @@ -1,3 +1,9 @@ +# phpWebNotes - a php based note addition system +# Copyright (C) 2000 Kenzaburo Ito - ke...@30... +# 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 + ------------------------------------------------------------------------------- ### Installation steps ### ------------------------------------------------------------------------------- @@ -10,8 +16,8 @@ 2. Next, untar/gzip it to the directory that you want. -3. After that you will need to cd into the directory and locate the -db_generate.sql file. Run the following command: +3. After that you will need to cd into the lang/ 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 @@ -19,35 +25,28 @@ package like phpMyAdmin. You will need to have created the database ahead of time. -4. Now edit config_inc.php and set the appropriate variables. In particular you -will want to set the database variables. hostname, username, password, and +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 +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. Also, don't forget to input the correct directory paths. -Open up core_API.php and edit the path on the two require() lines to match your -setup. - 5. If you require .php3 extensions (instead of .php) run the convertToPHP3 script. You may need to first run "chmod +x convertToPHP3" to make the script executable. You will also have to look through the index.html file and change -admin.php to admin.php3. You will also need to rename all occurance of -core_API.php to core_API.php3 - -The script will rename all the .php3 files to .php. You also need to edit the -config_inc.php file and change $g_php = ".php3" to be ".php" +admin.php to admin.php3. You will also need to rename all occurrences of +api.php to api.php3 -NOTE: If your server sends .php3 files in plain text you're going to need to do -some heavy editing. Basically you'll need to rename all the .php files to .php3 -and then do a search and replace in every single file to rename core_API.php to -core_API.php3, and rename config_inc.php to config_inc.php3 in the core_API -file... and the same for all the other affected files. +The script will rename all the .php files to .php3. You also need to edit the +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: <? - include("/home/www/webnotes/core_API.php"); + include("/home/www/webnotes/api.php"); # replace with actual path print_web_notes( __FILE__, $PHP_SELF ); ?> @@ -59,7 +58,7 @@ 7. 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 +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 @@ -92,4 +91,4 @@ 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. \ No newline at end of file +http://www.apache.org/ - you should be able to find what you need, I hope. Index: README =================================================================== RCS file: /cvsroot/webnotes/webnotes/doc/README,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- README 3 Sep 2002 03:20:37 -0000 1.2 +++ README 3 Sep 2002 06:59:09 -0000 1.3 @@ -1,8 +1,8 @@ -------------------------------------------------------------------------------- -phpWebNotes -Copyright (C) 2000 Kenzaburo Ito - ke...@30... -------------------------------------------------------------------------------- - +# phpWebNotes - a php based note addition system +# Copyright (C) 2000 Kenzaburo Ito - ke...@30... +# 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 LICENSE @@ -25,37 +25,32 @@ INSTALL - installation instructions LICENSE - GPL license Changelog - List of fixes, additions, and todo items -config_inc.php3 - global configuration options -core_API.php3 - core functions -db_generate.sql - SQL tables ------------------------------------------------------------------------------- -phpWebNotes is a php based solution to letting users add their own comments to +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 -less involving for the users than signing up for a mailing list. Of course, +help docs and how-tos. It's 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 I've 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 -maintainer do less work. Whenever the maintainer needs to update the doc they -can just roll in the user feedback instead of recreating the info. +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 +maintainer do less work. Whenever the maintainer needs to update the doc they +can just roll in the user feedback instead of recreating the information. This sort of automation cuts down on email and mailing list traffic as well. -You will need to have php, mysql, and a webserver. You don't need to know too -much about any of them other than how to set them up and some basic +You will need to have PHP, MySql, phpMyAdmin, and a web server. You don't need +to know too much about any of them other than how to set them up and some basic administration commands. -I'd appreciate an email letting me know if you find this program useful. -I won't publish any information without permission, I'd just like an idea -of usage and knowing I'm helping people will only motivate me more. - -Credits: - -Kenzaburo Ito - ke...@30... +The team would appreciate an email letting us know if you find this program +useful. This information will not be published without permission, it will just +provide the team with the feedback that this have proven to be useful for some +people and hence will motivate the team to put more effort into it. Also this +feedback is what we need to keep improving phpWebNotes. |
