NusaATK - User contributions [en]

Achievo/Howto/Developers/Create pim items

2006-03-17T21:05:08Z

82.176.160.186:

''Author'': Sandy Pleyte

''Last modified'': 17 March 2006

''Complexity'': Easy

== Intro ==
In Achievo it's possible to create [[pim]] items in your own module. As of Achievo 1.2 it's possible for users to choose what [[pim]] items they want to show on they [[pim]] page. This howto explains how to accomplish this.

== Achievo 1.1 and below ==
If you want to add a [[pim]] item to your module, you should extend your module class with the following function:

<code>
function getPimItems()
{
return "This is my Pim Item";
}

</code>

If you want more then 1 [[pim]] item, you should collect the result and return it as one variable.

<code>
function getPimItems()
{
$ret = "";
$ret.= $this->getExample1();
$ret.= $this->getExample2();
return $ret;
}
</code>

== Achievo 1.2 and above ==

In Achievo 1.2 and above it's possible to specify 1 or more [[pim]] items for a module. To get this result you need to extend your module class with the following function:

<code>
function getPimItems()
{
return array("example1"=>"getExample1",
"example2"=>"getExample2");
}

function getExample1()
{
return "Example 1 Pim item";
}

function getExample2()
{
return "Example 2 Pim item";
}
</code>

As you can see in stead of returning the content for the [[pim]] page, we now return an array with the [[pim]] item name and the function to call.

Achievo/Howto/Developers/Create pim items

2006-03-17T21:03:14Z

82.176.160.186: /* Intro */

"Author": Sandy Pleyte

"Last modified": 17 March 2006

"Complexity": Easy

== Intro ==
In Achievo it's possible to create pim items in your own module. As of Achievo 1.2 it's possible for users to choose what pim items they want to show on they pim page. This howto explains how to accomplish this.

== Achievo 1.1 and below ==
If you want to add a pim item to your module, you should extend your module class with the following function:

<code>
function getPimItems()
{
return "This is my Pim Item";
}

</code>

If you want more then 1 Pim item, you should collect the result and return it as one variable.

<code>
function getPimItems()
{
$ret = "";
$ret.= $this->getExample1();
$ret.= $this->getExample2();
return $ret;
}
</code>

== Achievo 1.2 and above ==

In Achievo 1.2 and above it's possible to specify 1 or more pim items for a module. To get this result you need to extend your module class with the following function:

<code>
function getPimItems()
{
return array("example1"=>"getExample1",
"example2"=>"getExample2");
}

function getExample1()
{
return "Example 1 Pim item";
}

function getExample2()
{
return "Example 2 Pim item";
}
</code>

As you can see in stead of returning the content for the pim page, we now return an array with the pim item name and the function to call.

Achievo/Howto/Developers/Create pim items

2006-03-17T21:02:43Z

82.176.160.186:

"Author": Sandy Pleyte

"Last modified": 17 March 2006

"Complexity": Easy

== Intro ==
In Achievo it's possible to create pim items in your own module. As of Achievo 1.2 it's possible for users to choose what pim items they want to show on they pim page.

== Achievo 1.1 and below ==
If you want to add a pim item to your module, you should extend your module class with the following function:

<code>
function getPimItems()
{
return "This is my Pim Item";
}

</code>

If you want more then 1 Pim item, you should collect the result and return it as one variable.

<code>
function getPimItems()
{
$ret = "";
$ret.= $this->getExample1();
$ret.= $this->getExample2();
return $ret;
}
</code>

== Achievo 1.2 and above ==

In Achievo 1.2 and above it's possible to specify 1 or more pim items for a module. To get this result you need to extend your module class with the following function:

<code>
function getPimItems()
{
return array("example1"=>"getExample1",
"example2"=>"getExample2");
}

function getExample1()
{
return "Example 1 Pim item";
}

function getExample2()
{
return "Example 2 Pim item";
}
</code>

As you can see in stead of returning the content for the pim page, we now return an array with the pim item name and the function to call.

Achievo/Howto/Developers/Create pim items

2006-03-17T20:50:37Z

82.176.160.186:

[[Create Pim Items]]

