ARK - User contributions [en]

Settings.php

2008-11-14T15:16:13Z

92.234.27.85: /* Server Specific Information */

This is the main settings file for each instance of ARK. The file is divide into sections as set out below

===Server Setup===
The server setup being used. Currently ARK is configured for Mapserver 4 Windows (ms4w), Mac, and Linux servers. Set the server type and include the [[env_settings.php]] file using:
<pre>
$server="ms4w";
// Include settings related to your server environment (this also uses the server specified above)
include('env_settings.php');
</pre>

====Server Specific Information====
You will need to edit the following depending on your specific server information. Edit the information under the type of server you are using. Basic settings for each server are included below:
<pre>
switch($server){

case ms4w:
// The folder name of THIS instance of Ark (relative to the document root of the host in which it is hosted)
$ark_dir = '/ark/';
// The mysql db name of this instance of ark
$ark_db = 'ark';
// The mysqlserver
$sql_server = 'localhost';
// The mysql user who will make all the db calls
$sql_user = 'usr';
// The mysql user's password
$sql_pwd = 'psw';
// EXPORT
$export_dir = $ark_dir.'data/tmp/';
// FILE specific
// Where the files are stored after they are registered (/ after last folder)
$registered_files_dir = $doc_root. $ark_dir . 'data/files/';
// Where the files are stored after they are registered (/ after last folder)
// Browser option: default is $ark_dir . 'data/files/
// If the registered files directory is outside the main server directory then you need to setup an alias in httdp.conf
$registered_files_host = $ark_dir . 'data/files/';
// Top directory of the file browser - can only search relative to this directory.
$default_upload_dir = 'C:/';
break;
case mac:
// The folder name of THIS instance of Ark (relative to the document root of the host in which it is hosted)
$ark_dir = '/ark/';
// The mysql db name of this instance of ark
$ark_db = 'ark';
// The mysqlserver
$sql_server = '127.0.0.1';
// The mysql user who will make all the db calls
$sql_user = 'usr';
// The mysql user's password
$sql_pwd = 'pws';
// EXPORT
$export_dir = $ark_dir.'data/tmp/';
// FILE specific
// Where the files are stored after they are registered (/ after last folder)
$registered_files_dir = $doc_root. $ark_dir . 'data/files/';
// Where the files are stored after they are registered (/ after last folder)
// Browser option: default is $ark_dir . 'data/files/
// If the registered files directory is outside the main server directory then you need to setup an alias in httdp.conf
$registered_files_host = $ark_dir . 'data/files/';
// Top directory of the file browser - can only search relative to this directory.
$default_upload_dir = '\srv';

break;
case linux:
// The folder name of THIS instance of Ark (relative to the document root of the host in which it is hosted)
$ark_dir = '/ark/';
// The mysql db name of this instance of ark
$ark_db = 'ark';
// The mysqlserver
$sql_server = 'localhost';
// The mysql user who will make all the db calls
$sql_user = 'usr';
// The mysql user's password
$sql_pwd = 'pwd';
// EXPORT
$export_dir = $ark_dir.'data/tmp/';
// FILE specific
// Where the files are stored after they are registered (/ after last folder)
$registered_files_dir = $doc_root. $ark_dir . 'data/files/';
// Where the files are stored after they are registered (/ after last folder)
// Browser option: default is $ark_dir . 'data/files/
// If the registered files directory is outside the main server directory then you need to setup an alias in httdp.conf
$registered_files_host = $ark_dir . 'data/files/';
// Top directory of the file browser - can only search relative to this directory.
$default_upload_dir = '\srv';
break;
}
</pre>

===General===
This contains general configuration for the ARK.

====Minimiser====
Is the minimiser enabled?
<pre>
// Set to TRUE if you want to use the minimising right hand navigation bar
$minimiser = TRUE;
</pre>

====ARK Name====
The name of this instance of ARK
<pre>
// The Ark name
$ark_name = 'Tutorial';
</pre>

===Live Search===
The controls for the live search function
<pre>
// Live search controls
/*
* live = live search
* dd = drop down menu
* plain = plain text search
*/
$mode = "live";
</pre>

Also the controls for live search for XMI
<pre>
// Live search controls for xmi
/*
* live = live search - this should only be set to live if you are using the collapsing data entry
* dd = drop down menu
* plain = plain text search
*/
$xmi_mode = "live";
</pre>

===Modules===
Configure the modules to be used in this ARK project:
<pre>
// List the modules that need to be loaded in this ARK project
$loaded_modules =
array(
'abk', // address book
'cxt', // contexts
'pln', // plans
'smp', // samples
'spf', // Special finds
'sph', // Site photos

);
</pre>

Also configure the modules to load mapping data:
<pre>
// Lists the modules to load maps for
$loaded_map_mods =
array(
'cxt', // context
'smp', // samples
);
</pre>

Set the default item key for this ARK setup:
<pre>
// The default item key for this instance of Ark - format: mod_cd
$default_itemkey = 'cxt_cd'; // context
</pre>

Set the DSN for this ARK (this should generally NOT need adjusting)
<pre>
// DSN (this shouldn't need adjusting)
$dsn = 'mysql://'.$sql_user.':'.$sql_pwd.'@'.$sql_server.'/'.$ark_db;
</pre>

