KNOTES

***
**Please read this document #fully# before contacting
**any member of the KnowNet                          
*

KNotes is a fully featured communications suite for Plone.  
The initial product was developed by the knownet to satisfy their needs for a
simple fast discussion forum.  The speed comes from the use of an external sql
database for delivery of data, which produces excellent results.  Since the
initial specification, KNotes has become rich in content and now includes 
components to cover any portal communication needs.

Components:

 KNWeblog -      Standards compliant blogging application with full support for
                 Blogger, metaWeblog and Movable Type.  API implemntation allows
                 use of external blogging apps such as Ecto 
                 (http://ecto.kung-foo.tv/).


 KNDiscussion -  Base class for comments and blog entries.
 
 KNBlog -        Weblog entry
                 
 KNLink -        A standard link object extended to support trackback,
                 and also to add some support for cross-posting to del.icio.us accounts.
                 
 KNExFile -      Lightly adapted ExFile for use in the KNotes system

Prerequisites:
    Zope (goes without saying realy)
    CMF-1.4 (min)
    CMFPlone-2
    
In addition to the above, you will need access to a suitable database server and
a python adapter for connecting from within Zope.  The system has been fully 
tested with PostgreSQL (http://www.postgresql.org/) and psycopg 
(http://initd.org/software/initd/psycopg) Please seek advice on installing 
these product from the relavant website. 

There is no reason why KNotes will not not work with other databases such as 
MySQL etc, as long as there is Zope support, however you will need to make a
change to the main SQL script. open KNSQL.py in a text editor and look for the 
line '    def doDBQ(self,qs):'. This method is suitable only for use with
psycopg. We will over time supply methods for other adapters but feel free to
write your own.

Installation:

Prior to installing KNotes you will need to ensure that the SQL database is
installed and a database configured, preferably with the name 'zope'.

1 - Use portal quickinstaller to install the product

2 - In the ZMI, in the root of your portal, open kndiscuss_sql (KNotes Config Tool)

    - note the tabs: DB Access, DB Status,Anonymous Comments
    
    - go to the 'DB Access' tab
        - select a database type from the drop-down menu ( MYSQL or PGSQL)
        - fill in the values from your own database set-up for  DBMS Database Name,
            DBMS Username, DBMS Hostname and DBMS password.
            (By default, the database name will be assumedto be 'zope')
            
    - go to the 'DB Status ' tab
        - when first insalled, KNotes will show a button called 'Create Tables'.
          Click that button to generatwe the tables that KNotes will use.
        - after the tables have been created, you will no longer see that button,
          but can use the DB Status tab to see a summary of the database use.
          
    - If you want to allow Anonymous Comments, go to the 'Anonymous Comments' tab
       and set your preferences.  The 'Anonymous Username' field is for the name that
       will be used for the portal member used to backend anonymous comments.
       The 'Anonymous comments' checkbox controls whether anonymous comments will be allowed.
       The 'Allow join from anonymous comment form' checkbox controls whether non-members
       of the portal will be able to register as members in the same user-interface gesture
       as they use to post a comment (this assumes a registration policy in which passwords
       are autmatically generated and emailed to the registering email address).


3 - Thats it!


After installation all portal content becomes trackback aware.  The database
maintains a list of all backlinks.  By default these trackbacks are displayed in
a portlet on the left hand side of the page. If you do not whish to show 
trackbacks, then do the following:

    in the root of your potal; click the properties tab. You should now see a 
    lines field titled 'left_slots'. Amongst the defined portlets, there will be
    two entries created by KNotes:
    
        'here/trackback_portlet/macros/portlet'
        
        This entry controls the display of trackback on the rendered page.  if 
        do NOT want to show trackback, then removing ths line will do the trick
        
        'here/rdf_portlet/macros/portlet'
        
        This entry embeds into every page, the necessary code to attract a 
        trackback ping.  If you want to stop the collection of trackback data, 
        then removal of this entry is needed.
        
    If you whish to alllow collection of trackback data at some later date, 
    reinstating the entries above is all thats needed.

Uninstallation:

The uninstaller will return your system to the state prior to installtion, 
removing any installed components and reinstalling any removed componens. 


futher information on this and any other 'KN' product can be found at our 
website - www.theknownet.com.

If you run into any difficulties installing this product
email stephen@theknownet.com for advice.


Good luck & Enjoy