CREDITS

Date:    2004-12-20
Version: 0.0.1
File:    glcmi-0.0.1.tar.gz
Author:  Mike Green <mikey at badpenguins dot com>
License: GPLv2

NOTES

glcmi (Geeklog Copyright Managment Information) is a plugin/mod that:

1)  Allows authors to select from a system administrator provided list of
    licenses when posting articles or comments.
2)  Allows administrators to change licensing information and author 
    attribution on articles or comments.
3)  Displays the user selected license when showing articles/comments.
4)  Adds cmi.add, cmi.edit, cmi.list, and cmi.delete perms to allow CMI
    moderation by groups of users.
5)  Creates two groups during installation - CMI Admins and CMI Moderators.
    CMI Admins can add licenses to the system, CMI Moderators can alter CMI
    on existing posts.
6)  By default adds cmi.list perms to All Users so that any user can select
    licensing information when posting, even anonymous posters.

FILE LIST

plugins/cmi/language/english.php
    Addition of $LANG_CMI array for messages.
plugins/cmi/templates/admin/*.thtml
    Templates for manipulating licenses, template for editing CMI on comments.
plugins/cmi/config.php
    Configuration settings.  At the time of this writing, none of these
    settings should be modified with the possible exception of the table names.
    The remaining enable flags are not used at this time.
plugins/cmi/functions.inc
    Functions used for various plugin/mod operations.
public_html/admin/plugins/cmi/index.php
    Traffic cop to call various plugin related functions.
public_html/admin/plugins/cmi/install.php
    Installs/uninstalls the plugin.
public_html/admin/moderation.php
    Modified Geeklog moderation.php.
public_html/admin/story.php
    Modified Geeklog story.php.
public_html/article.php
    Modified Geeklog article.php.
public_html/comment.php
    Modified Geeklog comment.php.
public_html/lib-common.php
    Modified Geeklog lib-common.php.
public_html/license.php
    Called to edit licensing information on existing posts.
public_html/submit.php
    Modified Geeklog submit.php.
public_html/layout/*/admin/story/cmi-storyeditor.thtml
    Modified storyeditor.thtml with selection list to select license when
    drafting articles.
public_html/layout/*/article/cmi-printable.thtml
    Adds license information to bottom of printable page.
public_html/layout/*/comment/cmi-comment.thtml
    Adds display of license information to comments.
public_html/layout/*/comment/cmi-commentform.thtml
    Modified commentform.thtml with selection list to select license when
    posting comments.
public_html/layout/*/submit/cmi-submitstory.thtml
    Modified submitstory.thtml adds selection list to select license
    when posting article for submission.
system/lib-story.php (geeklog 1.3.10 only)
    Modified geeklog lib-story.php.

DATABASE MODIFICATIONS

Adds a lid (license id) column to the comments, stories, and storysubmissions 
tables.  These columns are removed if the plugin is uninstalled.  Creates
cmi_licenses table to store license information (license name, version, url,
etc).  The entire text of the license can be added but at the time of this
release it cannot be viewed by users.  Use URLS for now.

INSTALLATION

Before installation, backup your database and geeklog install!  If you have a
large comments, stories, or storysubmissions table, verify that the
appropriate php timeout settings are adequate.  You DO NOT want the plugin
install to timeout as it is updating tables!  Refer to your php documentation
on setting these values before proceeding.

If you are starting with a freshly untarred geeklog, the simplest method
is to simply patch the source code with the provided patch and then proceed
as normal with the geeklog installation.  For example if you have just 
untarred geeklog 1.3.9, perform the following commands:

cd geeklog-1.3.9
patch -p1 </path/to/glrevive/patches/geeklog-1.3.9-cmi.patch

If you are working with a site that has already been installed and configured,
manually copy to the correct locations.  If you using a custom theme, create
copies of the templates before installing the plugin via the admin plugin
menu.  There are basically two variables that need to be added to the
templates, {license_link} and {license_option}.  The {license_link} is
what displays the licensing information on articles and comments, the
{license_option} displays the select box that allows authors to select
licensing for posts.  The templates have to be named cmi-x.thtml.  Run a diff
on comment.thtml and cmi-comment.thtml to see exactly changes might need to
made to custom templates.

For sites that have been heavily modified, it is safe to copy the entire
plugins/cmi directory over, all templates, then view the patch files to 
manually modify an exising installation.

After patching, don't forget to set the correct path to config.php in
public_html/lib-common.php.  Finish the install by logging in as admin 
and install the plugin through the plugins menu.

After installation of the plugin, every article and comment will be set to the
default license, which is "Contact Author".  Several Creative Commons Licenses
are installed as well as the GNU Free Documentation License.  These licenses
can be removed via the "CMI Admin" link in the Admin Menu.

To uninstall the plugin, load /plugins/cmi/install.php?action=uninstall.
Uninstalling will remove all CMI from the database!

Have Fun!