===Security===
The security for ARK is handled by LiveUser. The liveuser configuration is as follows:
<pre>
// Liveuser:
// These are the names of the liveuser objects. They should be unique per ARK
// (to prevent cross ark hacking). They need to be called in the code as
// $$liveuser and $$liveuser_admin
$liveuser = $ark_name . 'usr';
$liveuser_admin = $ark_name . 'usr' . '_admin';
// The path to the login script (relative to the document root)
$loginScript = 'index.php';
// Anonymous Logins
// If these variables are set then you are allowing anonymous logins
// This is a security risk! Its best to leave these statements commented out.
// Bear in mind that this does not need to be a real user.
$anonymous_login['username'] = 'anon';
$anonymous_login['password'] = 'anon';
// Method used in forms:
// get = form messages sent via get method - vissible in browser bar.
// post = form message sent via post method - invisible to the user.
$form_method = 'get';
</pre>

===Skin===
Sets the skin name and skin path for this ARK project:
<pre>
// Skin name
$skin = 'arkologik';
// Skin path
$skin_path = "$ark_dir/skins/$skin";
</pre>

===Thumbnails===
Sets thumbnail sizes for ARK (this will be used when uploading files)
<pre>
// Optional
$thumbnail_sizes =
array(
'arkthumb_width' => 100,
'arkthumb_height' => 100,
'webthumb_width' => 500,
'webthumb_height' => 500
);
</pre>

===Forms===
Set default year and site code for data entry and viewing:
<pre>
//Default year as a setting for form data entry
$default_year = '2008';
//Default site code
$default_site_cd = 'PCO06';
</pre>

===Viewers===
Configure the viewers to display a set number of rows:
<pre>
// Number of rows to display on the data viewer
$conf_viewer_rows = 25;
</pre>

Also configure the index pages for Micro View, Data View, and Search pages:
<pre>
// Default Micro viewer page (used by search result handlers)
$conf_micro_viewer = $ark_dir."micro_view.php";
// Default data viewer page
$conf_data_viewer = $ark_dir."data_view.php";
// Default search page - search funtions will send data thru to this page
$conf_search_viewer = $ark_dir."data_view.php";
</pre>

Set the default for search results display:
<pre>
// Default $output_mode for the data viewer
$default_output_mode = 'tbl';
</pre>

===Mapping===
Set the basic configuration for mapping functions (map directory, temp directory, etc):
<pre>
// Path to temp directory (server)
$ark_maptemp_dir = 'C:/ms4w/Apache/htdocs/'.$ark_dir.'mapserver/tmp/';
// Path to temp directory (web)
$ark_web_maptemp_dir = 'mapserver/tmp/';
// Path to WMS mapfile (server)
$ark_wms_map = 'C:/ms4w/Apache/htdocs/'.$ark_dir.'mapserver/mapfiles/ark_wms.map';
// Path to WFS mapfile (server)
$ark_wfs_map = 'C:/ms4w/Apache/htdocs/'.$ark_dir.'mapserver/mapfiles/ark_wfs.map';
// Map scales
$map_scales = '[1000,750,500,250,150,100,50,25,10]';
// Tilecache_path - only set this if you have a tilecache setup on your server
//$tilecache_path = '/cgi-bin/tilecache.cgi?';
</pre>

Configure the wms query layers:
<pre>
/*$wms_qlayers = array (
array(
'name' => 'cxt_schm',
'geom' => 'pgn'
),
array(
'name' => 'sfi_points',
'geom' => 'pt'
),
);*/
</pre>

Set up the map projection and extents to suit the location of the ARK project:
<pre>
// Map projection (in form: "EPSG:4326")
$map_projection = 'EPSG:27700';
// Map extents (in form: "1075,970,1115,1010")
$map_extents = '533866, 180940,533963, 181000';
</pre>

Set the layer from WMS to be used in map view
<pre>
// Maplayers from the WMS layer used in the map view
$mapview_layers = array ('contexts');
</pre>

===Logging===
Cofigures logging levels to record logging into database and changes to data.
<pre>
//Logging levels
$conf_log_add = 'on';
$conf_log_edt = 'on';
$conf_log_del = 'on';
</pre>

===Search Engine===
Configures words to cut out of multi-string searches to streamline the search process and maximise results.
<pre>
// words to cut out of multi string searches
$conf_non_search_words = array('and', 'di', 'in');
</pre>

===Languages===
Configures the default language and other languages in use.
<pre>
// The default lang
$default_lang = 'en';
// These are the languages in use (in order)
$conf_langs = array('en', 'da');
</pre>

===Fields===
Used to include the [[field_settings.php]] file.
<pre>
include_once('field_settings.php');
</pre>

===Document Type===
Configures the document type to use for web output
<pre>
$doctype = "html \n
PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"\n
\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\"";
</pre>

===Navigation===
====Navigation Links====
Configure to state what links will appear in the end of the navigation bar.
<pre>
$conf_linklist =
array(
'file' => 'index.php',
'vars' => 'logout=true',
'label' => 'logout'
);
</pre>

====Navigation Pages====
Unless listed in this array, all pages will appear in the main nav.
<pre>
$conf_hide_pages =
array(
'index.php',
'record_view.php',
'contact.php',
'about.php',
'search.php',
'folder.php',
);
</pre>

===Left Panel Configuration===

