Difference between revisions of "Developer Manual"
| Line 20: | Line 20: | ||
Coding standards are simple and follow the PEAR system rigidly without exception. See the page blow for further detail. Some further guidance is given below to try to help you build new code in a way that fits into the overall ARK style. This material is incomplete at this stage. | Coding standards are simple and follow the PEAR system rigidly without exception. See the page blow for further detail. Some further guidance is given below to try to help you build new code in a way that fits into the overall ARK style. This material is incomplete at this stage. | ||
| − | [[Coding Standards]] | + | ====[[Coding Standards]]==== |
| + | An overview of the coding standards with a link to PEAR. | ||
| − | [[Adding a New Page]] | + | ====[[Adding a New Page]]==== |
| + | How to add a new page to the system | ||
| − | [[Data Entry Pages]] | + | ====[[Data Entry Pages]]==== |
| + | How the data entry pages fit together. Possibly needs to be re-written as something more generic | ||
| − | [[Page Header Block]] example. | + | ====[[Page Header Block]]==== |
| + | example code for a page header block. Possibly needs to be made into a more generic code snippets page | ||
| − | [[Developing Subforms]] | + | ====[[Developing Subforms]]==== |
| + | A brief guide to developing new subforms | ||
| − | [[Accessing User Information]] which is in the SESSION | + | ====[[Accessing User Information]]==== |
| + | How to get access to the logged in user's information which is held in the SESSION | ||
| − | [[ARK log]] | + | ====[[ARK log]]==== |
| + | An overview of the log system with detailed notes (note that this system is currently not fully working) | ||
| − | [[Markup and Aliases]] | + | ====[[Markup and Aliases]]==== |
| + | An overview and guide | ||
| − | [[Error and Message Handling]] | + | ====[[Error and Message Handling]]==== |
| + | An overview and guide | ||
| − | [[Configuration Settings for Developers]] | + | ====[[Configuration Settings for Developers]]==== |
| + | An overview for developers of the config system | ||
==API Documentation== | ==API Documentation== | ||
Revision as of 10:02, 27 February 2009
The developer manual is aimed at people who will be contributing to the project and to a certain extent to those who intend to hack ARK to use it for their own ends. As a general rule, if you find yourself doing extensive hacking, please let us know as we would be happy to consider adding new code to the project.
If you don't know why you are reading this documentation, you are probably looking in the wrong part of the manual. For information on installation and administration see the administrator section of the manual.
Work to create developer documentation including migration of old documentation (Ticket #122) is ongoing (as of 11th Feb 2009) but in the meantime please contact a member of the ARK Development Team if you can't find what you are looking for within these pages.
Background Reading
ARK model
An incomplete guide to the overall structure of ARK, its file structures etc.
ARK Data Storage
An overview of the ARK data storage model
Filters
An overview of filters and how they work (theoretical)
Standards and Guidance
Coding standards are simple and follow the PEAR system rigidly without exception. See the page blow for further detail. Some further guidance is given below to try to help you build new code in a way that fits into the overall ARK style. This material is incomplete at this stage.
Coding Standards
An overview of the coding standards with a link to PEAR.
Adding a New Page
How to add a new page to the system
Data Entry Pages
How the data entry pages fit together. Possibly needs to be re-written as something more generic
Page Header Block
example code for a page header block. Possibly needs to be made into a more generic code snippets page
Developing Subforms
A brief guide to developing new subforms
Accessing User Information
How to get access to the logged in user's information which is held in the SESSION
ARK log
An overview of the log system with detailed notes (note that this system is currently not fully working)
Markup and Aliases
An overview and guide
Error and Message Handling
An overview and guide
Configuration Settings for Developers
An overview for developers of the config system
API Documentation
The code is documented in detail within the header blocks for each file and the documentation blocks for each function. This doucmentation is in the process of being categorised and grouped for easier reading, but can be consulted at:
