Krang Documentation Archive

Welcome to the Krang documentation archive. This section of the site is autogenerated from the docs/ directory in the latest Krang CVS checkout.

Admin Documentation

Install - how to install Krang
Running Krang - a guide to getting Krang up and running after installation (unfinished)
Running Krang on Your Desktop - a guide to setting up Krang in a desktop environment.
Upgrade - how to upgrade an existing Krang installation
Backup and Restore - how to backup and restore Krang
Configuration - how to configure Krang
Add-On Installation - how to install Krang add-ons
Script Documentation - documentation for all scripts in the bin/ directory.
Changelog - a list of changes for each version of Krang

User Documentation

Writing Templates - guide to template creation
Customizing Publish - guide to customizing the publish process
Element System - the Krang element system
Creating an Element Library in Krang - How to create your own element library in Krang
Module Documentation - complete Krang module API documentation

Krang Developer Documentation

Coding Standards - rules for Krang development
Development Install - how to install a new Krang instance for developers
Porting Krang - How to port Krang to a new platform.
Building a Krang Add-On - How to build a Krang add-on
Add-On HOWTO 1 - Adding Custom Navigation Entries
Skins - How to create a Krang skin
Adding CPAN Modules - how to add a new CPAN module to Krang
Upgrade System - How the Krang upgrade system works.
Releasing Krang - how to make a krang distribution
Build System - How the Krang build system works.
Localization API - How to use Krang's localization API.

Technical Reference / Design Documentation

ToDo List - the current Krang ToDo list
Goals - goals of the Krang project
Technical Specification - general technical overview (somewhat out of date)
XML System - the Krang XML system
Krang Permissions System - How the Krang permissions system works.
Scheduler Technical Design - How the Krang scheduler works.
Krang vs. Bricolage - Krang/Bricolage comparison document
Performance - Performance test results
CPAN Module Inventory - A list of all CPAN modules included with Krang
Database Schema Diagram - graphical overview of the database