Modulog: a simple PHP Blog
==========================

About
=====

  This simple configless PHP Blog module was written by Silvio Rhatto
  (rhatto at riseup.net) and is distributed according the terms of the
  file named "COPYING".

  It was developed as a PHP learning exercise and its not full of
  features like all zilions of existing blogwares, but its fast,
  multi-user, doesn't need a SQL server and it's a bit modular.

  I dont plan to keep this software up to date.

Requirements
============

  - Unix environment
  - PHP 4.x or later
  - SQLite 2.x or later
  - pecl_sqlite package

Installation
============

  1 - Put the code in a web folder
  2 - Chown a data/ folder for webserver user
  3 - Access the folder through a web browser
  4 - Login as admin/admin and change the default settings
  5 - Check if data/ folder is unreadable from the web

Design
======

  - No need for config file: everything is stored in a
    sqlite database. Database name is determined via
    the URL in the HTTP request. Sqlite database uses
    data/URL/ folder for storage.

  - Database tables:

    - users: blog users
    - posts: blog data
    - options: blog options
    - comments: blog comments
    - scheme: databse scheme and internal data

  - Actions:

    - read: read posts
    - admin: admin page
    - login: user login
    - logout: user logout
    - info: user info
    - register: create a new account
    - edituser: change user options
    - edit: create, edit or delete a post
    - comment: create, edit or delete a comment
    - rss: show rss
    - search: do searches on published content
    - mine: show user's own posts and comments

  - Function name convention:

    - do_action: action functions
    - display_stuff: prinf functions
    - session_stuff: session functions
    - user_stuff: user functions
    - config section: free naming convetion
    - sqlite_database and sqlite_blog classes: free naming convention

  - Namespaces:

    - id: post id
    - uid: username id
    - cid: comment id