Author: Sandy Pleyte
Last modified: 17 March 2006
Complexity: Easy

== Intro ==

== Achievo 1.1 and below ==

== Achievo 1.2 and above ==

Achievo

2006-03-17T20:48:49Z

82.176.160.186: /* Howto */

== Manuals ==
At this moment we have 2 small manuals:

[[Installation]]

[[Guided Tour]]

== Howto ==

[[Create Pim Items]]

[[Languages]]

Achievo

2006-03-17T20:48:37Z

82.176.160.186: /* Manuals */

== Manuals ==
At this moment we have 2 small manuals:

[[Installation]]

[[Guided Tour]]

== Howto ==

[[Create Pim Items]]
[[Languages]]

Guided Tour

2006-01-25T19:52:17Z

82.176.160.186:

Guided Tour

Achievo Installation

2006-01-25T19:51:35Z

82.176.160.186:

== Installation Procedure ==
Note that this guide does not describe how to install a webserver or PHP or a database server. See the documentation for these programs on how to install those. This installation guide assumes that you already have a working webserver with PHP support and a MySQL database installed.

'''Important''': this is the installation instruction for Achievo versions 1.0.RC1 and higher. The setup.php script mentioned did not yet exist in older versions. Older versions all contain a doc/ directory though inside the tar.gz file, which contains an INSTALL file describing how to get Achievo installed without a setup.php script.

== Unpacking ==
After you've [http://www.achievo.org/download downloaded] Achievo, untar the entire achievo archive to a place where you can access it with your webserver.

example:
$ cd /usr/local/apache/htdocs # change to a web accessible directory
$ tar xzvf ~user/achievo_x.x.tar.gz # unpack the tar.gz file

optional:
$ ln -s achievo_x.x achievo # make a symbolic link

== Create the database ==
Create an empty database in mysql and a user that has create, alter,
select, insert, update and delete-access on the database.

example (assuming your mysql root password is 'secret'):

$ mysql -u root --password=secret mysql
mysql> create database achievo_1_0;
mysql> grant create,alter,select,insert,update,delete on achievo_1_0.*
to achievo@localhost identified by 'secret';
mysql> quit;

This creates a database named 'achievo_1_0', and a user with username
'achievo' and password 'secret'.

''Note'': the create and alter privileges are only needed during installation and upgrades. You can revoke these privileges once the installation is complete.

''Note 2'': if you are using MySQL 4, you must also grant the 'lock tables' privilege to the user.

== Configure Achievo's database connection ==
Edit the file config.inc.php in the achievo directory, and set the
$config_databasehost, $config_databasename, $config_databaseuser and
$config_databasepassword, $config_database variables to match your setup.

example:

$config_databasehost = "localhost";
$config_databasename = "achievo_1_0";
$config_databaseuser = "achievo";
$config_databasepassword = "secret";
$config_database = "mysql";

== Configure administrator login ==
In the same configuration file there is a variable $config_administratorpassword. This is the password you need on your first login. You might want to change this password.

There are some other things in the config-file that you can change, but
for your first configuration, you can leave those settings to the default.

== The Achievo database setup script ==
After editing the configuration file, point your browser to the setup.php script in the Achievo directory. For example:

http://yourserver/achievo/setup.php

You'll be prompted to login. Enter 'administrator' as username and the password you've set in step 4.

Follow the instructions. Achievo will first perform some system checks, to see if your PHP configuration is up to date. If it discovers any problems, it will tell you how to solve them. If everything is ok, it will install the database for you.

== Finished! ==
Once the setup.php script is completed, you'll be ready to run Achievo.
You can point your browser to the Achievo directory, like this:

http://yourserver/achievo/

If this is the first time you're using Achievo, you might want to take the [[Guided Tour]], which will show you everything you should do to make Achievo useable for your users.

== Cron script setup ==
Achievo contains some useful cron scripts that can be run periodically from a cron job. See the cron/README file in the Achievo distribution for available cron features and instructions.

Achievo Installation

2006-01-25T19:51:03Z

82.176.160.186:

== Installation Procedure ==
Note that this guide does not describe how to install a webserver or PHP or a database server. See the documentation for these programs on how to install those. This installation guide assumes that you already have a working webserver with PHP support and a MySQL database installed.

'''Important''': this is the installation instruction for Achievo versions 1.0.RC1 and higher. The setup.php script mentioned did not yet exist in older versions. Older versions all contain a doc/ directory though inside the tar.gz file, which contains an INSTALL file describing how to get Achievo installed without a setup.php script.

== Unpacking ==
After you've [http://www.achievo.org/download link downloaded] Achievo, untar the entire achievo archive to a place where you can access it with your webserver.

example:
$ cd /usr/local/apache/htdocs # change to a web accessible directory
$ tar xzvf ~user/achievo_x.x.tar.gz # unpack the tar.gz file

optional:
$ ln -s achievo_x.x achievo # make a symbolic link

== Create the database ==
Create an empty database in mysql and a user that has create, alter,
select, insert, update and delete-access on the database.

example (assuming your mysql root password is 'secret'):

$ mysql -u root --password=secret mysql
mysql> create database achievo_1_0;
mysql> grant create,alter,select,insert,update,delete on achievo_1_0.*
to achievo@localhost identified by 'secret';
mysql> quit;

This creates a database named 'achievo_1_0', and a user with username
'achievo' and password 'secret'.

''Note'': the create and alter privileges are only needed during installation and upgrades. You can revoke these privileges once the installation is complete.

''Note 2'': if you are using MySQL 4, you must also grant the 'lock tables' privilege to the user.

== Configure Achievo's database connection ==
Edit the file config.inc.php in the achievo directory, and set the
$config_databasehost, $config_databasename, $config_databaseuser and
$config_databasepassword, $config_database variables to match your setup.

example:

$config_databasehost = "localhost";
$config_databasename = "achievo_1_0";
$config_databaseuser = "achievo";
$config_databasepassword = "secret";
$config_database = "mysql";

== Configure administrator login ==
In the same configuration file there is a variable $config_administratorpassword. This is the password you need on your first login. You might want to change this password.

There are some other things in the config-file that you can change, but
for your first configuration, you can leave those settings to the default.

== The Achievo database setup script ==
After editing the configuration file, point your browser to the setup.php script in the Achievo directory. For example:

http://yourserver/achievo/setup.php

You'll be prompted to login. Enter 'administrator' as username and the password you've set in step 4.

Follow the instructions. Achievo will first perform some system checks, to see if your PHP configuration is up to date. If it discovers any problems, it will tell you how to solve them. If everything is ok, it will install the database for you.

== Finished! ==
Once the setup.php script is completed, you'll be ready to run Achievo.
You can point your browser to the Achievo directory, like this:

http://yourserver/achievo/

If this is the first time you're using Achievo, you might want to take the [[Guided Tour]], which will show you everything you should do to make Achievo useable for your users.

== Cron script setup ==
Achievo contains some useful cron scripts that can be run periodically from a cron job. See the cron/README file in the Achievo distribution for available cron features and instructions.

Achievo Installation

2006-01-25T19:48:10Z

82.176.160.186:

Achievo

2006-01-25T19:44:00Z

82.176.160.186:

== Manuals ==
At this moment we have 2 small manuals:

[[Installation]]

[[Guided Tour]]

ATK 101

2006-01-25T19:38:53Z

82.176.160.186: added node types

=== General Documentation ===

[[InstallationGuide]]

[[atkMetaNode]]

[[System Requirements]]

=== Modules ===

An ATK Application consists of one or more modules.

A [[CompleteModuleFile]]

=== Nodes ===

A module consists of one or more nodes. ATK knows 3 node types: [[atkNode]], [[atkTreeNode]] and [[atkMetaNode]]

An [[ExampleNode]] file.

[[NodeFlags]]

=== Attributes ===

A node is build with attributes.

[[AttributesExplained]]

[[AttributeFlags]]

[[AttributeLevelSecurity]]

=== Sessions ===

Application state is remembered in sessions.

[[SessionVariables]]

=== Advanced techniques ===

[[Polymorphism]]

=== Misc Tips ===

[[OrderingAttributesWithinANode]]<br />
[[SmartDebug]]