Jump to content

ATK Configuration: Difference between revisions

From NusaATK
Cleaning up the interface for readability
No edit summary
Line 4: Line 4:


== Database Configuration ==
== Database Configuration ==
 
;$config_db["default"]["driver"]
{| class="metadata"
:Which database driver to use
! Configoption || Description || Possible values || Default
:Possible values : [[mysql]],[[mysqli]],[[mysql41]],[[mssql]],[[oci805]],[[oci8]],[[oci9]],[[pgqsl]],[[db2]],[[i5]]
|-
:Default : mysql
| $config_db["default"]["driver"]
| Which database driver to use
| [[mysql]],[[mysqli]],[[mysql41]],[[mssql]],[[oci805]],[[oci8]],[[oci9]],[[pgqsl]],[[db2]],[[i5]]
  | mysql
|}


== GUI Configuration ==  
== GUI Configuration ==  
Line 37: Line 32:


== Relations ==
== Relations ==
;$config_manytoone_autocomplete_minchars
:The number of characters a user must type before a manytoonerelation starts to do autocompletion
:Possible values : Number higher than 0
:Default : 2


{| class="metadata"
! Configoption || Description || Possible values || Default
|-
| $config_manytoone_autocomplete_minchars
| The number of characters a user must type before a manytoonerelation starts to do autocompletion
| Number higher than 0
| 2
|}


== Auth Config ==
== Auth Config ==
;$config_auth_enablepasswordmailer = true;
:This will put an extra button on the longin screen to have a password sent to the email address regered for the username entered. '''Of note''', the following options must also be set for this to work:
:* $config_auth_usernode = "module.nodename";
:* $config_auth_usertable = "user_tablename";
:* $config_auth_userfield = "username_fieldname";
:* $config_auth_emailfield = "useremail_fieldname";
:* $config_auth_passwordfield = "userpassword_fieldname";
:Possible values : True
:Default : N/A
;$config_auth_loginpage = 'http://myurl';
:For applications that do not want to use the atk login form or the htaccess box this config variable can contain an url to redirect to instead of displaying the login form of ATK.
:Possible values : Text with the url
:Default : N/A


{| class="metadata"
! Configoption || Description || Possible values || Default
|-
| $config_auth_enablepasswordmailer = true;
| This will put an extra button on the longin screen to have a password sent to the email address regered for the username entered. '''Of note''', the following options must also be set for this to work: $config_auth_usernode = "module.nodename"; $config_auth_usertable = "user_tablename";  $config_auth_userfield = "username_fieldname"; $config_auth_emailfield = "useremail_fieldname"; $config_auth_passwordfield = "userpassword_fieldname";
| True
| N/A
|-
| $config_auth_loginpage = 'http://myurl';
| For applications that do not want to use the atk login form or the htaccess box this config variable can contain an url to redirect to instead of displaying the login form of ATK.
| Text with the url
| N/A
|}


== Other config ==
== Other config ==
 
;$config_edit_fieldprefix
{| class="metadata"
:This configoption sets the default fieldprefix for all fields in all nodes to use in ATK. If you only want to use the fieldprefix for some of the nodes in your ATK application use the setEditFieldPrefix method of the atknode class instead.
! Configoption || Description || Possible values || Default
:Possible values : Text with the fieldprefix
|-
:Default : N/A
| $config_edit_fieldprefix
| This configoption sets the default fieldprefix for all fields in all nodes to use in ATK. If you only want to use the fieldprefix for some of the nodes in your ATK application use the setEditFieldPrefix method of the atknode class instead.
| Text with the fieldprefix
| N/A
|}

Revision as of 17:50, 21 December 2007

Below is a categorized list of configuration options. This page is far from complete. If you encounter a configuration value in ATK that is not listed here, please help us improve the documentation by adding it.

Within a category, the options are listed alphabetically.

Database Configuration

$config_db["default"]["driver"]
Which database driver to use
Possible values : mysql,mysqli,mysql41,mssql,oci805,oci8,oci9,pgqsl,db2,i5
Default : mysql

GUI Configuration

$config_menu_align
how the menu aligns. This is not a standard config variable, so you can't find it in config.inc.php
Possible values : left, center, right
Default : center
$config_recordlistorientation
Place the recordlist action icons on the left or right of recordlists.
Possible values : right, left, both
Default : right
$config_recordlistvorientation
Place the column headers (fieldname, searchfields etc.) at the top or bottom of recordlists.
Possible values : top, bottom, both
Default : top
$config_recordsperpage
The number of records to display in a list of records. If there are more records than this number, previous/next links and page numbers will be added.
Possible values : positive number
Default : 25


Relations

$config_manytoone_autocomplete_minchars
The number of characters a user must type before a manytoonerelation starts to do autocompletion
Possible values : Number higher than 0
Default : 2


Auth Config

$config_auth_enablepasswordmailer = true;
This will put an extra button on the longin screen to have a password sent to the email address regered for the username entered. Of note, the following options must also be set for this to work:
  • $config_auth_usernode = "module.nodename";
  • $config_auth_usertable = "user_tablename";
  • $config_auth_userfield = "username_fieldname";
  • $config_auth_emailfield = "useremail_fieldname";
  • $config_auth_passwordfield = "userpassword_fieldname";
Possible values : True
Default : N/A
$config_auth_loginpage = 'http://myurl';
For applications that do not want to use the atk login form or the htaccess box this config variable can contain an url to redirect to instead of displaying the login form of ATK.
Possible values : Text with the url
Default : N/A


Other config

$config_edit_fieldprefix
This configoption sets the default fieldprefix for all fields in all nodes to use in ATK. If you only want to use the fieldprefix for some of the nodes in your ATK application use the setEditFieldPrefix method of the atknode class instead.
Possible values : Text with the fieldprefix
Default : N/A