Menu
▾
▴
[Webnotes-cvs] web index.php,1.3,1.4
|
From: <vb...@us...> - 2002-09-09 03:35:25
|
Update of /cvsroot/webnotes/web In directory usw-pr-cvs1:/tmp/cvs-serv908 Modified Files: index.php Log Message: Updated the main page. Index: index.php =================================================================== RCS file: /cvsroot/webnotes/web/index.php,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- index.php 8 Sep 2002 06:12:53 -0000 1.3 +++ index.php 9 Sep 2002 03:35:22 -0000 1.4 @@ -3,31 +3,30 @@ <span class="page_title">What is it?</span> <hr size="1" noshade="noshade" width="100%"> -<p>phpWebNotes is a php based solution to letting users add their own comments to a document.</p> -<p>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, it adapts to other uses extremely easily.</p> -<p>Updating documents is tedious and documents all to example lack the real world 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 almost all 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 a lot of the user feedback instead of recreating the info. This sort of automation cuts down on email and mailing list traffic as well.</p> -<p>The release numbering convention I'm using is major.minor.micro. Major indicates a large change in the core package, minor a significant amount of feature addition/modification, micro for mostly bug fixes. I am leaning towards releasing a new version for a significant bugfix as often as daily.</p> +<p>phpWebNotes is a php based solution to letting users contribute their own comments to a document.</p> +<p>This project was originally conceived to help people who maintain technical help documents 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 extremely easily.</p> +<p>Updating documents is tedious and a lot of documents lack the real world examples and experience to make them truly useful. The best help sites we 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 almost all man pages (unix help docs). Allowing user comments lets the doc maintainer do less work. Whenever the maintainer needs to update the document they can just roll in user feedback instead of recreating the information. This sort of automation cuts down on email and mailing list traffic as well.</p> <span class="page_title">Goals</span> <hr size="1" noshade="noshade" width="100%"> -<p>A simple way to add user note/footnote capability to any document. I'd like to see this used in particular for HOW-TO, help files, and online documentation (see <a href="http://www.php.net/">php.net</a> for an excellent example).</p> +<p>A simple way to allow users to contribute their comments to any document. We would like to see this used in particular for HOW-TO, help files, and online documentation (see <a href="http://www.php.net/manual/en/">PHP manual</a> for an excellent example).</p> <span class="page_title">Requirements</span> <hr size="1" noshade="noshade" width="100%"> +<p>Following are the required software modules to be able to install phpWebNotes:</p> <ul> -<li><a href="http://www.php.net/">php</a> 4.0.6 and higher</li> -<li><a href="http://www.mysql.com/">MySQL database</a> (more support is planned)</li> -<li>Web server (<a href="http://www.apache.org/">apache</a>, IIS, etc.)</li> +<li><a href="http://www.php.net/">PHP</a> 4.0.6 and higher</li> +<li><a href="http://www.mysql.com/">MySQL database</a> (more support is planned).</li> +<li>Web server (eg: <a href="http://www.apache.org/">apache</a>, IIS, etc.)</li> </ul> -<p>Additionally you will need to know basic administration of MySQL (login, create new database, run a SQL query). The webserver needs to be configured to handle php files at a minimum.</p> -<p>It also helps a great deal to at least be able to tinker with php scripts (when there's a little bug or you want to tweak something). Of course, knowing HTML is essential to do any custom formatting. Along the lines of appearance, I have tried to use my best judgement in colors, layout, and feel. Eventually I hope to be able to customize the look and feel from a single CSS file.</p> -<p>I highly recommend using <a href="http://www.phpwizard.net">phpMyAdmin</a> to administer your mysql database.</p> +<p>Additionally you will need to know basic administration of MySQL (login, create new database, run a SQL query). We strongly recommend using <a href="http://www.phpwizard.net">phpMyAdmin</a> to accomplish the database administration task. The webserver needs to be configured to handle php files at a minimum.</p> +<p>It also helps a great deal to at least be able to tinker with php scripts (when there's a little bug or you want to tweak something). Of course, knowing HTML is essential to do any custom formatting. Along the lines of appearance, we attempt to use our best judgement in colors, layout, and feel. Eventually we aim to be able to customize the look and feel from a single CSS file.</p> <span class="page_title">Features and Benefits</span> <hr size="1" noshade="noshade" width="100%"> +<p>Following are some of the nice features of phpWebNotes:</p> <ul> <li>Web based and platform independent</li> -<li>Supports PHP3 and PHP4</li> <li>Configuration files allow for site-wide control</li> <li>Automatic indexing of files</li> <li>Takes two lines of php to add notes to a file</li> @@ -35,21 +34,20 @@ <span class="page_title">Upcoming Features</span> <hr size="1" noshade="noshade" width="100%"> -<p>Check the <a href="roadmap.php">Roadmap</a> for a more detailed and up to date list of items.</p> +<p>Check the <a href="roadmap.php">Roadmap</a> for a more detailed and up to date list of features.</p> <span class="page_title">Versioning</span> <hr size="1" noshade="noshade" width="100%"> -<p>The release numbering convention I'm using is major.minor.micro. Major indicates a very large change in the core package, minor a significant amount of feature addition/modification, micro for mostly bug fixes. I will release a new version for a significant bugfix as often as daily.</p> -<p>Version 1.0.0 will be used when I consider phpWebNotes to be production quality. This basically means that I would not hesitate to recommend it for most uses.</p> + +<p>The release numbering convention used for phpWebNotes is major.minor.micro. Major indicates a large change in the core package, minor a significant amount of feature addition/modification, micro for mostly bug fixes. A database change always requires a change in major release.</p> <span class="page_title">How to help?</span> <hr size="1" noshade="noshade" width="100%"> <ul> <li>Report any bugs at the <a href="bugtracker.php">Bugtracker</a></li> -<li>Suggest (reasonable) features</li> -<li>Contribute code or tell me where to look</li> -<li><strong>Let me know if you use it and find it useful</strong>.</li> +<li>Suggest (generic) features that would add value to the product.</li> +<li>Contribute code or pointers to code that can be re-used in this project.</li> +<li><strong>Let us know if you use it and find it useful</strong> (this information will not be published without your approval, but it keeps the team motivated knowing that their work has been of use).</li> </ul> -<p>I won't publish the information without permission, but I would appreciate the feedback. This, more than any one thing, keeps me motivated.</p> <?php include('footer.php') ?> |
