Requirements and Design Specifications
From KnowledgeTree Document Management Made Simple
This page provides information for the KnowledgeTree Development Community on Requirements and Design documentation, covering existing and proposed new features for KnowledgeTree.
Contents |
Contributing Specifications
Your contributions to this list are most welcome! Logging a feature request in our Issue Tracker tells us what you'd like to see in KnowledgeTree, but developing those features will be quicker and easier if you provide some formal documentation around behavior. This helps everyone to understand your idea, and encourages the involvement of other community members.
What should the Specification include?
In your specification, please include the following sections:
- Purpose of the feature (i.e. what problem does it solve)
- Status - proposal, specification, implementation
- Dependencies - any modules that the new feature may depend on to be installed
- Impacting modules - existing functionality/modules that may need to change
- Usage scenarios - how the new feature would be used
- References - any references to sources of additional information
Terms and Definitions
Needs content. Descriptions of the various terms and definitions of KnowledgeTree concepts.
System Architecture
This article describes the KnowledgeTree architecture from the source perspective to provide guidance on how the source folder is structured.
Database
Database Schema
An description of all tables, including: table name, fields, primary key, foreign keys, indexes.
Database Schema Diagrams
Needs content. A set of diagrams illustrating the relation between tables within KnowledgeTree.
Object Model
Object Model Framework
Discusses current classes that implement core functionality within KnowledgeTree. Discusses internals of the KnowledgeTree framework.
Object Model Diagrams
A set of diagrams for the existing KnowledgeTree framework.
Plugin Versioning
This is the specification for the new mechanism for version management on plugins within KnowledgeTree.
Hot Fix Management
This is a draft specification for an update manager to apply hot fixes to the system.
KT Model API
This is a new model that wraps existing functionality.
KT Model API Diagrams
This is a set of diagrams for the new KT API.
User Interface
User Interface Framework
This document describes the components in the User Interface.
Search
This describes how to add additional search options to KnowledgeTree.
User Interface Plugins
This contains the requirments, design and implementation of various plugins in KnowledgeTree.
Customising the User Interface
This document describes how you can change the look of KnowledgeTree by editing the CSS, Smarty Template, and configuration files.
Web 2.0
Dashboard
This is the specification for the KnowledgeTree Dashboard.
RSS Feeds
This is the specification for RSS Feeds.
Tag Clouds
This is the specification for the KnowledgeTree Tag Cloud.
File Upload
This is the specification for how file uploads will work when adding a document or checking in a document.
Batch Import of Related Files
This is the specification to extend the file upload to also import related files.
Batch Export of Related Files
This is the specification to export related files when checking out or downloading a document.
Storage Management
Flexible Document Storage Engine
This is the specification for the flexible document storage engine which allows for various storage devices to be used in KnowledgeTree.
Document Storage Integrity
This specification documents how KnowledgeTree manages document integrity and detects if files have been tampered with.
Document Versioning
This is the specification for the Custom Document Versioning plugin where KnowledgeTree installations may have a custom metadata version field that can be updated according to custom requirements.
Repository Export
This is the specification for the Repository Export utility to extract all documents from the repository.
Repository Import
This is the specification for the Repository Import utility to assist users in importing documents and metadata from an external source into KnowledgeTree.
Offline Processing
Scheduling Background Events
This describes the implementation of background scheduling within KnowledgeTree on which additional processes can be implemented.
Indexing
This describes the mechanism for implementing offline indexer processing of documents.
Notifications
This describes the mechanism for sending notifications.
Document Management
Workflow
Incomplete: Page for requirements, specification, and implementation around workflow and workflow plugins.
Event Scheduler
This is the specification on timed events within KnowledgeTree.
Calendar
This is a specification for a calendar component within KnowledgeTree.
Document Numbering
Documents are generally referenced via a document id. This is a numeric id.
To assist software integrators, documents may also be referenced using Integration IDs.
Web Services
Web services is a great way of exposing functionality in that is platform and language independent.
SOAP Web Service Specification
KnowledgeTree web service available by svn.
KnowledgeTree web service guide
System Administration
Backup
This is the specification for the backup administration plugin.
Guide To High Availability
Support for Mac OS
Required Features
Required Software Integration
del.icio.us
digg
reddit
facebook
stumbleupon
