ATK Reference: Difference between revisions

Revision as of 20:29, 14 September 2006

This part of the wiki is intended to supply a complete reference to every part of ATK.
It aims to provide high level documentation on every part of ATK.
For further detailed information about the objects/methods and functions of ATK, please visit the ATK API documentation.

Reference categories

Modules

ATK is a modular framework and as such all functionality in ATK applications reside in modules.

Attributes

A node is built with attributes. Attributes are comparable to datatypes of fields in the database. They describe the content and house all functionality for dealing with that content.

Actions

In order to use a node ATK uses 'actions', these include but are not limited to CRUD functions of a database (corresponding to the Add, View, Update and Delete actions in ATK).

Graphical User Interface

ATK posesses serveral methods of output handling and automated generating of a GUI.

Testing

ATK uses and extends the SimpleTest Testing framework for Test driven development.

Languages

ATK fully supports the creation of multi-language applications.

Nodes

A node is comparable to a table in a database, which groups certain data elements in one collection.
An ATK node provides all the functionality for one data collection.

Relations

To associate nodes with eachother ATK makes use of Relations, these are comparable to relations in ERDs (one-to-one, one-to-many, etc.).

Meta functionality

ATK now supports on-the-fly generation of nodes and attributes by using the metadata of your database. A very powerfull tool for quick development of web applications on an existing database.

Utilities

ATK provides various objects and functions for performing common tasks like traversing a directory, parsing stringings, debugging, etc.

Security

ATK supports various methods of authentication (users) and authorisation (privileges).

@@ Line 1: / Line 1: @@
 <div align=right style="float: right; padding: 20px;">__TOC__</div>
-== Introduction ==
 This part of the wiki is intended to supply a complete reference to every part of ATK.<br />
 It aims to provide high level documentation on every part of ATK.<br />
 For further detailed information about the objects/methods and functions of ATK, please visit the [http://achievo.org/docs/atk/latest/ ATK API documentation].
-== References categories ==
+== Reference categories ==
 {|
 |-
 | valign="top" |
 === [[ATK Reference Modules|Modules]] ===
+ATK is a modular framework and as such all functionality in ATK applications reside in modules.
-ATK is a modular framework and as such all functionality in ATK applications reside in modules.<br />
-This category lists everything about modularity.
 <!--An [[example module.inc file]] [[Module Flags]] -->
 === [[ATK Reference Attributes|Attributes]] ===
+A node is built with attributes. Attributes are comparable to datatypes of fields in the database. They describe the content and house all functionality for dealing with that content.
-A node is build with attributes. Attributes are comparable to datatypes of fields in the database. They describe the content and house all functionality for dealing with that content.
 <!--[[List of attributes]][[Attribute Flags]][[Attribute-level Security]]-->
 === [[ATK Reference Actions|Actions]] ===
+In order to use a node ATK uses 'actions', these include but are not limited to [http://en.wikipedia.org/wiki/CRUD_%28acronym%29 CRUD] functions of a database (corresponding to the Add, View, Update and Delete actions in ATK).
 === [[ATK Reference GUI|Graphical User Interface]] ===
+ATK posesses serveral methods of output handling and automated generating of a GUI.
 === [[ATK Reference Testing|Testing]] ===
+ATK uses and extends the [http://www.simpletest.org SimpleTest Testing framework] for [http://en.wikipedia.org/wiki/Test_driven_development Test driven development].
+=== [[ATK Reference Languages|Languages]] ===
+ATK fully supports the creation of multi-language applications.
 | valign="top" |
 === [[ATK Reference Nodes|Nodes]] ===
 A node is comparable to a table in a database, which groups certain data elements in one collection.<br />
 An ATK node provides all the functionality for one data collection.
 <!--A module consists of one or more nodes. ATK knows 3 node types: [[atkNode]], [[atkTreeNode]] and [[atkMetaNode]]
@@ Line 45: / Line 42: @@
 === [[ATK Reference Relations|Relations]] ===
+To associate nodes with eachother ATK makes use of Relations, these are comparable to relations in [http://en.wikipedia.org/wiki/ERD ERDs] (one-to-one, one-to-many, etc.).
-General explanation of [[relations]] in atk.
+<!--General explanation of [[relations]] in atk.-->
 === [[ATK Reference Meta|Meta functionality]] ===
+ATK now supports on-the-fly generation of nodes and attributes by using the metadata of your database. A very powerfull tool for quick development of web applications on an existing database.
 === [[ATK Reference Utilities|Utilities]] ===
+ATK provides various objects and functions for performing common tasks like traversing a directory, parsing stringings, debugging, etc.
 === [[ATK Reference Security|Security]] ===
+ATK supports various methods of authentication (users) and authorisation (privileges).
+|}
+== Miscellaneous References ==
+===[[ATK Reference Constants|Constants]]===
+Various constants used by ATK.
-|}
+===[[ATK Reference Database connections|Database connections]]===
-== References ==
+Information about database connections in ATK.
+=== [[ATK Reference Extensions|Extensions in ATK]] ===
+Various 'extensions' in ATK, other Open Source software that is included in ATK.
-[[Available Open Source software in ATK]]<br />
+===[[ATK Reference Sessions|Sessions]]===
-[[Constants]]<br />
+ATK has advanced session handling methods for remembering and application data.
-[[ATK Reference Database connections|Database connections]]<br />
+<!--[[SessionVariables]]<br />-->
-[[ATK Reference Sessions|Sessions]]<br />
-<!--Application state is remembered in sessions.<br />
-[[SessionVariables]]<br />-->