Zikula Community

Developer Documentation

This section contains documentation on all aspects of coding for the Zikula Application Framework. If you have any questions, please post in the developers forums∞.

Introduction to Developing for Zikula

• Coding Standards
• Versioning and Release Standards

FAQ

• How Do I Submit a Bug Report/Feature Request?
• How Do I Submit a Patch?
• How Do I Join the Developers Team?∞

Working with the Cozi

The "Cozi" is the nickname for the public development and code depository. Cozi is short for COde.ZIkula.org

• Hosting Your Projects? at http://code.zikula.org∞
• Cozi Wiki formatting∞ (slightly different than here)
• About the Cozi Wiki Engine∞
• Code Management with SubVersion
• Integrating SVN Commits and Cozi/trac tickets
• How Do I Release My Code??
• Writing a Release Announcement? for http://community.zikula.org∞
• Submitting your project? to the Extensions Database∞

Translation Index

Templating

• Introduction to Templating
• Overriding Templates
• Icon Sets
• Structure of Templates For a Consistent Administration Interface
• Hooks in Templates - Place Them Wherever You Like

Technologies

• Zikula API
• Programming Permissions
• Database Access Using DBUtil
• ADOdb Data Dictionary e.g. ADOdb database field types
• Creating Module Dependencies
• Categorising Data Using CategoryUtil
• Logging Errors and Messages Using LogUtil
• Using Page Variables
• Web Forms Using the pnForms Framework
• Using Ajax
• Locking Pages for Single-User Access Using PageLock Module
• Creating Workflows Using WorkflowUtil
• Using Other Database Servers Than MySQL
• About deprecated and obsolete stuff

Module authoring

• Introduction to Writing a Module
• Basic File Structure
• Programming a Module Part 1 - Calling Modules from the Browser
• Programming a Module Part 2 - Module Variables
• Programming a Module Part 3 - pnRender Template Display
• Programming a Module Part 4 - Search Functionality
• Programming a Module Part 5 - Module Initialization
• Programming a Module Part 6 - Module Upgrades
• A Module Example Part 1: Defining the StrainID module - Determining the needs of the module and the process of module creation.
• A Module Example Part 2: Security and version of the StrainID module - Writing pnversion.php
• A Module Example Part 3: The initialization code of the StrainID module - Writing pntables.php and pninit.php
• A Module Example Part 4: The admin interface of the StrainID module - Writing pnadmin.php and pnadminapi.php
• A Module Example Part 5: The user interface of the StrainID module - Writing pnuser.php and pnuserapi.php
• Standard Functions Within a Module
• Guidelines for Module Developers
• Utilizing Hooks in your module (allowing your module to be hooked)
• Creating a Hook? for other modules in your own (hooking to other modules)
• Adding Your Module to Zikula's Tour Module
• Porting old-style pnHTML Modules to pnRender

Block authoring

• Writing a Block

Plugin authoring

• Introduction to Plugin Architecture
• Writing a Template Function?
• Writing a Modifier

Theme Authoring Index

• Introduction to Creating a Theme
• Anatomy of a Theme
• Components of a Theme
• Design Guidelines
• Theme Templates
• Preview Images
• Porting an Open-Source Template
• Variables Available in Theme Templates
• Using Custom Filters
• A List of Standard Plugins

HOWTOs

• How to Build a Distribution
• How to Create a Language Pack
• How to Customize Zikula for SEO
• How to Make a Whiz-Bang-Fancy Ajax-based Pop-up Login Window in Zikula

Miscellaneous

• Links to External Libraries∞ Used by Zikula
• Useful Tips and Tricks That Don't Fit Anywhere Else
• Google SOC Projects
• Samples code (DBUtils, pnform ...)∞
• Eclipse Formater∞

---

CategoryDocumentation
CategoryDeveloperDocs