Read Me

skb v0.1.0 2010/08/31
---------------------
PHP access to a specific (sven's) knowledge base

This software provides PHP code,  CSS styles, templates (in PHP),  databases
and other related material to maintain and access the SKB using PHP or  HTTP
(if installed and configured to a  web server such as Apache in  cooperation
with  a PHP  installation). It  focuses on  structure and  re-use of  code,
information and knowledge and provides a modular sytems based on a small yet
powerfull core package (Packages.Core)  and a distribution package  offering
some  (hopefully  interesting  and  usefull)  additions.  The  software also
includes  a  demo server,  which  show a  few  of the  key  features of  the
distribution package. The PHP SKB integrates well with the LaTeX SKB (please
see CTAN package skb or SourceForge project latex-skb for details).

skb-complete-v0.1.0: the complete software, including core, dist and demo
skb-core-v0.1.0    : the core package and related material
skb-dist-v0.1.0    : the dist(ribution) package
skb-demo-v0.1.0    : the demo server



Status: Alpha, Experimental
---------------------------

This software, while being used by me and some early adaptors, is  still  in
alpha status, thus experimental. We are using it to maintain a large  amount
of  information  in  different  ways (from  simple  foto  albums  to complex
applications as  well as  domain specific  language support)  and on various
different  platforms (Windows, several Linux systems). Since we  eat our own
dog  food, we are  fairly confident that the  software  does it's job  well.
However, it  might or  might  not  be usefull  for you  and might  or  might
not work  on your machine.   We   are    very   interested   in    comments,
critic,  advice,  recommendations, complaints;  as long  as you  try to keep
them contructive ;)



Contents and Installation
-------------------------

For a complete  installation, one will  need a working  PHP 5.3 installation
and a web server. Assuming you are using Apache, then unzip the main archive
skb-complete-v0.1.0.7z into your Apache HTML document folder. It will create
a folder  named 'skb'.  You can  then use  a web  browser to  test the  demo
server. Assuming your Appache is configured for 'localhost' on the  standard
HTTP port 80 simply try this URL:

  http://localhost/skb/www/demo/index.php5

For  details  on  how  to  install  PHP  and  Apache,  please  refer  to the
documentation of  these software  packages. Also:  you need  to add the file
extentions .php5 to your Appache's MIME list (might not be the default).



Configuration
-------------

The demo server does  not need any configuration,  it should run out  of the
box as long as your PHP and Apache installation work. If you want to have  a
look into  the configuration  parameters, try  the demo  server; it provides
access  to all  configuration data.  If you  want to  have a  look into  the
databases yourself, then simply get  some software that can read  SQLite 3.0
files and checkout skb/database/core/cfg.db and skb/database/demo/cfg.db.



Where do I get it?
------------------

SourceForge: http://sourceforge.net/projects/php-skb



License
-------
/*
 * [The BSD License, http://www.opensource.org/licenses/bsd-license.php]
 * Copyright (c) 2010-2010, Sven van der Meer <sven@vandermeer.de>
 * All rights reserved.
 *
 * Redistribution  and  use  in  source  and  binary  forms,  with  or  without
 * modification, are permitted provided that the following conditions are met:
 * 
 *     + Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 *     + Redistributions  in binary  form must  reproduce the  above copyright
 *       notice, this list  of conditions and  the following disclaimer  in the
 *       documentation and/or other materials provided with the distribution.
 *     + Neither the name of the the author nor the names of its contributors
 *       may be used to endorse or promote products derived from this software
 *       without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS  IS"
 * AND ANY EXPRESS  OR IMPLIED WARRANTIES,  INCLUDING, BUT NOT  LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY  AND FITNESS FOR A  PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN  NO EVENT SHALL  THE COPYRIGHT HOLDER  OR CONTRIBUTORS BE
 * LIABLE  FOR  ANY  DIRECT,  INDIRECT,  INCIDENTAL,  SPECIAL,  EXEMPLARY,   OR
 * CONSEQUENTIAL  DAMAGES  (INCLUDING,  BUT  NOT  LIMITED  TO,  PROCUREMENT  OF
 * SUBSTITUTE GOODS  OR SERVICES;  LOSS OF  USE, DATA,  OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER  CAUSED AND  ON ANY  THEORY OF  LIABILITY, WHETHER  IN
 * CONTRACT,  STRICT LIABILITY,  OR TORT  (INCLUDING NEGLIGENCE  OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE  USE OF THIS SOFTWARE, EVEN IF ADVISED  OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */