How to Develop for KnowledgeTree

From KnowledgeTree Document Management Made Simple

Contents 1 Environment 2 Architecture 3 Datamodel 4 KnowledgeTree Coding Basics 4.1 Developing plugins 4.2 User Interface Development 4.3 New Developments 5 Tutorials 6 Knowledgebase Articles 7 KnowledgeTree Components Needing Community Attention 8 Additional Resources

Environment

• Programming language: PHP

• Uses the PEAR DB classes, but abstracts this behind its own DBUtil class (lib/database/dbutil.inc). Currently, KnowledgeTree provides only install and upgrade scripts for MySQL.

• Uses the Smarty templating languages, but abstracts this behind its own templating abstraction (lib/templating/templating.inc.php and lib/templating/template.inc.php, and lib/templating/smartytemplate.inc.php).

Architecture

See the KnowledgeTree Architecture diagram - a graphical overview of KnowledgeTree's architectural roadmap.

Datamodel

See the KnowledgeTree Datamodel representation - a table format overview of the core document and folder structure.

KnowledgeTree Coding Basics

This section provides information on the basics of coding in the KnowledgeTree environment, including editing templates, i18n issues, and writing new dispatchers:

• Dispatchers - incomplete
• Templating - an overview to working with the smarty templating engine in KnowledgeTree
• KTEntity
• Errors - what to do and how to use them properly.
• Developing i18n support - discusses Internationalization and the process of providing support for multiple locales, with Translation as the primary focus for KnowledgeTree.
• Login process - a guide to how KnowledgeTree handles login, including a discussion on interceptors

• Major API Components
  • KTDocumentUtil
    • Metadata array format
  • FolderUtil
  • KTPermissionUtil

Developing plugins

This section provides links to pages on the Wiki where you can find more information on writing Plugins for KnowledgeTree:

• Plugin Registration - incomplete.
• Workflow Triggers
• Custom Database Tables

User Interface Development

All those pretty little things ...

• Form Machinery
  • Forms
  • Widgets
  • Validators
  • Creating New Widgets
  • Creating New Validators

• Javascript

• Core CSS
  • Smarty Primer
  • Links within KnowledgeTree

See Also: UI Development

New Developments

• Search2
• Scheduler
• Zip Class

Tutorials

A growing selection of developer tutorials are available on the Tutorials page on this Wiki.

Knowledgebase Articles

A list of resource articles around KnowledgeTree functionality and concepts.

KnowledgeTree Components Needing Community Attention

• KnowledgeTree WebDAV 3rd-Party Client Support

Additional Resources

• KnowledgeTree Community Forums: This is where you can discuss development issues with other developers

• IRC Channel: For more 'realtime' discussions, you can find us on #knowledgetree on irc.freenode.net.

• For language packs and plugins, see the KnowledgeTree Forge