====Left Panel- Data Entry====
Configures the left panel in the data entry pages, requires the following:
*'''view''' - the view the link should point to (regist, detfrm, files or a custom view)
*'''item_key''' - itemkey to point to if any (cxt_cd, smp_cd)
*'''href''' - link to the output
*'''mknname''' - mark-up nickname will search the markup table for this nickname and print the markup

<pre>
$data_entry_left_panel[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=regist&item_key=cxt_cd",
'mknname' => 'regcxt'
);
$data_entry_left_panel[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=detfrm&item_key=cxt_cd",
'mknname' => 'detcxt'
);
$data_entry_left_panel[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=regist&item_key=pln_cd",
'mknname' => 'regpln'
);
$data_entry_left_panel[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=regist&item_key=sph_cd",
'mknname' => 'regsph'
);
$data_entry_left_panel[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=regist&item_key=abk_cd",
'mknname' => 'regabk'
);
$data_entry_left_panel[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=regist&item_key=smp_cd",
'mknname' => 'regsmp'
);
$data_entry_left_panel[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=detfrm&item_key=smp_cd",
'mknname' => 'detsmp'
);
$data_entry_left_panel[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=materi&item_key=smp_cd",
'mknname' => 'matsmp'
);
$data_entry_left_panel[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=regist&item_key=spf_cd",
'mknname' => 'regspf'
);
$data_entry_left_panel[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=files",
'mknname' => 'uplfile'
);
</pre>

====Left Panel- Micro View====
Configures the left panel in the micro view pages, requires the following:
*'''item_key''' - itemkey to point to if any (cxt_cd, smp_cd)
*'''href''' - link to the output
*'''mknname''' - mark-up nickname will search the markup table for this nickname and print the markup

<pre>
$micro_view_left_panel[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?item_key=cxt_cd",
'mknname' => 'vwcxt'
);
$micro_view_left_panel[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?item_key=pln_cd",
'mknname' => 'vwpln'
);
$micro_view_left_panel[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?item_key=smp_cd",
'mknname' => 'vwsmp'
);
$micro_view_left_panel[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?item_key=spf_cd",
'mknname' => 'vwspf'
);
$micro_view_left_panel[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?item_key=sph_cd",
'mknname' => 'vwsph'
);
</pre>

====Left Panel- Data View====
This configures the left panel for the data view pages and needs the following:
*'''href''' - link to the output ({$_SERVER['PHP_SELF']} is on same page, $ark_dir/export.php is on export page)
*'''output_mode''' - output format for internal links
*'''output''' - is output format for external links
*'''mknname''' - mark-up nickname will search the markup table for this nickname and print the markup

<pre>
$data_view_left_panel[] =
array(
'href' => "$ark_dir/export.php?output=CSVExt",
'mknname' => 'expcsv'
);
$data_view_left_panel[] =
array(
'href' => "$ark_dir/export.php?output=XMLExt",
'mknname' => 'expxml'
);
$data_view_left_panel[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?output_mode=tbl",
'mknname' => 'vwtbl'
);
$data_view_left_panel[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?output_mode=chat",
'mknname' => 'vwchat'
);
</pre>

====Left Panel- User Home====
This configures the left-panel for the user home pages and needs the following fields:
*'''href''' - link to the output
*'''mknname''' - mark-up nickname will search the markup table for this nickname and print the markup

<pre>
$user_home_left_panel[] =
array(
'href' => "data_view.php?vtok=1&nname=All_Contexts&ftype=key&key=1&ktype=all",
'mknname' => 'vwcxt'
);
</pre>

[[Category: Administrator]]

Env settings.php

2008-11-14T15:12:11Z

92.234.27.85: /* MS4W */

__TOC__

This small file contains only settings relating to the specific server environment. This is specifically for the ends of multiple sever environments. There are three settings which you need to think about: the document root of this virtual host, the path to the pear configuration, and the path to the ARK directory.

The env_settings.php file will look different depending on your server setup. An example of each is shown below.

====MS4W====

A ms4w (mapserver for windows) is appropriate for projects holding the ARK database on a Windows system (eg. a laptop, a Windows shuttle). The env_settings.php for an ms4w installation of ARK should look like this:

<pre>
// The document root of this virtual host (as set up in your apache conf)
$doc_root = 'C:\ms4w\Apache\htdocs';
// The path to the PEAR installation (windows has ; first)
$pear_path = ";C:\ms4w\Apache\php\PEAR";
// The server path to the ark directory
$ark_server_path = 'C:\ms4w\Apache\htdocs\ark';
</pre>

====Mac====

A Mac setup will differ from the above. For projects holding the ARK database on a Mac system, the env_settings.php should look like this:

<pre>
// The document root of this virtual host (as set up in your apache conf)
$doc_root = '/Applications/MAMP/htdocs';
// The path to the PEAR installation (unix has : first)
$pear_path = ':/Applications/MAMP/htdocs/pear/';
// The server path to the ark directory
$ark_server_path = '/Users/user1/Sites/ark/';
</pre>

====Linux====
When using a linux system, users will need to use the following env_settings.php configuration:

<pre>
// The document root of this virtual host (as set up in your apache conf)
$doc_root = '/srv/www/docroot/';
// The path to the PEAR installation (unix has : first)
$pear_path = ':/usr/share/php5/PEAR';
// The server path to the ark directory
$ark_server_path = '/srv/www/htdocs/ark';
</pre>

