root/tags/mvblog-1_8/README

MvBlog v 1.8

Copyright (c) 2005-2006, Michiel van Baak <mvanbaak (AT) users (DOT) sourceforge (DOT) net>
Logo design (c) 2005-2006, Sofie van Tendeloo <eldridge (AT) users (DOT) sourceforge (DOT) net>
Licensed under the General Public License (GPL), see LICENSE file 
provided with this program.


Contents of this document
-------------------------------------------------------------------------------

   1. What is MvBlog?
   2. (New) Features.
   3. Requirements.
   4. Installation.
   5. Project goals.
   6. For administrators.
   7. For endusers.
   8. Security.
   9. Contributing.
  10. Copyright stuff.
  11. Contact information.
  12. Thanks


1. What is MvBlog?
-------------------------------------------------------------------------------

MvBlog is a webbased tool written in PHP to manage a 
PHP::PEAR compatible written blog.

2. (New) Features
-------------------------------------------------------------------------------

List of current features (new features marked with *) :
 
Managing posts
Managing authors
Managing categories
PHP5 support
Plugin system (#52, michiel)

3. Requirements.
-------------------------------------------------------------------------------

  See the INSTALL file

4. Installation.
-------------------------------------------------------------------------------

  See the INSTALL file

5. Project goals.
-------------------------------------------------------------------------------

Main goal is:
        * to make a blogtool without bloat features that can compromise
          security.

6. For administrators.
-------------------------------------------------------------------------------

  This section is intended for system administrators who would like to 
  offer MvBlog to the users on their systems. 
  See the INSTALL file

7. For endusers
-------------------------------------------------------------------------------

All the magic is in the common files.
You can customize the look of your blog without too much effort.
See the CSS file for a list/tree of the ids and classes used.
If you want to create your own index.php you can call some functions to
place the blog things in there.

blog_content($initial_start_article, $number_of_posts_per_page);
        this will show the blog posts. URL params can change what type of 
        posts are shown.
        example: blog_content(0,20);

blog_show_search();
        show a search box. Search results will be realtime, so no enter needed.
        Right under the input box will be a layer with the results, limited to 
        the first 5 results matching the input.

blog_archive_links($how_many_months);
        this will show a <ul> block with $how_many_months months.
        It will show how many posts are in that month.
        The name is clickable to show the month's archive

blog_cats_links();
        same as above, cept there's no limit and instead of the months it
        will show the categories.

8. Security.
-------------------------------------------------------------------------------

* Do not run your webserver as user root!
  
Also read the beautiful NO WARRANTY disclaimer in the GPL. ;)

  
9. Contributing.
-------------------------------------------------------------------------------

If you wish to contribute to MvBlog, 
you can do so with the following things:
  
    * patches.
    * suggestions.
    * feature requests.
  
  When contributing code, please keep the following in mind:
  
    * Write your code according to the rest of programs code style.
    * Send in patches created with the 'diff' command and the -u flag set.
    * Patch purpose must follow the project goals. (or fix bugs, etc)
    * Patches sent to me are public domain or under a GPL (compatible) 
      license, or they can't be added to the code. 
  

10. Copyright stuff.
-------------------------------------------------------------------------------

  MvBlog is Copyright by Michiel van Baak,
  licensed under the General Public License (GPL)
  
  Copyright (C), 2005-2006 by Michiel van Baak <mvanbaak (AT) users (DOT) sourceforge (DOT) net>
  
  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation; either version 2
  of the License, or (at your option) any later version.
      
  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  GNU General Public License for more details.
      
  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
              
  For more information, see the COPYING file supplied with this
  program.


11. Contact information.
-------------------------------------------------------------------------------

Author:
  
    Michiel van Baak
    Email: mvanbaak (AT) users (DOT) sourceforge (DOT) net
    HomePage: http://michiel.vanbaak.info

  Please report any bugs, requests and general comments by using the project
  page at dev.mvblog.org
  
  You may also mail them to me. Before reporting bugs or sending contributions
  please read the Contributing section in this README.

  Project HomePage: http://dev.mvblog.org

  

12. Thanks
-------------------------------------------------------------------------------

  Thanks go out to:

  Logo and favico design:
  -----------------------
        Sofie van Tendeloo (Kermit)

  Additional Styles:
  ------------------
    Leonieke Aalders (Nieke)

  Documentation:
  --------------
        Leonieke Aalders (Nieke)
  
  Testing:
  --------
        Nieke     (http://leonieke.net)
        Kermit    (http://xulon.info)
        f.boender (http://www.electricmonk.nl)
  
  Various suggestions and patches:
  --------------------------------
        Ferry Boender (http://www.electricmonk.nl) - Finding and reporting several SQL-injections and XSS vulnerabilities.

  Used software:
  --------------
  * Xinha HTMLArea fork
  * VIM (my programming enviroment)
  * WebDeveloper toolbar for mozilla (for making stuff w3c compat)