[[category:Administrator]]

Administrator Manual

2008-11-14T06:55:06Z

92.234.27.85: /* mod_settings.pnp */

__TOC__

The administrator manual is aimed at people who are downloading and installing ARK. If you are struggling with installation or administration, you should consider contacting the ARK team to buy a preconfigured ARK. This would help support the project and make a contribution towards the ongoing development of the project.

===Key Concepts===

====[[Navigation]]====

Information about the navigation tools used within ARK.

=====[[Navigation#Basic Navigation|Basic Navigation]]=====

=====[[Navigation#Subform Navigation|Subform Navigation]]=====

====[[Views]]====

The different 'Views' of ARK.

====[[Key Administration Concepts]]====

An overview of the key administration concepts.

=====[[Key Administration Concepts#Settings Files|Settings Files]]=====

=====[[Key Administration Concepts#Forms Overview|Forms Overview]]=====

===Installation and Setup===

====[[Basic Installation]]====

A description of the ARK installation process.

=====[[Basic Installation#Dependencies|Dependencies]]=====

=====[[Basic Installation#Installing ARK|Installing ARK]]=====

====[[Initial setup]]====

Some things to consider when completing the initial setup of your ARK.

=====[[Initial setup#A Name|ARK Name]]=====

=====[[Initial setup#What do you want to record?|What to record?]]=====

=====[[Initial setup#What subforms do you want?|What Subforms?]]=====

====[[Database Tables]]====

A list of the standard ARK tables, with a basic explanation for each.

===ARK Customisation===

This chapter will help the new ARK administrator who is comfortable with editing PHP configuration files through the setup of an ARK project. For a general overview of settings please see [[Key Administration Concepts#Settings Files|Settings Files]].

====[[env_settings.php]]====

A description of the env_settings.php file for three different operating systems.

=====[[env_settings.php#ms4w|Mapserver for Windows]]=====

=====[[env_settings.php#mac|Mac]]=====

=====[[env_settings.php#linux|Linux]]=====

====[[field_settings.php]]====

Instructions on how to configure the field_settings.php file.

=====[[field_settings.php#Common/Obligatory Attributes|Obligatory Attributes]]=====

=====[[field_settings.php#Class Specific Settings|Class Specific Settings]]=====

=====[[field_settings.php#Event Fields|Event Fields]]=====

====[[mod_settings.php]]====

Instructions on how to configure module specific settings files.

====[[settings.php]]====

The general settings for ARK.

====[[vd_settings.php]]====

A description of information found within the vd_settings.php file.

===Subforms===

====[[Subforms Overview]]====

A general overview of ARK Subforms and their configuration.

=====[[Subforms Overview#Subform Reference|Subform Reference List]]=====

====[[Subform Requirements]]====

The required fields for configuration of subforms.

====[[Subform Options]]====

Some optional subform fields.

===Administration===

====[[User Administration]]====

Some tools for administering user accounts.

====[[Address Book Administration]]====

How to update the Address Book module.

====[[Exporting data]]====

====[[Importing Data]]====

===Custom Configuration===

The following are examples of custom configurations and may be specific to previous installations of ARK. Only use these for reference if you are upgrading from development code prior to the v0.6 release.

====[[Transcluding]]====

====[[Configuring file registration]]====

====[[Configuring the Mapping]]====

====[[Configuring the Export Functionality]]====

[[category: Administrator]]

Administrator Manual

2008-11-14T06:51:37Z

92.234.27.85: /* ARK Customisation */

__TOC__

The administrator manual is aimed at people who are downloading and installing ARK. If you are struggling with installation or administration, you should consider contacting the ARK team to buy a preconfigured ARK. This would help support the project and make a contribution towards the ongoing development of the project.

===Key Concepts===

====[[Navigation]]====

Information about the navigation tools used within ARK.

=====[[Navigation#Basic Navigation|Basic Navigation]]=====

=====[[Navigation#Subform Navigation|Subform Navigation]]=====

====[[Views]]====

The different 'Views' of ARK.

====[[Key Administration Concepts]]====

An overview of the key administration concepts.

=====[[Key Administration Concepts#Settings Files|Settings Files]]=====

=====[[Key Administration Concepts#Forms Overview|Forms Overview]]=====

===Installation and Setup===

====[[Basic Installation]]====

A description of the ARK installation process.

=====[[Basic Installation#Dependencies|Dependencies]]=====

=====[[Basic Installation#Installing ARK|Installing ARK]]=====

====[[Initial setup]]====

Some things to consider when completing the initial setup of your ARK.

=====[[Initial setup#A Name|ARK Name]]=====

=====[[Initial setup#What do you want to record?|What to record?]]=====

=====[[Initial setup#What subforms do you want?|What Subforms?]]=====

====[[Database Tables]]====

A list of the standard ARK tables, with a basic explanation for each.

===ARK Customisation===

This chapter will help the new ARK administrator who is comfortable with editing PHP configuration files through the setup of an ARK project. For a general overview of settings please see [[Key Administration Concepts#Settings Files|Settings Files]].

====[[env_settings.php]]====

A description of the env_settings.php file for three different operating systems.

=====[[env_settings.php#ms4w|Mapserver for Windows]]=====

=====[[env_settings.php#mac|Mac]]=====

=====[[env_settings.php#linux|Linux]]=====

====[[field_settings.php]]====

Instructions on how to configure the field_settings.php file.

=====[[field_settings.php#Common/Obligatory Attributes|Obligatory Attributes]]=====

=====[[field_settings.php#Class Specific Settings|Class Specific Settings]]=====

=====[[field_settings.php#Event Fields|Event Fields]]=====

====[[mod_settings.pnp]]====

Instructions on how to configure module specific settings files.

====[[settings.php]]====

The general settings for ARK.

====[[vd_settings.php]]====

A description of information found within the vd_settings.php file.

===Subforms===

====[[Subforms Overview]]====

A general overview of ARK Subforms and their configuration.

=====[[Subforms Overview#Subform Reference|Subform Reference List]]=====

====[[Subform Requirements]]====

The required fields for configuration of subforms.

====[[Subform Options]]====

Some optional subform fields.

===Administration===

====[[User Administration]]====

Some tools for administering user accounts.

====[[Address Book Administration]]====

How to update the Address Book module.

====[[Exporting data]]====

====[[Importing Data]]====

===Custom Configuration===

The following are examples of custom configurations and may be specific to previous installations of ARK. Only use these for reference if you are upgrading from development code prior to the v0.6 release.

====[[Transcluding]]====

====[[Configuring file registration]]====

====[[Configuring the Mapping]]====

====[[Configuring the Export Functionality]]====

[[category: Administrator]]

Administrator Manual

2008-11-14T06:50:59Z

92.234.27.85: /* ARK Customisation */

__TOC__

The administrator manual is aimed at people who are downloading and installing ARK. If you are struggling with installation or administration, you should consider contacting the ARK team to buy a preconfigured ARK. This would help support the project and make a contribution towards the ongoing development of the project.

===Key Concepts===

====[[Navigation]]====

Information about the navigation tools used within ARK.

=====[[Navigation#Basic Navigation|Basic Navigation]]=====

=====[[Navigation#Subform Navigation|Subform Navigation]]=====

====[[Views]]====

The different 'Views' of ARK.

====[[Key Administration Concepts]]====

An overview of the key administration concepts.

=====[[Key Administration Concepts#Settings Files|Settings Files]]=====

=====[[Key Administration Concepts#Forms Overview|Forms Overview]]=====

===Installation and Setup===

====[[Basic Installation]]====

A description of the ARK installation process.

=====[[Basic Installation#Dependencies|Dependencies]]=====

=====[[Basic Installation#Installing ARK|Installing ARK]]=====

====[[Initial setup]]====

Some things to consider when completing the initial setup of your ARK.

=====[[Initial setup#A Name|ARK Name]]=====

=====[[Initial setup#What do you want to record?|What to record?]]=====

=====[[Initial setup#What subforms do you want?|What Subforms?]]=====

====[[Database Tables]]====

A list of the standard ARK tables, with a basic explanation for each.

===ARK Customisation===

This chapter will help the new ARK administrator who is comfortable with editing PHP configuration files through the setup of an ARK project.

====[[env_settings.php]]====

A description of the env_settings.php file for three different operating systems.

=====[[env_settings.php#ms4w|Mapserver for Windows]]=====

=====[[env_settings.php#mac|Mac]]=====

=====[[env_settings.php#linux|Linux]]=====

====[[field_settings.php]]====

Instructions on how to configure the field_settings.php file.

=====[[field_settings.php#Common/Obligatory Attributes|Obligatory Attributes]]=====

=====[[field_settings.php#Class Specific Settings|Class Specific Settings]]=====

=====[[field_settings.php#Event Fields|Event Fields]]=====

====[[mod_settings.pnp]]====

Instructions on how to configure module specific settings files.

====[[settings.php]]====

The general settings for ARK.

====[[vd_settings.php]]====

A description of information found within the vd_settings.php file.

===Subforms===

====[[Subforms Overview]]====

A general overview of ARK Subforms and their configuration.

=====[[Subforms Overview#Subform Reference|Subform Reference List]]=====

====[[Subform Requirements]]====

The required fields for configuration of subforms.

====[[Subform Options]]====

Some optional subform fields.

===Administration===

====[[User Administration]]====

Some tools for administering user accounts.

====[[Address Book Administration]]====

How to update the Address Book module.

====[[Exporting data]]====

====[[Importing Data]]====

===Custom Configuration===

The following are examples of custom configurations and may be specific to previous installations of ARK. Only use these for reference if you are upgrading from development code prior to the v0.6 release.

====[[Transcluding]]====

====[[Configuring file registration]]====

====[[Configuring the Mapping]]====

====[[Configuring the Export Functionality]]====

[[category: Administrator]]

Data View

2008-11-14T06:49:36Z

92.234.27.85: /* View Options */

__TOC__

===Main Panel===

[[image:dataview2.jpg|left|frame|The main panel of the data view, viewed as table]]

The main panel of the data view page holds the results of searches and is used for manipulating large collections of data. Using the [[Data View#Search Filters|Search Filters]] a set of data can be obtained. The main panel lists the total number of search results, and allows paging through search results using the page numbers at the bottom of the main panel. Data is displayed in the main panel according to [[Data View#View Options|View Options]].

 
 
 
 
 
 
 
 
 
 
 

===Search Filters===

Search filters are used to create specialised data sets in the data view. Before searching, be sure to understand the different types of [[Data Class]] used in ARK. It is essential to understand this terminology to make the most of the search filters.

[[image:toolbox2.jpg|left|frame|The Data Toolbox and search functions.]]

The main types of search are outlined below:
*'''Free Text Search''' - A search based on a text string. The search filter looks in all text fields, and may return all types of record.
*'''Filter by Item''' - A search filter for a specific type of record (egs. contexts, special finds, photos, files, etc).
*'''Filter by Attribute''' - A search for a specific attribute of a record (egs. findtypes, period, etc).
*'''Filter by Site Code''' - A filter for ARKs with multiple site codes, returns all records from the requested code.
*'''Filter by Actor''' - A search for a specific Actor, returns all records that are in some way attached to this actor.

To complete a search, select the data class to be searched from the right-hand 'Data Toolbox'. Either enter the text string, or select the type or attribute from a dropdown list, and select 'Search'. You can narrow down your results by creating multiple filters until reaching the desired result. For example, after searching for all Special Finds (Item-->Special Find), the search could be further refined by searching for the text 'Gold' (Free Text-->'Gold'). This would return a set of all Special Find records including the word 'Gold'. To save the search within your ARK profile, type in a nickname for the results set and hit 'Save'.

The search function is likely to be restructured in future ARK releases to imrpove this process and include more complex searching options.

===View Options===

The data displayed in the data view main column can be shown in a number pre-configured ways. These are shown in the left-hand panel.

*'''View as Table:''' Displays a table with basic information about each result. The structure of the table will generally mirror the [[Data Entry#Data Entry Register|Data Entry Register]]. Please see your ARK administrator if you want to customise this view.
*'''View as Chat:''' Displays a short Google-style excerpt for each search result. This generally includes the record number, a short text describing the record, and a score showing how relevant the record is to the search request. Please see your ARK administrator if you want to customise this view.
*'''View as Map:''' Shows the user to a map view highlighting all the search results. By hovering over a highlighted result on the map, the context number will appear in a dedicated window. Clicking on this window you can link directly to a specific record. When many results are present within a small area, they are clustered together. By zooming in to a smaller scale, it is possible to make out individual results.

===Export Data===

To export a search result from the data view, simply select the 'Export as CSV' option from the top of the Left-Panel. This will prompt for you to download a CSV (Comma Separated Values) file. This file can then be imported as a table into standard spreadsheet or database programmes (Excel, Open Office, Access, etc).

[[category: Usermanual]]

Navigation

2008-11-13T08:06:33Z

92.234.27.85:

__TOC__

===ARK Navigation===

[[image:nav2.jpg|left|frame|The ARK navigation]]

All pages within ARK have the same basic navigation tools. The basic areas are discussed below:

*'''Navigation Tabs:''' The navigation tabs run horizontally along the top of the page. They are used to move through the basic pages of ARK (data entry, data view, micro view, map view). Additional tabs are added for users with higher administrative privileges (import, export).
*'''Left Panel:''' The left panel holds options specific to a page. For example, on the 'Data Entry' page (selected using the 'Navigation Tabs') the left panel will contain a list of different data entry modules.
*'''Main Panel:''' The main panel holds the main information for any given page. This can be a series of data entry forms, a list of items, a map, etc and changes depending on the 'Navigation Tabs' (as discussed above).

Some pages, such as data entry, also have a right panel with additional navigation options. These will be discussed in the relevant sections.

===Subform Navigation===

[[category: Usermanual]]

User Manual

2008-11-12T14:48:02Z

92.234.27.85:

__TOC__

The end user documentation is intended for archaeologists who are using the system. This includes people doing data entry and project leaders who need to understand a little bit about ARK in order to decide how to set up the fields they want.

For a basic overview of the key ARK concepts take a look at the [[http://ark.lparchaeology.com/about/overview about]] section of the ARK website.

===Basic Functions===

====[[Basic Navigation]]====

====[[User Administration]]====

====[[Data Entry]]====

====[[Data View]]====

====[[Micro View]]====

====[[Map View]]====

====[[Exporting data]]====

===Advanced Functions===

====Importing Data====

====[[Transcluding]]====

[[category: Usermanual]]

User Administration

2008-11-12T14:44:08Z

92.234.27.85:

__TOC__

===Adding Users===

In order for team members become visible within Ark, a user account must first be created. From the 'Users' [[Basic Navigation|navigation tab]], select 'Add User' from the left panel. The system will ask for a number of bits of information. When these have all been entered, select 'Create User' to create and enable the user account.

All users are assigned a '''username''' according to their surname (family name) and their
initials in the form ''''dufton_ad''''. In cases where multiple team members share the same
initials an alternative set of initials will be used to avoid duplicates within the system.

===Editing Users===
User information can be altered by using the 'Edit User' command. Basic information like firstname and lastname is changed by altering the text field. To change the password, a new password must be entered and confirmed. The username is created automatically through a combination of lastname and initials. This cannot be changed after the user has been initially added.

Beyond this basic information, users can also be assigned groups from the 'Edit User' menu. Users within the 'Admin' group will have greater privileges within Ark such as creating or activating user accounts, checking context records, and the like. Currently all users will be assigned to the 'User' group as the 'Admin' group has yet to be given special privileges. This will be updated at a later date to allow for specific project administrators.

Finally, accounts can be enabled/disabled from the 'Edit User' menu. Enabled accounts have full access to the Ark system. Disabled accounts will not be able to log in or enter data. It is important to understand that users created in the 'Add User' option will not automatically be activated, and will not be able to access the system until their user account has been enabled.

[[category: Usermanual]]

Data Entry

2008-11-12T12:30:53Z

92.234.27.85:

The Data Entry system of Ark is defined to mirror the paper record as closely as possible, making data entry and viewing highly intuitive. As such, users entering excavation or evaluation data should not require advanced training or user help guides to complete their task.

Data entry for ALL modules in ARK follows a similar system. All items must first be entered in a 'Register', this creates a basic entry for the item. Many items (contexts, special finds, samples) will also have additional information beyond the simple register entry. This information is entered on a specific 'Sheet' for each item. Some basic units will also require 'Additional Custom Sheets' for other types of information, such as a pottery assemblage associated with a given context.

The list of data entry pages available is found in the left-hand panel of the 'Data Entry' tab. This list is specific to each instance of ARK.

==Data Entry Register==

The first step of data entry is always to enter the item into the Register. Detailed data entry sheets cannot be accessed before this step. '''Entering a record into the appropriate register is ALWAYS the first step of data entry'''.

The entry process in the register is very straightforward. Some of the common fields usually entered are outlined below:
*'''itm_cd:''' The item code, to be entered manually. This is usually in the form 'SITECODE_#'. The 'Site Code' will be assigned above, so does not need to be entered again at this stage.
*'''type:''' Some items require a specific 'type', the most obvious example being different types of context (Cut, Fill, Masonry, etc)
*'''definition/short description:''' Most registers will require a short sentence giving a general description of the item.
*'''issued to/taken by/drawn by/etc:''' Most registers have some information about who created the record in the field.
*'''issued on/taken on/drawn on/etc:''' The date the record was created, photo taken, plan drawn, etc.
*'''options:''' The [view] option links to the detailed view of the record. The [enter] option links to the data entry sheet (see below). The [q.ed] option allows a quick edit of the register entry.
*'''save:''' The save button saves all information in the register.

==Data Entry Sheet==

==Additional Sheets==

Additional sheets are often specific to a given project and the exact method of data entry depends on the information to be entered. On the most basic level these sheets follow similar rules to the other data entry pages, and so a more detailed description of their functionality will not be provided. Please see your project-specific ARK administrator for more information on the Additional Sheets for your project.

[[category: Usermanual]]

Data Entry

2008-11-12T12:20:35Z

92.234.27.85:

Navigation

2008-11-12T12:17:46Z

92.234.27.85:

==Navigation Tabs==

==The Left Panel==

==The Main Panel==

[[category: Usermanual]]

Navigation

2008-11-12T12:15:43Z

92.234.27.85:

==Navigation Tabs==

==The Left Panel==

[[category: Usermanual]]

Data View

2008-11-12T12:14:54Z

92.234.27.85:

[[category: Usermanual]]

User Manual

2008-11-12T12:12:24Z

92.234.27.85:

The end user documentation is intended for archaeologists who are using the system. This includes people doing data entry and project leaders who need to understand a little bit about ARK in order to decide how to set up the fields they want.

For a basic overview of the key ARK concepts take a look at the [[http://ark.lparchaeology.com/about/overview about]] section of the ARK website.

===Basic Functions===

[[Basic Navigation]]

[[User Administration]]

[[Data Entry]]

[[Data View]]

[[Micro View]]

[[Map View]]

[[Exporting data]]

===Advanced Functions===

Importing Data

[[Transcluding]]

[[category: Usermanual]]

Data Entry

2008-11-12T12:11:07Z

92.234.27.85:

Data entry for ALL modules in ARK follows a similar system. All items must first be entered in a 'Register', this creates a basic entry for the item. Many items (contexts, special finds, samples) will also have additional information beyond the simple register entry. This information is entered on a specific 'Sheet' for each item. Some basic units will also require 'Additional Custom Sheets' for other types of information, such as a pottery assemblage associated with a given context.

The list of data entry pages available is found in the left-hand panel of the 'Data Entry' tab. This list is specific to each instance of ARK.

==Data Entry Register==

==Data Entry Sheet==

==Additional Sheets==

Additional sheets are often specific to a given project and the exact method of data entry depends on the information to be entered. On the most basic level these sheets follow similar rules to the other data entry pages, and so a more detailed description of their functionality will not be provided. Please see your project-specific ARK administrator for more information on the Additional Sheets for your project.

[[category: Usermanual]]

Data Entry

2008-11-12T12:09:52Z

92.234.27.85:

Data Entry

2008-11-12T11:50:19Z

92.234.27.85:

==Register==

==Sheet==

==Additional Forms==

User Manual

2008-11-12T11:44:23Z

92.234.27.85: /* Basic Functions */

The end user documentation is intended for archaeologists who are using the system. This includes people doing data entry and project leaders who need to understand a little bit about ARK in order to decide how to set up the fields they want.

For a basic overview of the key ARK concepts take a look at the [[http://ark.lparchaeology.com/about/overview about]] section of the ARK website.

===Basic Functions===

[[User Administration]]

[[Data Entry]]

[[Data View]]

[[Micro View]]

[[Map View]]

[[Exporting data]]

===Advanced Functions===

Importing Data

[[Transcluding]]

[[category: Usermanual]]

User Manual

2008-11-12T11:24:31Z

92.234.27.85: /* Advanced Functions */

The end user documentation is intended for archaeologists who are using the system. This includes people doing data entry and project leaders who need to understand a little bit about ARK in order to decide how to set up the fields they want.

For a basic overview of the key ARK concepts take a look at the [[http://ark.lparchaeology.com/about/overview about]] section of the ARK website.

===Basic Functions===

User Administration

Data Entry

Data View

Micro View

Map View

Exporting data

===Advanced Functions===

Importing Data

[[Transcluding]]

[[category: Usermanual]]

User Manual

2008-11-12T11:24:17Z

92.234.27.85: /* Basic Functions */

The end user documentation is intended for archaeologists who are using the system. This includes people doing data entry and project leaders who need to understand a little bit about ARK in order to decide how to set up the fields they want.

For a basic overview of the key ARK concepts take a look at the [[http://ark.lparchaeology.com/about/overview about]] section of the ARK website.

===Basic Functions===

User Administration

Data Entry

Data View

Micro View

Map View

Exporting data

===Advanced Functions===

[[Transcluding]]

[[category: Usermanual]]

User Manual

2008-11-12T11:24:04Z

92.234.27.85: /* Basic Functions */

The end user documentation is intended for archaeologists who are using the system. This includes people doing data entry and project leaders who need to understand a little bit about ARK in order to decide how to set up the fields they want.

For a basic overview of the key ARK concepts take a look at the [[http://ark.lparchaeology.com/about/overview about]] section of the ARK website.

===Basic Functions===

User Administration

Data Entry

Data View

Micro View

Map View

Importing Data

Exporting data

===Advanced Functions===

[[Transcluding]]

[[category: Usermanual]]

User Manual

2008-11-12T11:15:12Z

92.234.27.85:

The end user documentation is intended for archaeologists who are using the system. This includes people doing data entry and project leaders who need to understand a little bit about ARK in order to decide how to set up the fields they want.

For a basic overview of the key ARK concepts take a look at the [[http://ark.lparchaeology.com/about/overview about]] section of the ARK website.

===Basic Functions===

Adding data

Editing data

Manipulating data

Viewing records

Exporting data

===Advanced Functions===

[[Transcluding]]

[[category: Usermanual]]

User Manual

2008-11-12T11:14:05Z

92.234.27.85:

The end user documentation is intended for archaeologists who are using the system. This includes people doing data entry and project leaders who need to understand a little bit about ARK in order to decide how to set up the fields they want.

For a basic overview of the key ARK concepts take a look at the [[http://ark.lparchaeology.com/about about]] section of the ARK website.

===Basic Functions===

Adding data

Editing data

Manipulating data

Viewing records

Exporting data

===Advanced Functions===

[[Transcluding]]

[[category: Usermanual]]

Transcluding

2008-11-12T11:11:57Z

92.234.27.85:

Elements of ARK can be [http://en.wikipedia.org/wiki/Transclusion 'transcluded'] - that is you can make a live query to your ARK and bring back the results of a [[Subform]].

What this means is that subforms of a particular [[item]] (e.g a context) can be included in any other webpage - for example if you are entering an online blog and you want to show the photos of the special find you recovered today - then you can just include them and they will show up just as they show up when viewing them in ARK.

This starts getting very useful when you begin to think about a running site narrative, built within a webpage/blogging software/google documents. So when you are talking about the local matrix of a context - you can just transclude it straight into the document. Because this is running a live query against the database, you are getting the most up-to-date data and it will change as the original data is changed.

Its very easy to transclude in ARK. All you need to do is ensure whatever application you are in (e.g. Mediawiki, Blogger, TextPattern, etc.) can read raw html and the include the following in your page:

<pre><object type="text/html" data="http://192.168.0.61:8080/ark/transclude_object.php?transclude=yes
&sf_conf=conf_mcd_spat
&sf_key=cxt_cd
&sf_val=CH05SR_699
&width=100%
&height=100%">
</object></pre>

*The web address that you put in the data field should point at your own version of ARK.
*The sf_conf value is the name of the subform that you want to transclude - if you don't know this then you should contact your administrator.
*The sf_key and sf_val are the itemkey and itemvalue of the item that you want to transclude. In this case we are transcluding the spatial subform for Context CH05SR_699.

The results of this can be seen below:

http://www.lparchaeology.com/prescot/journal/ark-and-the-art-of-tranclusion-mechanics

[[Category:usermanual]][[Category:How-Tos]]

User Manual

2008-11-12T11:06:38Z

92.234.27.85:

The end user documentation is intended for archaeologists who are using the system. This includes people doing data entry and project leaders who need to understand a little bit about ARK in order to decide how to set up the fields they want.

For a basic overview of the key ARK concepts take a look at the [[http://ark.lparchaeology.com/about about]] section of the ARK website.

Adding data

Editing data

Manipulating data

Viewing records

Exporting data

[[Transcluding]]

[[category: Usermanual]]