ARK - User contributions [en]

GetConcepts

2015-03-13T16:50:36Z

Jessogden: Created page with "GetConcepts."

GetConcepts.

Developer Manual

2015-03-13T16:49:40Z

Jessogden: /* API Documentation */

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 Manual| 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 [http://ark.lparchaeology.com/contact 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

===Developer 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:

====[[http://ark.lparchaeology.com/ark_phpdoc/li_ark.html PhpDocumenter Output]]====
Detailed reference material for every function and script in the system - NB this is for ARK v0.7, and has not yet been updated for the latest release(s).

====[[http://www.phpdoc.org/ PhpDocumenter]]====
Some info on the software used to create the documentation from the header blocks

[[Category:Developer]]

===API Documentation===

As of v1.1 it is possible to access ARK using an API via a URL - which currently responds with a JSON object.

The following methods can be used:

[[describeARK]] - this provides some simple metadata about the ARK instance

[[describeItems]] - this provides a list of all the types of modules available

[[describeFrags]] - this provides a list of all the different types of data available within the ARK instance (it lists the different 'types' of dataclass available

[[describeFilters]] - this provides a list of all available filters

[[describeSubforms]] - this provides a list of available subforms (for transclusion)

[[describeFields]] - this provides a list of available fields

[[getItems]] - this returns an array of items of a specified module

[[getFrags]] - this returns an array of data frags attached to a specified item

[[getFilter]] - this returns the result of a saved filter or a free-text search

[[getFields]] - this returns an array of the fields attached to an item with their values

[[getConcepts]] - this is a wrapper page which retrieves the definition of a particular concept

[[transcludeFilter]] - this returns a fully rendered HTML representation of a filter result

[[transcludeSubform]] - this returns a fully rendered HTML representation of a subform

[[putField]] - this is for putting values to an ARK. Use this for adding, editing or deleting fields

[[XMLParser]] - this is mainly used internally by the spatial elements of ARK to retrieve and present GML data

[[Category:Developer]]

The ARK Help System

2014-06-25T15:29:28Z

Jessogden: /* Configuring the subform */

As of version 1.2 - a field-level help system has been introduced to ARK.

The help system works by using the [[Markup]] system to attach chunks of Markup to specific fields. There is very little configuration needed to enable the help system.

==Configuring the subform==

A new subform conf will need to be entered in the page_settings.php file:

<pre>

$conf_mcd_help =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'nmedit',
'sf_title' => 'help',
'sf_html_id' => 'help', // Must be unique
'script' => 'php/subforms/sf_help.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'fields' =>
array(
)
);

</pre>

This needs to be named $conf_mcd_help, otherwise the help system will not be able to find it. The subform has one 'op' value that can be applied:

'op_textile' => TRUE

If this op is specified, then the help will be printed using the Textile tool - which means it can be used to print complex formatted HTML (along with images, etc.). For more information on Textile see this link: http://txstyle.org/

==Configuring the navigation==

The help is currently launched using an icon in the title bar of the subform that contains the fields you want help for. This is setup in the sf_conf 'sf_nav_type' configuration option. Currently the help icon will appear when sf_nav_type is set to 'full' or 'help'.

==Other things to bear in mind==

The help uses the Markup system to attach the help to the fields. Therefore, the contents of the help can either be edited directly from the help subform - or using the Markup Admin tools. By default the system assumes the nickname of the markup is 'help_' concatenated onto whatever the field_id is. For instance, the help for a field with id 'conf_field_description' would be 'help_conf_field_description'. It is possible to specify a different nickname, by including the option 'op_help_nname' in the field and setting a new nickname.

As the names for the nicknames of the markup are usually help_ prefixed on the name of the field - the length of the nname field in cor_tbl_markup maybe too short. If you get an Error when updating or adding help related to the size of the field in the database then run this SQL command to fix it:
<pre>
ALTER TABLE `cor_tbl_markup` CHANGE `nname` `nname` VARCHAR( 255 ) CHARACTER SET utf8 COLLATE utf8_unicode_ci NOT NULL DEFAULT
</pre>

Transcluding

2014-03-14T13:48:24Z

Jessogden:

=== NOTE: As of ARK version equal to or greater than 1.1 transclusion is undertaken using the API - see [[transcludeSubform()]] and [[transcludeFilters()]]. The notes below are preserved as documentation for ARK versions prior to this. The basic HTML will work - but the data value will need to be updated to point at the appropriate API request string ===

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.

===Transcluding Filter Results===

As of v0.7 (currently in SVN) it is possible to transclude results of saved filters as well. The code you need is as follows:

<pre><object type="text/html" data="http://192.168.0.61:8080/ark/transclude_object.php?transclude=filter
&filter=whorls
&output_mode=tbl
&width=100%
&height=100%">
</object></pre>

This works in the same way as transcluding a subform except you can specify which saved filter and what output mode you want.

*transclude=filter - this is essential to let the transclude script know you are transcluding a filter
*filter=whorls - this can either be the saved name of the filter (i.e. 'whorls' or 'All Contexts') or it can be the number of the filter as saved in cor_tbl_filter.
*output_mode=tbl - the output modes are 'tbl', 'chat' or 'map'

[[Category:Administrator]][[Category:How-Tos]]

Basic Installation

2014-03-05T14:22:53Z

Jessogden:

If you are comfortable setting up an Apache webserver and a MySQL database, then setting up ARK is very easy. Follow the guide below to get your ARK instance installed and set up.

If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting the ARK team to acquire a fully running ARK.

There are some further resources for learning about ARK and how to install it and some of the required dependencies [http://ark.lparchaeology.com/resources/ on the ARK website].

===Download source===

Download the latest source code from http://sourceforge.net/projects/arkdb/ sourceforge.

===Check and Install Dependencies===

====Dependencies====

ARK requires the following open source software packages to be installed on your server:

#Apache
#PHP 5.4
#MySQL

ARK is able to connect to any WMC/WFS compliant server of geographic information. Mapserver is no longer an ARK dependency. This means that that administrators can connect to a geographic database of their choice, to suit their needs. Details on [http://mapserver.org/ Mapserver] setup can be found on their website.

ARK 1.1 requires PHP 5.4 or later. PHP 5.5 will run ARK but will produce "deprecated" errors as some functions used in ARK have been deprecated as of 5.5. If you are using PHP 5.5 and see deprecated messages, these can be hidden by following the relevant PHP documentation. These functions will be updated in a future release of ARK.

ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.

In addition the following packages are useful:

#phpMyAdmin

Once you have Apache and MySQL running, phpMyAdmin is a very convenient tool for administering databases. More information on how to use phpMyadmin can be found on their [http://docs.phpmyadmin.net/en/latest/user.html website].

====on LINUX====

On most Linux distributions these packages will be installed by default.

=====Apache=====

Most Linux distributions include an Apache webserver. Consult the documentation on your installation for instructions on how to configure your server. If your service path is configured, the service can be started with:

<code> sudo service httpd start </code>

If you need to install Apache, instructions can be found on their [http://httpd.apache.org/docs/current/install.html website].

=====PHP=====

Most Linux distributions include PHP. Make sure that the version number of PHP installed on your system matches the requirements of ARK.

If you need to install PHP, instructions can be found on their [http://www.php.net/manual/en/install.php website].

=====MySQL=====

MySQL is included in many Linux distributions, but if you do not have it you may need to install <code>mysql-server</code> and <code>mysql</code>, instructions are available on the [http://dev.mysql.com/doc/refman/5.1/en/binary-installation.html MySQL website].

You will need to secure the installation, <code>sudo /usr/bin/mysql_secure_installation</code>.

====on OSX or WINDOWS====

There are several ways to manually install each of the required packages on OSX or Windows. These methods will work perfectly well with ARK and if you are comfortable installing and configuring the required packages, please go ahead and do so. For OSX the instructions will be similar to the Linux instructions.

If you would prefer a simple package-based installer, please consider using either WAMP/MAMP or if you are using Windows, MS4W also provides a good way to install a complete WAMP stack along with a Mapserver instance.

=====MAMP/WAMP=====

For Mac OSX or Windows, the required packages are available as a bundle known as [http://www.mamp.info/en/index.php MAMP] for Mac or [http://www.wampserver.com/en/ WAMP] Windows. Their websites detail the installation procedures for these services.

=====MS4W=====

This package provides a standalone WAMP stack with a Mapserver instance. We have provided some walk through guidance [http://ark.lparchaeology.com/installing-mapserver-and-ms4w/ on the ARK website] for installing this package.

==Unpack ARK==

The ARK download consists of an SQL file and a folder of the php code and configuration files. All you need to do is to copy the arkv1_1 folder into the desired location in your web server directory. Consult the documentation of your distribution if you are unsure where this is. It is likely to be something like <code>/var/www/</code> or <code>/srv/www/</code>.

You can now rename the ARK package's folder to your desired name. If you do so, make a note of the folder name because you will need to update the environment settings to match it. This folder name will be used to navigate your ARK using your browser (in the URL), so call it something short, easy to remember and unique to your installation.

==Create Database and User==

You now need to create a new database, import the SQL into it and create a new user on your MySQL server.

The basic ARK database is included in the ARK package as an SQL file.

ARK only requires one user on the database, this is the user that the php code will use to access the MySQL database. Actual end users of your ARK will be created later using the tools provided by ARK.

The easiest way to accomplish these steps is to use phpMyAdmin, but you can also accomplish it using the command line mysql tools:

===Using phpMyAdmin===

Use the phpMyAdmin interface to create the new database. This is the database that will contain your ARK data, so make a note of the name so that you can update the settings files to match.

Now create a new user and grant them privileges on the new database.

Import the arkv1_1.sql file from the ARK source code into your database. Select the newly created database and then go to the Import tab and Browse to the .zip file that contains the SQL statement. This will copy all of the relevant tables to the database.

===Using the Command Line===

You can use MySQL from the command line to add the 'arkuser' user to the MySQL installation for instance:
<code>CREATE USER arkuser'@'%' IDENTIFIED BY 'XXXXXX';
GRANT ALL PRIVILEGES ON *.* TO 'arkuser'@'%' WITH GRANT OPTION;</code>

The values in this must be changed in order to secure your database. See the [http://dev.mysql.com/doc/ mysql manual] for more information.

You will also need to create a database for your ARK to connect to.
<code>CREATE DATABASE arkv1_1</code>

You are encouraged to change these default names see the [http://dev.mysql.com/doc/ mysql manual] for more information.

You should now load the ARK SQL into your database by using the <code>Source</code> command on the mysql terminal specifying the location of the arkv1_1.sql file.

==Initial Setup==

===Config===

You will need to edit some of the configuration directives in the settings files located inside the <code>config</code> folder of your ARK installation.

====settings====

Start with the general <code>settings.php</code> file.

You can update the name of your ARK, this value will be used as the markup nickname (nname) for a piece of markup containing the human readable name of your ARK. This allows you to customise the name of your ARK as it appears in page headers and titles. You will now need to add the markup to the ARK database.

You should also set your default site code in this file. Make a note of your site code(s) and be sure to add them to the ARK database using the form provided in the data entry page as soon as you log in. You will now need to add the site code to the ARK database.

====environment settings====

Next edit your <code>env_settings.php</code> file. This file should be self-explanatory, however there is an explanation of the relevant settings [http://ark.lparchaeology.com/wiki/index.php/Env_settings.php on this wiki page].

Change the <code>$server</code> directive on line 52 to match your server type, either mac, windows or linux.

Then in the correct code block of your server type, alter the paths to match the locations of the relevant directories in your ARK environment.

Make sure that the various path directives are correct. Be aware that you should update these to match your new ark folder name as set up earlier. For example:

<pre>
// The folder name of THIS instance of ARK (relative to the domain)
$ark_dir
// The server path to the ark directory
$ark_server_path
// The path to the PEAR installation
$pear_path
</pre>

Both local and remote paths for OpenLayers are offered, use // to comment out the line that you are not using.

Alter the database settings at the end of the file to match the database and user that you created earlier.

You are now ready to connect to your ARK!

===Preflight Checks===

Point your browser to the preflight checks file included in ARK to test that you have configured ARK correctly. It should be available on your server at www.example.com/'your ark directory'/config/preflight_checks.php. Depending on your setup you may be able to access it at localhost. Check your server documentation for details.

This tool will list set up options with either PASS or FAIL. If your config FAILs please follow the instructions on the preflight checks page, or refer to other pages on the wiki for more details.

====File Uploads and phMagick====

It is highly likely that a standard ARK install will fail on some or all of the tests in this section of the pre-flight tests.

If you intend to upload files such as PDFs or images to your ARK and would like them to have thumbnails, then you will need to pass all of these tests. If not, then ignore this section of the tests.

For further information on how to install the required PHP extensions, imageMagick and phMagick, please consult the relevant online documentation.

===Browse to your ARK===

Point your browser to the newly created ARK directory, typically this would be <code>www.example.com/ark_dir/</code> or <code>localhost/ark_dir/</code> although the exact URL will vary according to both your hostname and your ARK directory settings.

After browsing to the ARK directory you should see the login pages for the new ARK system. The default ARK is created with the following admin user account:

<pre>
username: doe_jd
password: janedoe
</pre>

Log in using these details and then finalise your configuration.

===Final Configuration===

If you successfully logged in as Jane Doe, pat yourself on the back and now mask sure you finish the last few steps:

You now need to [http://ark.lparchaeology.com/wiki/index.php/User_Administration create a new user] for yourself on ARK and make yourself and administrator. Once you have created this new administrator, you should logout and log back in again using you new username.

You should now remove the default doe_jd user to prevent unauthorised access to your system.

Now [http://ark.lparchaeology.com/wiki/index.php/Markup_Administration add markup] for the ARK name you specified in the settings file.

Now [http://ark.lparchaeology.com/wiki/index.php/site_code_administration add your default site code] as specified in the settings file.

==Debug==

If you experience problems after following the steps above, there are a range of possible reasons that your local setup may not be correct. In order to display debug messages, go to your settings file and turn on debug by adjusting the settings from:

<pre>
error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES
//error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING
</pre>

to

<pre>
//error_reporting(0); // Turn off all error reporting - USE THIS FOR PRODUCTION SITES
error_reporting(E_ALL); // Report all PHP errors (see changelog) - USE THIS FOR SETUP AND TESTING
</pre>

==Cleanup==

Once you have passed the pre-flight checks you should remove (delete or make inaccessible) this file so that it cannot be seen by unwanted users.

Remove the Jane Doe default user. This is to prevent unauthorised access to your ARK via this account!

If you plan on using your ARK on an unsecured network (such as the Internet) you should consider how you intend to encrypt traffic between the users and the server. You should consider how you will be securing passwords and login credentials against various kind of attacks. Such security measures are important but are outside the scope of this install document.

[[category:Administrator]]

Main Page

2014-03-05T14:03:45Z

Jessogden:

This wiki is the documentation project for ARK the archaeological recording kit. The documentation falls into 3 categories:

#[[User Manual]] - Notes for end users of the system
#[[Administrator Manual]] - Notes for setup and administration of ARK
#[[Developer Manual]] - Documentation of the ARK engine

For a quickstart installation after downloading the demo ARK, go straight to [[Basic Installation]].

Users of the system are encouraged to join the '''[http://groups.google.com/group/arkusers arkusers]''' Group.

Developers of the system are encouraged to join the '''[http://groups.google.com/group/arkdev arkdev]''' Group.

We also have an [[:Category:glossary|ARK Glossary]] to try to explain some key terms and the way they are used in ARK.

TranscludeFilter

2013-11-29T16:44:49Z

Jessogden: /* Example 1 - transcluding a saved filter as a table */

This method is used to return the results of a filter in a standard ARK results array. It can return the results of a saved filter or can be used to run a simple freetext search.

===Path===

http://your.ark.instance/api.php?req=transcludeFilter

===Arguments===

*'''ftype''' - The filtertype. Currently only a free text search can be undertaken using the API. If you want to run a free text search ftype needs to be set to 'ftx'. You will also need to send a src.
*'''src''' - This is the free text phrase to search on. Normal Boolean Search (i.e. Google) parameters apply.

If you want to retrieve a previously saved filter (saved using the ARK web interface) use:

*'''retftrset''' - this needs to be set to the numeric id of a saved filter. Current saved filters can be queried using the API method [[describeFilters]]().

*'''disp_mode''' - this is the display mode of the filter results - how the HTML will be rendered. The possible options are: chat, table, text, thumb, map. If no disp_mode is specified the results will be returned in table view.

If anonymous logins are not enabled a username and password will need to be supplied:

*'''handle''' - username

*'''passwd''' - password

===Example===

====Example 1 - transcluding a saved filter as a table====

http://your.ark.instance/api.php?req=transcludeFilter&retftrset=3&handle=johndoe&passwd=johndoepassword&disp_mode=table

Example return (returned as HTML):

[[File:transcludedFilter.png|500px]]

Sf modtype

2013-06-26T09:20:24Z

Jessogden: /* Example Configuration */

===Description===
This subform displays and edits the modtype of an item. It can be used either as a standard subform or within an overlay.

Edits are complex and require a user feedback and checking routine that uses [[Subform Conflict Resolution| conflict resolution]].

===Additional Fields===
*'''conflict_res_sf''' - this is used to specify the subform conf to use when conflict resolution information is needed to be be passed to the user. This is most likely to use sf_modtype_conflicts.php.

===Example Configuration===
An example of sf_modtype in action

<pre>
$conf_mcd_modtype =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'full',
'sf_title' => 'cxttype',
'sf_html_id' => 'cxt_modtype', // Must be unique
'script' => 'php/subforms/sf_modtype.php',
'op_label' => 'space',
'op_input' => 'save',
'op_modtype' => FALSE, //this is FALSE as should not be set to different fields
'conflict_res_sf' => 'conf_mcd_modtype_conflicts',
'fields' =>
array(
$conf_field_cxttype
)
);
</pre>

[[category:Administrator]]

Sf modtype conflicts

2013-06-26T09:19:54Z

Jessogden:

===Description===
This subform is used to provide information to users on potential conflicts between two modtypes of a particular record. It also examine the presence of data in this case.

===Additional Fields===

===Example Configuration===

An example of sf_modtype_conflicts configuration:

<pre>
$conf_mcd_modtype_conflicts =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'full',
'sf_title' => 'cxttypeconflicts',
'sf_html_id' => 'cxt_modtypeconflict', // Must be unique
'script' => 'php/subforms/sf_modtype_conflicts.php',
'op_label' => 'space',
'op_input' => 'save',
'op_modtype' => FALSE, //this is FALSE as should not be set to different fields
'fields' =>
array(
$conf_field_cxttype
)
);
</pre>

[[category:Administrator]]

Sf itemval

2013-06-26T09:18:44Z

Jessogden: /* Example Configuration */

===Description===
This subform is used for deleting records, it can be implemented either as a typical subform within a column, or it can be called into an overlay form.

This form relies on a further subform to provide conflict resolution feedback to users. This is governed by required setup (see below).

===Additional Fields===

*'''conflict_res_sf''' - This is NOT optional. Specify the 'name' of the sf_conf array that will handle conflict resolution. This is currently only sf_dnarecord.php.

===Example Configuration===

An example of sf_delete_record configuration:

<pre>
$conf_mcd_itemval =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'full',
'sf_title' => 'itemval',
'sf_html_id' => 'cxt_itemval', // Must be unique
'script' => 'php/subforms/sf_itemval.php',
'op_label' => 'space',
'op_input' => 'save',
'op_modtype' => FALSE, //this is always false as is not dependant on modtype
'conflict_res_sf' => 'conf_mcd_itemval_conflicts',
'fields' =>
array(
$conf_field_itemkey
)
);
</pre>

[[category:Administrator]]

ARK Data Storage

2013-06-13T16:23:53Z

Jessogden: /* Spatial Data */

This page set out some of major principles of how data is held in and handled by Ark. More specific practical issues related to the MySQL tables or the spatial tables can be found on those pages.

The two most fundamental characteristics of the Ark data model are:

#All data is data. Spatial data and text data are handled seamlessly
#Ark is modular, not all modules are inter compatible but all must be compatible with the ''core''

==Table Types==

There are a number of different table types within the ark database structure.

#tbl - this is a standard table that is generally the focus of the subject. i.e. cxt_tbl_cxt is within the module cxt and is the table about contexts
#lut - this is a LookUp Table - it is generally used as a dropdown list for various items. i.e lut_findtype is a lookup table of findtypes. These tables are slowly being weeded out and replaced by attributes (see below).
#xmi - this is a Cross Module Itermediate table. Effectively it allows item_keys from different modules to be realted to each other. So for instance, a plan may depict many different contexts or a photo may depict different contexts AND different special finds (in-situ).

==Data Classes==

In Ark we only hold 6 classes of data:

#Text
#Dates
#Actions
#Actors
#Attributes
#Spans

In order to make calls to data classes don't write out sql long hand in scripts, make use of the data abstraction functions. See [[DB calls in ARK]] for details.

===Text===

All text is held as fragments in the cor_tbl_txt this the items of text can have attributes attached to them such as author credits by means ot the cor_tbl_textattr

===Attributes===

Attributes are considered to be effectively properties of a item key. This means things like the 'colour' of a context or the 'resolution' of a digital scan.

Attributes are made up of a name/value pair. Therefore the Munsell colour GLEY 7/5 is 'GLEY 7/5' of type 'Munsell Colour'. In the same way 'Excellent' is a value that can be applied to the name 'Stratigraphic Reliability'.

The structure is as follows. cor_tbl_attribute. This is the table that links the attribute with the item key. cor_lut_attribute is the table that lists the attirbutes (Excellent, Good, etc.) alongside its type id. cor_lut_attributetype is the table that elucidates the type_id so type_id 4 is 'Stratigraphic Reliability'.

===Spans===

Spans are a conceptual object that need to be used when a simple 'date' is not enough. There can be many different type of 'spans', these include Temperature, Percentage, Date Ranges, etc. They can also be slightly more conceptual such as the idea of the temporal vector. Effectively this is a 'span' between two contexts. A span has an explicit direction (i.e. From and To) - therefore a temporal vector has a From (context 341) and a To (context 345). The nature of the span implies the nature of the relationship between the from and to. Therefore if context 341 is cut by context 345 then the span is a 'Cut By' and the implication is that 345 CUTS 341 as well as the explicit statement 341 IS CUT BY 345.

Spans therefore have a type, a beginning and an end. A spantype has certain properties and can also limit what can be inserted in the From/To fields of the span. For instance, if the spantype is 'Percentage' the values that can be inserted in the From/To fields of the particular span have to be between 0 and 100. If the spantype is 'Years BP' then the values have to be above 0.

This all works in the database in the following way:

cor_tbl_span - holds all of the information about the instance of the span itself. It has the same structure as other cor_tbls, i.e itemvalue itemkey, etc. It also has spantype (links to cor_lut_spantype) and beg and end (the fields for the values for From and To).

cor_lut_spantype - has the alias(es) and id for the span type. It also has two special fields one is called 'meta' - this is for an explanation of the type of span, outlining what it is conceptually and also what it should and shouldn't contain. There is also a 'evaluation' field - this should contain parameters for the evalaution of whatever is put into the beg and end fields of cor_tbl_span. This evalaution will be run before any update of that table to ensure that the inputted values are valid. It is currently soncieved that evaluation will consist of a self-contained PHP script. This gives us the freedom to evlaute things as widely ranging as 'This number must be greater than 0' to 'This context code does not exist'.

[http://localhost:8080/ark_dev_wiki/uploads/span_conversation_09_05_06.txt For the Messenger conversation log in which this was thought up]

''THIS IS AN ADDITION AND MAY NOT BE IMPLEMENTED'' - Spans can now also be used to link together fragments of data or indeed data descriptors. This means that they can be used to build complicated hierarchies of pottery types for instance by linking parent and child types. so to create amphora->type45->type45a you would create 2 spans - one linking amphora to type45 and one linking type 45 to type 45a. This means that you can then draw hierarchical trees of data-types which can be enforced (if necessary) in the front-end but can also be searched so that if you search for an amphora your results include all of the type45as even tho they are not directly linked to amphora (just implicit link through type45).

===Events===

The Ark system deals with the concept of an event abstractly. As an event can be considered to be a mixture of a date (either a date range or an absolute date) and an actor (theoretically this can be a non-human actor). Ark deals with this in the following way:

Let's take the example of issuing context number 341. We have a table that contains datetypes such as 'Issued on' for contexts. We also have a a table of action types such as 'Issued to'. Therefore the whole context number issue event is actually already stored in the database - its just not all in one table. It can however be joined by a simple SQL statement. Therefore to list all of the properties of the Context Issue Event we just have to:

SELECT cor_tbl_date.date, cor_tbl_people.initials
FROM cor_tbl_date, cor_tbl_action, cor_tbl_people
WHERE cor_tbl_date.itemkey = 'cxt_cd'
AND cor_tbl_date.itemvalue = 'FBN05_341' (i.e. the desired context number)
AND cor_tbl_date.datetype = 1 (i.e. 'issued on')
AND cor_tbl_action.itemkey = 'cxt_cd'
AND cor_tbl_action.itemvalue = 'FBN05_341'
AND cor_tbl_action.actiontype = '1' (i.e. issued to')
AND cor_tbl_action.people = cor_tbl_people.id (to make the link to get the actor's initials)

===Spatial Data===

!NB - as of v1.0 this is now deprecated, as all spatial data storage has been separated from the core data structure of ARK.

In order to dynamically build up the mapfile we include a number of different tables within the database structure (see [http://localhost:8080/ark_dev_wiki/uploads/mapserver_chat_15_05_06.txt conversation]). These are the basic settings for a unlimited number of maps (i.e. sizes/outputs/etc) which is held in cor_tbl_mapfile. This includes the sections of the mapfile that are not related to any layer specific stuff, just the desired projection, size, and some path information.

As each GIS layer is modular (and we don't want the mapping to break if a module isn;t loaded) the actual layer information is organised per module. Therefore each module has a mod_tbl_maplayers. This table contains all of the different elements that go into to making the layer declaration within the mapfile (i.e. colour, outlinecolour, etc.). Also it states where the data is and what type of data it is. This is very important as different types of data have different connection strings. This links to cor_lut_maplayertype - which is a lut of all of the different types - so that the php builder script knows how to contrcut the connection.

In addition to this there is a mod_tbl_mapexpressions which contains layername, and the expressions need to query out colour and label information - should you want to colour different types of data different colours.

Finally this is done per the map id in the cor_tbl_mapfile - as for different types of map you may want different colours, or available layers, etc.

The coding notes for this are in [[Mapserver]]

===How to retrieve two records for the same table and present them in one result set===

Here's the SQL - this gives us the x and y coordinates of (a fasti site) and is a good example of using a nested query to get two items of the same class related to the same itemkey/itemval:

SELECT q1.fst_cd,q1.number as easting,q2.number as northing FROM
(SELECT a.fst_cd,b.number,b.numbertype FROM fst_tbl_fst AS a, cor_tbl_number AS b
WHERE a.fst_cd=b.itemvalue AND b.numbertype = 3) AS q1,
(SELECT a.fst_cd, b.number,b.numbertype FROM fst_tbl_fst AS a, cor_tbl_number AS b
WHERE a.fst_cd=b.itemvalue AND b.numbertype = 4) AS q2
WHERE q1.fst_cd = q2.fst_cd

[[Category: Developer]]

ARK Data Storage

2013-06-13T16:22:16Z

Jessogden: /* Data Classes */

This page set out some of major principles of how data is held in and handled by Ark. More specific practical issues related to the MySQL tables or the spatial tables can be found on those pages.

The two most fundamental characteristics of the Ark data model are:

#All data is data. Spatial data and text data are handled seamlessly
#Ark is modular, not all modules are inter compatible but all must be compatible with the ''core''

==Table Types==

There are a number of different table types within the ark database structure.

#tbl - this is a standard table that is generally the focus of the subject. i.e. cxt_tbl_cxt is within the module cxt and is the table about contexts
#lut - this is a LookUp Table - it is generally used as a dropdown list for various items. i.e lut_findtype is a lookup table of findtypes. These tables are slowly being weeded out and replaced by attributes (see below).
#xmi - this is a Cross Module Itermediate table. Effectively it allows item_keys from different modules to be realted to each other. So for instance, a plan may depict many different contexts or a photo may depict different contexts AND different special finds (in-situ).

==Data Classes==

In Ark we only hold 6 classes of data:

#Text
#Dates
#Actions
#Actors
#Attributes
#Spans

In order to make calls to data classes don't write out sql long hand in scripts, make use of the data abstraction functions. See [[DB calls in ARK]] for details.

===Text===

All text is held as fragments in the cor_tbl_txt this the items of text can have attributes attached to them such as author credits by means ot the cor_tbl_textattr

===Attributes===

Attributes are considered to be effectively properties of a item key. This means things like the 'colour' of a context or the 'resolution' of a digital scan.

Attributes are made up of a name/value pair. Therefore the Munsell colour GLEY 7/5 is 'GLEY 7/5' of type 'Munsell Colour'. In the same way 'Excellent' is a value that can be applied to the name 'Stratigraphic Reliability'.

The structure is as follows. cor_tbl_attribute. This is the table that links the attribute with the item key. cor_lut_attribute is the table that lists the attirbutes (Excellent, Good, etc.) alongside its type id. cor_lut_attributetype is the table that elucidates the type_id so type_id 4 is 'Stratigraphic Reliability'.

===Spans===

Spans are a conceptual object that need to be used when a simple 'date' is not enough. There can be many different type of 'spans', these include Temperature, Percentage, Date Ranges, etc. They can also be slightly more conceptual such as the idea of the temporal vector. Effectively this is a 'span' between two contexts. A span has an explicit direction (i.e. From and To) - therefore a temporal vector has a From (context 341) and a To (context 345). The nature of the span implies the nature of the relationship between the from and to. Therefore if context 341 is cut by context 345 then the span is a 'Cut By' and the implication is that 345 CUTS 341 as well as the explicit statement 341 IS CUT BY 345.

Spans therefore have a type, a beginning and an end. A spantype has certain properties and can also limit what can be inserted in the From/To fields of the span. For instance, if the spantype is 'Percentage' the values that can be inserted in the From/To fields of the particular span have to be between 0 and 100. If the spantype is 'Years BP' then the values have to be above 0.

This all works in the database in the following way:

cor_tbl_span - holds all of the information about the instance of the span itself. It has the same structure as other cor_tbls, i.e itemvalue itemkey, etc. It also has spantype (links to cor_lut_spantype) and beg and end (the fields for the values for From and To).

cor_lut_spantype - has the alias(es) and id for the span type. It also has two special fields one is called 'meta' - this is for an explanation of the type of span, outlining what it is conceptually and also what it should and shouldn't contain. There is also a 'evaluation' field - this should contain parameters for the evalaution of whatever is put into the beg and end fields of cor_tbl_span. This evalaution will be run before any update of that table to ensure that the inputted values are valid. It is currently soncieved that evaluation will consist of a self-contained PHP script. This gives us the freedom to evlaute things as widely ranging as 'This number must be greater than 0' to 'This context code does not exist'.

[http://localhost:8080/ark_dev_wiki/uploads/span_conversation_09_05_06.txt For the Messenger conversation log in which this was thought up]

''THIS IS AN ADDITION AND MAY NOT BE IMPLEMENTED'' - Spans can now also be used to link together fragments of data or indeed data descriptors. This means that they can be used to build complicated hierarchies of pottery types for instance by linking parent and child types. so to create amphora->type45->type45a you would create 2 spans - one linking amphora to type45 and one linking type 45 to type 45a. This means that you can then draw hierarchical trees of data-types which can be enforced (if necessary) in the front-end but can also be searched so that if you search for an amphora your results include all of the type45as even tho they are not directly linked to amphora (just implicit link through type45).

===Events===

The Ark system deals with the concept of an event abstractly. As an event can be considered to be a mixture of a date (either a date range or an absolute date) and an actor (theoretically this can be a non-human actor). Ark deals with this in the following way:

Let's take the example of issuing context number 341. We have a table that contains datetypes such as 'Issued on' for contexts. We also have a a table of action types such as 'Issued to'. Therefore the whole context number issue event is actually already stored in the database - its just not all in one table. It can however be joined by a simple SQL statement. Therefore to list all of the properties of the Context Issue Event we just have to:

SELECT cor_tbl_date.date, cor_tbl_people.initials
FROM cor_tbl_date, cor_tbl_action, cor_tbl_people
WHERE cor_tbl_date.itemkey = 'cxt_cd'
AND cor_tbl_date.itemvalue = 'FBN05_341' (i.e. the desired context number)
AND cor_tbl_date.datetype = 1 (i.e. 'issued on')
AND cor_tbl_action.itemkey = 'cxt_cd'
AND cor_tbl_action.itemvalue = 'FBN05_341'
AND cor_tbl_action.actiontype = '1' (i.e. issued to')
AND cor_tbl_action.people = cor_tbl_people.id (to make the link to get the actor's initials)

===Spatial Data===

!NB - as of v1.0 this is now deprecated, as all spatial data storage has been separated from the core data structure of ARK.

In order to dynamically build up the mapfile we include a number of different tables within the database structure (see [http://localhost:8080/ark_dev_wiki/uploads/mapserver_chat_15_05_06.txt conversation]). These are the basic settings for a unlimited number of maps (i.e. sizes/outputs/etc) which is held in cor_tbl_mapfile. This includes the sections of the mapfile that are not related to any layer specific stuff, just the desired projection, size, and some path information.

As each GIS layer is modular (and we don't want the mapping to break if a module isn;t loaded) the actual layer information is organised per module. Therefore each module has a mod_tbl_maplayers. This table contains all of the different elements that go into to making the layer declaration within the mapfile (i.e. colour, outlinecolour, etc.). Also it states where the data is and what type of data it is. This is very important as different types of data have different connection strings. This links to cor_lut_maplayertype - which is a lut of all of the different types - so that the php builder script knows how to contrcut the connection.

In addition to this there is a mod_tbl_mapexpressions which contains layername, and the expressions need to query out colour and label information - should you want to colour different types of data different colours.

Finally this is done per the map id in the cor_tbl_mapfile - as for different types of map you may want different colours, or available layers, etc.

The coding notes for this are in [[Mapserver]]

===How to retrieve two records for the same table and present them in one result set===

Here's the SQL - this gives us the x and y coordinates of (a fasti site) and is a good example of using a nested query to get two items of the same class related to the same itemkey/itemval:

SELECT q1.fst_cd,q1.number as easting,q2.number as northing FROM
(SELECT a.fst_cd,b.number,b.numbertype FROM fst_tbl_fst AS a, cor_tbl_number AS b
WHERE a.fst_cd=b.itemvalue AND b.numbertype = 3) AS q1,
(SELECT a.fst_cd, b.number,b.numbertype FROM fst_tbl_fst AS a, cor_tbl_number AS b
WHERE a.fst_cd=b.itemvalue AND b.numbertype = 4) AS q2
WHERE q1.fst_cd = q2.fst_cd

[[Category: Developer]]

ARK Data Storage

2013-06-13T16:22:00Z

Jessogden: /* Data Classes */

This page set out some of major principles of how data is held in and handled by Ark. More specific practical issues related to the MySQL tables or the spatial tables can be found on those pages.

The two most fundamental characteristics of the Ark data model are:

#All data is data. Spatial data and text data are handled seamlessly
#Ark is modular, not all modules are inter compatible but all must be compatible with the ''core''

==Table Types==

There are a number of different table types within the ark database structure.

#tbl - this is a standard table that is generally the focus of the subject. i.e. cxt_tbl_cxt is within the module cxt and is the table about contexts
#lut - this is a LookUp Table - it is generally used as a dropdown list for various items. i.e lut_findtype is a lookup table of findtypes. These tables are slowly being weeded out and replaced by attributes (see below).
#xmi - this is a Cross Module Itermediate table. Effectively it allows item_keys from different modules to be realted to each other. So for instance, a plan may depict many different contexts or a photo may depict different contexts AND different special finds (in-situ).

==Data Classes==

In Ark we only hold 9 classes of data:

#Text
#Dates
#Actions
#Actors
#Attributes
#Spans

In order to make calls to data classes don't write out sql long hand in scripts, make use of the data abstraction functions. See [[DB calls in ARK]] for details.

===Text===

All text is held as fragments in the cor_tbl_txt this the items of text can have attributes attached to them such as author credits by means ot the cor_tbl_textattr

===Attributes===

Attributes are considered to be effectively properties of a item key. This means things like the 'colour' of a context or the 'resolution' of a digital scan.

Attributes are made up of a name/value pair. Therefore the Munsell colour GLEY 7/5 is 'GLEY 7/5' of type 'Munsell Colour'. In the same way 'Excellent' is a value that can be applied to the name 'Stratigraphic Reliability'.

The structure is as follows. cor_tbl_attribute. This is the table that links the attribute with the item key. cor_lut_attribute is the table that lists the attirbutes (Excellent, Good, etc.) alongside its type id. cor_lut_attributetype is the table that elucidates the type_id so type_id 4 is 'Stratigraphic Reliability'.

===Spans===

Spans are a conceptual object that need to be used when a simple 'date' is not enough. There can be many different type of 'spans', these include Temperature, Percentage, Date Ranges, etc. They can also be slightly more conceptual such as the idea of the temporal vector. Effectively this is a 'span' between two contexts. A span has an explicit direction (i.e. From and To) - therefore a temporal vector has a From (context 341) and a To (context 345). The nature of the span implies the nature of the relationship between the from and to. Therefore if context 341 is cut by context 345 then the span is a 'Cut By' and the implication is that 345 CUTS 341 as well as the explicit statement 341 IS CUT BY 345.

Spans therefore have a type, a beginning and an end. A spantype has certain properties and can also limit what can be inserted in the From/To fields of the span. For instance, if the spantype is 'Percentage' the values that can be inserted in the From/To fields of the particular span have to be between 0 and 100. If the spantype is 'Years BP' then the values have to be above 0.

This all works in the database in the following way:

cor_tbl_span - holds all of the information about the instance of the span itself. It has the same structure as other cor_tbls, i.e itemvalue itemkey, etc. It also has spantype (links to cor_lut_spantype) and beg and end (the fields for the values for From and To).

cor_lut_spantype - has the alias(es) and id for the span type. It also has two special fields one is called 'meta' - this is for an explanation of the type of span, outlining what it is conceptually and also what it should and shouldn't contain. There is also a 'evaluation' field - this should contain parameters for the evalaution of whatever is put into the beg and end fields of cor_tbl_span. This evalaution will be run before any update of that table to ensure that the inputted values are valid. It is currently soncieved that evaluation will consist of a self-contained PHP script. This gives us the freedom to evlaute things as widely ranging as 'This number must be greater than 0' to 'This context code does not exist'.

[http://localhost:8080/ark_dev_wiki/uploads/span_conversation_09_05_06.txt For the Messenger conversation log in which this was thought up]

''THIS IS AN ADDITION AND MAY NOT BE IMPLEMENTED'' - Spans can now also be used to link together fragments of data or indeed data descriptors. This means that they can be used to build complicated hierarchies of pottery types for instance by linking parent and child types. so to create amphora->type45->type45a you would create 2 spans - one linking amphora to type45 and one linking type 45 to type 45a. This means that you can then draw hierarchical trees of data-types which can be enforced (if necessary) in the front-end but can also be searched so that if you search for an amphora your results include all of the type45as even tho they are not directly linked to amphora (just implicit link through type45).

===Events===

The Ark system deals with the concept of an event abstractly. As an event can be considered to be a mixture of a date (either a date range or an absolute date) and an actor (theoretically this can be a non-human actor). Ark deals with this in the following way:

Let's take the example of issuing context number 341. We have a table that contains datetypes such as 'Issued on' for contexts. We also have a a table of action types such as 'Issued to'. Therefore the whole context number issue event is actually already stored in the database - its just not all in one table. It can however be joined by a simple SQL statement. Therefore to list all of the properties of the Context Issue Event we just have to:

SELECT cor_tbl_date.date, cor_tbl_people.initials
FROM cor_tbl_date, cor_tbl_action, cor_tbl_people
WHERE cor_tbl_date.itemkey = 'cxt_cd'
AND cor_tbl_date.itemvalue = 'FBN05_341' (i.e. the desired context number)
AND cor_tbl_date.datetype = 1 (i.e. 'issued on')
AND cor_tbl_action.itemkey = 'cxt_cd'
AND cor_tbl_action.itemvalue = 'FBN05_341'
AND cor_tbl_action.actiontype = '1' (i.e. issued to')
AND cor_tbl_action.people = cor_tbl_people.id (to make the link to get the actor's initials)

===Spatial Data===

!NB - as of v1.0 this is now deprecated, as all spatial data storage has been separated from the core data structure of ARK.

In order to dynamically build up the mapfile we include a number of different tables within the database structure (see [http://localhost:8080/ark_dev_wiki/uploads/mapserver_chat_15_05_06.txt conversation]). These are the basic settings for a unlimited number of maps (i.e. sizes/outputs/etc) which is held in cor_tbl_mapfile. This includes the sections of the mapfile that are not related to any layer specific stuff, just the desired projection, size, and some path information.

As each GIS layer is modular (and we don't want the mapping to break if a module isn;t loaded) the actual layer information is organised per module. Therefore each module has a mod_tbl_maplayers. This table contains all of the different elements that go into to making the layer declaration within the mapfile (i.e. colour, outlinecolour, etc.). Also it states where the data is and what type of data it is. This is very important as different types of data have different connection strings. This links to cor_lut_maplayertype - which is a lut of all of the different types - so that the php builder script knows how to contrcut the connection.

In addition to this there is a mod_tbl_mapexpressions which contains layername, and the expressions need to query out colour and label information - should you want to colour different types of data different colours.

Finally this is done per the map id in the cor_tbl_mapfile - as for different types of map you may want different colours, or available layers, etc.

The coding notes for this are in [[Mapserver]]

===How to retrieve two records for the same table and present them in one result set===

Here's the SQL - this gives us the x and y coordinates of (a fasti site) and is a good example of using a nested query to get two items of the same class related to the same itemkey/itemval:

SELECT q1.fst_cd,q1.number as easting,q2.number as northing FROM
(SELECT a.fst_cd,b.number,b.numbertype FROM fst_tbl_fst AS a, cor_tbl_number AS b
WHERE a.fst_cd=b.itemvalue AND b.numbertype = 3) AS q1,
(SELECT a.fst_cd, b.number,b.numbertype FROM fst_tbl_fst AS a, cor_tbl_number AS b
WHERE a.fst_cd=b.itemvalue AND b.numbertype = 4) AS q2
WHERE q1.fst_cd = q2.fst_cd

[[Category: Developer]]

Developing Subforms

2013-05-29T16:36:17Z

Jessogden:

[[Subforms]] are the key building blocks of the ARK user interface. Therefore this is probably one of the key areas we expect plugins and community contributions. These notes set out some of the key principles of developing a new subform.

==Overview==

Make sure that your code has the correct header block at the top. Do not just copy some old code. Many older subforms are badly formed.

Process of user input should go at the top. This is followed by error reporting and by data and form display.

Your subform will receive the following live vars

*$sf_state - a string supplied to the subform, but usually based on the settings found in the sf_conf
*$sf_conf - an array of settings for the subform.
*$sf_key - string, an ARK compliant itemkey
*$sf_val - string, and ARK compliant itemvalue

The sf_key and $sf_val are used in order to allow a subform to display data relating to an item other than the main item of the page. Always refer to these keys within a subform and not the main item_key of the page.

==Settings==

More detailed information about how to configure a subform can be found in the administration manual [[subforms]] page. It is important that developers (that's YOU!) conform to rules for settings in subforms so that the architecture does not get all messy and impossible to follow.

Settings will be passed to the subform by the page in the form of an array called sf_conf. This contains the obligatory and optional settings set up for the subform in the settings file. These settings are given in more detail int eh administrators manual.

Optional settings are used if stuff specific to your subform. You must make your subform work even when your op setting is NOT set. This may be a case of setting a default behavior or it may be a case of returning an error for admins to update their settings.

==sf_states==

Subforms are set up to behave differently when called in different environments. Your form should be set up to display data int he main states, in all other states, the default should be used in order to give meaningful feedback to the administrator.

The $sf_state is supplied to the subform as a live string var. The subform then selects which code to use for this state using a switch statement. This means that several different states can make use of the same code.

States can be of three types:

*auto
*transclude
*overlay.

Automatic states are set using a combination of three factors: the column type, the 'view state' and the 'edit state'. This evaluation is performed outside of the subform by the getSfState() function.

====Column Type====

This differentiates primary (wide) columns and secondary (narrrow) columns. This enables us to present data in different ways depending on the approximate width of a column.

====View State====

Min establishes a state for minimised forms. Typically this is just to display the sf_nav (see below), but it could display some very limited information like a number of records. Max establishes fully open subforms.

====Edit State====

View sets the subform to present data in an uneditable way. Edit presents data in an editable format. Enter sets up the form for data entry. This would allow different views for data entry work or casual edits

===Automatic States (Resulting Combinations)===

The following combinations are therefore possible. Things like min_edit are impossible.

*p_max_ent
*p_max_edit
*p_max_view
*s_max_edit
*s_max_view
*min_view

===Transclusion===

When the data from a subform is called into an external web page, this is called transclusion. In this state, the subform will send back its data in a neatly wrapped package. It is important to remember that the subform must wrap its content within a fully formed xhtml page.

*transclude

===Overlays===

Subforms may also be used as popup overlays. Typically this is for dialogues, but could be for any purpose really. In order to design a subform to work as an overlay, it will need to wrap the content into a fully formed xhtml document much like transclusion.

*overlay

==sf_nav==

Within the code for a particular state, it may be desirable to set up a navigation bar. In all of the auto states, a navigation bar should be included. This can then be turned off by the administrator using the sf_conf. If you do not supply a nav bar, this will confuse the admins.

==CSS Classes==

Optional CSS classes can be applied to subforms so that they can be displayed atypically. The default class you should apply is the mc_subform class. This establishes the standard subform CSS across the site. Should an admin require specific CSS for a form, this can be set up from within the sf_conf.

[[Category: Developer]]

Developer Manual

2013-05-29T16:32:13Z

Jessogden: /* API Documentation */

Developer Manual

2013-05-29T16:31:14Z

Jessogden: /* API Documentation */

Developer Manual

2013-05-29T16:29:26Z

Jessogden: /* API Documentation */

Developer Manual

2013-05-29T16:27:47Z

Jessogden: /* API Documentation */

Developer Manual

2013-05-29T16:27:22Z

Jessogden: /* API Documentation */

User:Michael Page

2012-12-10T12:31:29Z

Jessogden: Creating user page with biography of new user.

Michael is the Geospatial Coordinator at Emory University and serves as Adjunct Faculty in the Department of Environmental Studies at Emory University in Atlanta, Georgia. Michael teaches introductory and advanced courses at both the college and the school of public health and short workshops on urban geography, cartography, and geospatial technologies like GIS and Remote Sensing. His current research focuses on using new technologies to survey and map landscape change at ancient Greek archaeological sites. Working out of Emory University Libraries Michael’s work focuses on strengthening the cartography and GIS education program across campus as well as building data and dissemination structures to support research and instruction.

User talk:Michael Page

2012-12-10T12:31:29Z

Jessogden: Welcome!

'''Welcome to ''ARK''!'''
We hope you will contribute much and well.
You will probably want to read the [[Help:Contents|help pages]].
Again, welcome and have fun! [[User:Jessogden|Jessogden]] 12:31, 10 December 2012 (UTC)

User talk:GHOZZI

2012-12-10T12:31:02Z

Jessogden: Welcome!

User:GHOZZI

2012-12-10T12:31:01Z

Jessogden: Creating user page with biography of new user.

Chargé de recherche à l'Insttitut National du Patrioine, Tunis. Coordonne le projet "Utica" avec l'Université d'Oxford.

CURRICULUM VITAE

Mr. Faouzi GHOZZI
CEPAM-CNRS (UMR 6130)
Rue Sidi Bousaïd, 9000, Béja, Tunisie

Tel : +21699744552
Courriel : ghozzi@cepam.cnrs.fr
ghozzi_faouzi@yahoo.com

SPECIALITE

Archéomatique, Géo-archéologie, Géomatique et Système d'Information Géographique

DIPLOMES

• Doctorat Histoire (diplôme français) :

o Titre : "La feuille 1/50000ème de Zaouiet Medien (Tunisie NO), étude archéologique à travers un Système d'Information Géographique (SIG) depuis la protohistoire jusqu'à la fin du Moyen Âge"
o Date de soutenance : 01 / 12 / 2006
o Lieu : CEPAM – CNRS (UMR-6130), Sophia-Antipolis, Valbonne France
o Composition du jury :
 ARNAUD PASCAL, Professeur, Université de Nice - Sophia Antipolis
 BEJAOUI FETHI, Directeur de recherche, INP – Tunis
 BRAEMER FRANK, DIRECTEUR de recherche, CEPAM – CNRS
 DAVTIAN GOURGUEN, INGENIEUR de recherche, CEPAM – CNRS
 FAVORY FRANÇOIS, PROFESSEUR, Université de Franche-Comté
 GHAKI MANSOUR, Directeur de recherche, INP - Tunis
o Mention : Très honorable

• Diplôme d'Etudes Approfondies (DEA, "Expansions, Modèles et Transferts ; Histoire, diplôme français, Université de Nice Sophia-Antipolis)
o Titre : "Modélisation du peuplement de la région de Zaouiet Medien (Tunisie NO), à partir d'une analyse par un Système d'Information Géographique (SIG)"
o Date de soutenance : 26 / 06 / 2002
o Lieu : CEPAM – CNRS (UMR-6130), Sophia-Antipolis, Valbonne France
o Sous la direction de PASCAL ARNAUD, Professeur, Université de Nice - Sophia Antipolis
o Mention : Très bien

• Maîtrise en Histoire (Juin 1998), Université de Tunis, Faculté des Lettres, Manouba
• Baccalauréat Lettres (Juillet 1994), Amdoun, Tunisie

EXPERIENCES PROFESSIONELLES

• Pendant les mois de septembre et octobre des années 2003, 2004 et 2005, à Lucciana, Haute Corse

o Mission : Cartographie thématique, numérique et analyse spatiale sur des logiciels SIG de la région de Lucciana et la Basse Vallée du Golo.
o Cadre : Projet de recherche, fouilles et étude pluridisciplinaire sur le site de Mariana (Haute Corse)
o Y participe : Mairie de Lucciana (maitre d'œuvre), Le Conseil Général de Haute Corse (Financement), le CEPAM-CNRS, Ecole Française de Rome, et plusieurs autres universités et laboratoires de recherches en France, Italie et Belgique.
o En résulte : Une publication en cours dans les actes du colloque international "Lucciana et la Basse Vallée du Golo".

• De Août 2003 à Juin 2004 : Ecomusée du Pays de la Roudoule
o Mission : Cartographie thématique, numérique, analyse spatiale sur des logiciels SIG et réalisation d'une base de données alphanumérique de la commune de Guillaume dans le Parc National du Mercantour.
o Cadre : Projet de recherche et étude pluridisciplinaire sur les trois hameaux (La Palud, Le Serres et le Lave à Barels, commune de Guillaume, Alpes Maritimes)
o Y participe : L'Ecomusée du Pays de la Roudoule (maître d'œuvre) Le Conseil Général des Alpes Maritimes (Financement) et le CEPAM-CNRS.
o En résulte : Plusieurs publications ("Géomatique Expert" N° 39 et 40, 2003, colloque International "Temps et Espace de l'Homme en Société", 2005, etc.)
• Du 1er janv. 1999 au 31 déc. 2002, Projet IPAMED à l'INP Tunis
o Mission : Participation à la réalisation de la carte informatisée du patrimoine
o Cadre : Projet de recherche et étude pluridisciplinaire dit "IPAMED" programme "Euromed Hertitage".
o Y participe : L'Institut National du Patrimoine de Tunis (maître d'œuvre) La Commission Européenne (Financement), le CEPAM-CNRS France; LATER, Turin-Italie, etc.
o En résulte : Une base de données complète, une publication d'un récapitulatif en 2005 par l'INP, Tunis.
• Dec. 2003, CEPAM-CNRS, Sophia Antipolis, France
o Cartographie numérique (Scannage et digitalisation de plusieurs couches thématique sur un fond cartographique du XIXème s.
• Sep. 2007 – fev. 2009 :
o Chargé de faire le suivi du travail d’une équipe de 60 personnes multidisciplinaire (historiens, archéologues, topographes, architectes…) ayant pour mission la réalisation de la carte archéologique informatisée de la Tunisie, notamment dans les zones où devra passer le tracé d’une autoroute en projet reliant trois pays du Maghreb : Libye, Tunisie et Algérie.
• Depuis mars 2009 :
o Chargé de recherches archéologiques au profit de l’Institut National du Patrimoine, Tunis : Responsable de plusieurs projets de restauration et de mise en valeur de monuments et sites archéologiques dans la région de Béja, au nord-ouest de la Tunisie.

STAGES ET FORMATIONS

• Dec. 2000, stage SIG et GPS au CEPAM-CNRS, Sophia Antipolis
• Mars, avril et mai 2001, stage de télédétection au Centre National de la télédétection, Tunis
• Nov., dec. 1999, télédétection et topographie, au LATER, Turin-Italie

CONNAISSANCES EN INFORMATIQUE

• Maîtrise parfaite des logiciels du pack office 2003 (Word, Access, Excel, Power Point, Picture Manager, etc.)
• Maîtrise parfaite des logiciels d'Adobe (Illustrateur CS, Photoshop CS, Image Ready) et plusieurs autres programmes de traitement d'images
• Maîtrise professionnelle, suite à des formations spécialisée et à de plusieurs applications durant plusieurs années, des logiciels SIG (ArcGis 9.x, ArcView 3.x, Idrisi Kilimanjaro, Pathfinder Office 3, Global Mapper 7.03, etc.
• Initiations sur Auto CAD-9

LANGUES

• Arabe : langue maternelle
• Français : bilingue
• Anglais : bilingue
• Italien et espagnol : initialisations
• Grec et latin : initiations

LISTE DES TRAVAUX

2002-1:

GHOZZI Faouzi, Modélisation de l'évolution du peuplement de la région de Zaouiet Medien (Tunisie) à partir d'une analyse sous S.I.G., Mémoire de DEA : Expansions, modèles et transferts : UNSA-Nice, CEPAM : 2002.

2004-1 :

GHOZZI Faouzi, DAVTIAN Gourguen et TOMASSIN Philippe, « Apport d'un SIG au Cadastre Napoléen de 1868 du Parc National du Mercantour », Conférence francophone d’Esri, SIG 2004, Issy-les-Moulinaux, 6 et 7 oct. 2004, France.
(http://www.esrifrance.fr/sig2004/communications/homearcheo.htm)

2004-2 :

GHOZZI Faouzi, DAVTIAN Gourguen et TOMASSIN Philippe, « Apports d’un SIG à l’étude d’un cadastre dit napoléonien », dans Géomatique Expert, N° 38 - Novembre 2004, pp 33-38.

2005-1 :

GHOZZI Faouzi, DAVTIAN Gourguen et TOMASSIN Philippe, « Utilisation d’un SIG pour l’étude d’un cadastre « napoléonien » : exemple des hameaux de Barels, commune de Guillaumes (Alpes-Maritimes) », TEMPS ET ESPACES DE L’HOMME EN SOCIÉTÉ, ANALYSES ET MODÈLES SPATIAUX EN ARCHÉOLOGIE, XXVe rencontres internationales d’archéologie et d’histoire d’Antibes, Sous la direction de J.-F. Berger, F. Bertoncello, F. Braemer, G. Davtian, M. Gazenbeek, Éditions APDCA, Antibes, 2005, pp. 263-267.

2006-1 :

GHOZZI Faouzi, « Valeur stratégique d’un S.I.G. en archéologie: Exemple d’application sur le territoire de la commune de Lucciana en Haute Corse », Actes du colloque international : Mariana et la basse vallée du Golo, bilan des recherches (1998-2003), Bastia –Lucciana, 11 – 16 septembre 2004, publication en cours par la MSH, Aix-en-Provence et l’École Française de Rome.

2006-2 :

GHOZZI Faouzi, « Modélisation des zones de peuplement protohistorique et historique dans la région de Zaouiet Medien par la méthode SIG dite évaluation multicritère », Colloque du Réseau Thématique Pluridisciplinaire « Paysage et environnement : de la reconstitution du passé aux modèles prospectifs », Chilhac - France, 27-28-29-30 septembre 2006.

2006-3 :

GHOZZI Faouzi, La feuille 1:50000 de Zaouiet Medien (Tunisie n-o): Étude archéologique à travers un Système d’Information Géographique (S.I.G.) de la protohistoire jusqu’à la fin du Moyen Âge, thèses doctorat, UNSA-Nice, CEPAM-CNRS, INP – Tunis, Nov. 2006.

2011

GHOZZI Faouzi, « Collines et contrebas entre l’Antiquité et l’Antiquité tardive, étude géo archéologique sur quelques exemples de sites du nord ouest tunisien », Kairouan IV, « Montagnes et plaine dans le bassin méditerranéen » 4ème Colloque international du Kairouan, faculté des lettres et sciences humaines du Kairouan, département d’archéologie, le 5,6 et 7 dec. 2011.

Prochainement :

GHOZZI Faouzi, « La Dea Africa encore et encore… »

Field settings.php

2012-12-10T12:29:44Z

Jessogden: /* Examples */

This is the documentation for the field settings file. It contains a technical description of the elements that must be and may optionally be present in fields.

===Common/Obligatory Attributes===

====Basics====

The two top settings are essential for the good working of the field:

*'''dataclass''' = This tells the system what [[Data Class]] the field is.
*'''classtype''' = This tells the system what [[Classtype]] the field is.

There is not currently an ARK function to create new classtypes. In order to add a new classtype, please access the database using PHPMyAdmin and add the classtype directly in the cor_lut_classtype table (eg. cor_lut_actiontype, cor_lut_datetype, etc...).

====Sorting====
As of v0.8 fields now have the option of being made 'sortable' in the data view (search). In order to allow for ascending and descending sorting on fields a 'field_id' must be added to the fields of interest, rendering them sortable in the search results table view.

*'''field_id''' = This is set to the name of the field, i.e. for field 'conf_field_textdesc', the 'field_id' => 'conf_field_textdesc'

====Alias Settings====

The alias for the field requires the following 4 attributes:

*'''alias_tbl''' = the table for the getAlias call
*'''alias_col''' = the col for the getAlias call
*'''alias_src_key''' = the alias_src_key for the getAlias call
*'''alias_type''' = the alias_type for the getAlias call

It is important to add all alias values to cor_tbl_alias when configuring fields. This can be completed using the [[Alias Administration]] tools.

====Other Obligatory Settings====

*'''editable''' = set TRUE to process this field in forms set FALSE for display only
*'''hidden''' = 1/TRUE | 0/FALSE/blank | string (see below)
*'''add_validation''' = validation rules for this field when on an add routine
*'''edt_validation''' = validation rules for this field when on an edt routine

=====editable=====
This is to with how the system processes As of v1.1 this variable only affects the way update_db processes fields - not the user interface.
*'''1/TRUE''' - handles field as normal
*'''0/FALSE''' - update_db will ignore this field (e.g. options field)

=====hidden=====
This variable is processed by frmElem() and is a setting which allows admins to a hide a given field from user input. If hidden a default needs to be supplied so that the input is supplied with a variable. The only dataclasses that has implemented this option as of v1.1 are xmi and itemkey. Variable will be ignored on all other dataclasses, but still obligatory as this will implemented in the future.
*'''1/TRUE''' - field is hidden, input type = hidden (needs default supplied, as mentioned above)
*'''0/FALSE''' - user input form displayed as normal
*'''string''' - nname which adds the markup for label displayed in form, functions the same as TRUE

====Optional Settings====
*'''field_op_default''' = 0/FALSE/blank/unset | string
Processed by frmElem() but only implemented on itemkeys as of v1.1
*'''0/FALSE/blank/unset''' - input displayed as normal
*'''string''' - string displayed as default within field, e.g. next

====Examples====

An example of a standard text field:
<pre>$conf_field_desc =
array(
'field_id' => 'conf_field_desc',
'dataclass' => 'txt',
'classtype' => 'desc',
'aliasinfo' => FALSE,
'editable' => TRUE,
'hidden' => FALSE,
'add_validation' => $txt_add_validation,
'edt_validation' => $txt_edt_validation
);
</pre>

An example of a standard attribute field:
<pre>
$conf_field_samplecondition =
array(
'field_id' => 'conf_field_samplecondition',
'dataclass' => 'attr',
'classtype' => 'samplecondition',
'aliasinfo' => FALSE,
'editable' => TRUE,
'hidden' => FALSE,
'add_validation' => $attr_add_validation,
'edt_validation' => $attr_edt_validation
);
</pre>

An example of a standard number field:
<pre>
$conf_field_total =
array(
'field_id' => 'conf_field_total',
'dataclass' => 'number',
'classtype' => 'total',
'aliasinfo' => FALSE,
'editable' => TRUE,
'hidden' => FALSE,
'add_validation' => $number_add_validation,
'edt_validation' => $number_edt_validation
);
</pre>

An example of a standard date field:
<pre>
$conf_field_issuedon =
array(
'field_id' => 'conf_field_issuedon',
'dataclass' => 'date',
'datestyle' => 'dd,mm,yr',
'classtype' => 'issuedon',
'aliasinfo' => FALSE,
'editable' => TRUE,
'hidden' => FALSE,
'add_validation' => $date_add_validation,
'edt_validation' => $date_edt_validation
);
</pre>

An example of a standard span field:
<pre>
$conf_field_sameas =
array(
'field_id' => 'conf_field_sameas',
'dataclass' => 'span',
'classtype' => 'sameas',
'aliasinfo' => FALSE,
'editable' => TRUE,
'hidden' => FALSE,
'add_validation' => $span_add_validation,
'edt_validation' => $span_edt_validation
);
</pre>

An example of a standard xmi field:
<pre>
$conf_field_plnxmicxt =
array(
'field_id' => 'conf_field_plnxmicxt',
'dataclass' => 'xmi',
'classtype' => 'xmi_list',
'aliasinfo' =>
array(
'alias_tbl' => 'cor_tbl_module',
'alias_col' => 'itemkey',
'alias_src_key' => 'pln_cd',
'alias_type' => '1',
),
'module' => 'cxt',
'xmi_mod' => 'pln',
'force_var_itemkey' => 'pln_cd',
'editable' => TRUE,
'hidden' => FALSE,
'add_validation' => $xmi_add_validation,
'edt_validation' => $xmi_edt_validation
);
</pre>

And finally, an example of a standard file field:
<pre>
$conf_field_file =
array(
'field_id' => 'conf_field_file',
'dataclass' => 'file',
'classtype' => 'file',
'aliasinfo' => FALSE,
'editable' => TRUE,
'hidden' => FALSE,
'add_validation' => $file_add_validation,
'edt_validation' => $file_edt_validation
);
</pre>

===Class specific settings===

Each class has some specific settings some of which may be optional or required.

====Class: action====

An example of an action class field.

<pre>$conf_field_issuedto =
array(
'field_id' => 'conf_field_issuedto',
'dataclass' => 'action',
'classtype' => 'issuedto',
'aliasinfo' => FALSE,
'actors_mod' => 'abk',
'actors_type' => 'people',
'actors_element' => 'name',
'actors_style' => 'single',
'actors_elementclass' => 'txt',
'actors_grp' => FALSE,
'editable' => TRUE,
'hidden' => FALSE,
'add_validation' => $action_add_validation,
'edt_validation' => $action_edt_validation
);
</pre>

*'''actors_mod''' = The module holding the actors (normally abk)
*'''actors_type''' = The mod type as listed in mod_lut_modtype
*'''actors_element''' = The text type to display within the dropdown
*'''actors_style''' = whether actor information is displayed in a list style ('list') or as a single actor/date pairing ('single')
*'''actors_elementclass''' = Class of data to be displayed for a given actor (ie. txt, number, etc)
*'''actors_grp''' = Group functionality will allow the selection of a group of actors (in development)

===Event Fields===

Event fields are effectively wrappers for action/date fields. All fields
must be set up above. One can also use actions and dates without having the event wrapper, but this allows one to group multiple events into a single subform.

See below for an example of a configured event field:

<pre>
$conf_event_compiled =
array(
'type' => 'compiled',
'date' => $conf_field_compiledon,
'action' => $conf_field_compiledby
);
</pre>

[[Category: Administrator]]

Field settings.php

2012-12-10T12:26:57Z

Jessogden: /* Class: action */

This is the documentation for the field settings file. It contains a technical description of the elements that must be and may optionally be present in fields.

===Common/Obligatory Attributes===

====Basics====

The two top settings are essential for the good working of the field:

*'''dataclass''' = This tells the system what [[Data Class]] the field is.
*'''classtype''' = This tells the system what [[Classtype]] the field is.

There is not currently an ARK function to create new classtypes. In order to add a new classtype, please access the database using PHPMyAdmin and add the classtype directly in the cor_lut_classtype table (eg. cor_lut_actiontype, cor_lut_datetype, etc...).

====Sorting====
As of v0.8 fields now have the option of being made 'sortable' in the data view (search). In order to allow for ascending and descending sorting on fields a 'field_id' must be added to the fields of interest, rendering them sortable in the search results table view.

*'''field_id''' = This is set to the name of the field, i.e. for field 'conf_field_textdesc', the 'field_id' => 'conf_field_textdesc'

====Alias Settings====

The alias for the field requires the following 4 attributes:

*'''alias_tbl''' = the table for the getAlias call
*'''alias_col''' = the col for the getAlias call
*'''alias_src_key''' = the alias_src_key for the getAlias call
*'''alias_type''' = the alias_type for the getAlias call

It is important to add all alias values to cor_tbl_alias when configuring fields. This can be completed using the [[Alias Administration]] tools.

====Other Obligatory Settings====

*'''editable''' = set TRUE to process this field in forms set FALSE for display only
*'''hidden''' = 1/TRUE | 0/FALSE/blank | string (see below)
*'''add_validation''' = validation rules for this field when on an add routine
*'''edt_validation''' = validation rules for this field when on an edt routine

=====editable=====
This is to with how the system processes As of v1.1 this variable only affects the way update_db processes fields - not the user interface.
*'''1/TRUE''' - handles field as normal
*'''0/FALSE''' - update_db will ignore this field (e.g. options field)

=====hidden=====
This variable is processed by frmElem() and is a setting which allows admins to a hide a given field from user input. If hidden a default needs to be supplied so that the input is supplied with a variable. The only dataclasses that has implemented this option as of v1.1 are xmi and itemkey. Variable will be ignored on all other dataclasses, but still obligatory as this will implemented in the future.
*'''1/TRUE''' - field is hidden, input type = hidden (needs default supplied, as mentioned above)
*'''0/FALSE''' - user input form displayed as normal
*'''string''' - nname which adds the markup for label displayed in form, functions the same as TRUE

====Optional Settings====
*'''field_op_default''' = 0/FALSE/blank/unset | string
Processed by frmElem() but only implemented on itemkeys as of v1.1
*'''0/FALSE/blank/unset''' - input displayed as normal
*'''string''' - string displayed as default within field, e.g. next

====Examples====

An example of a standard text field:
<pre>$conf_field_desc =
array(
'dataclass' => 'txt',
'classtype' => 'desc',
'aliasinfo' => FALSE,
'editable' => TRUE,
'hidden' => FALSE,
'add_validation' => $txt_add_validation,
'edt_validation' => $txt_edt_validation
);
</pre>

An example of a standard attribute field:
<pre>
$conf_field_samplecondition =
array(
'dataclass' => 'attr',
'classtype' => 'samplecondition',
'aliasinfo' => FALSE,
'editable' => TRUE,
'hidden' => FALSE,
'add_validation' => $attr_add_validation,
'edt_validation' => $attr_edt_validation
);
</pre>

An example of a standard number field:
<pre>
$conf_field_total =
array(
'dataclass' => 'number',
'classtype' => 'total',
'aliasinfo' => FALSE,
'editable' => TRUE,
'hidden' => FALSE,
'add_validation' => $number_add_validation,
'edt_validation' => $number_edt_validation
);
</pre>

An example of a standard date field:
<pre>
$conf_field_issuedon =
array(
'dataclass' => 'date',
'datestyle' => 'dd,mm,yr',
'classtype' => 'issuedon',
'aliasinfo' => FALSE,
'editable' => TRUE,
'hidden' => FALSE,
'add_validation' => $date_add_validation,
'edt_validation' => $date_edt_validation
);
</pre>

An example of a standard span field:
<pre>
$conf_field_sameas =
array(
'dataclass' => 'span',
'classtype' => 'sameas',
'aliasinfo' => FALSE,
'editable' => TRUE,
'hidden' => FALSE,
'add_validation' => $span_add_validation,
'edt_validation' => $span_edt_validation
);
</pre>

An example of a standard xmi field:
<pre>
$conf_field_romxmimus =
array(
'dataclass' => 'xmi',
'classtype' => 'xmi_list',
'aliasinfo' =>
array(
'alias_tbl' => 'cor_tbl_module',
'alias_col' => 'itemkey',
'alias_src_key' => 'rom_cd',
'alias_type' => '1',
),
'module' => 'mus',
'xmi_mod' => 'rom',
'force_var_itemkey' => 'rom_cd',
'editable' => TRUE,
'hidden' => FALSE,
'add_validation' => $xmi_add_validation,
'edt_validation' => $xmi_edt_validation
);
</pre>

And finally, an example of a standard file field:
<pre>
$conf_field_file =
array(
'dataclass' => 'file',
'classtype' => 'file',
'aliasinfo' => FALSE,
'editable' => TRUE,
'hidden' => FALSE,
'add_validation' => $file_add_validation,
'edt_validation' => $file_edt_validation
);
</pre>

===Class specific settings===

Each class has some specific settings some of which may be optional or required.

====Class: action====

An example of an action class field.

<pre>$conf_field_issuedto =
array(
'field_id' => 'conf_field_issuedto',
'dataclass' => 'action',
'classtype' => 'issuedto',
'aliasinfo' => FALSE,
'actors_mod' => 'abk',
'actors_type' => 'people',
'actors_element' => 'name',
'actors_style' => 'single',
'actors_elementclass' => 'txt',
'actors_grp' => FALSE,
'editable' => TRUE,
'hidden' => FALSE,
'add_validation' => $action_add_validation,
'edt_validation' => $action_edt_validation
);
</pre>

*'''actors_mod''' = The module holding the actors (normally abk)
*'''actors_type''' = The mod type as listed in mod_lut_modtype
*'''actors_element''' = The text type to display within the dropdown
*'''actors_style''' = whether actor information is displayed in a list style ('list') or as a single actor/date pairing ('single')
*'''actors_elementclass''' = Class of data to be displayed for a given actor (ie. txt, number, etc)
*'''actors_grp''' = Group functionality will allow the selection of a group of actors (in development)

===Event Fields===

Event fields are effectively wrappers for action/date fields. All fields
must be set up above. One can also use actions and dates without having the event wrapper, but this allows one to group multiple events into a single subform.

See below for an example of a configured event field:

<pre>
$conf_event_compiled =
array(
'type' => 'compiled',
'date' => $conf_field_compiledon,
'action' => $conf_field_compiledby
);
</pre>

[[Category: Administrator]]

Field settings.php

2012-12-10T12:21:34Z

Jessogden: /* Examples */

This is the documentation for the field settings file. It contains a technical description of the elements that must be and may optionally be present in fields.

===Common/Obligatory Attributes===

====Basics====

The two top settings are essential for the good working of the field:

*'''dataclass''' = This tells the system what [[Data Class]] the field is.
*'''classtype''' = This tells the system what [[Classtype]] the field is.

There is not currently an ARK function to create new classtypes. In order to add a new classtype, please access the database using PHPMyAdmin and add the classtype directly in the cor_lut_classtype table (eg. cor_lut_actiontype, cor_lut_datetype, etc...).

====Sorting====
As of v0.8 fields now have the option of being made 'sortable' in the data view (search). In order to allow for ascending and descending sorting on fields a 'field_id' must be added to the fields of interest, rendering them sortable in the search results table view.

*'''field_id''' = This is set to the name of the field, i.e. for field 'conf_field_textdesc', the 'field_id' => 'conf_field_textdesc'

====Alias Settings====

The alias for the field requires the following 4 attributes:

*'''alias_tbl''' = the table for the getAlias call
*'''alias_col''' = the col for the getAlias call
*'''alias_src_key''' = the alias_src_key for the getAlias call
*'''alias_type''' = the alias_type for the getAlias call

It is important to add all alias values to cor_tbl_alias when configuring fields. This can be completed using the [[Alias Administration]] tools.

====Other Obligatory Settings====

*'''editable''' = set TRUE to process this field in forms set FALSE for display only
*'''hidden''' = 1/TRUE | 0/FALSE/blank | string (see below)
*'''add_validation''' = validation rules for this field when on an add routine
*'''edt_validation''' = validation rules for this field when on an edt routine

=====editable=====
This is to with how the system processes As of v1.1 this variable only affects the way update_db processes fields - not the user interface.
*'''1/TRUE''' - handles field as normal
*'''0/FALSE''' - update_db will ignore this field (e.g. options field)

=====hidden=====
This variable is processed by frmElem() and is a setting which allows admins to a hide a given field from user input. If hidden a default needs to be supplied so that the input is supplied with a variable. The only dataclasses that has implemented this option as of v1.1 are xmi and itemkey. Variable will be ignored on all other dataclasses, but still obligatory as this will implemented in the future.
*'''1/TRUE''' - field is hidden, input type = hidden (needs default supplied, as mentioned above)
*'''0/FALSE''' - user input form displayed as normal
*'''string''' - nname which adds the markup for label displayed in form, functions the same as TRUE

====Optional Settings====
*'''field_op_default''' = 0/FALSE/blank/unset | string
Processed by frmElem() but only implemented on itemkeys as of v1.1
*'''0/FALSE/blank/unset''' - input displayed as normal
*'''string''' - string displayed as default within field, e.g. next

====Examples====

An example of a standard text field:
<pre>$conf_field_desc =
array(
'dataclass' => 'txt',
'classtype' => 'desc',
'aliasinfo' => FALSE,
'editable' => TRUE,
'hidden' => FALSE,
'add_validation' => $txt_add_validation,
'edt_validation' => $txt_edt_validation
);
</pre>

An example of a standard attribute field:
<pre>
$conf_field_samplecondition =
array(
'dataclass' => 'attr',
'classtype' => 'samplecondition',
'aliasinfo' => FALSE,
'editable' => TRUE,
'hidden' => FALSE,
'add_validation' => $attr_add_validation,
'edt_validation' => $attr_edt_validation
);
</pre>

An example of a standard number field:
<pre>
$conf_field_total =
array(
'dataclass' => 'number',
'classtype' => 'total',
'aliasinfo' => FALSE,
'editable' => TRUE,
'hidden' => FALSE,
'add_validation' => $number_add_validation,
'edt_validation' => $number_edt_validation
);
</pre>

An example of a standard date field:
<pre>
$conf_field_issuedon =
array(
'dataclass' => 'date',
'datestyle' => 'dd,mm,yr',
'classtype' => 'issuedon',
'aliasinfo' => FALSE,
'editable' => TRUE,
'hidden' => FALSE,
'add_validation' => $date_add_validation,
'edt_validation' => $date_edt_validation
);
</pre>

An example of a standard span field:
<pre>
$conf_field_sameas =
array(
'dataclass' => 'span',
'classtype' => 'sameas',
'aliasinfo' => FALSE,
'editable' => TRUE,
'hidden' => FALSE,
'add_validation' => $span_add_validation,
'edt_validation' => $span_edt_validation
);
</pre>

An example of a standard xmi field:
<pre>
$conf_field_romxmimus =
array(
'dataclass' => 'xmi',
'classtype' => 'xmi_list',
'aliasinfo' =>
array(
'alias_tbl' => 'cor_tbl_module',
'alias_col' => 'itemkey',
'alias_src_key' => 'rom_cd',
'alias_type' => '1',
),
'module' => 'mus',
'xmi_mod' => 'rom',
'force_var_itemkey' => 'rom_cd',
'editable' => TRUE,
'hidden' => FALSE,
'add_validation' => $xmi_add_validation,
'edt_validation' => $xmi_edt_validation
);
</pre>

And finally, an example of a standard file field:
<pre>
$conf_field_file =
array(
'dataclass' => 'file',
'classtype' => 'file',
'aliasinfo' => FALSE,
'editable' => TRUE,
'hidden' => FALSE,
'add_validation' => $file_add_validation,
'edt_validation' => $file_edt_validation
);
</pre>

===Class specific settings===

Each class has some specific settings some of which may be optional or required.

====Class: action====

An example of an action class field.

<pre>$conf_field_issuedto =
array(
'dataclass' => 'action',
'classtype' => 'issuedto',
'alias_tbl' => 'cor_lut_actiontype',
'alias_col' => 'actiontype',
'alias_src_key' => 'issuedto',
'actors_mod' => 'abk',
'actors_type' => 'people',
'actors_element' => 'name',
'actors_style' => 'single',
'actors_elementclass' => 'txt',
'actors_grp' => FALSE,
'alias_type' => '1',
'editable' => TRUE,
'hidden' => FALSE,
'add_validation' => $action_add_validation,
'edt_validation' => $action_edt_validation
);
</pre>

*'''actors_mod''' = The module holding the actors (normally abk)
*'''actors_type''' = The mod type as listed in mod_lut_modtype
*'''actors_element''' = The text type to display within the dropdown
*'''actors_style''' = whether actor information is displayed in a list style ('list') or as a single actor/date pairing ('single')
*'''actors_elementclass''' = Class of data to be displayed for a given actor (ie. txt, number, etc)
*'''actors_grp''' = Group functionality will allow the selection of a group of actors (in development)

===Event Fields===

Event fields are effectively wrappers for action/date fields. All fields
must be set up above. One can also use actions and dates without having the event wrapper, but this allows one to group multiple events into a single subform.

See below for an example of a configured event field:

<pre>
$conf_event_compiled =
array(
'type' => 'compiled',
'date' => $conf_field_compiledon,
'action' => $conf_field_compiledby
);
</pre>

[[Category: Administrator]]

Basic Installation

2012-03-23T12:09:34Z

Jessogden: /* How To's */

Pre-configured ARK setups are available from the ARK team. If you are unfamiliar with the setup and administration of webservers along with the security risks to your system and data this entails, please consider contacting us to acquire a fully running ARK. For those of you who have already got a server and want to go though the installation procedure, we have provided the following notes:

===How To's===

Detailed How-To documents have been written to take the new administrator through the installation and setup of MS4W, Mapserver, and ARK. They can be downloaded [http://ark.lparchaeology.com/download/windows-installation-walkthroughs-now-available].

===Dependencies===

ARK requires the following open source software packages to be installed on your server:

#Apache 2
#PHP 5
#MySQL 5
#PEAR Liveuser

In order to benefit from the spatial integration offered by ARK, you will also need the following packages:

#PHP Mapscript

====Apache PHP MySQL====

On most Linux distributions these packages will be installed by default. ARK is not particularly fussy about the version numbers of these packages and should run ok on PHP4 and MySQL4, although this may require some minor modifications. It is important to ensure that you have the gd and dbase php extensions enabled.

You will need to make sure that you set the short_open_tag option to On in your [http://uk2.php.net/ini.core php.ini].

For Mac OSX and Windows, these packages are available as binary distributions. ARK is known to run on [http://www.mamp.info/en/index.php MAMP], the binary distribution for Mac and [http://www.wampserver.com/en/ WAMP] or [http://www.maptools.org/ms4w/index.phtml MS4W], the binary distributions for Windows.

The MS4W distribution also contains Mapserver and if this is installed only MySQL needs to be added.

ARK runs on top of these packages and does not provide any set up of them or additional security to them. If you are using your server exposed to the internet, it is essential that you follow good standard security practice for the configuration of your packages. This setup is outside of the scope of this documentation and you are advised to undertake your research carefully.

====PEAR LiveUser====

The PEAR Liveuser is used to ensure effective security for the ARK system. ARK makes use of PEAR LiveUser, LiveUser_Admin, MDB2, and MDB2_driver_mysql, DB, and Event_Dispatcher. All of these packages will need to be installed in order for ARK user authentication to function.

'''PLEASE NOTE that ALL the PEAR SQL tables are already included with the basic ARK database, and do not need to be added to the database during PEAR setup. ALSO the required PEAR depencies are included with the v1.0 directory structure and in the environment settings, so no further installation or set-up of PEAR should be needed.'''

====MS4W====
MS4W [http://www.maptools.org/ms4w/] is a no fuss installer for setting up MapServer on Microsoft Windows platforms. It includes a Apache HTTP version, PHP, Mapserver and loads of nice tools.

MS4W is super simple to install on a server. Either download [http://www.maptools.org/ms4w/index.phtml?page=downloads.html] the base package which consists of a folder which unpacks to the C-drive of the server or try out the new installer.

If you are using the base package you need to start the Apache server by running C:\ms4w\apache-install.bat. If the installation is succesful you should get the main page by pointing you browser to http://localhost/ or http://127.0.0.1/.

If this does not work it is very likely that your port 80 is already in use. Go to C:\ms4w\Apache\conf\httpd.conf and on line 120 change LISTEN 80 to LISTEN 8080 or another port which is not in use.

====Mapscript====

Mapscript runs on all three major operating systems. The installation instructions vary depending on many factors. Detailed installation instructions are available on the [http://mapserver.gis.umn.edu/ Mapserver] website.

===Installing ARK===

Ark is installed by unpacking the source code into the document root of the webserver where you intend to host it. The second phase of installation is then the initial setup and creation of the empty database.

====Download source====

Download the latest source code from http://ark.lparchaeology.com/downloads and unpack it into the document root of your server. If you are unsure of the correct location of the document root, you could try reading the manual of your apache distribution.

====Install a database====

In order for ark to work, you need to install an ARK database on your MySQL server. Preconfigured sample databases are available for download from the download area of the ARK site. At present you must install the sql dump on the server manually using your tool of choice. We think that [http://www.phpmyadmin.net/home_page/index.php phpMyAdmin] is a good way to do this.

#Download your chosen database dump file
#Point your browser at the phpMyAdmin installation on your web-server
#Make an empty database, by going to the Databases screen and filling in the Create new database box. Make the Collation utf8_unicode_ci and that should deal with most character sets.
#Once the database is created, switch to it and choose Import
#Using the Browse button, point it at the file that you have downloaded (it should be a tar.gz) - make the character set utf8
#Click Go and wait a little while, and the database structure should be loaded up fine.
#You will need to set up a user and give it at least SELECT, INSERT, UPDATE and DELETE privileges to the new db.

===Update the DB Settings===

You will now need to update the server-specific DB settings in [[env_settings.php]] and [[settings.php]]. '''THE DATABASE WILL NOT WORK UNTIL THESE SETTINGS HAVE BEEN UPDATED'''.

===Setup Windows server for ARK===

This will take you through setting up a windows server from scratch to work for ARK.

====Download and install====
*MS4W, newest release: http://www.maptools.org/ms4w/
** Download with installer
** Install without ad-on packages
** Install in C:\
** Install in port 80 unless it is already in use then use port 8080
** Go to http://127.0.0.1 or http://localhost to check that it is running.
** You can also go to Control Panel > Administrative Tools > Services and check that the Apache MS4W Web Server is started.

* MySQL
** Download MySQL community server: http://dev.mysql.com/downloads/
** Install a typical installation
** Configuration:
*** Server Machine
*** Transactional Database Only
*** Installation path C:
*** Online Transaction Processing
*** Enable TCP?IP Networking on port nr. 3306
*** Enable Strict Mode
*** Best Support for Multilingualism
*** Install as Windows Service
*** Include Bin Directory in Windows PATH
*** Set root password
** You can also go to Control Panel > Administrative Tools > Services and check that the MySQL is started.

* PEAR
** Firstly make sure that there is a path to the folder containing php.exe in the environmental variables: Control Panel > System > Advanced > Environmental Variables > System Variables: Click Edit for the 'path' variable and add ; and the full path to the folder after the last path (in this case C:\ms4w\Apache\cgi-bin
** Restart the server after this.
** Now go to the command line and find the folder containing go-pear.bat (should be C:\ms4w\Apache\php) and type in go-pear.bat
** This will run the pear installation and if you can get this to work then congratulations. I give up here and move the old pear files over from another project.

===Browse to ARK directory===

After browsing to the ARK directory you should now be able to see the login pages for the database. The tutorial database is created with the following admin user account:

<pre>
username: doe_jd
password: janedoe

</pre>

If there are any problems, please check your [[settings.php]] and [[env_settings.php]] files to ensure you are using the correct settings.

[[category:Administrator]]

Page settings.php

2012-03-21T16:52:49Z

Jessogden:

As of v1.0, all settings related to individual page displays, navigation, and toolbars are to be included in the [[page_settings.php]].
==Navigation==
===Navigation Pages===
As of v1.1 $conf_hide_pages has been replaced with $conf_pages. All pages listed in this array will appear in the main nav. Overlay holder, download, feed, and transclude object are required pages with their visibility setting set to FALSE so they do not appear in the navigation. As of v1.1, each page also requires its own settings array, as detailed under each page heading below.
<pre>
$conf_pages =
array(
'user_home',
'data_entry',
'micro_view',
'data_view',
'user_admin',
'alias_admin',
'markup_admin',
'import',
'resultsmicro_view',
'index',
'overlay_holder',
'download',
'feed',
'transclude_object'
);
</pre>

===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>
==User Home==
These settings control the subforms and left panel in the user home. The user home needs configuration both for the left panel and for the subforms included in the main area.
===User Home Page Settings===
As of v1.1 an individual page setting array is required for each page directing the ARK to the code directory and navigation settings for that particular page.
<pre>
// PAGE SETTINGS
$conf_page_user_home =
array(
'name' => 'User Home',
'title' => 'User Home Page',
'file' => 'user_home.php',
'sgrp' => '1',
'navname' => 'homenav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/user_home/',
'is_visible' => TRUE
);
</pre>
===User Home Left Panel===
Configures the left panel in the user home pages, requires the administrator to configure the lpanel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $uhlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'user_home' in the [[sf_module]].
====Subforms Option Example====
Define the configuration type:
<pre>
$uhlpoutput = 'subforms';
</pre>
Configure the subform:
<pre>
$uhlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'user_home',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$user_home_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$uhlp_subform_module
)
);
</pre>

== Data Entry ==
These settings configure the data entry page. The data entry requires configuration for both the left panel and the record navigation bar appearing at the top of the main area. Further options for advanced file upload are also included below.
===Data Entry Page Settings===
<pre>
// PAGE SETTINGS
$conf_page_data_entry =
array(
'name' =>'Data Entry',
'title' => 'Data Entry Page',
'file' => 'data_entry.php',
'sgrp' => '1',
'navname' => 'dataentrynav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/data_entry/',
'is_visible' => TRUE
);
</pre>
=== Data Entry Left Panel ===
This section gives examples for the left panel configuration in the data entry pages using either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation.
==== Minimiser Option ====
This tool condenses subforms and offers quick navigation in left panel. To use the minimiser on specific data entry pages you need to go to the mod_settings files (ex. mod_cxt_settings.php) and make sure that 'col_type' => 'collaps_col', instead of single_col in the $conf_dat_materi and $conf_dat_detfrm settings.
<pre>
$minimiser = TRUE;
</pre>

====Link list Option Example====

Define the configuration type:
<pre>
$delpoutput = 'linklist';
</pre>
Configure the links:
<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=files",
'mknname' => 'uplfile'
);
</pre>

====Subforms Option Example====

Define the configuration type:
<pre>
$delpoutput = 'subforms';
</pre>

Configure the linklist (in this case, a linklist is being used to display the upload files link and the sf_linklist is calling the link):
<pre>
$link_list_admin[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=files",
'mknname' => 'uplfile',
'img' => 'bigplus.png'
);
</pre>

Configure the subforms - Subform listing the modules:
<pre>
$delp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpmodlist',
'sf_html_id' => 'delpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'data_entry',
'fields' => array (
'cxt',
'smp',
'spf',
'sph',
)
);
</pre>
Admin Subform calling the file upload linklist from above:
<pre>
$delp_subform_admin =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpadmin',
'sf_html_id' => 'delpadmin', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_label' => 'space',
'op_input' => 'save',
'op_linktype' => 'icon',
'op_sf_cssclass' => 'module_list',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'fields' => $link_list_admin
);
</pre>
Load the subforms:
<pre>
$data_entry_left_panel =
array(
'col_id' => 'delp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$delp_subform_module,
$delp_subform_admin
)
);
</pre>

=== Data Entry Toolbar ===
Configure the tools for data entry. First form the individual buttons and displays:
==== User Navigation ====
<pre>
// Previous record button
$group_entry_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays site code
$group_entry_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays record number
$group_entry_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays module type
$group_entry_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record button
$group_entry_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Administrator tools ====
<pre>
// Delete record
$group_entry_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit module type
$group_entry_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chngmod',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_entry_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'DEL',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_entry_nav =
array(
'record_nav' => $group_entry_nav,
'record_admin' => $group_entry_admin,
);
</pre>

===Advanced File Upload===
The following includes instructions on how to configure the advanced file uploader which was developed as a mechanism for not only batch uploading files, but also registering and/or linking them to existing records on the fly.
*'''on''' - Set to TRUE, advanced file uploader dialog is displayed.
*'''pattern''' - This is a regex (Regular expression) designed to detect the file names and associate the files with the appropriate records (item_keys). These example expressions are set up to treat the first 3 letters of a file name as the relevant site code and the numbers following as the number. (For example: 'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-zA-Z0-9]*))\.[a-zA-Z]{2,4}\b/i" handles files xxx-1234.jpg, xxx-1234-yyy.jpg, where xxx can be any letter and yyy any alphanumeric combination, only number before first '-' is used as an ID)
<pre>
$fu =
array(
'on' => TRUE,
'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-z0-9A-Z]*))\.[a-z0-9]{2,4}\b/i",
);
</pre>

==Data View (Search)==
These settings configure the data view (or search) page. The data view requires configuration for the left panel, the search tools options (results views, download options, etc) as well as some general settings for search results.
===General Page Settings===
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>

And the number of pages to display on the data viewer:
<pre>
// Number of pages to display on the data viewer
$conf_num_res_pgs = 5; // best choose an odd number
</pre>

Also configure the index pages for Data View and Search pages:
<pre>
// 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 (options include: text, table, or map):
<pre>
// Default $output_mode for the data viewer
$default_output_mode = 'table';
</pre>
===Data View Page Settings===
<pre>
// PAGE SETTINGS
$conf_page_data_view =
array(
'name' =>'Search',
'title' => 'Search Page',
'file' => 'data_view.php',
'sgrp' => '1',
'navname' => 'searchnav',
'navlinkvars' => '?view=standard',
'cur_code_dir' => 'php/data_view/',
'is_visible' => TRUE
);
</pre>
===Data View Left Panel===
This configures the left panel for the data view pages through a series of complex subforms including [[sf_linklist]], [[sf_buildfilter]], and [[sf_mysavedstuff]].
====Configure the linklist====
First configure the linklist, which requires the following:
*'''href''' - link to the output ({$_SERVER['PHP_SELF']} is on same page, and then links to the key ID in the relevant cor table of the designated data filter
*'''mknname''' - mark-up nickname will search the markup table for this nickname and print the markup
*'''img''' - optional image for the icon defined in the subform linklist:
<pre>
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=1&ftr_id=new",
'mknname' => 'filtercxt',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=6&ftr_id=new",
'mknname' => 'filtersmp',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=stecd&ftr_id=new",
'mknname' => 'filterstecd',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=action&ftr_id=new",
'mknname' => 'filteractor',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=ftx&ftr_id=new",
'mknname' => 'ftx',
'img' => 'view_mag.png'
);
</pre>

Configure the linklist subform:
<pre>
$dvlp_subform_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_linktype' => 'icon',
'op_sf_cssclass' => 'ftr_list',
'fields' => $link_list_filters
);
</pre>

====Filter Builders====
Various options exist for the types of filters administrators will want to make available to users- including different stages of pre-built or partially executed filters. For more information on this subform and options see [[sf_buildfilter]].
 
Subform for the filter builder to run in the left panel:
<pre>
$dvlp_filter_builder =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_condition' =>
array(
array(
'func'=> 'chkTmpFtr',
'args'=> FALSE
),
),
);
</pre>
Subform for the filter builder to run in the left panel preloaded with a filter:
<pre>
$dvlp_filter_builder_atridx =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_filter' => 'atr', // the filter to be used
'op_filter_args' =>
array(
// 'arg' => 'var', // example
'atrtype' => 1,
'op_display' => 'dd'
)
);

</pre>
Subform for user saved filters
<pre>
$dvlp_my_saved_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'savedfilters',
'sf_html_id' => 'dvlp_saved_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_mysavedstuff.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'op_sf_cssclass' => 'ftr_subform',
);
</pre>
Make a column to hold the subforms:
<pre>
$data_view_left_panel =
array(
'col_id' => 'dvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$dvlp_filter_builder,
$dvlp_filter_builder_atridx,
$dvlp_subform_filters,
$dvlp_my_saved_filters
)
);
</pre>

===Results Toolbar===
Configure the tools and display options for the search page (data_view). All of the toolbars require the following in the array:
*'''type''' - Options of 'img', 'text', or 'newpage' (used in the all record view to display function in a new page)
*'''href''' - The href link to the function being called
*'''css_class''' - The css class to style the button or display
*'''mkname''' - The name of markup contained within cor_tbl_markup used for buttons which combine text and images, are just text based. Set to FALSE if not used.
*'''lightbox''' - Option of using the lightbox when calling an overlay form, set to FALSE otherwise

First form the individual buttons:

==== Tools ====
<pre>
// TOOLS
$group_tools[] =
array(
'type' => 'img',
'href' => "overlay_holder.php?sf_conf=conf_mac_userconfigfields&lboxreload=1",
'css_class' => 'gears',
'mkname' => FALSE,
'lightbox' => 'lightbox'
);
</pre>

==== Displays ====
<pre>
// DISPs
$res = "results_mode=disp";
// Text view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=text",
'css_class' => 'text',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Table view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=table",
'css_class' => 'table',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Map view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=map",
'css_class' => 'map',
'mkname' => FALSE,
'lightbox' => FALSE
);
// All record view
$group_disp[] =
array(
'type' => 'newpage',
'href' => "resultsmicro_view.php?",
'css_class' => 'printall',
'mkname' => FALSE,
'lightbox' => FALSE
);
</pre>

==== Feeds ====
<pre>
// FEEDS
$res = "results_mode=feed";
// RSS feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=rss",
'css_class' => FALSE,
'mkname' => 'rss',
'lightbox' => FALSE
);
// Atom feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=atom",
'css_class' => FALSE,
'mkname' => 'atom',
'lightbox' => FALSE
);
</pre>

==== Downloads ====
<pre>
// DOWNLOADS
$res = "results_mode=dl";
// CSV download
$group_dls[] =
array(
'type' => 'text',
'href' => "overlay_holder.php?$res&dl_mode=csv&lboxreload=1&sf_conf=conf_mac_exportdownloadcsv",
'css_class' => FALSE,
'mkname' => 'csv',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_results_nav =
array(
'tools' => $group_tools,
'result_views' => $group_disp,
'result_feeds' => $group_feeds,
'result_downloads' => $group_dls,
);
</pre>

==Micro View (Record View)==
These settings configure the micro view (or record view) page. The micro view requires configuration for the left panel, and record nav options as well as some general settings.
===General Page Settings===
Configure the index page for the micro view:
<pre>
// Default Micro viewer page (used by search result handlers)
$conf_micro_viewer = $ark_dir."micro_view.php";
</pre>
===Micro View Page Settings===
<pre>
// PAGE SETTINGS
$conf_page_micro_view =
array(
'name' =>'Record View',
'title' => 'Record View Page',
'file' => 'micro_view.php',
'sgrp' => '1',
'navname' => 'recordviewnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/micro_view/',
'is_visible' => TRUE
);
</pre>
===Micro View Left Panel===
Configures the left panel in the micro view pages, requires the administrator to configure the left panel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $mvlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'micro_view' in the [[sf_module]].

====Subforms Option Example====
Define the configuration type:
<pre>
$mvlpoutput = 'subforms';
</pre>
Configure the subform module to include the relevant modules:
<pre>
$mvlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'micro_view',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$micro_view_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$mvlp_subform_module
)
);
</pre>
===Record Toolbar===
Configure the tools for the record view toolbar. This tool bar controls what navigation and options which appear in data entry record toolbar.

==== Record Navigation ====
First form the individual buttons and displays:
<pre>
// Previous record
$group_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays current site code
$group_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays current record number
$group_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays current modtype
$group_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record
$group_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Refresh View ====
<pre>
// Refresh button
$group_refresh[] =
array(
'name' => 'refresh',
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?disp_reset=default",
'css_class' => 'refresh',
'mkname' => 'reset',
'lightbox' => FALSE
);
</pre>

==== Administrator Tools ====
<pre>
// ADMIN TOOLS
// Delete record
$group_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit modtype
$group_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgtype',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgkey',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_record_nav =
array(
'record_nav' => $group_nav,
'record_refresh' => $group_refresh,
'record_admin' => $group_admin,
);
</pre>

==Map View==
This is optional, but needs to be configured correctly if you are using the mapping capabilities of ARK. It needs to be set up like other top level pages, but also a series of settings need to be configured.

===Map View Page Settings===
The page needs to be set up like all other standard top-level pages. If not using, or if you would like it to be inaccessible in the dynamic navigation set 'is_visible' to FALSE.

<pre>
// MAP VIEW PAGE SETTINGS
$conf_page_map_view =
array(
'name' =>'Map View',
'title' => 'Map View Page',
'file' => 'map_view.php',
'sgrp' => '1',
'navname' => 'mapviewnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/map_view/',
'is_visible' => TRUE
);
</pre>

===Map View Left Panel===
The first subform is to allow saving of maps from the left panel, and the second to allow downloads of maps as PDFs.
<pre>
// LEFT PANEL
// Subforms
$conf_map_wmcoverlay =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'nmedit',
'sf_title' => 'wmcoverlay',
'sf_html_id' => 'map_wmcoverlay', // Must be unique
'script' => 'php/map_admin/subforms/sf_savewmc_overlay.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);

$conf_maptopdf =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'full',
'sf_title' => 'interp',
'sf_html_id' => 'map_maptopdf', // Must be unique
'script' => 'php/map_view/subforms/sf_maptopdf.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);
</pre>
===Map View Main===
These are a series of settings that define the query layers and query maps displayed in the map view as well as the results map view.
====Map Timeout====
Mapping timeout in milliseconds- if you are using a slow WxS server set this to be high (default is 1500).
<pre>
$map_timeout = 5000;
</pre>
====WXS Query Layers====
$wxs_qlayers: mapping layers for mods - specify in this array the names of the wms/wfs layers that contain the spatial data for each mod. Bear in mind that these layers should contain an ark_id column that can be retrieved using a getFeatureInfo request.
Each layer is a separate entry in the array containing an array of variables:

*'''mod''' - the mod of the item (without _cd) eg. 'cxt'
*'''geom''' - the geometry of the layer - eg. 'pt', 'pl' or 'pgn'
*'''url''' - the full url of the WMS/WFS server that is hosting the layer
*'''title_field''' - this is the field_id of the field that you want to be displayed during the click to query, if this is set to 'GIS' then it will return the attributes in the remote GIS attribute table.
<pre>
$wxs_qlayers =
array(
'sites' => array(
'mod' => 'cxt',
'geom' => 'pt',
'url' => 'http://localhost/ark/php/map/ark_wxs_server.php?',
'title_field' => 'conf_field_name',
'style_array' =>
array(
'fillOpacity' => 0.75,
'strokeColor' => '"black"',
'fillColor' => '"red"',
'pointRadius' => 10,
)
),
);
</pre>

====WXS Query Map====
$wxs_query_map - this is the name of a saved map (saved using the map_admin tools), that you want to be the background for the 'View Results as Map'. Admins should note: the $wxs_qlayers array is used to determine which layers can be used to display the spatial data for each mod - therefore those layers HAVE to be available in the saved $wxs_query_map. Also, the more info button - if you store information about your GIS layers as ARK items then set this to TRUE. Please note you will need to have a 'gis' module and you will need to name your WMS-served GIS layers in the format for instance,'contexts_PCO06_123'
<pre>
$wxs_query_map = 'QueryMap';

$map_more_info_button = FALSE;
</pre>

==Other Pages==
These settings configure the the page settings array for all other pages. These can include pages that do not have any other associated configuration needed, or other commonly hidden pages that are included with the trunk code (index.php, overlay_holder.php).
<pre>
// ADMIN PAGES
// USER ADMIN PAGE SETTINGS
$conf_page_user_admin =
array(
'name' =>'User Admin',
'title' => 'User Admin Page',
'file' => 'user_admin.php',
'sgrp' => '2',
'navname' => 'usersnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/user_admin/',
'is_visible' => TRUE
);

// ALIAS ADMIN PAGE SETTINGS
$conf_page_alias_admin =
array(
'name' =>'Alias Admin',
'title' => 'Alias Admin Page',
'file' => 'alias_admin.php',
'sgrp' => '2',
'navname' => 'aliasnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/alias_admin/',
'is_visible' => TRUE
);

// MARKUP ADMIN PAGE SETTINGS
$conf_page_markup_admin =
array(
'name' => 'Markup Admin',
'title' => 'Markup Admin Page',
'file' => 'markup_admin.php',
'sgrp' => '2',
'navname' => 'markupnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/markup_admin/',
'is_visible' => TRUE
);

// MAP ADMIN PAGE SETTINGS
$conf_page_map_admin =
array(
'name' => 'Map Admin',
'title' => 'Map Admin Page',
'file' => 'map_admin.php',
'sgrp' => '2',
'navname' => 'mapadminnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/map_admin/',
'is_visible' => TRUE
);

// HIDDEN PAGES
// FEED PAGE SETTINGS
$conf_page_feed =
array(
'name' => 'Feed',
'title' => 'Feed Page',
'file' => 'feed.php',
'sgrp' => '1',
'navname' => 'feednav',
'navlinkvars' => '?view=home',
'cur_code_dir' => FALSE,
'is_visible' => FALSE
);

// DOWNLOAD PAGE SETTINGS
$conf_page_download =
array(
'name' => 'Download',
'title' => 'Download Page',
'file' => 'download.php',
'sgrp' => '1',
'navname' => 'downloadnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => FALSE,
'is_visible' => FALSE
);

// TRANSCLUDE PAGE SETTINGS
$conf_page_transclude_object =
array(
'name' => 'Transclude',
'title' => 'Transclude Page',
'file' => 'transclude_object.php',
'sgrp' => '1',
'navname' => 'transcludenav',
'navlinkvars' => '?view=home',
'cur_code_dir' => FALSE,
'is_visible' => FALSE
);

// IMPORT PAGE SETTINGS
$conf_page_import =
array(
'name' => 'Import',
'title' => 'Import',
'file' => 'import.php',
'sgrp' => '1',
'navname' => 'importnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => FALSE,
'is_visible' => FALSE
);

// RESULTS MICRO PAGE SETTINGS
$conf_page_resultsmicro_view =
array(
'name' => 'All Records',
'title' => 'All Records',
'file' => 'resultsmicro_view.php',
'sgrp' => '1',
'navname' => 'allrecordsnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => FALSE,
'is_visible' => FALSE
);

// INDEX PAGE SETTINGS
$conf_page_index =
array(
'name' => 'Index',
'title' => 'Index',
'file' => 'index.php',
'sgrp' => '1',
'navname' => 'index',
'navlinkvars' => '?view=home',
'cur_code_dir' => FALSE,
'is_visible' => FALSE
);

// OVERLAY HOLDER PAGE SETTINGS
$conf_page_overlay_holder =
array(
'name' => 'Overlay',
'title' => 'Overlay',
'file' => 'overlay_holder.php',
'sgrp' => '1',
'navname' => 'overlayholder',
'navlinkvars' => '?view=home',
'cur_code_dir' => FALSE,
'is_visible' => FALSE
);
</pre>

Page settings.php

2012-03-21T16:47:29Z

Jessogden:

As of v1.0, all settings related to individual page displays, navigation, and toolbars are to be included in the [[page_settings.php]].
==Navigation==
===Navigation Pages===
As of v1.1 $conf_hide_pages has been replaced with $conf_pages. All pages listed in this array will appear in the main nav. Overlay holder, download, feed, and transclude object are required pages with their visibility setting set to FALSE so they do not appear in the navigation.
<pre>
$conf_pages =
array(
'user_home',
'data_entry',
'micro_view',
'data_view',
'user_admin',
'alias_admin',
'markup_admin',
'import',
'resultsmicro_view',
'index',
'overlay_holder',
'download',
'feed',
'transclude_object'
);
</pre>

===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>
==User Home==
These settings control the subforms and left panel in the user home. The user home needs configuration both for the left panel and for the subforms included in the main area.
===User Home Page Settings===
As of v1.1 an individual page setting array is required for each page directing the ARK to the code directory and navigation settings for that particular page.
<pre>
// PAGE SETTINGS
$conf_page_user_home =
array(
'name' => 'User Home',
'title' => 'User Home Page',
'file' => 'user_home.php',
'sgrp' => '1',
'navname' => 'homenav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/user_home/',
'is_visible' => TRUE
);
</pre>
===User Home Left Panel===
Configures the left panel in the user home pages, requires the administrator to configure the lpanel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $uhlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'user_home' in the [[sf_module]].
====Subforms Option Example====
Define the configuration type:
<pre>
$uhlpoutput = 'subforms';
</pre>
Configure the subform:
<pre>
$uhlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'user_home',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$user_home_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$uhlp_subform_module
)
);
</pre>

== Data Entry ==
These settings configure the data entry page. The data entry requires configuration for both the left panel and the record navigation bar appearing at the top of the main area. Further options for advanced file upload are also included below.
===Data Entry Page Settings===
<pre>
// PAGE SETTINGS
$conf_page_data_entry =
array(
'name' =>'Data Entry',
'title' => 'Data Entry Page',
'file' => 'data_entry.php',
'sgrp' => '1',
'navname' => 'dataentrynav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/data_entry/',
'is_visible' => TRUE
);
</pre>
=== Data Entry Left Panel ===
This section gives examples for the left panel configuration in the data entry pages using either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation.
==== Minimiser Option ====
This tool condenses subforms and offers quick navigation in left panel. To use the minimiser on specific data entry pages you need to go to the mod_settings files (ex. mod_cxt_settings.php) and make sure that 'col_type' => 'collaps_col', instead of single_col in the $conf_dat_materi and $conf_dat_detfrm settings.
<pre>
$minimiser = TRUE;
</pre>

====Link list Option Example====

Define the configuration type:
<pre>
$delpoutput = 'linklist';
</pre>
Configure the links:
<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=files",
'mknname' => 'uplfile'
);
</pre>

====Subforms Option Example====

Define the configuration type:
<pre>
$delpoutput = 'subforms';
</pre>

Configure the linklist (in this case, a linklist is being used to display the upload files link and the sf_linklist is calling the link):
<pre>
$link_list_admin[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=files",
'mknname' => 'uplfile',
'img' => 'bigplus.png'
);
</pre>

Configure the subforms - Subform listing the modules:
<pre>
$delp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpmodlist',
'sf_html_id' => 'delpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'data_entry',
'fields' => array (
'cxt',
'smp',
'spf',
'sph',
)
);
</pre>
Admin Subform calling the file upload linklist from above:
<pre>
$delp_subform_admin =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpadmin',
'sf_html_id' => 'delpadmin', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_label' => 'space',
'op_input' => 'save',
'op_linktype' => 'icon',
'op_sf_cssclass' => 'module_list',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'fields' => $link_list_admin
);
</pre>
Load the subforms:
<pre>
$data_entry_left_panel =
array(
'col_id' => 'delp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$delp_subform_module,
$delp_subform_admin
)
);
</pre>

=== Data Entry Toolbar ===
Configure the tools for data entry. First form the individual buttons and displays:
==== User Navigation ====
<pre>
// Previous record button
$group_entry_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays site code
$group_entry_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays record number
$group_entry_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays module type
$group_entry_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record button
$group_entry_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Administrator tools ====
<pre>
// Delete record
$group_entry_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit module type
$group_entry_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chngmod',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_entry_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'DEL',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_entry_nav =
array(
'record_nav' => $group_entry_nav,
'record_admin' => $group_entry_admin,
);
</pre>

===Advanced File Upload===
The following includes instructions on how to configure the advanced file uploader which was developed as a mechanism for not only batch uploading files, but also registering and/or linking them to existing records on the fly.
*'''on''' - Set to TRUE, advanced file uploader dialog is displayed.
*'''pattern''' - This is a regex (Regular expression) designed to detect the file names and associate the files with the appropriate records (item_keys). These example expressions are set up to treat the first 3 letters of a file name as the relevant site code and the numbers following as the number. (For example: 'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-zA-Z0-9]*))\.[a-zA-Z]{2,4}\b/i" handles files xxx-1234.jpg, xxx-1234-yyy.jpg, where xxx can be any letter and yyy any alphanumeric combination, only number before first '-' is used as an ID)
<pre>
$fu =
array(
'on' => TRUE,
'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-z0-9A-Z]*))\.[a-z0-9]{2,4}\b/i",
);
</pre>

==Data View (Search)==
These settings configure the data view (or search) page. The data view requires configuration for the left panel, the search tools options (results views, download options, etc) as well as some general settings for search results.
===General Page Settings===
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>

And the number of pages to display on the data viewer:
<pre>
// Number of pages to display on the data viewer
$conf_num_res_pgs = 5; // best choose an odd number
</pre>

Also configure the index pages for Data View and Search pages:
<pre>
// 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 (options include: text, table, or map):
<pre>
// Default $output_mode for the data viewer
$default_output_mode = 'table';
</pre>
===Data View Page Settings===
<pre>
// PAGE SETTINGS
$conf_page_data_view =
array(
'name' =>'Search',
'title' => 'Search Page',
'file' => 'data_view.php',
'sgrp' => '1',
'navname' => 'searchnav',
'navlinkvars' => '?view=standard',
'cur_code_dir' => 'php/data_view/',
'is_visible' => TRUE
);
</pre>
===Data View Left Panel===
This configures the left panel for the data view pages through a series of complex subforms including [[sf_linklist]], [[sf_buildfilter]], and [[sf_mysavedstuff]].
====Configure the linklist====
First configure the linklist, which requires the following:
*'''href''' - link to the output ({$_SERVER['PHP_SELF']} is on same page, and then links to the key ID in the relevant cor table of the designated data filter
*'''mknname''' - mark-up nickname will search the markup table for this nickname and print the markup
*'''img''' - optional image for the icon defined in the subform linklist:
<pre>
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=1&ftr_id=new",
'mknname' => 'filtercxt',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=6&ftr_id=new",
'mknname' => 'filtersmp',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=stecd&ftr_id=new",
'mknname' => 'filterstecd',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=action&ftr_id=new",
'mknname' => 'filteractor',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=ftx&ftr_id=new",
'mknname' => 'ftx',
'img' => 'view_mag.png'
);
</pre>

Configure the linklist subform:
<pre>
$dvlp_subform_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_linktype' => 'icon',
'op_sf_cssclass' => 'ftr_list',
'fields' => $link_list_filters
);
</pre>

====Filter Builders====
Various options exist for the types of filters administrators will want to make available to users- including different stages of pre-built or partially executed filters. For more information on this subform and options see [[sf_buildfilter]].
 
Subform for the filter builder to run in the left panel:
<pre>
$dvlp_filter_builder =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_condition' =>
array(
array(
'func'=> 'chkTmpFtr',
'args'=> FALSE
),
),
);
</pre>
Subform for the filter builder to run in the left panel preloaded with a filter:
<pre>
$dvlp_filter_builder_atridx =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_filter' => 'atr', // the filter to be used
'op_filter_args' =>
array(
// 'arg' => 'var', // example
'atrtype' => 1,
'op_display' => 'dd'
)
);

</pre>
Subform for user saved filters
<pre>
$dvlp_my_saved_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'savedfilters',
'sf_html_id' => 'dvlp_saved_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_mysavedstuff.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'op_sf_cssclass' => 'ftr_subform',
);
</pre>
Make a column to hold the subforms:
<pre>
$data_view_left_panel =
array(
'col_id' => 'dvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$dvlp_filter_builder,
$dvlp_filter_builder_atridx,
$dvlp_subform_filters,
$dvlp_my_saved_filters
)
);
</pre>

===Results Toolbar===
Configure the tools and display options for the search page (data_view). All of the toolbars require the following in the array:
*'''type''' - Options of 'img', 'text', or 'newpage' (used in the all record view to display function in a new page)
*'''href''' - The href link to the function being called
*'''css_class''' - The css class to style the button or display
*'''mkname''' - The name of markup contained within cor_tbl_markup used for buttons which combine text and images, are just text based. Set to FALSE if not used.
*'''lightbox''' - Option of using the lightbox when calling an overlay form, set to FALSE otherwise

First form the individual buttons:

==== Tools ====
<pre>
// TOOLS
$group_tools[] =
array(
'type' => 'img',
'href' => "overlay_holder.php?sf_conf=conf_mac_userconfigfields&lboxreload=1",
'css_class' => 'gears',
'mkname' => FALSE,
'lightbox' => 'lightbox'
);
</pre>

==== Displays ====
<pre>
// DISPs
$res = "results_mode=disp";
// Text view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=text",
'css_class' => 'text',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Table view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=table",
'css_class' => 'table',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Map view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=map",
'css_class' => 'map',
'mkname' => FALSE,
'lightbox' => FALSE
);
// All record view
$group_disp[] =
array(
'type' => 'newpage',
'href' => "resultsmicro_view.php?",
'css_class' => 'printall',
'mkname' => FALSE,
'lightbox' => FALSE
);
</pre>

==== Feeds ====
<pre>
// FEEDS
$res = "results_mode=feed";
// RSS feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=rss",
'css_class' => FALSE,
'mkname' => 'rss',
'lightbox' => FALSE
);
// Atom feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=atom",
'css_class' => FALSE,
'mkname' => 'atom',
'lightbox' => FALSE
);
</pre>

==== Downloads ====
<pre>
// DOWNLOADS
$res = "results_mode=dl";
// CSV download
$group_dls[] =
array(
'type' => 'text',
'href' => "overlay_holder.php?$res&dl_mode=csv&lboxreload=1&sf_conf=conf_mac_exportdownloadcsv",
'css_class' => FALSE,
'mkname' => 'csv',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_results_nav =
array(
'tools' => $group_tools,
'result_views' => $group_disp,
'result_feeds' => $group_feeds,
'result_downloads' => $group_dls,
);
</pre>

==Micro View (Record View)==
These settings configure the micro view (or record view) page. The micro view requires configuration for the left panel, and record nav options as well as some general settings.
===General Page Settings===
Configure the index page for the micro view:
<pre>
// Default Micro viewer page (used by search result handlers)
$conf_micro_viewer = $ark_dir."micro_view.php";
</pre>
===Micro View Page Settings===
<pre>
// PAGE SETTINGS
$conf_page_micro_view =
array(
'name' =>'Record View',
'title' => 'Record View Page',
'file' => 'micro_view.php',
'sgrp' => '1',
'navname' => 'recordviewnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/micro_view/',
'is_visible' => TRUE
);
</pre>
===Micro View Left Panel===
Configures the left panel in the micro view pages, requires the administrator to configure the left panel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $mvlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'micro_view' in the [[sf_module]].

====Subforms Option Example====
Define the configuration type:
<pre>
$mvlpoutput = 'subforms';
</pre>
Configure the subform module to include the relevant modules:
<pre>
$mvlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'micro_view',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$micro_view_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$mvlp_subform_module
)
);
</pre>
===Record Toolbar===
Configure the tools for the record view toolbar. This tool bar controls what navigation and options which appear in data entry record toolbar.

==== Record Navigation ====
First form the individual buttons and displays:
<pre>
// Previous record
$group_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays current site code
$group_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays current record number
$group_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays current modtype
$group_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record
$group_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Refresh View ====
<pre>
// Refresh button
$group_refresh[] =
array(
'name' => 'refresh',
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?disp_reset=default",
'css_class' => 'refresh',
'mkname' => 'reset',
'lightbox' => FALSE
);
</pre>

==== Administrator Tools ====
<pre>
// ADMIN TOOLS
// Delete record
$group_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit modtype
$group_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgtype',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgkey',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_record_nav =
array(
'record_nav' => $group_nav,
'record_refresh' => $group_refresh,
'record_admin' => $group_admin,
);
</pre>

==Map View==
This is optional, but needs to be configured correctly if you are using the mapping capabilities of ARK. It needs to be set up like other top level pages, but also a series of settings need to be configured.

===Map View Page Settings===
The page needs to be set up like all other standard top-level pages. If not using, or if you would like it to be inaccessible in the dynamic navigation set 'is_visible' to FALSE.

<pre>
// MAP VIEW PAGE SETTINGS
$conf_page_map_view =
array(
'name' =>'Map View',
'title' => 'Map View Page',
'file' => 'map_view.php',
'sgrp' => '1',
'navname' => 'mapviewnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/map_view/',
'is_visible' => TRUE
);
</pre>

===Map View Left Panel===
The first subform is to allow saving of maps from the left panel, and the second to allow downloads of maps as PDFs.
<pre>
// LEFT PANEL
// Subforms
$conf_map_wmcoverlay =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'nmedit',
'sf_title' => 'wmcoverlay',
'sf_html_id' => 'map_wmcoverlay', // Must be unique
'script' => 'php/map_admin/subforms/sf_savewmc_overlay.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);

$conf_maptopdf =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'full',
'sf_title' => 'interp',
'sf_html_id' => 'map_maptopdf', // Must be unique
'script' => 'php/map_view/subforms/sf_maptopdf.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);
</pre>
===Map View Main===
These are a series of settings that define the query layers and query maps displayed in the map view as well as the results map view.
====Map Timeout====
Mapping timeout in milliseconds- if you are using a slow WxS server set this to be high (default is 1500).
<pre>
$map_timeout = 5000;
</pre>
====WXS Query Layers====
$wxs_qlayers: mapping layers for mods - specify in this array the names of the wms/wfs layers that contain the spatial data for each mod. Bear in mind that these layers should contain an ark_id column that can be retrieved using a getFeatureInfo request.
Each layer is a separate entry in the array containing an array of variables:

*'''mod''' - the mod of the item (without _cd) eg. 'cxt'
*'''geom''' - the geometry of the layer - eg. 'pt', 'pl' or 'pgn'
*'''url''' - the full url of the WMS/WFS server that is hosting the layer
*'''title_field''' - this is the field_id of the field that you want to be displayed during the click to query, if this is set to 'GIS' then it will return the attributes in the remote GIS attribute table.
<pre>
$wxs_qlayers =
array(
'sites' => array(
'mod' => 'cxt',
'geom' => 'pt',
'url' => 'http://localhost/ark/php/map/ark_wxs_server.php?',
'title_field' => 'conf_field_name',
'style_array' =>
array(
'fillOpacity' => 0.75,
'strokeColor' => '"black"',
'fillColor' => '"red"',
'pointRadius' => 10,
)
),
);
</pre>

====WXS Query Map====
$wxs_query_map - this is the name of a saved map (saved using the map_admin tools), that you want to be the background for the 'View Results as Map'. Admins should note: the $wxs_qlayers array is used to determine which layers can be used to display the spatial data for each mod - therefore those layers HAVE to be available in the saved $wxs_query_map. Also, the more info button - if you store information about your GIS layers as ARK items then set this to TRUE. Please note you will need to have a 'gis' module and you will need to name your WMS-served GIS layers in the format for instance,'contexts_PCO06_123'
<pre>
$wxs_query_map = 'QueryMap';

$map_more_info_button = FALSE;
</pre>

==Other Pages==
These settings configure the the page settings array for all other pages. These can include pages that do not have any other associated configuration needed, or other commonly hidden pages that are included with the trunk code (index.php, overlay_holder.php).
<pre>
// ADMIN PAGES
// USER ADMIN PAGE SETTINGS
$conf_page_user_admin =
array(
'name' =>'User Admin',
'title' => 'User Admin Page',
'file' => 'user_admin.php',
'sgrp' => '2',
'navname' => 'usersnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/user_admin/',
'is_visible' => TRUE
);

// ALIAS ADMIN PAGE SETTINGS
$conf_page_alias_admin =
array(
'name' =>'Alias Admin',
'title' => 'Alias Admin Page',
'file' => 'alias_admin.php',
'sgrp' => '2',
'navname' => 'aliasnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/alias_admin/',
'is_visible' => TRUE
);

// MARKUP ADMIN PAGE SETTINGS
$conf_page_markup_admin =
array(
'name' => 'Markup Admin',
'title' => 'Markup Admin Page',
'file' => 'markup_admin.php',
'sgrp' => '2',
'navname' => 'markupnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/markup_admin/',
'is_visible' => TRUE
);

// MAP ADMIN PAGE SETTINGS
$conf_page_map_admin =
array(
'name' => 'Map Admin',
'title' => 'Map Admin Page',
'file' => 'map_admin.php',
'sgrp' => '2',
'navname' => 'mapadminnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/map_admin/',
'is_visible' => TRUE
);

// HIDDEN PAGES
// FEED PAGE SETTINGS
$conf_page_feed =
array(
'name' => 'Feed',
'title' => 'Feed Page',
'file' => 'feed.php',
'sgrp' => '1',
'navname' => 'feednav',
'navlinkvars' => '?view=home',
'cur_code_dir' => FALSE,
'is_visible' => FALSE
);

// DOWNLOAD PAGE SETTINGS
$conf_page_download =
array(
'name' => 'Download',
'title' => 'Download Page',
'file' => 'download.php',
'sgrp' => '1',
'navname' => 'downloadnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => FALSE,
'is_visible' => FALSE
);

// TRANSCLUDE PAGE SETTINGS
$conf_page_transclude_object =
array(
'name' => 'Transclude',
'title' => 'Transclude Page',
'file' => 'transclude_object.php',
'sgrp' => '1',
'navname' => 'transcludenav',
'navlinkvars' => '?view=home',
'cur_code_dir' => FALSE,
'is_visible' => FALSE
);

// IMPORT PAGE SETTINGS
$conf_page_import =
array(
'name' => 'Import',
'title' => 'Import',
'file' => 'import.php',
'sgrp' => '1',
'navname' => 'importnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => FALSE,
'is_visible' => FALSE
);

// RESULTS MICRO PAGE SETTINGS
$conf_page_resultsmicro_view =
array(
'name' => 'All Records',
'title' => 'All Records',
'file' => 'resultsmicro_view.php',
'sgrp' => '1',
'navname' => 'allrecordsnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => FALSE,
'is_visible' => FALSE
);

// INDEX PAGE SETTINGS
$conf_page_index =
array(
'name' => 'Index',
'title' => 'Index',
'file' => 'index.php',
'sgrp' => '1',
'navname' => 'index',
'navlinkvars' => '?view=home',
'cur_code_dir' => FALSE,
'is_visible' => FALSE
);

// OVERLAY HOLDER PAGE SETTINGS
$conf_page_overlay_holder =
array(
'name' => 'Overlay',
'title' => 'Overlay',
'file' => 'overlay_holder.php',
'sgrp' => '1',
'navname' => 'overlayholder',
'navlinkvars' => '?view=home',
'cur_code_dir' => FALSE,
'is_visible' => FALSE
);
</pre>

Page settings.php

2012-03-21T16:45:05Z

Jessogden: /* WXS Query Map */

As of v1.0, all settings related to individual page displays, navigation, and toolbars are to be included in the [[page_settings.php]].
==Navigation==
===Navigation Pages===
As of v1.1 $conf_hide_pages has been replaced with $conf_pages. All pages listed in this array will appear in the main nav. Overlay holder, download, feed, and transclude object are required pages with their visibility setting set to FALSE so they do not appear in the navigation.
<pre>
$conf_pages =
array(
'user_home',
'data_entry',
'micro_view',
'data_view',
'user_admin',
'alias_admin',
'markup_admin',
'import',
'resultsmicro_view',
'index',
'overlay_holder',
'download',
'feed',
'transclude_object'
);
</pre>

===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>
==User Home==
These settings control the subforms and left panel in the user home. The user home needs configuration both for the left panel and for the subforms included in the main area.
===User Home Page Settings===
As of v1.1 an individual page setting array is required for each page directing the ARK to the code directory and navigation settings for that particular page.
<pre>
// PAGE SETTINGS
$conf_page_user_home =
array(
'name' => 'User Home',
'title' => 'User Home Page',
'file' => 'user_home.php',
'sgrp' => '1',
'navname' => 'homenav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/user_home/',
'is_visible' => TRUE
);
</pre>
===User Home Left Panel===
Configures the left panel in the user home pages, requires the administrator to configure the lpanel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $uhlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'user_home' in the [[sf_module]].
====Subforms Option Example====
Define the configuration type:
<pre>
$uhlpoutput = 'subforms';
</pre>
Configure the subform:
<pre>
$uhlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'user_home',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$user_home_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$uhlp_subform_module
)
);
</pre>

== Data Entry ==
These settings configure the data entry page. The data entry requires configuration for both the left panel and the record navigation bar appearing at the top of the main area. Further options for advanced file upload are also included below.
===Data Entry Page Settings===
<pre>
// PAGE SETTINGS
$conf_page_data_entry =
array(
'name' =>'Data Entry',
'title' => 'Data Entry Page',
'file' => 'data_entry.php',
'sgrp' => '1',
'navname' => 'dataentrynav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/data_entry/',
'is_visible' => TRUE
);
</pre>
=== Data Entry Left Panel ===
This section gives examples for the left panel configuration in the data entry pages using either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation.
==== Minimiser Option ====
This tool condenses subforms and offers quick navigation in left panel. To use the minimiser on specific data entry pages you need to go to the mod_settings files (ex. mod_cxt_settings.php) and make sure that 'col_type' => 'collaps_col', instead of single_col in the $conf_dat_materi and $conf_dat_detfrm settings.
<pre>
$minimiser = TRUE;
</pre>

====Link list Option Example====

Define the configuration type:
<pre>
$delpoutput = 'linklist';
</pre>
Configure the links:
<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=files",
'mknname' => 'uplfile'
);
</pre>

====Subforms Option Example====

Define the configuration type:
<pre>
$delpoutput = 'subforms';
</pre>

Configure the linklist (in this case, a linklist is being used to display the upload files link and the sf_linklist is calling the link):
<pre>
$link_list_admin[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=files",
'mknname' => 'uplfile',
'img' => 'bigplus.png'
);
</pre>

Configure the subforms - Subform listing the modules:
<pre>
$delp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpmodlist',
'sf_html_id' => 'delpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'data_entry',
'fields' => array (
'cxt',
'smp',
'spf',
'sph',
)
);
</pre>
Admin Subform calling the file upload linklist from above:
<pre>
$delp_subform_admin =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpadmin',
'sf_html_id' => 'delpadmin', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_label' => 'space',
'op_input' => 'save',
'op_linktype' => 'icon',
'op_sf_cssclass' => 'module_list',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'fields' => $link_list_admin
);
</pre>
Load the subforms:
<pre>
$data_entry_left_panel =
array(
'col_id' => 'delp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$delp_subform_module,
$delp_subform_admin
)
);
</pre>

=== Data Entry Toolbar ===
Configure the tools for data entry. First form the individual buttons and displays:
==== User Navigation ====
<pre>
// Previous record button
$group_entry_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays site code
$group_entry_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays record number
$group_entry_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays module type
$group_entry_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record button
$group_entry_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Administrator tools ====
<pre>
// Delete record
$group_entry_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit module type
$group_entry_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chngmod',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_entry_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'DEL',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_entry_nav =
array(
'record_nav' => $group_entry_nav,
'record_admin' => $group_entry_admin,
);
</pre>

===Advanced File Upload===
The following includes instructions on how to configure the advanced file uploader which was developed as a mechanism for not only batch uploading files, but also registering and/or linking them to existing records on the fly.
*'''on''' - Set to TRUE, advanced file uploader dialog is displayed.
*'''pattern''' - This is a regex (Regular expression) designed to detect the file names and associate the files with the appropriate records (item_keys). These example expressions are set up to treat the first 3 letters of a file name as the relevant site code and the numbers following as the number. (For example: 'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-zA-Z0-9]*))\.[a-zA-Z]{2,4}\b/i" handles files xxx-1234.jpg, xxx-1234-yyy.jpg, where xxx can be any letter and yyy any alphanumeric combination, only number before first '-' is used as an ID)
<pre>
$fu =
array(
'on' => TRUE,
'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-z0-9A-Z]*))\.[a-z0-9]{2,4}\b/i",
);
</pre>

==Data View (Search)==
These settings configure the data view (or search) page. The data view requires configuration for the left panel, the search tools options (results views, download options, etc) as well as some general settings for search results.
===General Page Settings===
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>

And the number of pages to display on the data viewer:
<pre>
// Number of pages to display on the data viewer
$conf_num_res_pgs = 5; // best choose an odd number
</pre>

Also configure the index pages for Data View and Search pages:
<pre>
// 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 (options include: text, table, or map):
<pre>
// Default $output_mode for the data viewer
$default_output_mode = 'table';
</pre>
===Data View Page Settings===
<pre>
// PAGE SETTINGS
$conf_page_data_view =
array(
'name' =>'Search',
'title' => 'Search Page',
'file' => 'data_view.php',
'sgrp' => '1',
'navname' => 'searchnav',
'navlinkvars' => '?view=standard',
'cur_code_dir' => 'php/data_view/',
'is_visible' => TRUE
);
</pre>
===Data View Left Panel===
This configures the left panel for the data view pages through a series of complex subforms including [[sf_linklist]], [[sf_buildfilter]], and [[sf_mysavedstuff]].
====Configure the linklist====
First configure the linklist, which requires the following:
*'''href''' - link to the output ({$_SERVER['PHP_SELF']} is on same page, and then links to the key ID in the relevant cor table of the designated data filter
*'''mknname''' - mark-up nickname will search the markup table for this nickname and print the markup
*'''img''' - optional image for the icon defined in the subform linklist:
<pre>
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=1&ftr_id=new",
'mknname' => 'filtercxt',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=6&ftr_id=new",
'mknname' => 'filtersmp',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=stecd&ftr_id=new",
'mknname' => 'filterstecd',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=action&ftr_id=new",
'mknname' => 'filteractor',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=ftx&ftr_id=new",
'mknname' => 'ftx',
'img' => 'view_mag.png'
);
</pre>

Configure the linklist subform:
<pre>
$dvlp_subform_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_linktype' => 'icon',
'op_sf_cssclass' => 'ftr_list',
'fields' => $link_list_filters
);
</pre>

====Filter Builders====
Various options exist for the types of filters administrators will want to make available to users- including different stages of pre-built or partially executed filters. For more information on this subform and options see [[sf_buildfilter]].
 
Subform for the filter builder to run in the left panel:
<pre>
$dvlp_filter_builder =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_condition' =>
array(
array(
'func'=> 'chkTmpFtr',
'args'=> FALSE
),
),
);
</pre>
Subform for the filter builder to run in the left panel preloaded with a filter:
<pre>
$dvlp_filter_builder_atridx =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_filter' => 'atr', // the filter to be used
'op_filter_args' =>
array(
// 'arg' => 'var', // example
'atrtype' => 1,
'op_display' => 'dd'
)
);

</pre>
Subform for user saved filters
<pre>
$dvlp_my_saved_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'savedfilters',
'sf_html_id' => 'dvlp_saved_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_mysavedstuff.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'op_sf_cssclass' => 'ftr_subform',
);
</pre>
Make a column to hold the subforms:
<pre>
$data_view_left_panel =
array(
'col_id' => 'dvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$dvlp_filter_builder,
$dvlp_filter_builder_atridx,
$dvlp_subform_filters,
$dvlp_my_saved_filters
)
);
</pre>

===Results Toolbar===
Configure the tools and display options for the search page (data_view). All of the toolbars require the following in the array:
*'''type''' - Options of 'img', 'text', or 'newpage' (used in the all record view to display function in a new page)
*'''href''' - The href link to the function being called
*'''css_class''' - The css class to style the button or display
*'''mkname''' - The name of markup contained within cor_tbl_markup used for buttons which combine text and images, are just text based. Set to FALSE if not used.
*'''lightbox''' - Option of using the lightbox when calling an overlay form, set to FALSE otherwise

First form the individual buttons:

==== Tools ====
<pre>
// TOOLS
$group_tools[] =
array(
'type' => 'img',
'href' => "overlay_holder.php?sf_conf=conf_mac_userconfigfields&lboxreload=1",
'css_class' => 'gears',
'mkname' => FALSE,
'lightbox' => 'lightbox'
);
</pre>

==== Displays ====
<pre>
// DISPs
$res = "results_mode=disp";
// Text view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=text",
'css_class' => 'text',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Table view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=table",
'css_class' => 'table',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Map view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=map",
'css_class' => 'map',
'mkname' => FALSE,
'lightbox' => FALSE
);
// All record view
$group_disp[] =
array(
'type' => 'newpage',
'href' => "resultsmicro_view.php?",
'css_class' => 'printall',
'mkname' => FALSE,
'lightbox' => FALSE
);
</pre>

==== Feeds ====
<pre>
// FEEDS
$res = "results_mode=feed";
// RSS feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=rss",
'css_class' => FALSE,
'mkname' => 'rss',
'lightbox' => FALSE
);
// Atom feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=atom",
'css_class' => FALSE,
'mkname' => 'atom',
'lightbox' => FALSE
);
</pre>

==== Downloads ====
<pre>
// DOWNLOADS
$res = "results_mode=dl";
// CSV download
$group_dls[] =
array(
'type' => 'text',
'href' => "overlay_holder.php?$res&dl_mode=csv&lboxreload=1&sf_conf=conf_mac_exportdownloadcsv",
'css_class' => FALSE,
'mkname' => 'csv',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_results_nav =
array(
'tools' => $group_tools,
'result_views' => $group_disp,
'result_feeds' => $group_feeds,
'result_downloads' => $group_dls,
);
</pre>

==Micro View (Record View)==
These settings configure the micro view (or record view) page. The micro view requires configuration for the left panel, and record nav options as well as some general settings.
===General Page Settings===
Configure the index page for the micro view:
<pre>
// Default Micro viewer page (used by search result handlers)
$conf_micro_viewer = $ark_dir."micro_view.php";
</pre>
===Micro View Page Settings===
<pre>
// PAGE SETTINGS
$conf_page_micro_view =
array(
'name' =>'Record View',
'title' => 'Record View Page',
'file' => 'micro_view.php',
'sgrp' => '1',
'navname' => 'recordviewnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/micro_view/',
'is_visible' => TRUE
);
</pre>
===Micro View Left Panel===
Configures the left panel in the micro view pages, requires the administrator to configure the left panel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $mvlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'micro_view' in the [[sf_module]].

====Subforms Option Example====
Define the configuration type:
<pre>
$mvlpoutput = 'subforms';
</pre>
Configure the subform module to include the relevant modules:
<pre>
$mvlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'micro_view',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$micro_view_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$mvlp_subform_module
)
);
</pre>
===Record Toolbar===
Configure the tools for the record view toolbar. This tool bar controls what navigation and options which appear in data entry record toolbar.

==== Record Navigation ====
First form the individual buttons and displays:
<pre>
// Previous record
$group_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays current site code
$group_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays current record number
$group_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays current modtype
$group_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record
$group_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Refresh View ====
<pre>
// Refresh button
$group_refresh[] =
array(
'name' => 'refresh',
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?disp_reset=default",
'css_class' => 'refresh',
'mkname' => 'reset',
'lightbox' => FALSE
);
</pre>

==== Administrator Tools ====
<pre>
// ADMIN TOOLS
// Delete record
$group_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit modtype
$group_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgtype',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgkey',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_record_nav =
array(
'record_nav' => $group_nav,
'record_refresh' => $group_refresh,
'record_admin' => $group_admin,
);
</pre>

==Map View==
This is optional, but needs to be configured correctly if you are using the mapping capabilities of ARK. It needs to be set up like other top level pages, but also a series of settings need to be configured.

===Map View Page Settings===
The page needs to be set up like all other standard top-level pages. If not using, or if you would like it to be inaccessible in the dynamic navigation set 'is_visible' to FALSE.

<pre>
// MAP VIEW PAGE SETTINGS
$conf_page_map_view =
array(
'name' =>'Map View',
'title' => 'Map View Page',
'file' => 'map_view.php',
'sgrp' => '1',
'navname' => 'mapviewnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/map_view/',
'is_visible' => TRUE
);
</pre>

===Map View Left Panel===
The first subform is to allow saving of maps from the left panel, and the second to allow downloads of maps as PDFs.
<pre>
// LEFT PANEL
// Subforms
$conf_map_wmcoverlay =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'nmedit',
'sf_title' => 'wmcoverlay',
'sf_html_id' => 'map_wmcoverlay', // Must be unique
'script' => 'php/map_admin/subforms/sf_savewmc_overlay.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);

$conf_maptopdf =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'full',
'sf_title' => 'interp',
'sf_html_id' => 'map_maptopdf', // Must be unique
'script' => 'php/map_view/subforms/sf_maptopdf.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);
</pre>
===Map View Main===
These are a series of settings that define the query layers and query maps displayed in the map view as well as the results map view.
====Map Timeout====
Mapping timeout in milliseconds- if you are using a slow WxS server set this to be high (default is 1500).
<pre>
$map_timeout = 5000;
</pre>
====WXS Query Layers====
$wxs_qlayers: mapping layers for mods - specify in this array the names of the wms/wfs layers that contain the spatial data for each mod. Bear in mind that these layers should contain an ark_id column that can be retrieved using a getFeatureInfo request.
Each layer is a separate entry in the array containing an array of variables:

*'''mod''' - the mod of the item (without _cd) eg. 'cxt'
*'''geom''' - the geometry of the layer - eg. 'pt', 'pl' or 'pgn'
*'''url''' - the full url of the WMS/WFS server that is hosting the layer
*'''title_field''' - this is the field_id of the field that you want to be displayed during the click to query, if this is set to 'GIS' then it will return the attributes in the remote GIS attribute table.
<pre>
$wxs_qlayers =
array(
'sites' => array(
'mod' => 'cxt',
'geom' => 'pt',
'url' => 'http://localhost/ark/php/map/ark_wxs_server.php?',
'title_field' => 'conf_field_name',
'style_array' =>
array(
'fillOpacity' => 0.75,
'strokeColor' => '"black"',
'fillColor' => '"red"',
'pointRadius' => 10,
)
),
);
</pre>

====WXS Query Map====
$wxs_query_map - this is the name of a saved map (saved using the map_admin tools), that you want to be the background for the 'View Results as Map'. Admins should note: the $wxs_qlayers array is used to determine which layers can be used to display the spatial data for each mod - therefore those layers HAVE to be available in the saved $wxs_query_map. Also, the more info button - if you store information about your GIS layers as ARK items then set this to TRUE. Please note you will need to have a 'gis' module and you will need to name your WMS-served GIS layers in the format for instance,'contexts_PCO06_123'
<pre>
$wxs_query_map = 'QueryMap';

$map_more_info_button = FALSE;
</pre>

Page settings.php

2012-03-21T16:43:31Z

Jessogden: /* Micro View (Record View) */

As of v1.0, all settings related to individual page displays, navigation, and toolbars are to be included in the [[page_settings.php]].
==Navigation==
===Navigation Pages===
As of v1.1 $conf_hide_pages has been replaced with $conf_pages. All pages listed in this array will appear in the main nav. Overlay holder, download, feed, and transclude object are required pages with their visibility setting set to FALSE so they do not appear in the navigation.
<pre>
$conf_pages =
array(
'user_home',
'data_entry',
'micro_view',
'data_view',
'user_admin',
'alias_admin',
'markup_admin',
'import',
'resultsmicro_view',
'index',
'overlay_holder',
'download',
'feed',
'transclude_object'
);
</pre>

===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>
==User Home==
These settings control the subforms and left panel in the user home. The user home needs configuration both for the left panel and for the subforms included in the main area.
===User Home Page Settings===
As of v1.1 an individual page setting array is required for each page directing the ARK to the code directory and navigation settings for that particular page.
<pre>
// PAGE SETTINGS
$conf_page_user_home =
array(
'name' => 'User Home',
'title' => 'User Home Page',
'file' => 'user_home.php',
'sgrp' => '1',
'navname' => 'homenav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/user_home/',
'is_visible' => TRUE
);
</pre>
===User Home Left Panel===
Configures the left panel in the user home pages, requires the administrator to configure the lpanel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $uhlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'user_home' in the [[sf_module]].
====Subforms Option Example====
Define the configuration type:
<pre>
$uhlpoutput = 'subforms';
</pre>
Configure the subform:
<pre>
$uhlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'user_home',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$user_home_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$uhlp_subform_module
)
);
</pre>

== Data Entry ==
These settings configure the data entry page. The data entry requires configuration for both the left panel and the record navigation bar appearing at the top of the main area. Further options for advanced file upload are also included below.
===Data Entry Page Settings===
<pre>
// PAGE SETTINGS
$conf_page_data_entry =
array(
'name' =>'Data Entry',
'title' => 'Data Entry Page',
'file' => 'data_entry.php',
'sgrp' => '1',
'navname' => 'dataentrynav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/data_entry/',
'is_visible' => TRUE
);
</pre>
=== Data Entry Left Panel ===
This section gives examples for the left panel configuration in the data entry pages using either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation.
==== Minimiser Option ====
This tool condenses subforms and offers quick navigation in left panel. To use the minimiser on specific data entry pages you need to go to the mod_settings files (ex. mod_cxt_settings.php) and make sure that 'col_type' => 'collaps_col', instead of single_col in the $conf_dat_materi and $conf_dat_detfrm settings.
<pre>
$minimiser = TRUE;
</pre>

====Link list Option Example====

Define the configuration type:
<pre>
$delpoutput = 'linklist';
</pre>
Configure the links:
<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=files",
'mknname' => 'uplfile'
);
</pre>

====Subforms Option Example====

Define the configuration type:
<pre>
$delpoutput = 'subforms';
</pre>

Configure the linklist (in this case, a linklist is being used to display the upload files link and the sf_linklist is calling the link):
<pre>
$link_list_admin[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=files",
'mknname' => 'uplfile',
'img' => 'bigplus.png'
);
</pre>

Configure the subforms - Subform listing the modules:
<pre>
$delp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpmodlist',
'sf_html_id' => 'delpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'data_entry',
'fields' => array (
'cxt',
'smp',
'spf',
'sph',
)
);
</pre>
Admin Subform calling the file upload linklist from above:
<pre>
$delp_subform_admin =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpadmin',
'sf_html_id' => 'delpadmin', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_label' => 'space',
'op_input' => 'save',
'op_linktype' => 'icon',
'op_sf_cssclass' => 'module_list',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'fields' => $link_list_admin
);
</pre>
Load the subforms:
<pre>
$data_entry_left_panel =
array(
'col_id' => 'delp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$delp_subform_module,
$delp_subform_admin
)
);
</pre>

=== Data Entry Toolbar ===
Configure the tools for data entry. First form the individual buttons and displays:
==== User Navigation ====
<pre>
// Previous record button
$group_entry_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays site code
$group_entry_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays record number
$group_entry_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays module type
$group_entry_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record button
$group_entry_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Administrator tools ====
<pre>
// Delete record
$group_entry_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit module type
$group_entry_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chngmod',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_entry_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'DEL',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_entry_nav =
array(
'record_nav' => $group_entry_nav,
'record_admin' => $group_entry_admin,
);
</pre>

===Advanced File Upload===
The following includes instructions on how to configure the advanced file uploader which was developed as a mechanism for not only batch uploading files, but also registering and/or linking them to existing records on the fly.
*'''on''' - Set to TRUE, advanced file uploader dialog is displayed.
*'''pattern''' - This is a regex (Regular expression) designed to detect the file names and associate the files with the appropriate records (item_keys). These example expressions are set up to treat the first 3 letters of a file name as the relevant site code and the numbers following as the number. (For example: 'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-zA-Z0-9]*))\.[a-zA-Z]{2,4}\b/i" handles files xxx-1234.jpg, xxx-1234-yyy.jpg, where xxx can be any letter and yyy any alphanumeric combination, only number before first '-' is used as an ID)
<pre>
$fu =
array(
'on' => TRUE,
'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-z0-9A-Z]*))\.[a-z0-9]{2,4}\b/i",
);
</pre>

==Data View (Search)==
These settings configure the data view (or search) page. The data view requires configuration for the left panel, the search tools options (results views, download options, etc) as well as some general settings for search results.
===General Page Settings===
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>

And the number of pages to display on the data viewer:
<pre>
// Number of pages to display on the data viewer
$conf_num_res_pgs = 5; // best choose an odd number
</pre>

Also configure the index pages for Data View and Search pages:
<pre>
// 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 (options include: text, table, or map):
<pre>
// Default $output_mode for the data viewer
$default_output_mode = 'table';
</pre>
===Data View Page Settings===
<pre>
// PAGE SETTINGS
$conf_page_data_view =
array(
'name' =>'Search',
'title' => 'Search Page',
'file' => 'data_view.php',
'sgrp' => '1',
'navname' => 'searchnav',
'navlinkvars' => '?view=standard',
'cur_code_dir' => 'php/data_view/',
'is_visible' => TRUE
);
</pre>
===Data View Left Panel===
This configures the left panel for the data view pages through a series of complex subforms including [[sf_linklist]], [[sf_buildfilter]], and [[sf_mysavedstuff]].
====Configure the linklist====
First configure the linklist, which requires the following:
*'''href''' - link to the output ({$_SERVER['PHP_SELF']} is on same page, and then links to the key ID in the relevant cor table of the designated data filter
*'''mknname''' - mark-up nickname will search the markup table for this nickname and print the markup
*'''img''' - optional image for the icon defined in the subform linklist:
<pre>
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=1&ftr_id=new",
'mknname' => 'filtercxt',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=6&ftr_id=new",
'mknname' => 'filtersmp',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=stecd&ftr_id=new",
'mknname' => 'filterstecd',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=action&ftr_id=new",
'mknname' => 'filteractor',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=ftx&ftr_id=new",
'mknname' => 'ftx',
'img' => 'view_mag.png'
);
</pre>

Configure the linklist subform:
<pre>
$dvlp_subform_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_linktype' => 'icon',
'op_sf_cssclass' => 'ftr_list',
'fields' => $link_list_filters
);
</pre>

====Filter Builders====
Various options exist for the types of filters administrators will want to make available to users- including different stages of pre-built or partially executed filters. For more information on this subform and options see [[sf_buildfilter]].
 
Subform for the filter builder to run in the left panel:
<pre>
$dvlp_filter_builder =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_condition' =>
array(
array(
'func'=> 'chkTmpFtr',
'args'=> FALSE
),
),
);
</pre>
Subform for the filter builder to run in the left panel preloaded with a filter:
<pre>
$dvlp_filter_builder_atridx =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_filter' => 'atr', // the filter to be used
'op_filter_args' =>
array(
// 'arg' => 'var', // example
'atrtype' => 1,
'op_display' => 'dd'
)
);

</pre>
Subform for user saved filters
<pre>
$dvlp_my_saved_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'savedfilters',
'sf_html_id' => 'dvlp_saved_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_mysavedstuff.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'op_sf_cssclass' => 'ftr_subform',
);
</pre>
Make a column to hold the subforms:
<pre>
$data_view_left_panel =
array(
'col_id' => 'dvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$dvlp_filter_builder,
$dvlp_filter_builder_atridx,
$dvlp_subform_filters,
$dvlp_my_saved_filters
)
);
</pre>

===Results Toolbar===
Configure the tools and display options for the search page (data_view). All of the toolbars require the following in the array:
*'''type''' - Options of 'img', 'text', or 'newpage' (used in the all record view to display function in a new page)
*'''href''' - The href link to the function being called
*'''css_class''' - The css class to style the button or display
*'''mkname''' - The name of markup contained within cor_tbl_markup used for buttons which combine text and images, are just text based. Set to FALSE if not used.
*'''lightbox''' - Option of using the lightbox when calling an overlay form, set to FALSE otherwise

First form the individual buttons:

==== Tools ====
<pre>
// TOOLS
$group_tools[] =
array(
'type' => 'img',
'href' => "overlay_holder.php?sf_conf=conf_mac_userconfigfields&lboxreload=1",
'css_class' => 'gears',
'mkname' => FALSE,
'lightbox' => 'lightbox'
);
</pre>

==== Displays ====
<pre>
// DISPs
$res = "results_mode=disp";
// Text view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=text",
'css_class' => 'text',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Table view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=table",
'css_class' => 'table',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Map view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=map",
'css_class' => 'map',
'mkname' => FALSE,
'lightbox' => FALSE
);
// All record view
$group_disp[] =
array(
'type' => 'newpage',
'href' => "resultsmicro_view.php?",
'css_class' => 'printall',
'mkname' => FALSE,
'lightbox' => FALSE
);
</pre>

==== Feeds ====
<pre>
// FEEDS
$res = "results_mode=feed";
// RSS feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=rss",
'css_class' => FALSE,
'mkname' => 'rss',
'lightbox' => FALSE
);
// Atom feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=atom",
'css_class' => FALSE,
'mkname' => 'atom',
'lightbox' => FALSE
);
</pre>

==== Downloads ====
<pre>
// DOWNLOADS
$res = "results_mode=dl";
// CSV download
$group_dls[] =
array(
'type' => 'text',
'href' => "overlay_holder.php?$res&dl_mode=csv&lboxreload=1&sf_conf=conf_mac_exportdownloadcsv",
'css_class' => FALSE,
'mkname' => 'csv',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_results_nav =
array(
'tools' => $group_tools,
'result_views' => $group_disp,
'result_feeds' => $group_feeds,
'result_downloads' => $group_dls,
);
</pre>

==Micro View (Record View)==
These settings configure the micro view (or record view) page. The micro view requires configuration for the left panel, and record nav options as well as some general settings.
===General Page Settings===
Configure the index page for the micro view:
<pre>
// Default Micro viewer page (used by search result handlers)
$conf_micro_viewer = $ark_dir."micro_view.php";
</pre>
===Micro View Page Settings===
<pre>
// PAGE SETTINGS
$conf_page_micro_view =
array(
'name' =>'Record View',
'title' => 'Record View Page',
'file' => 'micro_view.php',
'sgrp' => '1',
'navname' => 'recordviewnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/micro_view/',
'is_visible' => TRUE
);
</pre>
===Micro View Left Panel===
Configures the left panel in the micro view pages, requires the administrator to configure the left panel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $mvlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'micro_view' in the [[sf_module]].

====Subforms Option Example====
Define the configuration type:
<pre>
$mvlpoutput = 'subforms';
</pre>
Configure the subform module to include the relevant modules:
<pre>
$mvlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'micro_view',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$micro_view_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$mvlp_subform_module
)
);
</pre>
===Record Toolbar===
Configure the tools for the record view toolbar. This tool bar controls what navigation and options which appear in data entry record toolbar.

==== Record Navigation ====
First form the individual buttons and displays:
<pre>
// Previous record
$group_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays current site code
$group_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays current record number
$group_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays current modtype
$group_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record
$group_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Refresh View ====
<pre>
// Refresh button
$group_refresh[] =
array(
'name' => 'refresh',
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?disp_reset=default",
'css_class' => 'refresh',
'mkname' => 'reset',
'lightbox' => FALSE
);
</pre>

==== Administrator Tools ====
<pre>
// ADMIN TOOLS
// Delete record
$group_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit modtype
$group_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgtype',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgkey',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_record_nav =
array(
'record_nav' => $group_nav,
'record_refresh' => $group_refresh,
'record_admin' => $group_admin,
);
</pre>

==Map View==
This is optional, but needs to be configured correctly if you are using the mapping capabilities of ARK. It needs to be set up like other top level pages, but also a series of settings need to be configured.

===Map View Page Settings===
The page needs to be set up like all other standard top-level pages. If not using, or if you would like it to be inaccessible in the dynamic navigation set 'is_visible' to FALSE.

<pre>
// MAP VIEW PAGE SETTINGS
$conf_page_map_view =
array(
'name' =>'Map View',
'title' => 'Map View Page',
'file' => 'map_view.php',
'sgrp' => '1',
'navname' => 'mapviewnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/map_view/',
'is_visible' => TRUE
);
</pre>

===Map View Left Panel===
The first subform is to allow saving of maps from the left panel, and the second to allow downloads of maps as PDFs.
<pre>
// LEFT PANEL
// Subforms
$conf_map_wmcoverlay =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'nmedit',
'sf_title' => 'wmcoverlay',
'sf_html_id' => 'map_wmcoverlay', // Must be unique
'script' => 'php/map_admin/subforms/sf_savewmc_overlay.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);

$conf_maptopdf =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'full',
'sf_title' => 'interp',
'sf_html_id' => 'map_maptopdf', // Must be unique
'script' => 'php/map_view/subforms/sf_maptopdf.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);
</pre>
===Map View Main===
These are a series of settings that define the query layers and query maps displayed in the map view as well as the results map view.
====Map Timeout====
Mapping timeout in milliseconds- if you are using a slow WxS server set this to be high (default is 1500).
<pre>
$map_timeout = 5000;
</pre>
====WXS Query Layers====
$wxs_qlayers: mapping layers for mods - specify in this array the names of the wms/wfs layers that contain the spatial data for each mod. Bear in mind that these layers should contain an ark_id column that can be retrieved using a getFeatureInfo request.
Each layer is a separate entry in the array containing an array of variables:

*'''mod''' - the mod of the item (without _cd) eg. 'cxt'
*'''geom''' - the geometry of the layer - eg. 'pt', 'pl' or 'pgn'
*'''url''' - the full url of the WMS/WFS server that is hosting the layer
*'''title_field''' - this is the field_id of the field that you want to be displayed during the click to query, if this is set to 'GIS' then it will return the attributes in the remote GIS attribute table.
<pre>
$wxs_qlayers =
array(
'sites' => array(
'mod' => 'cxt',
'geom' => 'pt',
'url' => 'http://localhost/ark/php/map/ark_wxs_server.php?',
'title_field' => 'conf_field_name',
'style_array' =>
array(
'fillOpacity' => 0.75,
'strokeColor' => '"black"',
'fillColor' => '"red"',
'pointRadius' => 10,
)
),
);
</pre>

===WXS Query Map===
$wxs_query_map - this is the name of a saved map (saved using the map_admin tools), that you want to be the background for the 'View Results as Map'. Admins should note: the $wxs_qlayers array is used to determine which layers can be used to display the spatial data for each mod - therefore those layers HAVE to be available in the saved $wxs_query_map. Also, the more info button - if you store information about your GIS layers as ARK items then set this to TRUE. Please note you will need to have a 'gis' module and you will need to name your WMS-served GIS layers in the format for instance,'contexts_PCO06_123'
<pre>
$wxs_query_map = 'QueryMap';

$map_more_info_button = FALSE;
</pre>

Page settings.php

2012-03-21T16:42:28Z

Jessogden: /* Data View (Search) */

As of v1.0, all settings related to individual page displays, navigation, and toolbars are to be included in the [[page_settings.php]].
==Navigation==
===Navigation Pages===
As of v1.1 $conf_hide_pages has been replaced with $conf_pages. All pages listed in this array will appear in the main nav. Overlay holder, download, feed, and transclude object are required pages with their visibility setting set to FALSE so they do not appear in the navigation.
<pre>
$conf_pages =
array(
'user_home',
'data_entry',
'micro_view',
'data_view',
'user_admin',
'alias_admin',
'markup_admin',
'import',
'resultsmicro_view',
'index',
'overlay_holder',
'download',
'feed',
'transclude_object'
);
</pre>

===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>
==User Home==
These settings control the subforms and left panel in the user home. The user home needs configuration both for the left panel and for the subforms included in the main area.
===User Home Page Settings===
As of v1.1 an individual page setting array is required for each page directing the ARK to the code directory and navigation settings for that particular page.
<pre>
// PAGE SETTINGS
$conf_page_user_home =
array(
'name' => 'User Home',
'title' => 'User Home Page',
'file' => 'user_home.php',
'sgrp' => '1',
'navname' => 'homenav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/user_home/',
'is_visible' => TRUE
);
</pre>
===User Home Left Panel===
Configures the left panel in the user home pages, requires the administrator to configure the lpanel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $uhlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'user_home' in the [[sf_module]].
====Subforms Option Example====
Define the configuration type:
<pre>
$uhlpoutput = 'subforms';
</pre>
Configure the subform:
<pre>
$uhlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'user_home',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$user_home_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$uhlp_subform_module
)
);
</pre>

== Data Entry ==
These settings configure the data entry page. The data entry requires configuration for both the left panel and the record navigation bar appearing at the top of the main area. Further options for advanced file upload are also included below.
===Data Entry Page Settings===
<pre>
// PAGE SETTINGS
$conf_page_data_entry =
array(
'name' =>'Data Entry',
'title' => 'Data Entry Page',
'file' => 'data_entry.php',
'sgrp' => '1',
'navname' => 'dataentrynav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/data_entry/',
'is_visible' => TRUE
);
</pre>
=== Data Entry Left Panel ===
This section gives examples for the left panel configuration in the data entry pages using either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation.
==== Minimiser Option ====
This tool condenses subforms and offers quick navigation in left panel. To use the minimiser on specific data entry pages you need to go to the mod_settings files (ex. mod_cxt_settings.php) and make sure that 'col_type' => 'collaps_col', instead of single_col in the $conf_dat_materi and $conf_dat_detfrm settings.
<pre>
$minimiser = TRUE;
</pre>

====Link list Option Example====

Define the configuration type:
<pre>
$delpoutput = 'linklist';
</pre>
Configure the links:
<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=files",
'mknname' => 'uplfile'
);
</pre>

====Subforms Option Example====

Define the configuration type:
<pre>
$delpoutput = 'subforms';
</pre>

Configure the linklist (in this case, a linklist is being used to display the upload files link and the sf_linklist is calling the link):
<pre>
$link_list_admin[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=files",
'mknname' => 'uplfile',
'img' => 'bigplus.png'
);
</pre>

Configure the subforms - Subform listing the modules:
<pre>
$delp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpmodlist',
'sf_html_id' => 'delpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'data_entry',
'fields' => array (
'cxt',
'smp',
'spf',
'sph',
)
);
</pre>
Admin Subform calling the file upload linklist from above:
<pre>
$delp_subform_admin =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpadmin',
'sf_html_id' => 'delpadmin', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_label' => 'space',
'op_input' => 'save',
'op_linktype' => 'icon',
'op_sf_cssclass' => 'module_list',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'fields' => $link_list_admin
);
</pre>
Load the subforms:
<pre>
$data_entry_left_panel =
array(
'col_id' => 'delp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$delp_subform_module,
$delp_subform_admin
)
);
</pre>

=== Data Entry Toolbar ===
Configure the tools for data entry. First form the individual buttons and displays:
==== User Navigation ====
<pre>
// Previous record button
$group_entry_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays site code
$group_entry_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays record number
$group_entry_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays module type
$group_entry_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record button
$group_entry_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Administrator tools ====
<pre>
// Delete record
$group_entry_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit module type
$group_entry_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chngmod',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_entry_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'DEL',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_entry_nav =
array(
'record_nav' => $group_entry_nav,
'record_admin' => $group_entry_admin,
);
</pre>

===Advanced File Upload===
The following includes instructions on how to configure the advanced file uploader which was developed as a mechanism for not only batch uploading files, but also registering and/or linking them to existing records on the fly.
*'''on''' - Set to TRUE, advanced file uploader dialog is displayed.
*'''pattern''' - This is a regex (Regular expression) designed to detect the file names and associate the files with the appropriate records (item_keys). These example expressions are set up to treat the first 3 letters of a file name as the relevant site code and the numbers following as the number. (For example: 'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-zA-Z0-9]*))\.[a-zA-Z]{2,4}\b/i" handles files xxx-1234.jpg, xxx-1234-yyy.jpg, where xxx can be any letter and yyy any alphanumeric combination, only number before first '-' is used as an ID)
<pre>
$fu =
array(
'on' => TRUE,
'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-z0-9A-Z]*))\.[a-z0-9]{2,4}\b/i",
);
</pre>

==Data View (Search)==
These settings configure the data view (or search) page. The data view requires configuration for the left panel, the search tools options (results views, download options, etc) as well as some general settings for search results.
===General Page Settings===
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>

And the number of pages to display on the data viewer:
<pre>
// Number of pages to display on the data viewer
$conf_num_res_pgs = 5; // best choose an odd number
</pre>

Also configure the index pages for Data View and Search pages:
<pre>
// 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 (options include: text, table, or map):
<pre>
// Default $output_mode for the data viewer
$default_output_mode = 'table';
</pre>
===Data View Page Settings===
<pre>
// PAGE SETTINGS
$conf_page_data_view =
array(
'name' =>'Search',
'title' => 'Search Page',
'file' => 'data_view.php',
'sgrp' => '1',
'navname' => 'searchnav',
'navlinkvars' => '?view=standard',
'cur_code_dir' => 'php/data_view/',
'is_visible' => TRUE
);
</pre>
===Data View Left Panel===
This configures the left panel for the data view pages through a series of complex subforms including [[sf_linklist]], [[sf_buildfilter]], and [[sf_mysavedstuff]].
====Configure the linklist====
First configure the linklist, which requires the following:
*'''href''' - link to the output ({$_SERVER['PHP_SELF']} is on same page, and then links to the key ID in the relevant cor table of the designated data filter
*'''mknname''' - mark-up nickname will search the markup table for this nickname and print the markup
*'''img''' - optional image for the icon defined in the subform linklist:
<pre>
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=1&ftr_id=new",
'mknname' => 'filtercxt',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=6&ftr_id=new",
'mknname' => 'filtersmp',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=stecd&ftr_id=new",
'mknname' => 'filterstecd',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=action&ftr_id=new",
'mknname' => 'filteractor',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=ftx&ftr_id=new",
'mknname' => 'ftx',
'img' => 'view_mag.png'
);
</pre>

Configure the linklist subform:
<pre>
$dvlp_subform_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_linktype' => 'icon',
'op_sf_cssclass' => 'ftr_list',
'fields' => $link_list_filters
);
</pre>

====Filter Builders====
Various options exist for the types of filters administrators will want to make available to users- including different stages of pre-built or partially executed filters. For more information on this subform and options see [[sf_buildfilter]].
 
Subform for the filter builder to run in the left panel:
<pre>
$dvlp_filter_builder =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_condition' =>
array(
array(
'func'=> 'chkTmpFtr',
'args'=> FALSE
),
),
);
</pre>
Subform for the filter builder to run in the left panel preloaded with a filter:
<pre>
$dvlp_filter_builder_atridx =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_filter' => 'atr', // the filter to be used
'op_filter_args' =>
array(
// 'arg' => 'var', // example
'atrtype' => 1,
'op_display' => 'dd'
)
);

</pre>
Subform for user saved filters
<pre>
$dvlp_my_saved_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'savedfilters',
'sf_html_id' => 'dvlp_saved_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_mysavedstuff.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'op_sf_cssclass' => 'ftr_subform',
);
</pre>
Make a column to hold the subforms:
<pre>
$data_view_left_panel =
array(
'col_id' => 'dvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$dvlp_filter_builder,
$dvlp_filter_builder_atridx,
$dvlp_subform_filters,
$dvlp_my_saved_filters
)
);
</pre>

===Results Toolbar===
Configure the tools and display options for the search page (data_view). All of the toolbars require the following in the array:
*'''type''' - Options of 'img', 'text', or 'newpage' (used in the all record view to display function in a new page)
*'''href''' - The href link to the function being called
*'''css_class''' - The css class to style the button or display
*'''mkname''' - The name of markup contained within cor_tbl_markup used for buttons which combine text and images, are just text based. Set to FALSE if not used.
*'''lightbox''' - Option of using the lightbox when calling an overlay form, set to FALSE otherwise

First form the individual buttons:

==== Tools ====
<pre>
// TOOLS
$group_tools[] =
array(
'type' => 'img',
'href' => "overlay_holder.php?sf_conf=conf_mac_userconfigfields&lboxreload=1",
'css_class' => 'gears',
'mkname' => FALSE,
'lightbox' => 'lightbox'
);
</pre>

==== Displays ====
<pre>
// DISPs
$res = "results_mode=disp";
// Text view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=text",
'css_class' => 'text',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Table view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=table",
'css_class' => 'table',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Map view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=map",
'css_class' => 'map',
'mkname' => FALSE,
'lightbox' => FALSE
);
// All record view
$group_disp[] =
array(
'type' => 'newpage',
'href' => "resultsmicro_view.php?",
'css_class' => 'printall',
'mkname' => FALSE,
'lightbox' => FALSE
);
</pre>

==== Feeds ====
<pre>
// FEEDS
$res = "results_mode=feed";
// RSS feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=rss",
'css_class' => FALSE,
'mkname' => 'rss',
'lightbox' => FALSE
);
// Atom feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=atom",
'css_class' => FALSE,
'mkname' => 'atom',
'lightbox' => FALSE
);
</pre>

==== Downloads ====
<pre>
// DOWNLOADS
$res = "results_mode=dl";
// CSV download
$group_dls[] =
array(
'type' => 'text',
'href' => "overlay_holder.php?$res&dl_mode=csv&lboxreload=1&sf_conf=conf_mac_exportdownloadcsv",
'css_class' => FALSE,
'mkname' => 'csv',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_results_nav =
array(
'tools' => $group_tools,
'result_views' => $group_disp,
'result_feeds' => $group_feeds,
'result_downloads' => $group_dls,
);
</pre>

==Micro View (Record View)==
These settings configure the micro view (or record view) page. The micro view requires configuration for the left panel, and record nav options as well as some general settings.
===General Page Settings===
Configure the index page for the micro view:
<pre>
// Default Micro viewer page (used by search result handlers)
$conf_micro_viewer = $ark_dir."micro_view.php";
</pre>

===Micro View Left Panel===
Configures the left panel in the micro view pages, requires the administrator to configure the left panel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $mvlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'micro_view' in the [[sf_module]].

====Subforms Option Example====
Define the configuration type:
<pre>
$mvlpoutput = 'subforms';
</pre>
Configure the subform module to include the relevant modules:
<pre>
$mvlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'micro_view',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$micro_view_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$mvlp_subform_module
)
);
</pre>
===Record Toolbar===
Configure the tools for the record view toolbar. This tool bar controls what navigation and options which appear in data entry record toolbar.

==== Record Navigation ====
First form the individual buttons and displays:
<pre>
// Previous record
$group_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays current site code
$group_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays current record number
$group_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays current modtype
$group_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record
$group_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Refresh View ====
<pre>
// Refresh button
$group_refresh[] =
array(
'name' => 'refresh',
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?disp_reset=default",
'css_class' => 'refresh',
'mkname' => 'reset',
'lightbox' => FALSE
);
</pre>

==== Administrator Tools ====
<pre>
// ADMIN TOOLS
// Delete record
$group_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit modtype
$group_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgtype',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgkey',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_record_nav =
array(
'record_nav' => $group_nav,
'record_refresh' => $group_refresh,
'record_admin' => $group_admin,
);
</pre>

==Map View==
This is optional, but needs to be configured correctly if you are using the mapping capabilities of ARK. It needs to be set up like other top level pages, but also a series of settings need to be configured.

===Map View Page Settings===
The page needs to be set up like all other standard top-level pages. If not using, or if you would like it to be inaccessible in the dynamic navigation set 'is_visible' to FALSE.

<pre>
// MAP VIEW PAGE SETTINGS
$conf_page_map_view =
array(
'name' =>'Map View',
'title' => 'Map View Page',
'file' => 'map_view.php',
'sgrp' => '1',
'navname' => 'mapviewnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/map_view/',
'is_visible' => TRUE
);
</pre>

===Map View Left Panel===
The first subform is to allow saving of maps from the left panel, and the second to allow downloads of maps as PDFs.
<pre>
// LEFT PANEL
// Subforms
$conf_map_wmcoverlay =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'nmedit',
'sf_title' => 'wmcoverlay',
'sf_html_id' => 'map_wmcoverlay', // Must be unique
'script' => 'php/map_admin/subforms/sf_savewmc_overlay.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);

$conf_maptopdf =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'full',
'sf_title' => 'interp',
'sf_html_id' => 'map_maptopdf', // Must be unique
'script' => 'php/map_view/subforms/sf_maptopdf.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);
</pre>
===Map View Main===
These are a series of settings that define the query layers and query maps displayed in the map view as well as the results map view.
====Map Timeout====
Mapping timeout in milliseconds- if you are using a slow WxS server set this to be high (default is 1500).
<pre>
$map_timeout = 5000;
</pre>
====WXS Query Layers====
$wxs_qlayers: mapping layers for mods - specify in this array the names of the wms/wfs layers that contain the spatial data for each mod. Bear in mind that these layers should contain an ark_id column that can be retrieved using a getFeatureInfo request.
Each layer is a separate entry in the array containing an array of variables:

*'''mod''' - the mod of the item (without _cd) eg. 'cxt'
*'''geom''' - the geometry of the layer - eg. 'pt', 'pl' or 'pgn'
*'''url''' - the full url of the WMS/WFS server that is hosting the layer
*'''title_field''' - this is the field_id of the field that you want to be displayed during the click to query, if this is set to 'GIS' then it will return the attributes in the remote GIS attribute table.
<pre>
$wxs_qlayers =
array(
'sites' => array(
'mod' => 'cxt',
'geom' => 'pt',
'url' => 'http://localhost/ark/php/map/ark_wxs_server.php?',
'title_field' => 'conf_field_name',
'style_array' =>
array(
'fillOpacity' => 0.75,
'strokeColor' => '"black"',
'fillColor' => '"red"',
'pointRadius' => 10,
)
),
);
</pre>

===WXS Query Map===
$wxs_query_map - this is the name of a saved map (saved using the map_admin tools), that you want to be the background for the 'View Results as Map'. Admins should note: the $wxs_qlayers array is used to determine which layers can be used to display the spatial data for each mod - therefore those layers HAVE to be available in the saved $wxs_query_map. Also, the more info button - if you store information about your GIS layers as ARK items then set this to TRUE. Please note you will need to have a 'gis' module and you will need to name your WMS-served GIS layers in the format for instance,'contexts_PCO06_123'
<pre>
$wxs_query_map = 'QueryMap';

$map_more_info_button = FALSE;
</pre>

Page settings.php

2012-03-21T16:41:19Z

Jessogden: /* Data Entry */

As of v1.0, all settings related to individual page displays, navigation, and toolbars are to be included in the [[page_settings.php]].
==Navigation==
===Navigation Pages===
As of v1.1 $conf_hide_pages has been replaced with $conf_pages. All pages listed in this array will appear in the main nav. Overlay holder, download, feed, and transclude object are required pages with their visibility setting set to FALSE so they do not appear in the navigation.
<pre>
$conf_pages =
array(
'user_home',
'data_entry',
'micro_view',
'data_view',
'user_admin',
'alias_admin',
'markup_admin',
'import',
'resultsmicro_view',
'index',
'overlay_holder',
'download',
'feed',
'transclude_object'
);
</pre>

===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>
==User Home==
These settings control the subforms and left panel in the user home. The user home needs configuration both for the left panel and for the subforms included in the main area.
===User Home Page Settings===
As of v1.1 an individual page setting array is required for each page directing the ARK to the code directory and navigation settings for that particular page.
<pre>
// PAGE SETTINGS
$conf_page_user_home =
array(
'name' => 'User Home',
'title' => 'User Home Page',
'file' => 'user_home.php',
'sgrp' => '1',
'navname' => 'homenav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/user_home/',
'is_visible' => TRUE
);
</pre>
===User Home Left Panel===
Configures the left panel in the user home pages, requires the administrator to configure the lpanel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $uhlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'user_home' in the [[sf_module]].
====Subforms Option Example====
Define the configuration type:
<pre>
$uhlpoutput = 'subforms';
</pre>
Configure the subform:
<pre>
$uhlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'user_home',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$user_home_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$uhlp_subform_module
)
);
</pre>

== Data Entry ==
These settings configure the data entry page. The data entry requires configuration for both the left panel and the record navigation bar appearing at the top of the main area. Further options for advanced file upload are also included below.
===Data Entry Page Settings===
<pre>
// PAGE SETTINGS
$conf_page_data_entry =
array(
'name' =>'Data Entry',
'title' => 'Data Entry Page',
'file' => 'data_entry.php',
'sgrp' => '1',
'navname' => 'dataentrynav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/data_entry/',
'is_visible' => TRUE
);
</pre>
=== Data Entry Left Panel ===
This section gives examples for the left panel configuration in the data entry pages using either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation.
==== Minimiser Option ====
This tool condenses subforms and offers quick navigation in left panel. To use the minimiser on specific data entry pages you need to go to the mod_settings files (ex. mod_cxt_settings.php) and make sure that 'col_type' => 'collaps_col', instead of single_col in the $conf_dat_materi and $conf_dat_detfrm settings.
<pre>
$minimiser = TRUE;
</pre>

====Link list Option Example====

Define the configuration type:
<pre>
$delpoutput = 'linklist';
</pre>
Configure the links:
<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=files",
'mknname' => 'uplfile'
);
</pre>

====Subforms Option Example====

Define the configuration type:
<pre>
$delpoutput = 'subforms';
</pre>

Configure the linklist (in this case, a linklist is being used to display the upload files link and the sf_linklist is calling the link):
<pre>
$link_list_admin[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=files",
'mknname' => 'uplfile',
'img' => 'bigplus.png'
);
</pre>

Configure the subforms - Subform listing the modules:
<pre>
$delp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpmodlist',
'sf_html_id' => 'delpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'data_entry',
'fields' => array (
'cxt',
'smp',
'spf',
'sph',
)
);
</pre>
Admin Subform calling the file upload linklist from above:
<pre>
$delp_subform_admin =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpadmin',
'sf_html_id' => 'delpadmin', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_label' => 'space',
'op_input' => 'save',
'op_linktype' => 'icon',
'op_sf_cssclass' => 'module_list',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'fields' => $link_list_admin
);
</pre>
Load the subforms:
<pre>
$data_entry_left_panel =
array(
'col_id' => 'delp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$delp_subform_module,
$delp_subform_admin
)
);
</pre>

=== Data Entry Toolbar ===
Configure the tools for data entry. First form the individual buttons and displays:
==== User Navigation ====
<pre>
// Previous record button
$group_entry_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays site code
$group_entry_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays record number
$group_entry_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays module type
$group_entry_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record button
$group_entry_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Administrator tools ====
<pre>
// Delete record
$group_entry_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit module type
$group_entry_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chngmod',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_entry_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'DEL',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_entry_nav =
array(
'record_nav' => $group_entry_nav,
'record_admin' => $group_entry_admin,
);
</pre>

===Advanced File Upload===
The following includes instructions on how to configure the advanced file uploader which was developed as a mechanism for not only batch uploading files, but also registering and/or linking them to existing records on the fly.
*'''on''' - Set to TRUE, advanced file uploader dialog is displayed.
*'''pattern''' - This is a regex (Regular expression) designed to detect the file names and associate the files with the appropriate records (item_keys). These example expressions are set up to treat the first 3 letters of a file name as the relevant site code and the numbers following as the number. (For example: 'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-zA-Z0-9]*))\.[a-zA-Z]{2,4}\b/i" handles files xxx-1234.jpg, xxx-1234-yyy.jpg, where xxx can be any letter and yyy any alphanumeric combination, only number before first '-' is used as an ID)
<pre>
$fu =
array(
'on' => TRUE,
'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-z0-9A-Z]*))\.[a-z0-9]{2,4}\b/i",
);
</pre>

==Data View (Search)==
These settings configure the data view (or search) page. The data view requires configuration for the left panel, the search tools options (results views, download options, etc) as well as some general settings for search results.
===General Page Settings===
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>

And the number of pages to display on the data viewer:
<pre>
// Number of pages to display on the data viewer
$conf_num_res_pgs = 5; // best choose an odd number
</pre>

Also configure the index pages for Data View and Search pages:
<pre>
// 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 (options include: text, table, or map):
<pre>
// Default $output_mode for the data viewer
$default_output_mode = 'table';
</pre>
===Data View Left Panel===
This configures the left panel for the data view pages through a series of complex subforms including [[sf_linklist]], [[sf_buildfilter]], and [[sf_mysavedstuff]].
====Configure the linklist====
First configure the linklist, which requires the following:
*'''href''' - link to the output ({$_SERVER['PHP_SELF']} is on same page, and then links to the key ID in the relevant cor table of the designated data filter
*'''mknname''' - mark-up nickname will search the markup table for this nickname and print the markup
*'''img''' - optional image for the icon defined in the subform linklist:
<pre>
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=1&ftr_id=new",
'mknname' => 'filtercxt',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=6&ftr_id=new",
'mknname' => 'filtersmp',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=stecd&ftr_id=new",
'mknname' => 'filterstecd',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=action&ftr_id=new",
'mknname' => 'filteractor',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=ftx&ftr_id=new",
'mknname' => 'ftx',
'img' => 'view_mag.png'
);
</pre>

Configure the linklist subform:
<pre>
$dvlp_subform_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_linktype' => 'icon',
'op_sf_cssclass' => 'ftr_list',
'fields' => $link_list_filters
);
</pre>

====Filter Builders====
Various options exist for the types of filters administrators will want to make available to users- including different stages of pre-built or partially executed filters. For more information on this subform and options see [[sf_buildfilter]].
 
Subform for the filter builder to run in the left panel:
<pre>
$dvlp_filter_builder =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_condition' =>
array(
array(
'func'=> 'chkTmpFtr',
'args'=> FALSE
),
),
);
</pre>
Subform for the filter builder to run in the left panel preloaded with a filter:
<pre>
$dvlp_filter_builder_atridx =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_filter' => 'atr', // the filter to be used
'op_filter_args' =>
array(
// 'arg' => 'var', // example
'atrtype' => 1,
'op_display' => 'dd'
)
);

</pre>
Subform for user saved filters
<pre>
$dvlp_my_saved_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'savedfilters',
'sf_html_id' => 'dvlp_saved_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_mysavedstuff.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'op_sf_cssclass' => 'ftr_subform',
);
</pre>
Make a column to hold the subforms:
<pre>
$data_view_left_panel =
array(
'col_id' => 'dvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$dvlp_filter_builder,
$dvlp_filter_builder_atridx,
$dvlp_subform_filters,
$dvlp_my_saved_filters
)
);
</pre>

===Results Toolbar===
Configure the tools and display options for the search page (data_view). All of the toolbars require the following in the array:
*'''type''' - Options of 'img', 'text', or 'newpage' (used in the all record view to display function in a new page)
*'''href''' - The href link to the function being called
*'''css_class''' - The css class to style the button or display
*'''mkname''' - The name of markup contained within cor_tbl_markup used for buttons which combine text and images, are just text based. Set to FALSE if not used.
*'''lightbox''' - Option of using the lightbox when calling an overlay form, set to FALSE otherwise

First form the individual buttons:

==== Tools ====
<pre>
// TOOLS
$group_tools[] =
array(
'type' => 'img',
'href' => "overlay_holder.php?sf_conf=conf_mac_userconfigfields&lboxreload=1",
'css_class' => 'gears',
'mkname' => FALSE,
'lightbox' => 'lightbox'
);
</pre>

==== Displays ====
<pre>
// DISPs
$res = "results_mode=disp";
// Text view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=text",
'css_class' => 'text',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Table view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=table",
'css_class' => 'table',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Map view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=map",
'css_class' => 'map',
'mkname' => FALSE,
'lightbox' => FALSE
);
// All record view
$group_disp[] =
array(
'type' => 'newpage',
'href' => "resultsmicro_view.php?",
'css_class' => 'printall',
'mkname' => FALSE,
'lightbox' => FALSE
);
</pre>

==== Feeds ====
<pre>
// FEEDS
$res = "results_mode=feed";
// RSS feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=rss",
'css_class' => FALSE,
'mkname' => 'rss',
'lightbox' => FALSE
);
// Atom feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=atom",
'css_class' => FALSE,
'mkname' => 'atom',
'lightbox' => FALSE
);
</pre>

==== Downloads ====
<pre>
// DOWNLOADS
$res = "results_mode=dl";
// CSV download
$group_dls[] =
array(
'type' => 'text',
'href' => "overlay_holder.php?$res&dl_mode=csv&lboxreload=1&sf_conf=conf_mac_exportdownloadcsv",
'css_class' => FALSE,
'mkname' => 'csv',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_results_nav =
array(
'tools' => $group_tools,
'result_views' => $group_disp,
'result_feeds' => $group_feeds,
'result_downloads' => $group_dls,
);
</pre>
==Micro View (Record View)==
These settings configure the micro view (or record view) page. The micro view requires configuration for the left panel, and record nav options as well as some general settings.
===General Page Settings===
Configure the index page for the micro view:
<pre>
// Default Micro viewer page (used by search result handlers)
$conf_micro_viewer = $ark_dir."micro_view.php";
</pre>

===Micro View Left Panel===
Configures the left panel in the micro view pages, requires the administrator to configure the left panel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $mvlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'micro_view' in the [[sf_module]].

====Subforms Option Example====
Define the configuration type:
<pre>
$mvlpoutput = 'subforms';
</pre>
Configure the subform module to include the relevant modules:
<pre>
$mvlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'micro_view',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$micro_view_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$mvlp_subform_module
)
);
</pre>
===Record Toolbar===
Configure the tools for the record view toolbar. This tool bar controls what navigation and options which appear in data entry record toolbar.

==== Record Navigation ====
First form the individual buttons and displays:
<pre>
// Previous record
$group_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays current site code
$group_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays current record number
$group_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays current modtype
$group_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record
$group_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Refresh View ====
<pre>
// Refresh button
$group_refresh[] =
array(
'name' => 'refresh',
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?disp_reset=default",
'css_class' => 'refresh',
'mkname' => 'reset',
'lightbox' => FALSE
);
</pre>

==== Administrator Tools ====
<pre>
// ADMIN TOOLS
// Delete record
$group_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit modtype
$group_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgtype',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgkey',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_record_nav =
array(
'record_nav' => $group_nav,
'record_refresh' => $group_refresh,
'record_admin' => $group_admin,
);
</pre>

==Map View==
This is optional, but needs to be configured correctly if you are using the mapping capabilities of ARK. It needs to be set up like other top level pages, but also a series of settings need to be configured.

===Map View Page Settings===
The page needs to be set up like all other standard top-level pages. If not using, or if you would like it to be inaccessible in the dynamic navigation set 'is_visible' to FALSE.

<pre>
// MAP VIEW PAGE SETTINGS
$conf_page_map_view =
array(
'name' =>'Map View',
'title' => 'Map View Page',
'file' => 'map_view.php',
'sgrp' => '1',
'navname' => 'mapviewnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/map_view/',
'is_visible' => TRUE
);
</pre>

===Map View Left Panel===
The first subform is to allow saving of maps from the left panel, and the second to allow downloads of maps as PDFs.
<pre>
// LEFT PANEL
// Subforms
$conf_map_wmcoverlay =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'nmedit',
'sf_title' => 'wmcoverlay',
'sf_html_id' => 'map_wmcoverlay', // Must be unique
'script' => 'php/map_admin/subforms/sf_savewmc_overlay.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);

$conf_maptopdf =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'full',
'sf_title' => 'interp',
'sf_html_id' => 'map_maptopdf', // Must be unique
'script' => 'php/map_view/subforms/sf_maptopdf.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);
</pre>
===Map View Main===
These are a series of settings that define the query layers and query maps displayed in the map view as well as the results map view.
====Map Timeout====
Mapping timeout in milliseconds- if you are using a slow WxS server set this to be high (default is 1500).
<pre>
$map_timeout = 5000;
</pre>
====WXS Query Layers====
$wxs_qlayers: mapping layers for mods - specify in this array the names of the wms/wfs layers that contain the spatial data for each mod. Bear in mind that these layers should contain an ark_id column that can be retrieved using a getFeatureInfo request.
Each layer is a separate entry in the array containing an array of variables:

*'''mod''' - the mod of the item (without _cd) eg. 'cxt'
*'''geom''' - the geometry of the layer - eg. 'pt', 'pl' or 'pgn'
*'''url''' - the full url of the WMS/WFS server that is hosting the layer
*'''title_field''' - this is the field_id of the field that you want to be displayed during the click to query, if this is set to 'GIS' then it will return the attributes in the remote GIS attribute table.
<pre>
$wxs_qlayers =
array(
'sites' => array(
'mod' => 'cxt',
'geom' => 'pt',
'url' => 'http://localhost/ark/php/map/ark_wxs_server.php?',
'title_field' => 'conf_field_name',
'style_array' =>
array(
'fillOpacity' => 0.75,
'strokeColor' => '"black"',
'fillColor' => '"red"',
'pointRadius' => 10,
)
),
);
</pre>

===WXS Query Map===
$wxs_query_map - this is the name of a saved map (saved using the map_admin tools), that you want to be the background for the 'View Results as Map'. Admins should note: the $wxs_qlayers array is used to determine which layers can be used to display the spatial data for each mod - therefore those layers HAVE to be available in the saved $wxs_query_map. Also, the more info button - if you store information about your GIS layers as ARK items then set this to TRUE. Please note you will need to have a 'gis' module and you will need to name your WMS-served GIS layers in the format for instance,'contexts_PCO06_123'
<pre>
$wxs_query_map = 'QueryMap';

$map_more_info_button = FALSE;
</pre>

Page settings.php

2012-03-21T16:39:37Z

Jessogden: /* User Home */

As of v1.0, all settings related to individual page displays, navigation, and toolbars are to be included in the [[page_settings.php]].
==Navigation==
===Navigation Pages===
As of v1.1 $conf_hide_pages has been replaced with $conf_pages. All pages listed in this array will appear in the main nav. Overlay holder, download, feed, and transclude object are required pages with their visibility setting set to FALSE so they do not appear in the navigation.
<pre>
$conf_pages =
array(
'user_home',
'data_entry',
'micro_view',
'data_view',
'user_admin',
'alias_admin',
'markup_admin',
'import',
'resultsmicro_view',
'index',
'overlay_holder',
'download',
'feed',
'transclude_object'
);
</pre>

===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>
==User Home==
These settings control the subforms and left panel in the user home. The user home needs configuration both for the left panel and for the subforms included in the main area.
===User Home Page Settings===
As of v1.1 an individual page setting array is required for each page directing the ARK to the code directory and navigation settings for that particular page.
<pre>
// PAGE SETTINGS
$conf_page_user_home =
array(
'name' => 'User Home',
'title' => 'User Home Page',
'file' => 'user_home.php',
'sgrp' => '1',
'navname' => 'homenav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/user_home/',
'is_visible' => TRUE
);
</pre>
===User Home Left Panel===
Configures the left panel in the user home pages, requires the administrator to configure the lpanel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $uhlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'user_home' in the [[sf_module]].
====Subforms Option Example====
Define the configuration type:
<pre>
$uhlpoutput = 'subforms';
</pre>
Configure the subform:
<pre>
$uhlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'user_home',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$user_home_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$uhlp_subform_module
)
);
</pre>

== Data Entry ==
These settings configure the data entry page. The data entry requires configuration for both the left panel and the record navigation bar appearing at the top of the main area. Further options for advanced file upload are also included below.
=== Data Entry Left Panel ===
This section gives examples for the left panel configuration in the data entry pages using either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation.
==== Minimiser Option ====
This tool condenses subforms and offers quick navigation in left panel. To use the minimiser on specific data entry pages you need to go to the mod_settings files (ex. mod_cxt_settings.php) and make sure that 'col_type' => 'collaps_col', instead of single_col in the $conf_dat_materi and $conf_dat_detfrm settings.
<pre>
$minimiser = TRUE;
</pre>

====Link list Option Example====

Define the configuration type:
<pre>
$delpoutput = 'linklist';
</pre>
Configure the links:
<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=files",
'mknname' => 'uplfile'
);
</pre>

====Subforms Option Example====

Define the configuration type:
<pre>
$delpoutput = 'subforms';
</pre>

Configure the linklist (in this case, a linklist is being used to display the upload files link and the sf_linklist is calling the link):
<pre>
$link_list_admin[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=files",
'mknname' => 'uplfile',
'img' => 'bigplus.png'
);
</pre>

Configure the subforms - Subform listing the modules:
<pre>
$delp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpmodlist',
'sf_html_id' => 'delpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'data_entry',
'fields' => array (
'cxt',
'smp',
'spf',
'sph',
)
);
</pre>
Admin Subform calling the file upload linklist from above:
<pre>
$delp_subform_admin =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpadmin',
'sf_html_id' => 'delpadmin', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_label' => 'space',
'op_input' => 'save',
'op_linktype' => 'icon',
'op_sf_cssclass' => 'module_list',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'fields' => $link_list_admin
);
</pre>
Load the subforms:
<pre>
$data_entry_left_panel =
array(
'col_id' => 'delp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$delp_subform_module,
$delp_subform_admin
)
);
</pre>

=== Data Entry Toolbar ===
Configure the tools for data entry. First form the individual buttons and displays:
==== User Navigation ====
<pre>
// Previous record button
$group_entry_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays site code
$group_entry_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays record number
$group_entry_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays module type
$group_entry_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record button
$group_entry_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Administrator tools ====
<pre>
// Delete record
$group_entry_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit module type
$group_entry_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chngmod',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_entry_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'DEL',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_entry_nav =
array(
'record_nav' => $group_entry_nav,
'record_admin' => $group_entry_admin,
);
</pre>

===Advanced File Upload===
The following includes instructions on how to configure the advanced file uploader which was developed as a mechanism for not only batch uploading files, but also registering and/or linking them to existing records on the fly.
*'''on''' - Set to TRUE, advanced file uploader dialog is displayed.
*'''pattern''' - This is a regex (Regular expression) designed to detect the file names and associate the files with the appropriate records (item_keys). These example expressions are set up to treat the first 3 letters of a file name as the relevant site code and the numbers following as the number. (For example: 'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-zA-Z0-9]*))\.[a-zA-Z]{2,4}\b/i" handles files xxx-1234.jpg, xxx-1234-yyy.jpg, where xxx can be any letter and yyy any alphanumeric combination, only number before first '-' is used as an ID)
<pre>
$fu =
array(
'on' => TRUE,
'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-z0-9A-Z]*))\.[a-z0-9]{2,4}\b/i",
);
</pre>

==Data View (Search)==
These settings configure the data view (or search) page. The data view requires configuration for the left panel, the search tools options (results views, download options, etc) as well as some general settings for search results.
===General Page Settings===
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>

And the number of pages to display on the data viewer:
<pre>
// Number of pages to display on the data viewer
$conf_num_res_pgs = 5; // best choose an odd number
</pre>

Also configure the index pages for Data View and Search pages:
<pre>
// 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 (options include: text, table, or map):
<pre>
// Default $output_mode for the data viewer
$default_output_mode = 'table';
</pre>
===Data View Left Panel===
This configures the left panel for the data view pages through a series of complex subforms including [[sf_linklist]], [[sf_buildfilter]], and [[sf_mysavedstuff]].
====Configure the linklist====
First configure the linklist, which requires the following:
*'''href''' - link to the output ({$_SERVER['PHP_SELF']} is on same page, and then links to the key ID in the relevant cor table of the designated data filter
*'''mknname''' - mark-up nickname will search the markup table for this nickname and print the markup
*'''img''' - optional image for the icon defined in the subform linklist:
<pre>
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=1&ftr_id=new",
'mknname' => 'filtercxt',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=6&ftr_id=new",
'mknname' => 'filtersmp',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=stecd&ftr_id=new",
'mknname' => 'filterstecd',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=action&ftr_id=new",
'mknname' => 'filteractor',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=ftx&ftr_id=new",
'mknname' => 'ftx',
'img' => 'view_mag.png'
);
</pre>

Configure the linklist subform:
<pre>
$dvlp_subform_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_linktype' => 'icon',
'op_sf_cssclass' => 'ftr_list',
'fields' => $link_list_filters
);
</pre>

====Filter Builders====
Various options exist for the types of filters administrators will want to make available to users- including different stages of pre-built or partially executed filters. For more information on this subform and options see [[sf_buildfilter]].
 
Subform for the filter builder to run in the left panel:
<pre>
$dvlp_filter_builder =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_condition' =>
array(
array(
'func'=> 'chkTmpFtr',
'args'=> FALSE
),
),
);
</pre>
Subform for the filter builder to run in the left panel preloaded with a filter:
<pre>
$dvlp_filter_builder_atridx =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_filter' => 'atr', // the filter to be used
'op_filter_args' =>
array(
// 'arg' => 'var', // example
'atrtype' => 1,
'op_display' => 'dd'
)
);

</pre>
Subform for user saved filters
<pre>
$dvlp_my_saved_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'savedfilters',
'sf_html_id' => 'dvlp_saved_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_mysavedstuff.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'op_sf_cssclass' => 'ftr_subform',
);
</pre>
Make a column to hold the subforms:
<pre>
$data_view_left_panel =
array(
'col_id' => 'dvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$dvlp_filter_builder,
$dvlp_filter_builder_atridx,
$dvlp_subform_filters,
$dvlp_my_saved_filters
)
);
</pre>

===Results Toolbar===
Configure the tools and display options for the search page (data_view). All of the toolbars require the following in the array:
*'''type''' - Options of 'img', 'text', or 'newpage' (used in the all record view to display function in a new page)
*'''href''' - The href link to the function being called
*'''css_class''' - The css class to style the button or display
*'''mkname''' - The name of markup contained within cor_tbl_markup used for buttons which combine text and images, are just text based. Set to FALSE if not used.
*'''lightbox''' - Option of using the lightbox when calling an overlay form, set to FALSE otherwise

First form the individual buttons:

==== Tools ====
<pre>
// TOOLS
$group_tools[] =
array(
'type' => 'img',
'href' => "overlay_holder.php?sf_conf=conf_mac_userconfigfields&lboxreload=1",
'css_class' => 'gears',
'mkname' => FALSE,
'lightbox' => 'lightbox'
);
</pre>

==== Displays ====
<pre>
// DISPs
$res = "results_mode=disp";
// Text view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=text",
'css_class' => 'text',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Table view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=table",
'css_class' => 'table',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Map view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=map",
'css_class' => 'map',
'mkname' => FALSE,
'lightbox' => FALSE
);
// All record view
$group_disp[] =
array(
'type' => 'newpage',
'href' => "resultsmicro_view.php?",
'css_class' => 'printall',
'mkname' => FALSE,
'lightbox' => FALSE
);
</pre>

==== Feeds ====
<pre>
// FEEDS
$res = "results_mode=feed";
// RSS feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=rss",
'css_class' => FALSE,
'mkname' => 'rss',
'lightbox' => FALSE
);
// Atom feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=atom",
'css_class' => FALSE,
'mkname' => 'atom',
'lightbox' => FALSE
);
</pre>

==== Downloads ====
<pre>
// DOWNLOADS
$res = "results_mode=dl";
// CSV download
$group_dls[] =
array(
'type' => 'text',
'href' => "overlay_holder.php?$res&dl_mode=csv&lboxreload=1&sf_conf=conf_mac_exportdownloadcsv",
'css_class' => FALSE,
'mkname' => 'csv',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_results_nav =
array(
'tools' => $group_tools,
'result_views' => $group_disp,
'result_feeds' => $group_feeds,
'result_downloads' => $group_dls,
);
</pre>
==Micro View (Record View)==
These settings configure the micro view (or record view) page. The micro view requires configuration for the left panel, and record nav options as well as some general settings.
===General Page Settings===
Configure the index page for the micro view:
<pre>
// Default Micro viewer page (used by search result handlers)
$conf_micro_viewer = $ark_dir."micro_view.php";
</pre>

===Micro View Left Panel===
Configures the left panel in the micro view pages, requires the administrator to configure the left panel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $mvlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'micro_view' in the [[sf_module]].

====Subforms Option Example====
Define the configuration type:
<pre>
$mvlpoutput = 'subforms';
</pre>
Configure the subform module to include the relevant modules:
<pre>
$mvlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'micro_view',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$micro_view_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$mvlp_subform_module
)
);
</pre>
===Record Toolbar===
Configure the tools for the record view toolbar. This tool bar controls what navigation and options which appear in data entry record toolbar.

==== Record Navigation ====
First form the individual buttons and displays:
<pre>
// Previous record
$group_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays current site code
$group_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays current record number
$group_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays current modtype
$group_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record
$group_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Refresh View ====
<pre>
// Refresh button
$group_refresh[] =
array(
'name' => 'refresh',
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?disp_reset=default",
'css_class' => 'refresh',
'mkname' => 'reset',
'lightbox' => FALSE
);
</pre>

==== Administrator Tools ====
<pre>
// ADMIN TOOLS
// Delete record
$group_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit modtype
$group_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgtype',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgkey',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_record_nav =
array(
'record_nav' => $group_nav,
'record_refresh' => $group_refresh,
'record_admin' => $group_admin,
);
</pre>

==Map View==
This is optional, but needs to be configured correctly if you are using the mapping capabilities of ARK. It needs to be set up like other top level pages, but also a series of settings need to be configured.

===Map View Page Settings===
The page needs to be set up like all other standard top-level pages. If not using, or if you would like it to be inaccessible in the dynamic navigation set 'is_visible' to FALSE.

<pre>
// MAP VIEW PAGE SETTINGS
$conf_page_map_view =
array(
'name' =>'Map View',
'title' => 'Map View Page',
'file' => 'map_view.php',
'sgrp' => '1',
'navname' => 'mapviewnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/map_view/',
'is_visible' => TRUE
);
</pre>

===Map View Left Panel===
The first subform is to allow saving of maps from the left panel, and the second to allow downloads of maps as PDFs.
<pre>
// LEFT PANEL
// Subforms
$conf_map_wmcoverlay =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'nmedit',
'sf_title' => 'wmcoverlay',
'sf_html_id' => 'map_wmcoverlay', // Must be unique
'script' => 'php/map_admin/subforms/sf_savewmc_overlay.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);

$conf_maptopdf =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'full',
'sf_title' => 'interp',
'sf_html_id' => 'map_maptopdf', // Must be unique
'script' => 'php/map_view/subforms/sf_maptopdf.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);
</pre>
===Map View Main===
These are a series of settings that define the query layers and query maps displayed in the map view as well as the results map view.
====Map Timeout====
Mapping timeout in milliseconds- if you are using a slow WxS server set this to be high (default is 1500).
<pre>
$map_timeout = 5000;
</pre>
====WXS Query Layers====
$wxs_qlayers: mapping layers for mods - specify in this array the names of the wms/wfs layers that contain the spatial data for each mod. Bear in mind that these layers should contain an ark_id column that can be retrieved using a getFeatureInfo request.
Each layer is a separate entry in the array containing an array of variables:

*'''mod''' - the mod of the item (without _cd) eg. 'cxt'
*'''geom''' - the geometry of the layer - eg. 'pt', 'pl' or 'pgn'
*'''url''' - the full url of the WMS/WFS server that is hosting the layer
*'''title_field''' - this is the field_id of the field that you want to be displayed during the click to query, if this is set to 'GIS' then it will return the attributes in the remote GIS attribute table.
<pre>
$wxs_qlayers =
array(
'sites' => array(
'mod' => 'cxt',
'geom' => 'pt',
'url' => 'http://localhost/ark/php/map/ark_wxs_server.php?',
'title_field' => 'conf_field_name',
'style_array' =>
array(
'fillOpacity' => 0.75,
'strokeColor' => '"black"',
'fillColor' => '"red"',
'pointRadius' => 10,
)
),
);
</pre>

===WXS Query Map===
$wxs_query_map - this is the name of a saved map (saved using the map_admin tools), that you want to be the background for the 'View Results as Map'. Admins should note: the $wxs_qlayers array is used to determine which layers can be used to display the spatial data for each mod - therefore those layers HAVE to be available in the saved $wxs_query_map. Also, the more info button - if you store information about your GIS layers as ARK items then set this to TRUE. Please note you will need to have a 'gis' module and you will need to name your WMS-served GIS layers in the format for instance,'contexts_PCO06_123'
<pre>
$wxs_query_map = 'QueryMap';

$map_more_info_button = FALSE;
</pre>

Page settings.php

2012-03-21T16:36:34Z

Jessogden: /* Navigation Pages */

As of v1.0, all settings related to individual page displays, navigation, and toolbars are to be included in the [[page_settings.php]].
==Navigation==
===Navigation Pages===
As of v1.1 $conf_hide_pages has been replaced with $conf_pages. All pages listed in this array will appear in the main nav. Overlay holder, download, feed, and transclude object are required pages with their visibility setting set to FALSE so they do not appear in the navigation.
<pre>
$conf_pages =
array(
'user_home',
'data_entry',
'micro_view',
'data_view',
'user_admin',
'alias_admin',
'markup_admin',
'import',
'resultsmicro_view',
'index',
'overlay_holder',
'download',
'feed',
'transclude_object'
);
</pre>

===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>
==User Home==
These settings control the subforms and left panel in the user home. The user home needs configuration both for the left panel and for the subforms included in the main area.
===User Home Left Panel===
Configures the left panel in the user home pages, requires the administrator to configure the lpanel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $uhlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'user_home' in the [[sf_module]].
====Subforms Option Example====
Define the configuration type:
<pre>
$uhlpoutput = 'subforms';
</pre>
Configure the subform:
<pre>
$uhlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'user_home',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$user_home_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$uhlp_subform_module
)
);
</pre>
== Data Entry ==
These settings configure the data entry page. The data entry requires configuration for both the left panel and the record navigation bar appearing at the top of the main area. Further options for advanced file upload are also included below.
=== Data Entry Left Panel ===
This section gives examples for the left panel configuration in the data entry pages using either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation.
==== Minimiser Option ====
This tool condenses subforms and offers quick navigation in left panel. To use the minimiser on specific data entry pages you need to go to the mod_settings files (ex. mod_cxt_settings.php) and make sure that 'col_type' => 'collaps_col', instead of single_col in the $conf_dat_materi and $conf_dat_detfrm settings.
<pre>
$minimiser = TRUE;
</pre>

====Link list Option Example====

Define the configuration type:
<pre>
$delpoutput = 'linklist';
</pre>
Configure the links:
<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=files",
'mknname' => 'uplfile'
);
</pre>

====Subforms Option Example====

Define the configuration type:
<pre>
$delpoutput = 'subforms';
</pre>

Configure the linklist (in this case, a linklist is being used to display the upload files link and the sf_linklist is calling the link):
<pre>
$link_list_admin[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=files",
'mknname' => 'uplfile',
'img' => 'bigplus.png'
);
</pre>

Configure the subforms - Subform listing the modules:
<pre>
$delp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpmodlist',
'sf_html_id' => 'delpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'data_entry',
'fields' => array (
'cxt',
'smp',
'spf',
'sph',
)
);
</pre>
Admin Subform calling the file upload linklist from above:
<pre>
$delp_subform_admin =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpadmin',
'sf_html_id' => 'delpadmin', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_label' => 'space',
'op_input' => 'save',
'op_linktype' => 'icon',
'op_sf_cssclass' => 'module_list',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'fields' => $link_list_admin
);
</pre>
Load the subforms:
<pre>
$data_entry_left_panel =
array(
'col_id' => 'delp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$delp_subform_module,
$delp_subform_admin
)
);
</pre>

=== Data Entry Toolbar ===
Configure the tools for data entry. First form the individual buttons and displays:
==== User Navigation ====
<pre>
// Previous record button
$group_entry_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays site code
$group_entry_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays record number
$group_entry_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays module type
$group_entry_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record button
$group_entry_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Administrator tools ====
<pre>
// Delete record
$group_entry_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit module type
$group_entry_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chngmod',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_entry_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'DEL',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_entry_nav =
array(
'record_nav' => $group_entry_nav,
'record_admin' => $group_entry_admin,
);
</pre>

===Advanced File Upload===
The following includes instructions on how to configure the advanced file uploader which was developed as a mechanism for not only batch uploading files, but also registering and/or linking them to existing records on the fly.
*'''on''' - Set to TRUE, advanced file uploader dialog is displayed.
*'''pattern''' - This is a regex (Regular expression) designed to detect the file names and associate the files with the appropriate records (item_keys). These example expressions are set up to treat the first 3 letters of a file name as the relevant site code and the numbers following as the number. (For example: 'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-zA-Z0-9]*))\.[a-zA-Z]{2,4}\b/i" handles files xxx-1234.jpg, xxx-1234-yyy.jpg, where xxx can be any letter and yyy any alphanumeric combination, only number before first '-' is used as an ID)
<pre>
$fu =
array(
'on' => TRUE,
'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-z0-9A-Z]*))\.[a-z0-9]{2,4}\b/i",
);
</pre>

==Data View (Search)==
These settings configure the data view (or search) page. The data view requires configuration for the left panel, the search tools options (results views, download options, etc) as well as some general settings for search results.
===General Page Settings===
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>

And the number of pages to display on the data viewer:
<pre>
// Number of pages to display on the data viewer
$conf_num_res_pgs = 5; // best choose an odd number
</pre>

Also configure the index pages for Data View and Search pages:
<pre>
// 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 (options include: text, table, or map):
<pre>
// Default $output_mode for the data viewer
$default_output_mode = 'table';
</pre>
===Data View Left Panel===
This configures the left panel for the data view pages through a series of complex subforms including [[sf_linklist]], [[sf_buildfilter]], and [[sf_mysavedstuff]].
====Configure the linklist====
First configure the linklist, which requires the following:
*'''href''' - link to the output ({$_SERVER['PHP_SELF']} is on same page, and then links to the key ID in the relevant cor table of the designated data filter
*'''mknname''' - mark-up nickname will search the markup table for this nickname and print the markup
*'''img''' - optional image for the icon defined in the subform linklist:
<pre>
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=1&ftr_id=new",
'mknname' => 'filtercxt',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=6&ftr_id=new",
'mknname' => 'filtersmp',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=stecd&ftr_id=new",
'mknname' => 'filterstecd',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=action&ftr_id=new",
'mknname' => 'filteractor',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=ftx&ftr_id=new",
'mknname' => 'ftx',
'img' => 'view_mag.png'
);
</pre>

Configure the linklist subform:
<pre>
$dvlp_subform_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_linktype' => 'icon',
'op_sf_cssclass' => 'ftr_list',
'fields' => $link_list_filters
);
</pre>

====Filter Builders====
Various options exist for the types of filters administrators will want to make available to users- including different stages of pre-built or partially executed filters. For more information on this subform and options see [[sf_buildfilter]].
 
Subform for the filter builder to run in the left panel:
<pre>
$dvlp_filter_builder =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_condition' =>
array(
array(
'func'=> 'chkTmpFtr',
'args'=> FALSE
),
),
);
</pre>
Subform for the filter builder to run in the left panel preloaded with a filter:
<pre>
$dvlp_filter_builder_atridx =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_filter' => 'atr', // the filter to be used
'op_filter_args' =>
array(
// 'arg' => 'var', // example
'atrtype' => 1,
'op_display' => 'dd'
)
);

</pre>
Subform for user saved filters
<pre>
$dvlp_my_saved_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'savedfilters',
'sf_html_id' => 'dvlp_saved_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_mysavedstuff.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'op_sf_cssclass' => 'ftr_subform',
);
</pre>
Make a column to hold the subforms:
<pre>
$data_view_left_panel =
array(
'col_id' => 'dvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$dvlp_filter_builder,
$dvlp_filter_builder_atridx,
$dvlp_subform_filters,
$dvlp_my_saved_filters
)
);
</pre>

===Results Toolbar===
Configure the tools and display options for the search page (data_view). All of the toolbars require the following in the array:
*'''type''' - Options of 'img', 'text', or 'newpage' (used in the all record view to display function in a new page)
*'''href''' - The href link to the function being called
*'''css_class''' - The css class to style the button or display
*'''mkname''' - The name of markup contained within cor_tbl_markup used for buttons which combine text and images, are just text based. Set to FALSE if not used.
*'''lightbox''' - Option of using the lightbox when calling an overlay form, set to FALSE otherwise

First form the individual buttons:

==== Tools ====
<pre>
// TOOLS
$group_tools[] =
array(
'type' => 'img',
'href' => "overlay_holder.php?sf_conf=conf_mac_userconfigfields&lboxreload=1",
'css_class' => 'gears',
'mkname' => FALSE,
'lightbox' => 'lightbox'
);
</pre>

==== Displays ====
<pre>
// DISPs
$res = "results_mode=disp";
// Text view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=text",
'css_class' => 'text',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Table view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=table",
'css_class' => 'table',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Map view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=map",
'css_class' => 'map',
'mkname' => FALSE,
'lightbox' => FALSE
);
// All record view
$group_disp[] =
array(
'type' => 'newpage',
'href' => "resultsmicro_view.php?",
'css_class' => 'printall',
'mkname' => FALSE,
'lightbox' => FALSE
);
</pre>

==== Feeds ====
<pre>
// FEEDS
$res = "results_mode=feed";
// RSS feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=rss",
'css_class' => FALSE,
'mkname' => 'rss',
'lightbox' => FALSE
);
// Atom feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=atom",
'css_class' => FALSE,
'mkname' => 'atom',
'lightbox' => FALSE
);
</pre>

==== Downloads ====
<pre>
// DOWNLOADS
$res = "results_mode=dl";
// CSV download
$group_dls[] =
array(
'type' => 'text',
'href' => "overlay_holder.php?$res&dl_mode=csv&lboxreload=1&sf_conf=conf_mac_exportdownloadcsv",
'css_class' => FALSE,
'mkname' => 'csv',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_results_nav =
array(
'tools' => $group_tools,
'result_views' => $group_disp,
'result_feeds' => $group_feeds,
'result_downloads' => $group_dls,
);
</pre>
==Micro View (Record View)==
These settings configure the micro view (or record view) page. The micro view requires configuration for the left panel, and record nav options as well as some general settings.
===General Page Settings===
Configure the index page for the micro view:
<pre>
// Default Micro viewer page (used by search result handlers)
$conf_micro_viewer = $ark_dir."micro_view.php";
</pre>

===Micro View Left Panel===
Configures the left panel in the micro view pages, requires the administrator to configure the left panel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $mvlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'micro_view' in the [[sf_module]].

====Subforms Option Example====
Define the configuration type:
<pre>
$mvlpoutput = 'subforms';
</pre>
Configure the subform module to include the relevant modules:
<pre>
$mvlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'micro_view',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$micro_view_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$mvlp_subform_module
)
);
</pre>
===Record Toolbar===
Configure the tools for the record view toolbar. This tool bar controls what navigation and options which appear in data entry record toolbar.

==== Record Navigation ====
First form the individual buttons and displays:
<pre>
// Previous record
$group_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays current site code
$group_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays current record number
$group_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays current modtype
$group_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record
$group_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Refresh View ====
<pre>
// Refresh button
$group_refresh[] =
array(
'name' => 'refresh',
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?disp_reset=default",
'css_class' => 'refresh',
'mkname' => 'reset',
'lightbox' => FALSE
);
</pre>

==== Administrator Tools ====
<pre>
// ADMIN TOOLS
// Delete record
$group_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit modtype
$group_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgtype',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgkey',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_record_nav =
array(
'record_nav' => $group_nav,
'record_refresh' => $group_refresh,
'record_admin' => $group_admin,
);
</pre>

==Map View==
This is optional, but needs to be configured correctly if you are using the mapping capabilities of ARK. It needs to be set up like other top level pages, but also a series of settings need to be configured.

===Map View Page Settings===
The page needs to be set up like all other standard top-level pages. If not using, or if you would like it to be inaccessible in the dynamic navigation set 'is_visible' to FALSE.

<pre>
// MAP VIEW PAGE SETTINGS
$conf_page_map_view =
array(
'name' =>'Map View',
'title' => 'Map View Page',
'file' => 'map_view.php',
'sgrp' => '1',
'navname' => 'mapviewnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/map_view/',
'is_visible' => TRUE
);
</pre>

===Map View Left Panel===
The first subform is to allow saving of maps from the left panel, and the second to allow downloads of maps as PDFs.
<pre>
// LEFT PANEL
// Subforms
$conf_map_wmcoverlay =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'nmedit',
'sf_title' => 'wmcoverlay',
'sf_html_id' => 'map_wmcoverlay', // Must be unique
'script' => 'php/map_admin/subforms/sf_savewmc_overlay.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);

$conf_maptopdf =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'full',
'sf_title' => 'interp',
'sf_html_id' => 'map_maptopdf', // Must be unique
'script' => 'php/map_view/subforms/sf_maptopdf.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);
</pre>
===Map View Main===
These are a series of settings that define the query layers and query maps displayed in the map view as well as the results map view.
====Map Timeout====
Mapping timeout in milliseconds- if you are using a slow WxS server set this to be high (default is 1500).
<pre>
$map_timeout = 5000;
</pre>
====WXS Query Layers====
$wxs_qlayers: mapping layers for mods - specify in this array the names of the wms/wfs layers that contain the spatial data for each mod. Bear in mind that these layers should contain an ark_id column that can be retrieved using a getFeatureInfo request.
Each layer is a separate entry in the array containing an array of variables:

*'''mod''' - the mod of the item (without _cd) eg. 'cxt'
*'''geom''' - the geometry of the layer - eg. 'pt', 'pl' or 'pgn'
*'''url''' - the full url of the WMS/WFS server that is hosting the layer
*'''title_field''' - this is the field_id of the field that you want to be displayed during the click to query, if this is set to 'GIS' then it will return the attributes in the remote GIS attribute table.
<pre>
$wxs_qlayers =
array(
'sites' => array(
'mod' => 'cxt',
'geom' => 'pt',
'url' => 'http://localhost/ark/php/map/ark_wxs_server.php?',
'title_field' => 'conf_field_name',
'style_array' =>
array(
'fillOpacity' => 0.75,
'strokeColor' => '"black"',
'fillColor' => '"red"',
'pointRadius' => 10,
)
),
);
</pre>

===WXS Query Map===
$wxs_query_map - this is the name of a saved map (saved using the map_admin tools), that you want to be the background for the 'View Results as Map'. Admins should note: the $wxs_qlayers array is used to determine which layers can be used to display the spatial data for each mod - therefore those layers HAVE to be available in the saved $wxs_query_map. Also, the more info button - if you store information about your GIS layers as ARK items then set this to TRUE. Please note you will need to have a 'gis' module and you will need to name your WMS-served GIS layers in the format for instance,'contexts_PCO06_123'
<pre>
$wxs_query_map = 'QueryMap';

$map_more_info_button = FALSE;
</pre>

Mapping Overview

2012-03-21T16:24:05Z

Jessogden:

The mapping in ARK is all accessed using a WFS and WMS client. In order to do this within ARK we generally use [http://mapserver.gis.umn.edu/ Minnesota Mapserver] as the server - although as of v0.8 ARK can access any live WMS/WFS server.

The mapping in ARK appears in 3 different places.

*The Spatial Subform ([[Sf_wfs_spat|detailed setup instructions]])
*The Mapview Page ([[Page_settings.php#Map_View|detailed setup instructions]])
*The Data View Page (View as Map) ([[Page_settings.php#Map_View|detailed setup instructions]])

If you choose to use Mapserver as your WMS/WFS server then [[Configuring_the_Mapfile|here]] is a quick guide to how to setup the mapfile.

[[Category:Administrator]]

Page settings.php

2012-03-21T16:21:58Z

Jessogden: /* WXS Query Layers */

As of v1.0, all settings related to individual page displays, navigation, and toolbars are to be included in the [[page_settings.php]].
==Navigation==
===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',
'overlay_holder.php',
'export.php',
'alias_admin.php',
'markup_admin.php',
'import.php'
);
</pre>
===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>
==User Home==
These settings control the subforms and left panel in the user home. The user home needs configuration both for the left panel and for the subforms included in the main area.
===User Home Left Panel===
Configures the left panel in the user home pages, requires the administrator to configure the lpanel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $uhlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'user_home' in the [[sf_module]].
====Subforms Option Example====
Define the configuration type:
<pre>
$uhlpoutput = 'subforms';
</pre>
Configure the subform:
<pre>
$uhlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'user_home',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$user_home_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$uhlp_subform_module
)
);
</pre>
== Data Entry ==
These settings configure the data entry page. The data entry requires configuration for both the left panel and the record navigation bar appearing at the top of the main area. Further options for advanced file upload are also included below.
=== Data Entry Left Panel ===
This section gives examples for the left panel configuration in the data entry pages using either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation.
==== Minimiser Option ====
This tool condenses subforms and offers quick navigation in left panel. To use the minimiser on specific data entry pages you need to go to the mod_settings files (ex. mod_cxt_settings.php) and make sure that 'col_type' => 'collaps_col', instead of single_col in the $conf_dat_materi and $conf_dat_detfrm settings.
<pre>
$minimiser = TRUE;
</pre>

====Link list Option Example====

Define the configuration type:
<pre>
$delpoutput = 'linklist';
</pre>
Configure the links:
<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=files",
'mknname' => 'uplfile'
);
</pre>

====Subforms Option Example====

Define the configuration type:
<pre>
$delpoutput = 'subforms';
</pre>

Configure the linklist (in this case, a linklist is being used to display the upload files link and the sf_linklist is calling the link):
<pre>
$link_list_admin[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=files",
'mknname' => 'uplfile',
'img' => 'bigplus.png'
);
</pre>

Configure the subforms - Subform listing the modules:
<pre>
$delp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpmodlist',
'sf_html_id' => 'delpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'data_entry',
'fields' => array (
'cxt',
'smp',
'spf',
'sph',
)
);
</pre>
Admin Subform calling the file upload linklist from above:
<pre>
$delp_subform_admin =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpadmin',
'sf_html_id' => 'delpadmin', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_label' => 'space',
'op_input' => 'save',
'op_linktype' => 'icon',
'op_sf_cssclass' => 'module_list',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'fields' => $link_list_admin
);
</pre>
Load the subforms:
<pre>
$data_entry_left_panel =
array(
'col_id' => 'delp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$delp_subform_module,
$delp_subform_admin
)
);
</pre>

=== Data Entry Toolbar ===
Configure the tools for data entry. First form the individual buttons and displays:
==== User Navigation ====
<pre>
// Previous record button
$group_entry_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays site code
$group_entry_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays record number
$group_entry_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays module type
$group_entry_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record button
$group_entry_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Administrator tools ====
<pre>
// Delete record
$group_entry_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit module type
$group_entry_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chngmod',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_entry_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'DEL',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_entry_nav =
array(
'record_nav' => $group_entry_nav,
'record_admin' => $group_entry_admin,
);
</pre>

===Advanced File Upload===
The following includes instructions on how to configure the advanced file uploader which was developed as a mechanism for not only batch uploading files, but also registering and/or linking them to existing records on the fly.
*'''on''' - Set to TRUE, advanced file uploader dialog is displayed.
*'''pattern''' - This is a regex (Regular expression) designed to detect the file names and associate the files with the appropriate records (item_keys). These example expressions are set up to treat the first 3 letters of a file name as the relevant site code and the numbers following as the number. (For example: 'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-zA-Z0-9]*))\.[a-zA-Z]{2,4}\b/i" handles files xxx-1234.jpg, xxx-1234-yyy.jpg, where xxx can be any letter and yyy any alphanumeric combination, only number before first '-' is used as an ID)
<pre>
$fu =
array(
'on' => TRUE,
'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-z0-9A-Z]*))\.[a-z0-9]{2,4}\b/i",
);
</pre>

==Data View (Search)==
These settings configure the data view (or search) page. The data view requires configuration for the left panel, the search tools options (results views, download options, etc) as well as some general settings for search results.
===General Page Settings===
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>

And the number of pages to display on the data viewer:
<pre>
// Number of pages to display on the data viewer
$conf_num_res_pgs = 5; // best choose an odd number
</pre>

Also configure the index pages for Data View and Search pages:
<pre>
// 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 (options include: text, table, or map):
<pre>
// Default $output_mode for the data viewer
$default_output_mode = 'table';
</pre>
===Data View Left Panel===
This configures the left panel for the data view pages through a series of complex subforms including [[sf_linklist]], [[sf_buildfilter]], and [[sf_mysavedstuff]].
====Configure the linklist====
First configure the linklist, which requires the following:
*'''href''' - link to the output ({$_SERVER['PHP_SELF']} is on same page, and then links to the key ID in the relevant cor table of the designated data filter
*'''mknname''' - mark-up nickname will search the markup table for this nickname and print the markup
*'''img''' - optional image for the icon defined in the subform linklist:
<pre>
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=1&ftr_id=new",
'mknname' => 'filtercxt',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=6&ftr_id=new",
'mknname' => 'filtersmp',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=stecd&ftr_id=new",
'mknname' => 'filterstecd',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=action&ftr_id=new",
'mknname' => 'filteractor',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=ftx&ftr_id=new",
'mknname' => 'ftx',
'img' => 'view_mag.png'
);
</pre>

Configure the linklist subform:
<pre>
$dvlp_subform_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_linktype' => 'icon',
'op_sf_cssclass' => 'ftr_list',
'fields' => $link_list_filters
);
</pre>

====Filter Builders====
Various options exist for the types of filters administrators will want to make available to users- including different stages of pre-built or partially executed filters. For more information on this subform and options see [[sf_buildfilter]].
 
Subform for the filter builder to run in the left panel:
<pre>
$dvlp_filter_builder =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_condition' =>
array(
array(
'func'=> 'chkTmpFtr',
'args'=> FALSE
),
),
);
</pre>
Subform for the filter builder to run in the left panel preloaded with a filter:
<pre>
$dvlp_filter_builder_atridx =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_filter' => 'atr', // the filter to be used
'op_filter_args' =>
array(
// 'arg' => 'var', // example
'atrtype' => 1,
'op_display' => 'dd'
)
);

</pre>
Subform for user saved filters
<pre>
$dvlp_my_saved_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'savedfilters',
'sf_html_id' => 'dvlp_saved_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_mysavedstuff.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'op_sf_cssclass' => 'ftr_subform',
);
</pre>
Make a column to hold the subforms:
<pre>
$data_view_left_panel =
array(
'col_id' => 'dvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$dvlp_filter_builder,
$dvlp_filter_builder_atridx,
$dvlp_subform_filters,
$dvlp_my_saved_filters
)
);
</pre>

===Results Toolbar===
Configure the tools and display options for the search page (data_view). All of the toolbars require the following in the array:
*'''type''' - Options of 'img', 'text', or 'newpage' (used in the all record view to display function in a new page)
*'''href''' - The href link to the function being called
*'''css_class''' - The css class to style the button or display
*'''mkname''' - The name of markup contained within cor_tbl_markup used for buttons which combine text and images, are just text based. Set to FALSE if not used.
*'''lightbox''' - Option of using the lightbox when calling an overlay form, set to FALSE otherwise

First form the individual buttons:

==== Tools ====
<pre>
// TOOLS
$group_tools[] =
array(
'type' => 'img',
'href' => "overlay_holder.php?sf_conf=conf_mac_userconfigfields&lboxreload=1",
'css_class' => 'gears',
'mkname' => FALSE,
'lightbox' => 'lightbox'
);
</pre>

==== Displays ====
<pre>
// DISPs
$res = "results_mode=disp";
// Text view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=text",
'css_class' => 'text',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Table view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=table",
'css_class' => 'table',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Map view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=map",
'css_class' => 'map',
'mkname' => FALSE,
'lightbox' => FALSE
);
// All record view
$group_disp[] =
array(
'type' => 'newpage',
'href' => "resultsmicro_view.php?",
'css_class' => 'printall',
'mkname' => FALSE,
'lightbox' => FALSE
);
</pre>

==== Feeds ====
<pre>
// FEEDS
$res = "results_mode=feed";
// RSS feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=rss",
'css_class' => FALSE,
'mkname' => 'rss',
'lightbox' => FALSE
);
// Atom feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=atom",
'css_class' => FALSE,
'mkname' => 'atom',
'lightbox' => FALSE
);
</pre>

==== Downloads ====
<pre>
// DOWNLOADS
$res = "results_mode=dl";
// CSV download
$group_dls[] =
array(
'type' => 'text',
'href' => "overlay_holder.php?$res&dl_mode=csv&lboxreload=1&sf_conf=conf_mac_exportdownloadcsv",
'css_class' => FALSE,
'mkname' => 'csv',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_results_nav =
array(
'tools' => $group_tools,
'result_views' => $group_disp,
'result_feeds' => $group_feeds,
'result_downloads' => $group_dls,
);
</pre>
==Micro View (Record View)==
These settings configure the micro view (or record view) page. The micro view requires configuration for the left panel, and record nav options as well as some general settings.
===General Page Settings===
Configure the index page for the micro view:
<pre>
// Default Micro viewer page (used by search result handlers)
$conf_micro_viewer = $ark_dir."micro_view.php";
</pre>

===Micro View Left Panel===
Configures the left panel in the micro view pages, requires the administrator to configure the left panel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $mvlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'micro_view' in the [[sf_module]].

====Subforms Option Example====
Define the configuration type:
<pre>
$mvlpoutput = 'subforms';
</pre>
Configure the subform module to include the relevant modules:
<pre>
$mvlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'micro_view',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$micro_view_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$mvlp_subform_module
)
);
</pre>
===Record Toolbar===
Configure the tools for the record view toolbar. This tool bar controls what navigation and options which appear in data entry record toolbar.

==== Record Navigation ====
First form the individual buttons and displays:
<pre>
// Previous record
$group_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays current site code
$group_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays current record number
$group_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays current modtype
$group_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record
$group_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Refresh View ====
<pre>
// Refresh button
$group_refresh[] =
array(
'name' => 'refresh',
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?disp_reset=default",
'css_class' => 'refresh',
'mkname' => 'reset',
'lightbox' => FALSE
);
</pre>

==== Administrator Tools ====
<pre>
// ADMIN TOOLS
// Delete record
$group_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit modtype
$group_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgtype',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgkey',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_record_nav =
array(
'record_nav' => $group_nav,
'record_refresh' => $group_refresh,
'record_admin' => $group_admin,
);
</pre>

==Map View==
This is optional, but needs to be configured correctly if you are using the mapping capabilities of ARK. It needs to be set up like other top level pages, but also a series of settings need to be configured.

===Map View Page Settings===
The page needs to be set up like all other standard top-level pages. If not using, or if you would like it to be inaccessible in the dynamic navigation set 'is_visible' to FALSE.

<pre>
// MAP VIEW PAGE SETTINGS
$conf_page_map_view =
array(
'name' =>'Map View',
'title' => 'Map View Page',
'file' => 'map_view.php',
'sgrp' => '1',
'navname' => 'mapviewnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/map_view/',
'is_visible' => TRUE
);
</pre>

===Map View Left Panel===
The first subform is to allow saving of maps from the left panel, and the second to allow downloads of maps as PDFs.
<pre>
// LEFT PANEL
// Subforms
$conf_map_wmcoverlay =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'nmedit',
'sf_title' => 'wmcoverlay',
'sf_html_id' => 'map_wmcoverlay', // Must be unique
'script' => 'php/map_admin/subforms/sf_savewmc_overlay.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);

$conf_maptopdf =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'full',
'sf_title' => 'interp',
'sf_html_id' => 'map_maptopdf', // Must be unique
'script' => 'php/map_view/subforms/sf_maptopdf.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);
</pre>
===Map View Main===
These are a series of settings that define the query layers and query maps displayed in the map view as well as the results map view.
====Map Timeout====
Mapping timeout in milliseconds- if you are using a slow WxS server set this to be high (default is 1500).
<pre>
$map_timeout = 5000;
</pre>
====WXS Query Layers====
$wxs_qlayers: mapping layers for mods - specify in this array the names of the wms/wfs layers that contain the spatial data for each mod. Bear in mind that these layers should contain an ark_id column that can be retrieved using a getFeatureInfo request.
Each layer is a separate entry in the array containing an array of variables:

*'''mod''' - the mod of the item (without _cd) eg. 'cxt'
*'''geom''' - the geometry of the layer - eg. 'pt', 'pl' or 'pgn'
*'''url''' - the full url of the WMS/WFS server that is hosting the layer
*'''title_field''' - this is the field_id of the field that you want to be displayed during the click to query, if this is set to 'GIS' then it will return the attributes in the remote GIS attribute table.
<pre>
$wxs_qlayers =
array(
'sites' => array(
'mod' => 'cxt',
'geom' => 'pt',
'url' => 'http://localhost/ark/php/map/ark_wxs_server.php?',
'title_field' => 'conf_field_name',
'style_array' =>
array(
'fillOpacity' => 0.75,
'strokeColor' => '"black"',
'fillColor' => '"red"',
'pointRadius' => 10,
)
),
);
</pre>

===WXS Query Map===
$wxs_query_map - this is the name of a saved map (saved using the map_admin tools), that you want to be the background for the 'View Results as Map'. Admins should note: the $wxs_qlayers array is used to determine which layers can be used to display the spatial data for each mod - therefore those layers HAVE to be available in the saved $wxs_query_map. Also, the more info button - if you store information about your GIS layers as ARK items then set this to TRUE. Please note you will need to have a 'gis' module and you will need to name your WMS-served GIS layers in the format for instance,'contexts_PCO06_123'
<pre>
$wxs_query_map = 'QueryMap';

$map_more_info_button = FALSE;
</pre>

Page settings.php

2012-03-21T16:21:28Z

Jessogden: /* Filter Builders */

As of v1.0, all settings related to individual page displays, navigation, and toolbars are to be included in the [[page_settings.php]].
==Navigation==
===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',
'overlay_holder.php',
'export.php',
'alias_admin.php',
'markup_admin.php',
'import.php'
);
</pre>
===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>
==User Home==
These settings control the subforms and left panel in the user home. The user home needs configuration both for the left panel and for the subforms included in the main area.
===User Home Left Panel===
Configures the left panel in the user home pages, requires the administrator to configure the lpanel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $uhlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'user_home' in the [[sf_module]].
====Subforms Option Example====
Define the configuration type:
<pre>
$uhlpoutput = 'subforms';
</pre>
Configure the subform:
<pre>
$uhlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'user_home',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$user_home_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$uhlp_subform_module
)
);
</pre>
== Data Entry ==
These settings configure the data entry page. The data entry requires configuration for both the left panel and the record navigation bar appearing at the top of the main area. Further options for advanced file upload are also included below.
=== Data Entry Left Panel ===
This section gives examples for the left panel configuration in the data entry pages using either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation.
==== Minimiser Option ====
This tool condenses subforms and offers quick navigation in left panel. To use the minimiser on specific data entry pages you need to go to the mod_settings files (ex. mod_cxt_settings.php) and make sure that 'col_type' => 'collaps_col', instead of single_col in the $conf_dat_materi and $conf_dat_detfrm settings.
<pre>
$minimiser = TRUE;
</pre>

====Link list Option Example====

Define the configuration type:
<pre>
$delpoutput = 'linklist';
</pre>
Configure the links:
<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=files",
'mknname' => 'uplfile'
);
</pre>

====Subforms Option Example====

Define the configuration type:
<pre>
$delpoutput = 'subforms';
</pre>

Configure the linklist (in this case, a linklist is being used to display the upload files link and the sf_linklist is calling the link):
<pre>
$link_list_admin[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=files",
'mknname' => 'uplfile',
'img' => 'bigplus.png'
);
</pre>

Configure the subforms - Subform listing the modules:
<pre>
$delp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpmodlist',
'sf_html_id' => 'delpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'data_entry',
'fields' => array (
'cxt',
'smp',
'spf',
'sph',
)
);
</pre>
Admin Subform calling the file upload linklist from above:
<pre>
$delp_subform_admin =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpadmin',
'sf_html_id' => 'delpadmin', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_label' => 'space',
'op_input' => 'save',
'op_linktype' => 'icon',
'op_sf_cssclass' => 'module_list',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'fields' => $link_list_admin
);
</pre>
Load the subforms:
<pre>
$data_entry_left_panel =
array(
'col_id' => 'delp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$delp_subform_module,
$delp_subform_admin
)
);
</pre>

=== Data Entry Toolbar ===
Configure the tools for data entry. First form the individual buttons and displays:
==== User Navigation ====
<pre>
// Previous record button
$group_entry_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays site code
$group_entry_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays record number
$group_entry_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays module type
$group_entry_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record button
$group_entry_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Administrator tools ====
<pre>
// Delete record
$group_entry_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit module type
$group_entry_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chngmod',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_entry_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'DEL',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_entry_nav =
array(
'record_nav' => $group_entry_nav,
'record_admin' => $group_entry_admin,
);
</pre>

===Advanced File Upload===
The following includes instructions on how to configure the advanced file uploader which was developed as a mechanism for not only batch uploading files, but also registering and/or linking them to existing records on the fly.
*'''on''' - Set to TRUE, advanced file uploader dialog is displayed.
*'''pattern''' - This is a regex (Regular expression) designed to detect the file names and associate the files with the appropriate records (item_keys). These example expressions are set up to treat the first 3 letters of a file name as the relevant site code and the numbers following as the number. (For example: 'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-zA-Z0-9]*))\.[a-zA-Z]{2,4}\b/i" handles files xxx-1234.jpg, xxx-1234-yyy.jpg, where xxx can be any letter and yyy any alphanumeric combination, only number before first '-' is used as an ID)
<pre>
$fu =
array(
'on' => TRUE,
'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-z0-9A-Z]*))\.[a-z0-9]{2,4}\b/i",
);
</pre>

==Data View (Search)==
These settings configure the data view (or search) page. The data view requires configuration for the left panel, the search tools options (results views, download options, etc) as well as some general settings for search results.
===General Page Settings===
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>

And the number of pages to display on the data viewer:
<pre>
// Number of pages to display on the data viewer
$conf_num_res_pgs = 5; // best choose an odd number
</pre>

Also configure the index pages for Data View and Search pages:
<pre>
// 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 (options include: text, table, or map):
<pre>
// Default $output_mode for the data viewer
$default_output_mode = 'table';
</pre>
===Data View Left Panel===
This configures the left panel for the data view pages through a series of complex subforms including [[sf_linklist]], [[sf_buildfilter]], and [[sf_mysavedstuff]].
====Configure the linklist====
First configure the linklist, which requires the following:
*'''href''' - link to the output ({$_SERVER['PHP_SELF']} is on same page, and then links to the key ID in the relevant cor table of the designated data filter
*'''mknname''' - mark-up nickname will search the markup table for this nickname and print the markup
*'''img''' - optional image for the icon defined in the subform linklist:
<pre>
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=1&ftr_id=new",
'mknname' => 'filtercxt',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=6&ftr_id=new",
'mknname' => 'filtersmp',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=stecd&ftr_id=new",
'mknname' => 'filterstecd',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=action&ftr_id=new",
'mknname' => 'filteractor',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=ftx&ftr_id=new",
'mknname' => 'ftx',
'img' => 'view_mag.png'
);
</pre>

Configure the linklist subform:
<pre>
$dvlp_subform_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_linktype' => 'icon',
'op_sf_cssclass' => 'ftr_list',
'fields' => $link_list_filters
);
</pre>

====Filter Builders====
Various options exist for the types of filters administrators will want to make available to users- including different stages of pre-built or partially executed filters. For more information on this subform and options see [[sf_buildfilter]].
 
Subform for the filter builder to run in the left panel:
<pre>
$dvlp_filter_builder =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_condition' =>
array(
array(
'func'=> 'chkTmpFtr',
'args'=> FALSE
),
),
);
</pre>
Subform for the filter builder to run in the left panel preloaded with a filter:
<pre>
$dvlp_filter_builder_atridx =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_filter' => 'atr', // the filter to be used
'op_filter_args' =>
array(
// 'arg' => 'var', // example
'atrtype' => 1,
'op_display' => 'dd'
)
);

</pre>
Subform for user saved filters
<pre>
$dvlp_my_saved_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'savedfilters',
'sf_html_id' => 'dvlp_saved_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_mysavedstuff.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'op_sf_cssclass' => 'ftr_subform',
);
</pre>
Make a column to hold the subforms:
<pre>
$data_view_left_panel =
array(
'col_id' => 'dvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$dvlp_filter_builder,
$dvlp_filter_builder_atridx,
$dvlp_subform_filters,
$dvlp_my_saved_filters
)
);
</pre>

===Results Toolbar===
Configure the tools and display options for the search page (data_view). All of the toolbars require the following in the array:
*'''type''' - Options of 'img', 'text', or 'newpage' (used in the all record view to display function in a new page)
*'''href''' - The href link to the function being called
*'''css_class''' - The css class to style the button or display
*'''mkname''' - The name of markup contained within cor_tbl_markup used for buttons which combine text and images, are just text based. Set to FALSE if not used.
*'''lightbox''' - Option of using the lightbox when calling an overlay form, set to FALSE otherwise

First form the individual buttons:

==== Tools ====
<pre>
// TOOLS
$group_tools[] =
array(
'type' => 'img',
'href' => "overlay_holder.php?sf_conf=conf_mac_userconfigfields&lboxreload=1",
'css_class' => 'gears',
'mkname' => FALSE,
'lightbox' => 'lightbox'
);
</pre>

==== Displays ====
<pre>
// DISPs
$res = "results_mode=disp";
// Text view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=text",
'css_class' => 'text',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Table view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=table",
'css_class' => 'table',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Map view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=map",
'css_class' => 'map',
'mkname' => FALSE,
'lightbox' => FALSE
);
// All record view
$group_disp[] =
array(
'type' => 'newpage',
'href' => "resultsmicro_view.php?",
'css_class' => 'printall',
'mkname' => FALSE,
'lightbox' => FALSE
);
</pre>

==== Feeds ====
<pre>
// FEEDS
$res = "results_mode=feed";
// RSS feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=rss",
'css_class' => FALSE,
'mkname' => 'rss',
'lightbox' => FALSE
);
// Atom feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=atom",
'css_class' => FALSE,
'mkname' => 'atom',
'lightbox' => FALSE
);
</pre>

==== Downloads ====
<pre>
// DOWNLOADS
$res = "results_mode=dl";
// CSV download
$group_dls[] =
array(
'type' => 'text',
'href' => "overlay_holder.php?$res&dl_mode=csv&lboxreload=1&sf_conf=conf_mac_exportdownloadcsv",
'css_class' => FALSE,
'mkname' => 'csv',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_results_nav =
array(
'tools' => $group_tools,
'result_views' => $group_disp,
'result_feeds' => $group_feeds,
'result_downloads' => $group_dls,
);
</pre>
==Micro View (Record View)==
These settings configure the micro view (or record view) page. The micro view requires configuration for the left panel, and record nav options as well as some general settings.
===General Page Settings===
Configure the index page for the micro view:
<pre>
// Default Micro viewer page (used by search result handlers)
$conf_micro_viewer = $ark_dir."micro_view.php";
</pre>

===Micro View Left Panel===
Configures the left panel in the micro view pages, requires the administrator to configure the left panel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $mvlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'micro_view' in the [[sf_module]].

====Subforms Option Example====
Define the configuration type:
<pre>
$mvlpoutput = 'subforms';
</pre>
Configure the subform module to include the relevant modules:
<pre>
$mvlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'micro_view',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$micro_view_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$mvlp_subform_module
)
);
</pre>
===Record Toolbar===
Configure the tools for the record view toolbar. This tool bar controls what navigation and options which appear in data entry record toolbar.

==== Record Navigation ====
First form the individual buttons and displays:
<pre>
// Previous record
$group_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays current site code
$group_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays current record number
$group_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays current modtype
$group_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record
$group_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Refresh View ====
<pre>
// Refresh button
$group_refresh[] =
array(
'name' => 'refresh',
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?disp_reset=default",
'css_class' => 'refresh',
'mkname' => 'reset',
'lightbox' => FALSE
);
</pre>

==== Administrator Tools ====
<pre>
// ADMIN TOOLS
// Delete record
$group_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit modtype
$group_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgtype',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgkey',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_record_nav =
array(
'record_nav' => $group_nav,
'record_refresh' => $group_refresh,
'record_admin' => $group_admin,
);
</pre>

==Map View==
This is optional, but needs to be configured correctly if you are using the mapping capabilities of ARK. It needs to be set up like other top level pages, but also a series of settings need to be configured.

===Map View Page Settings===
The page needs to be set up like all other standard top-level pages. If not using, or if you would like it to be inaccessible in the dynamic navigation set 'is_visible' to FALSE.

<pre>
// MAP VIEW PAGE SETTINGS
$conf_page_map_view =
array(
'name' =>'Map View',
'title' => 'Map View Page',
'file' => 'map_view.php',
'sgrp' => '1',
'navname' => 'mapviewnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/map_view/',
'is_visible' => TRUE
);
</pre>

===Map View Left Panel===
The first subform is to allow saving of maps from the left panel, and the second to allow downloads of maps as PDFs.
<pre>
// LEFT PANEL
// Subforms
$conf_map_wmcoverlay =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'nmedit',
'sf_title' => 'wmcoverlay',
'sf_html_id' => 'map_wmcoverlay', // Must be unique
'script' => 'php/map_admin/subforms/sf_savewmc_overlay.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);

$conf_maptopdf =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'full',
'sf_title' => 'interp',
'sf_html_id' => 'map_maptopdf', // Must be unique
'script' => 'php/map_view/subforms/sf_maptopdf.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);
</pre>
===Map View Main===
These are a series of settings that define the query layers and query maps displayed in the map view as well as the results map view.
====Map Timeout====
Mapping timeout in milliseconds- if you are using a slow WxS server set this to be high (default is 1500).
<pre>
$map_timeout = 5000;
</pre>
====WXS Query Layers====
$wxs_qlayers: mapping layers for mods - specify in this array the names of the wms/wfs layers that contain the spatial data for each mod. Bear in mind that these layers should contain an ark_id column that can be retrieved using a getFeatureInfo request.
Each layer is a separate entry in the array containing an array of variables:

*mod - the mod of the item (without _cd) eg. 'cxt'
*geom - the geometry of the layer - eg. 'pt', 'pl' or 'pgn'
*url - the full url of the WMS/WFS server that is hosting the layer
*title_field - this is the field_id of the field that you want to be displayed during the click to query, if this is set to 'GIS' then it will return the attributes in the remote GIS attribute table.
<pre>
$wxs_qlayers =
array(
'sites' => array(
'mod' => 'cxt',
'geom' => 'pt',
'url' => 'http://localhost/ark/php/map/ark_wxs_server.php?',
'title_field' => 'conf_field_name',
'style_array' =>
array(
'fillOpacity' => 0.75,
'strokeColor' => '"black"',
'fillColor' => '"red"',
'pointRadius' => 10,
)
),
);
</pre>

===WXS Query Map===
$wxs_query_map - this is the name of a saved map (saved using the map_admin tools), that you want to be the background for the 'View Results as Map'. Admins should note: the $wxs_qlayers array is used to determine which layers can be used to display the spatial data for each mod - therefore those layers HAVE to be available in the saved $wxs_query_map. Also, the more info button - if you store information about your GIS layers as ARK items then set this to TRUE. Please note you will need to have a 'gis' module and you will need to name your WMS-served GIS layers in the format for instance,'contexts_PCO06_123'
<pre>
$wxs_query_map = 'QueryMap';

$map_more_info_button = FALSE;
</pre>

Page settings.php

2012-03-21T16:20:28Z

Jessogden: /* WXS Query Layers */

As of v1.0, all settings related to individual page displays, navigation, and toolbars are to be included in the [[page_settings.php]].
==Navigation==
===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',
'overlay_holder.php',
'export.php',
'alias_admin.php',
'markup_admin.php',
'import.php'
);
</pre>
===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>
==User Home==
These settings control the subforms and left panel in the user home. The user home needs configuration both for the left panel and for the subforms included in the main area.
===User Home Left Panel===
Configures the left panel in the user home pages, requires the administrator to configure the lpanel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $uhlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'user_home' in the [[sf_module]].
====Subforms Option Example====
Define the configuration type:
<pre>
$uhlpoutput = 'subforms';
</pre>
Configure the subform:
<pre>
$uhlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'user_home',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$user_home_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$uhlp_subform_module
)
);
</pre>
== Data Entry ==
These settings configure the data entry page. The data entry requires configuration for both the left panel and the record navigation bar appearing at the top of the main area. Further options for advanced file upload are also included below.
=== Data Entry Left Panel ===
This section gives examples for the left panel configuration in the data entry pages using either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation.
==== Minimiser Option ====
This tool condenses subforms and offers quick navigation in left panel. To use the minimiser on specific data entry pages you need to go to the mod_settings files (ex. mod_cxt_settings.php) and make sure that 'col_type' => 'collaps_col', instead of single_col in the $conf_dat_materi and $conf_dat_detfrm settings.
<pre>
$minimiser = TRUE;
</pre>

====Link list Option Example====

Define the configuration type:
<pre>
$delpoutput = 'linklist';
</pre>
Configure the links:
<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=files",
'mknname' => 'uplfile'
);
</pre>

====Subforms Option Example====

Define the configuration type:
<pre>
$delpoutput = 'subforms';
</pre>

Configure the linklist (in this case, a linklist is being used to display the upload files link and the sf_linklist is calling the link):
<pre>
$link_list_admin[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=files",
'mknname' => 'uplfile',
'img' => 'bigplus.png'
);
</pre>

Configure the subforms - Subform listing the modules:
<pre>
$delp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpmodlist',
'sf_html_id' => 'delpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'data_entry',
'fields' => array (
'cxt',
'smp',
'spf',
'sph',
)
);
</pre>
Admin Subform calling the file upload linklist from above:
<pre>
$delp_subform_admin =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpadmin',
'sf_html_id' => 'delpadmin', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_label' => 'space',
'op_input' => 'save',
'op_linktype' => 'icon',
'op_sf_cssclass' => 'module_list',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'fields' => $link_list_admin
);
</pre>
Load the subforms:
<pre>
$data_entry_left_panel =
array(
'col_id' => 'delp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$delp_subform_module,
$delp_subform_admin
)
);
</pre>

=== Data Entry Toolbar ===
Configure the tools for data entry. First form the individual buttons and displays:
==== User Navigation ====
<pre>
// Previous record button
$group_entry_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays site code
$group_entry_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays record number
$group_entry_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays module type
$group_entry_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record button
$group_entry_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Administrator tools ====
<pre>
// Delete record
$group_entry_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit module type
$group_entry_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chngmod',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_entry_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'DEL',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_entry_nav =
array(
'record_nav' => $group_entry_nav,
'record_admin' => $group_entry_admin,
);
</pre>

===Advanced File Upload===
The following includes instructions on how to configure the advanced file uploader which was developed as a mechanism for not only batch uploading files, but also registering and/or linking them to existing records on the fly.
*'''on''' - Set to TRUE, advanced file uploader dialog is displayed.
*'''pattern''' - This is a regex (Regular expression) designed to detect the file names and associate the files with the appropriate records (item_keys). These example expressions are set up to treat the first 3 letters of a file name as the relevant site code and the numbers following as the number. (For example: 'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-zA-Z0-9]*))\.[a-zA-Z]{2,4}\b/i" handles files xxx-1234.jpg, xxx-1234-yyy.jpg, where xxx can be any letter and yyy any alphanumeric combination, only number before first '-' is used as an ID)
<pre>
$fu =
array(
'on' => TRUE,
'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-z0-9A-Z]*))\.[a-z0-9]{2,4}\b/i",
);
</pre>

==Data View (Search)==
These settings configure the data view (or search) page. The data view requires configuration for the left panel, the search tools options (results views, download options, etc) as well as some general settings for search results.
===General Page Settings===
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>

And the number of pages to display on the data viewer:
<pre>
// Number of pages to display on the data viewer
$conf_num_res_pgs = 5; // best choose an odd number
</pre>

Also configure the index pages for Data View and Search pages:
<pre>
// 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 (options include: text, table, or map):
<pre>
// Default $output_mode for the data viewer
$default_output_mode = 'table';
</pre>
===Data View Left Panel===
This configures the left panel for the data view pages through a series of complex subforms including [[sf_linklist]], [[sf_buildfilter]], and [[sf_mysavedstuff]].
====Configure the linklist====
First configure the linklist, which requires the following:
*'''href''' - link to the output ({$_SERVER['PHP_SELF']} is on same page, and then links to the key ID in the relevant cor table of the designated data filter
*'''mknname''' - mark-up nickname will search the markup table for this nickname and print the markup
*'''img''' - optional image for the icon defined in the subform linklist:
<pre>
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=1&ftr_id=new",
'mknname' => 'filtercxt',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=6&ftr_id=new",
'mknname' => 'filtersmp',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=stecd&ftr_id=new",
'mknname' => 'filterstecd',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=action&ftr_id=new",
'mknname' => 'filteractor',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=ftx&ftr_id=new",
'mknname' => 'ftx',
'img' => 'view_mag.png'
);
</pre>

Configure the linklist subform:
<pre>
$dvlp_subform_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_linktype' => 'icon',
'op_sf_cssclass' => 'ftr_list',
'fields' => $link_list_filters
);
</pre>

====Filter Builders====
Various options exist for the types of filters administrators will want to make available to users- including different stages of pre-built or partially executed filters. For more information on this subform and options see [[sf_buildfilter]].
 
Subform for the filter builder to run in the left panel:
<pre>
$dvlp_filter_builder =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_condition' =>
array(
array(
'func'=> 'chkTmpFtr',
'args'=> FALSE
),
),
);
</pre>
Subform for the filter builder to run in the left panel preloaded with a filter:
<pre>
$dvlp_filter_builder_atridx =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_filter' => 'atr', // the filter to be used
'op_filter_args' =>
array(
// 'arg' => 'var', // example
'atrtype' => 1,
'op_display' => 'dd'
)
// 'op_condition' =>
// array(
// array(
// 'func'=> 'chkTmpFtr',
// 'args'=> FALSE
// ),
// ),
);

</pre>
Subform for user saved filters
<pre>
$dvlp_my_saved_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'savedfilters',
'sf_html_id' => 'dvlp_saved_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_mysavedstuff.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'op_sf_cssclass' => 'ftr_subform',
// 'op_condition' =>
// array(
// array(
// 'func'=> 'chkTmpFtr',
// 'args'=> FALSE
// ),
// ),
);
</pre>
Make a column to hold the subforms:
<pre>
$data_view_left_panel =
array(
'col_id' => 'dvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$dvlp_filter_builder,
$dvlp_filter_builder_atridx,
$dvlp_subform_filters,
$dvlp_my_saved_filters
)
);
</pre>

===Results Toolbar===
Configure the tools and display options for the search page (data_view). All of the toolbars require the following in the array:
*'''type''' - Options of 'img', 'text', or 'newpage' (used in the all record view to display function in a new page)
*'''href''' - The href link to the function being called
*'''css_class''' - The css class to style the button or display
*'''mkname''' - The name of markup contained within cor_tbl_markup used for buttons which combine text and images, are just text based. Set to FALSE if not used.
*'''lightbox''' - Option of using the lightbox when calling an overlay form, set to FALSE otherwise

First form the individual buttons:

==== Tools ====
<pre>
// TOOLS
$group_tools[] =
array(
'type' => 'img',
'href' => "overlay_holder.php?sf_conf=conf_mac_userconfigfields&lboxreload=1",
'css_class' => 'gears',
'mkname' => FALSE,
'lightbox' => 'lightbox'
);
</pre>

==== Displays ====
<pre>
// DISPs
$res = "results_mode=disp";
// Text view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=text",
'css_class' => 'text',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Table view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=table",
'css_class' => 'table',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Map view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=map",
'css_class' => 'map',
'mkname' => FALSE,
'lightbox' => FALSE
);
// All record view
$group_disp[] =
array(
'type' => 'newpage',
'href' => "resultsmicro_view.php?",
'css_class' => 'printall',
'mkname' => FALSE,
'lightbox' => FALSE
);
</pre>

==== Feeds ====
<pre>
// FEEDS
$res = "results_mode=feed";
// RSS feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=rss",
'css_class' => FALSE,
'mkname' => 'rss',
'lightbox' => FALSE
);
// Atom feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=atom",
'css_class' => FALSE,
'mkname' => 'atom',
'lightbox' => FALSE
);
</pre>

==== Downloads ====
<pre>
// DOWNLOADS
$res = "results_mode=dl";
// CSV download
$group_dls[] =
array(
'type' => 'text',
'href' => "overlay_holder.php?$res&dl_mode=csv&lboxreload=1&sf_conf=conf_mac_exportdownloadcsv",
'css_class' => FALSE,
'mkname' => 'csv',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_results_nav =
array(
'tools' => $group_tools,
'result_views' => $group_disp,
'result_feeds' => $group_feeds,
'result_downloads' => $group_dls,
);
</pre>
==Micro View (Record View)==
These settings configure the micro view (or record view) page. The micro view requires configuration for the left panel, and record nav options as well as some general settings.
===General Page Settings===
Configure the index page for the micro view:
<pre>
// Default Micro viewer page (used by search result handlers)
$conf_micro_viewer = $ark_dir."micro_view.php";
</pre>

===Micro View Left Panel===
Configures the left panel in the micro view pages, requires the administrator to configure the left panel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $mvlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'micro_view' in the [[sf_module]].

====Subforms Option Example====
Define the configuration type:
<pre>
$mvlpoutput = 'subforms';
</pre>
Configure the subform module to include the relevant modules:
<pre>
$mvlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'micro_view',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$micro_view_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$mvlp_subform_module
)
);
</pre>
===Record Toolbar===
Configure the tools for the record view toolbar. This tool bar controls what navigation and options which appear in data entry record toolbar.

==== Record Navigation ====
First form the individual buttons and displays:
<pre>
// Previous record
$group_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays current site code
$group_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays current record number
$group_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays current modtype
$group_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record
$group_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Refresh View ====
<pre>
// Refresh button
$group_refresh[] =
array(
'name' => 'refresh',
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?disp_reset=default",
'css_class' => 'refresh',
'mkname' => 'reset',
'lightbox' => FALSE
);
</pre>

==== Administrator Tools ====
<pre>
// ADMIN TOOLS
// Delete record
$group_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit modtype
$group_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgtype',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgkey',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_record_nav =
array(
'record_nav' => $group_nav,
'record_refresh' => $group_refresh,
'record_admin' => $group_admin,
);
</pre>

==Map View==
This is optional, but needs to be configured correctly if you are using the mapping capabilities of ARK. It needs to be set up like other top level pages, but also a series of settings need to be configured.

===Map View Page Settings===
The page needs to be set up like all other standard top-level pages. If not using, or if you would like it to be inaccessible in the dynamic navigation set 'is_visible' to FALSE.

<pre>
// MAP VIEW PAGE SETTINGS
$conf_page_map_view =
array(
'name' =>'Map View',
'title' => 'Map View Page',
'file' => 'map_view.php',
'sgrp' => '1',
'navname' => 'mapviewnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/map_view/',
'is_visible' => TRUE
);
</pre>

===Map View Left Panel===
The first subform is to allow saving of maps from the left panel, and the second to allow downloads of maps as PDFs.
<pre>
// LEFT PANEL
// Subforms
$conf_map_wmcoverlay =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'nmedit',
'sf_title' => 'wmcoverlay',
'sf_html_id' => 'map_wmcoverlay', // Must be unique
'script' => 'php/map_admin/subforms/sf_savewmc_overlay.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);

$conf_maptopdf =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'full',
'sf_title' => 'interp',
'sf_html_id' => 'map_maptopdf', // Must be unique
'script' => 'php/map_view/subforms/sf_maptopdf.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);
</pre>
===Map View Main===
These are a series of settings that define the query layers and query maps displayed in the map view as well as the results map view.
====Map Timeout====
Mapping timeout in milliseconds- if you are using a slow WxS server set this to be high (default is 1500).
<pre>
$map_timeout = 5000;
</pre>
====WXS Query Layers====
$wxs_qlayers: mapping layers for mods - specify in this array the names of the wms/wfs layers that contain the spatial data for each mod. Bear in mind that these layers should contain an ark_id column that can be retrieved using a getFeatureInfo request.
Each layer is a separate entry in the array containing an array of variables:

*mod - the mod of the item (without _cd) eg. 'cxt'
*geom - the geometry of the layer - eg. 'pt', 'pl' or 'pgn'
*url - the full url of the WMS/WFS server that is hosting the layer
*title_field - this is the field_id of the field that you want to be displayed during the click to query, if this is set to 'GIS' then it will return the attributes in the remote GIS attribute table.
<pre>
$wxs_qlayers =
array(
'sites' => array(
'mod' => 'cxt',
'geom' => 'pt',
'url' => 'http://localhost/ark/php/map/ark_wxs_server.php?',
'title_field' => 'conf_field_name',
'style_array' =>
array(
'fillOpacity' => 0.75,
'strokeColor' => '"black"',
'fillColor' => '"red"',
'pointRadius' => 10,
)
),
);
</pre>

===WXS Query Map===
$wxs_query_map - this is the name of a saved map (saved using the map_admin tools), that you want to be the background for the 'View Results as Map'. Admins should note: the $wxs_qlayers array is used to determine which layers can be used to display the spatial data for each mod - therefore those layers HAVE to be available in the saved $wxs_query_map. Also, the more info button - if you store information about your GIS layers as ARK items then set this to TRUE. Please note you will need to have a 'gis' module and you will need to name your WMS-served GIS layers in the format for instance,'contexts_PCO06_123'
<pre>
$wxs_query_map = 'QueryMap';

$map_more_info_button = FALSE;
</pre>

Page settings.php

2012-03-21T16:18:00Z

Jessogden: /* WXS Query Layers */

As of v1.0, all settings related to individual page displays, navigation, and toolbars are to be included in the [[page_settings.php]].
==Navigation==
===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',
'overlay_holder.php',
'export.php',
'alias_admin.php',
'markup_admin.php',
'import.php'
);
</pre>
===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>
==User Home==
These settings control the subforms and left panel in the user home. The user home needs configuration both for the left panel and for the subforms included in the main area.
===User Home Left Panel===
Configures the left panel in the user home pages, requires the administrator to configure the lpanel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $uhlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'user_home' in the [[sf_module]].
====Subforms Option Example====
Define the configuration type:
<pre>
$uhlpoutput = 'subforms';
</pre>
Configure the subform:
<pre>
$uhlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'user_home',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$user_home_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$uhlp_subform_module
)
);
</pre>
== Data Entry ==
These settings configure the data entry page. The data entry requires configuration for both the left panel and the record navigation bar appearing at the top of the main area. Further options for advanced file upload are also included below.
=== Data Entry Left Panel ===
This section gives examples for the left panel configuration in the data entry pages using either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation.
==== Minimiser Option ====
This tool condenses subforms and offers quick navigation in left panel. To use the minimiser on specific data entry pages you need to go to the mod_settings files (ex. mod_cxt_settings.php) and make sure that 'col_type' => 'collaps_col', instead of single_col in the $conf_dat_materi and $conf_dat_detfrm settings.
<pre>
$minimiser = TRUE;
</pre>

====Link list Option Example====

Define the configuration type:
<pre>
$delpoutput = 'linklist';
</pre>
Configure the links:
<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=files",
'mknname' => 'uplfile'
);
</pre>

====Subforms Option Example====

Define the configuration type:
<pre>
$delpoutput = 'subforms';
</pre>

Configure the linklist (in this case, a linklist is being used to display the upload files link and the sf_linklist is calling the link):
<pre>
$link_list_admin[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=files",
'mknname' => 'uplfile',
'img' => 'bigplus.png'
);
</pre>

Configure the subforms - Subform listing the modules:
<pre>
$delp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpmodlist',
'sf_html_id' => 'delpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'data_entry',
'fields' => array (
'cxt',
'smp',
'spf',
'sph',
)
);
</pre>
Admin Subform calling the file upload linklist from above:
<pre>
$delp_subform_admin =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpadmin',
'sf_html_id' => 'delpadmin', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_label' => 'space',
'op_input' => 'save',
'op_linktype' => 'icon',
'op_sf_cssclass' => 'module_list',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'fields' => $link_list_admin
);
</pre>
Load the subforms:
<pre>
$data_entry_left_panel =
array(
'col_id' => 'delp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$delp_subform_module,
$delp_subform_admin
)
);
</pre>

=== Data Entry Toolbar ===
Configure the tools for data entry. First form the individual buttons and displays:
==== User Navigation ====
<pre>
// Previous record button
$group_entry_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays site code
$group_entry_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays record number
$group_entry_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays module type
$group_entry_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record button
$group_entry_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Administrator tools ====
<pre>
// Delete record
$group_entry_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit module type
$group_entry_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chngmod',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_entry_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'DEL',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_entry_nav =
array(
'record_nav' => $group_entry_nav,
'record_admin' => $group_entry_admin,
);
</pre>

===Advanced File Upload===
The following includes instructions on how to configure the advanced file uploader which was developed as a mechanism for not only batch uploading files, but also registering and/or linking them to existing records on the fly.
*'''on''' - Set to TRUE, advanced file uploader dialog is displayed.
*'''pattern''' - This is a regex (Regular expression) designed to detect the file names and associate the files with the appropriate records (item_keys). These example expressions are set up to treat the first 3 letters of a file name as the relevant site code and the numbers following as the number. (For example: 'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-zA-Z0-9]*))\.[a-zA-Z]{2,4}\b/i" handles files xxx-1234.jpg, xxx-1234-yyy.jpg, where xxx can be any letter and yyy any alphanumeric combination, only number before first '-' is used as an ID)
<pre>
$fu =
array(
'on' => TRUE,
'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-z0-9A-Z]*))\.[a-z0-9]{2,4}\b/i",
);
</pre>

==Data View (Search)==
These settings configure the data view (or search) page. The data view requires configuration for the left panel, the search tools options (results views, download options, etc) as well as some general settings for search results.
===General Page Settings===
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>

And the number of pages to display on the data viewer:
<pre>
// Number of pages to display on the data viewer
$conf_num_res_pgs = 5; // best choose an odd number
</pre>

Also configure the index pages for Data View and Search pages:
<pre>
// 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 (options include: text, table, or map):
<pre>
// Default $output_mode for the data viewer
$default_output_mode = 'table';
</pre>
===Data View Left Panel===
This configures the left panel for the data view pages through a series of complex subforms including [[sf_linklist]], [[sf_buildfilter]], and [[sf_mysavedstuff]].
====Configure the linklist====
First configure the linklist, which requires the following:
*'''href''' - link to the output ({$_SERVER['PHP_SELF']} is on same page, and then links to the key ID in the relevant cor table of the designated data filter
*'''mknname''' - mark-up nickname will search the markup table for this nickname and print the markup
*'''img''' - optional image for the icon defined in the subform linklist:
<pre>
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=1&ftr_id=new",
'mknname' => 'filtercxt',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=6&ftr_id=new",
'mknname' => 'filtersmp',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=stecd&ftr_id=new",
'mknname' => 'filterstecd',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=action&ftr_id=new",
'mknname' => 'filteractor',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=ftx&ftr_id=new",
'mknname' => 'ftx',
'img' => 'view_mag.png'
);
</pre>

Configure the linklist subform:
<pre>
$dvlp_subform_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_linktype' => 'icon',
'op_sf_cssclass' => 'ftr_list',
'fields' => $link_list_filters
);
</pre>

====Filter Builders====
Various options exist for the types of filters administrators will want to make available to users- including different stages of pre-built or partially executed filters. For more information on this subform and options see [[sf_buildfilter]].
 
Subform for the filter builder to run in the left panel:
<pre>
$dvlp_filter_builder =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_condition' =>
array(
array(
'func'=> 'chkTmpFtr',
'args'=> FALSE
),
),
);
</pre>
Subform for the filter builder to run in the left panel preloaded with a filter:
<pre>
$dvlp_filter_builder_atridx =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_filter' => 'atr', // the filter to be used
'op_filter_args' =>
array(
// 'arg' => 'var', // example
'atrtype' => 1,
'op_display' => 'dd'
)
// 'op_condition' =>
// array(
// array(
// 'func'=> 'chkTmpFtr',
// 'args'=> FALSE
// ),
// ),
);

</pre>
Subform for user saved filters
<pre>
$dvlp_my_saved_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'savedfilters',
'sf_html_id' => 'dvlp_saved_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_mysavedstuff.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'op_sf_cssclass' => 'ftr_subform',
// 'op_condition' =>
// array(
// array(
// 'func'=> 'chkTmpFtr',
// 'args'=> FALSE
// ),
// ),
);
</pre>
Make a column to hold the subforms:
<pre>
$data_view_left_panel =
array(
'col_id' => 'dvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$dvlp_filter_builder,
$dvlp_filter_builder_atridx,
$dvlp_subform_filters,
$dvlp_my_saved_filters
)
);
</pre>

===Results Toolbar===
Configure the tools and display options for the search page (data_view). All of the toolbars require the following in the array:
*'''type''' - Options of 'img', 'text', or 'newpage' (used in the all record view to display function in a new page)
*'''href''' - The href link to the function being called
*'''css_class''' - The css class to style the button or display
*'''mkname''' - The name of markup contained within cor_tbl_markup used for buttons which combine text and images, are just text based. Set to FALSE if not used.
*'''lightbox''' - Option of using the lightbox when calling an overlay form, set to FALSE otherwise

First form the individual buttons:

==== Tools ====
<pre>
// TOOLS
$group_tools[] =
array(
'type' => 'img',
'href' => "overlay_holder.php?sf_conf=conf_mac_userconfigfields&lboxreload=1",
'css_class' => 'gears',
'mkname' => FALSE,
'lightbox' => 'lightbox'
);
</pre>

==== Displays ====
<pre>
// DISPs
$res = "results_mode=disp";
// Text view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=text",
'css_class' => 'text',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Table view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=table",
'css_class' => 'table',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Map view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=map",
'css_class' => 'map',
'mkname' => FALSE,
'lightbox' => FALSE
);
// All record view
$group_disp[] =
array(
'type' => 'newpage',
'href' => "resultsmicro_view.php?",
'css_class' => 'printall',
'mkname' => FALSE,
'lightbox' => FALSE
);
</pre>

==== Feeds ====
<pre>
// FEEDS
$res = "results_mode=feed";
// RSS feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=rss",
'css_class' => FALSE,
'mkname' => 'rss',
'lightbox' => FALSE
);
// Atom feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=atom",
'css_class' => FALSE,
'mkname' => 'atom',
'lightbox' => FALSE
);
</pre>

==== Downloads ====
<pre>
// DOWNLOADS
$res = "results_mode=dl";
// CSV download
$group_dls[] =
array(
'type' => 'text',
'href' => "overlay_holder.php?$res&dl_mode=csv&lboxreload=1&sf_conf=conf_mac_exportdownloadcsv",
'css_class' => FALSE,
'mkname' => 'csv',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_results_nav =
array(
'tools' => $group_tools,
'result_views' => $group_disp,
'result_feeds' => $group_feeds,
'result_downloads' => $group_dls,
);
</pre>
==Micro View (Record View)==
These settings configure the micro view (or record view) page. The micro view requires configuration for the left panel, and record nav options as well as some general settings.
===General Page Settings===
Configure the index page for the micro view:
<pre>
// Default Micro viewer page (used by search result handlers)
$conf_micro_viewer = $ark_dir."micro_view.php";
</pre>

===Micro View Left Panel===
Configures the left panel in the micro view pages, requires the administrator to configure the left panel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $mvlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'micro_view' in the [[sf_module]].

====Subforms Option Example====
Define the configuration type:
<pre>
$mvlpoutput = 'subforms';
</pre>
Configure the subform module to include the relevant modules:
<pre>
$mvlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'micro_view',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$micro_view_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$mvlp_subform_module
)
);
</pre>
===Record Toolbar===
Configure the tools for the record view toolbar. This tool bar controls what navigation and options which appear in data entry record toolbar.

==== Record Navigation ====
First form the individual buttons and displays:
<pre>
// Previous record
$group_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays current site code
$group_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays current record number
$group_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays current modtype
$group_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record
$group_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Refresh View ====
<pre>
// Refresh button
$group_refresh[] =
array(
'name' => 'refresh',
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?disp_reset=default",
'css_class' => 'refresh',
'mkname' => 'reset',
'lightbox' => FALSE
);
</pre>

==== Administrator Tools ====
<pre>
// ADMIN TOOLS
// Delete record
$group_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit modtype
$group_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgtype',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgkey',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_record_nav =
array(
'record_nav' => $group_nav,
'record_refresh' => $group_refresh,
'record_admin' => $group_admin,
);
</pre>

==Map View==
This is optional, but needs to be configured correctly if you are using the mapping capabilities of ARK. It needs to be set up like other top level pages, but also a series of settings need to be configured.

===Map View Page Settings===
The page needs to be set up like all other standard top-level pages. If not using, or if you would like it to be inaccessible in the dynamic navigation set 'is_visible' to FALSE.

<pre>
// MAP VIEW PAGE SETTINGS
$conf_page_map_view =
array(
'name' =>'Map View',
'title' => 'Map View Page',
'file' => 'map_view.php',
'sgrp' => '1',
'navname' => 'mapviewnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/map_view/',
'is_visible' => TRUE
);
</pre>

===Map View Left Panel===
The first subform is to allow saving of maps from the left panel, and the second to allow downloads of maps as PDFs.
<pre>
// LEFT PANEL
// Subforms
$conf_map_wmcoverlay =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'nmedit',
'sf_title' => 'wmcoverlay',
'sf_html_id' => 'map_wmcoverlay', // Must be unique
'script' => 'php/map_admin/subforms/sf_savewmc_overlay.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);

$conf_maptopdf =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'full',
'sf_title' => 'interp',
'sf_html_id' => 'map_maptopdf', // Must be unique
'script' => 'php/map_view/subforms/sf_maptopdf.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);
</pre>
===Map View Main===
These are a series of settings that define the query layers and query maps displayed in the map view as well as the results map view.
====Map Timeout====
Mapping timeout in milliseconds- if you are using a slow WxS server set this to be high (default is 1500).
<pre>
$map_timeout = 5000;
</pre>
====WXS Query Layers====
Each layer is a separate entry in the array containing an array of variables:
*mod - the mod of the item (without _cd) eg. 'cxt'
*geom - the geometry of the layer - eg. 'pt', 'pl' or 'pgn'
*url - the full url of the WMS/WFS server that is hosting the layer eg. http://localhost/ark/php/map/ark_wxs_server.php?
*title_field - this is the field_id of the field that you want to be displayed during the click to query, if this is set to 'GIS' then it will return the attributes in the remote GIS attribute table.

$wxs_qlayers: mapping layers for mods - specify in this array the names of the wms/wfs layers that contain the spatial data for each mod. Bear in mind that these layers should contain an ark_id column that can be retrieved using a getFeatureInfo request.

<pre>
$wxs_qlayers =
array(
'sites' => array(
'mod' => 'cxt',
'geom' => 'pt',
'url' => 'http://localhost/ark/php/map/ark_wxs_server.php?',
'title_field' => 'conf_field_name',
'style_array' =>
array(
'fillOpacity' => 0.75,
'strokeColor' => '"black"',
'fillColor' => '"red"',
'pointRadius' => 10,
)
),
);
</pre>

===WXS Query Map===
$wxs_query_map - this is the name of a saved map (saved using the map_admin tools), that you want to be the background for the 'View Results as Map'. Admins should note: the $wxs_qlayers array is used to determine which layers can be used to display the spatial data for each mod - therefore those layers HAVE to be available in the saved $wxs_query_map. Also, the more info button - if you store information about your GIS layers as ARK items then set this to TRUE. Please note you will need to have a 'gis' module and you will need to name your WMS-served GIS layers in the format for instance,'contexts_PCO06_123'
<pre>
$wxs_query_map = 'QueryMap';

$map_more_info_button = FALSE;
</pre>

Page settings.php

2012-03-21T16:17:45Z

Jessogden: /* WXS Query Layers */

As of v1.0, all settings related to individual page displays, navigation, and toolbars are to be included in the [[page_settings.php]].
==Navigation==
===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',
'overlay_holder.php',
'export.php',
'alias_admin.php',
'markup_admin.php',
'import.php'
);
</pre>
===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>
==User Home==
These settings control the subforms and left panel in the user home. The user home needs configuration both for the left panel and for the subforms included in the main area.
===User Home Left Panel===
Configures the left panel in the user home pages, requires the administrator to configure the lpanel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $uhlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'user_home' in the [[sf_module]].
====Subforms Option Example====
Define the configuration type:
<pre>
$uhlpoutput = 'subforms';
</pre>
Configure the subform:
<pre>
$uhlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'user_home',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$user_home_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$uhlp_subform_module
)
);
</pre>
== Data Entry ==
These settings configure the data entry page. The data entry requires configuration for both the left panel and the record navigation bar appearing at the top of the main area. Further options for advanced file upload are also included below.
=== Data Entry Left Panel ===
This section gives examples for the left panel configuration in the data entry pages using either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation.
==== Minimiser Option ====
This tool condenses subforms and offers quick navigation in left panel. To use the minimiser on specific data entry pages you need to go to the mod_settings files (ex. mod_cxt_settings.php) and make sure that 'col_type' => 'collaps_col', instead of single_col in the $conf_dat_materi and $conf_dat_detfrm settings.
<pre>
$minimiser = TRUE;
</pre>

====Link list Option Example====

Define the configuration type:
<pre>
$delpoutput = 'linklist';
</pre>
Configure the links:
<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=files",
'mknname' => 'uplfile'
);
</pre>

====Subforms Option Example====

Define the configuration type:
<pre>
$delpoutput = 'subforms';
</pre>

Configure the linklist (in this case, a linklist is being used to display the upload files link and the sf_linklist is calling the link):
<pre>
$link_list_admin[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=files",
'mknname' => 'uplfile',
'img' => 'bigplus.png'
);
</pre>

Configure the subforms - Subform listing the modules:
<pre>
$delp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpmodlist',
'sf_html_id' => 'delpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'data_entry',
'fields' => array (
'cxt',
'smp',
'spf',
'sph',
)
);
</pre>
Admin Subform calling the file upload linklist from above:
<pre>
$delp_subform_admin =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpadmin',
'sf_html_id' => 'delpadmin', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_label' => 'space',
'op_input' => 'save',
'op_linktype' => 'icon',
'op_sf_cssclass' => 'module_list',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'fields' => $link_list_admin
);
</pre>
Load the subforms:
<pre>
$data_entry_left_panel =
array(
'col_id' => 'delp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$delp_subform_module,
$delp_subform_admin
)
);
</pre>

=== Data Entry Toolbar ===
Configure the tools for data entry. First form the individual buttons and displays:
==== User Navigation ====
<pre>
// Previous record button
$group_entry_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays site code
$group_entry_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays record number
$group_entry_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays module type
$group_entry_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record button
$group_entry_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Administrator tools ====
<pre>
// Delete record
$group_entry_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit module type
$group_entry_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chngmod',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_entry_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'DEL',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_entry_nav =
array(
'record_nav' => $group_entry_nav,
'record_admin' => $group_entry_admin,
);
</pre>

===Advanced File Upload===
The following includes instructions on how to configure the advanced file uploader which was developed as a mechanism for not only batch uploading files, but also registering and/or linking them to existing records on the fly.
*'''on''' - Set to TRUE, advanced file uploader dialog is displayed.
*'''pattern''' - This is a regex (Regular expression) designed to detect the file names and associate the files with the appropriate records (item_keys). These example expressions are set up to treat the first 3 letters of a file name as the relevant site code and the numbers following as the number. (For example: 'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-zA-Z0-9]*))\.[a-zA-Z]{2,4}\b/i" handles files xxx-1234.jpg, xxx-1234-yyy.jpg, where xxx can be any letter and yyy any alphanumeric combination, only number before first '-' is used as an ID)
<pre>
$fu =
array(
'on' => TRUE,
'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-z0-9A-Z]*))\.[a-z0-9]{2,4}\b/i",
);
</pre>

==Data View (Search)==
These settings configure the data view (or search) page. The data view requires configuration for the left panel, the search tools options (results views, download options, etc) as well as some general settings for search results.
===General Page Settings===
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>

And the number of pages to display on the data viewer:
<pre>
// Number of pages to display on the data viewer
$conf_num_res_pgs = 5; // best choose an odd number
</pre>

Also configure the index pages for Data View and Search pages:
<pre>
// 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 (options include: text, table, or map):
<pre>
// Default $output_mode for the data viewer
$default_output_mode = 'table';
</pre>
===Data View Left Panel===
This configures the left panel for the data view pages through a series of complex subforms including [[sf_linklist]], [[sf_buildfilter]], and [[sf_mysavedstuff]].
====Configure the linklist====
First configure the linklist, which requires the following:
*'''href''' - link to the output ({$_SERVER['PHP_SELF']} is on same page, and then links to the key ID in the relevant cor table of the designated data filter
*'''mknname''' - mark-up nickname will search the markup table for this nickname and print the markup
*'''img''' - optional image for the icon defined in the subform linklist:
<pre>
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=1&ftr_id=new",
'mknname' => 'filtercxt',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=6&ftr_id=new",
'mknname' => 'filtersmp',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=stecd&ftr_id=new",
'mknname' => 'filterstecd',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=action&ftr_id=new",
'mknname' => 'filteractor',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=ftx&ftr_id=new",
'mknname' => 'ftx',
'img' => 'view_mag.png'
);
</pre>

Configure the linklist subform:
<pre>
$dvlp_subform_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_linktype' => 'icon',
'op_sf_cssclass' => 'ftr_list',
'fields' => $link_list_filters
);
</pre>

====Filter Builders====
Various options exist for the types of filters administrators will want to make available to users- including different stages of pre-built or partially executed filters. For more information on this subform and options see [[sf_buildfilter]].
 
Subform for the filter builder to run in the left panel:
<pre>
$dvlp_filter_builder =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_condition' =>
array(
array(
'func'=> 'chkTmpFtr',
'args'=> FALSE
),
),
);
</pre>
Subform for the filter builder to run in the left panel preloaded with a filter:
<pre>
$dvlp_filter_builder_atridx =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_filter' => 'atr', // the filter to be used
'op_filter_args' =>
array(
// 'arg' => 'var', // example
'atrtype' => 1,
'op_display' => 'dd'
)
// 'op_condition' =>
// array(
// array(
// 'func'=> 'chkTmpFtr',
// 'args'=> FALSE
// ),
// ),
);

</pre>
Subform for user saved filters
<pre>
$dvlp_my_saved_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'savedfilters',
'sf_html_id' => 'dvlp_saved_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_mysavedstuff.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'op_sf_cssclass' => 'ftr_subform',
// 'op_condition' =>
// array(
// array(
// 'func'=> 'chkTmpFtr',
// 'args'=> FALSE
// ),
// ),
);
</pre>
Make a column to hold the subforms:
<pre>
$data_view_left_panel =
array(
'col_id' => 'dvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$dvlp_filter_builder,
$dvlp_filter_builder_atridx,
$dvlp_subform_filters,
$dvlp_my_saved_filters
)
);
</pre>

===Results Toolbar===
Configure the tools and display options for the search page (data_view). All of the toolbars require the following in the array:
*'''type''' - Options of 'img', 'text', or 'newpage' (used in the all record view to display function in a new page)
*'''href''' - The href link to the function being called
*'''css_class''' - The css class to style the button or display
*'''mkname''' - The name of markup contained within cor_tbl_markup used for buttons which combine text and images, are just text based. Set to FALSE if not used.
*'''lightbox''' - Option of using the lightbox when calling an overlay form, set to FALSE otherwise

First form the individual buttons:

==== Tools ====
<pre>
// TOOLS
$group_tools[] =
array(
'type' => 'img',
'href' => "overlay_holder.php?sf_conf=conf_mac_userconfigfields&lboxreload=1",
'css_class' => 'gears',
'mkname' => FALSE,
'lightbox' => 'lightbox'
);
</pre>

==== Displays ====
<pre>
// DISPs
$res = "results_mode=disp";
// Text view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=text",
'css_class' => 'text',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Table view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=table",
'css_class' => 'table',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Map view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=map",
'css_class' => 'map',
'mkname' => FALSE,
'lightbox' => FALSE
);
// All record view
$group_disp[] =
array(
'type' => 'newpage',
'href' => "resultsmicro_view.php?",
'css_class' => 'printall',
'mkname' => FALSE,
'lightbox' => FALSE
);
</pre>

==== Feeds ====
<pre>
// FEEDS
$res = "results_mode=feed";
// RSS feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=rss",
'css_class' => FALSE,
'mkname' => 'rss',
'lightbox' => FALSE
);
// Atom feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=atom",
'css_class' => FALSE,
'mkname' => 'atom',
'lightbox' => FALSE
);
</pre>

==== Downloads ====
<pre>
// DOWNLOADS
$res = "results_mode=dl";
// CSV download
$group_dls[] =
array(
'type' => 'text',
'href' => "overlay_holder.php?$res&dl_mode=csv&lboxreload=1&sf_conf=conf_mac_exportdownloadcsv",
'css_class' => FALSE,
'mkname' => 'csv',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_results_nav =
array(
'tools' => $group_tools,
'result_views' => $group_disp,
'result_feeds' => $group_feeds,
'result_downloads' => $group_dls,
);
</pre>
==Micro View (Record View)==
These settings configure the micro view (or record view) page. The micro view requires configuration for the left panel, and record nav options as well as some general settings.
===General Page Settings===
Configure the index page for the micro view:
<pre>
// Default Micro viewer page (used by search result handlers)
$conf_micro_viewer = $ark_dir."micro_view.php";
</pre>

===Micro View Left Panel===
Configures the left panel in the micro view pages, requires the administrator to configure the left panel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $mvlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'micro_view' in the [[sf_module]].

====Subforms Option Example====
Define the configuration type:
<pre>
$mvlpoutput = 'subforms';
</pre>
Configure the subform module to include the relevant modules:
<pre>
$mvlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'micro_view',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$micro_view_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$mvlp_subform_module
)
);
</pre>
===Record Toolbar===
Configure the tools for the record view toolbar. This tool bar controls what navigation and options which appear in data entry record toolbar.

==== Record Navigation ====
First form the individual buttons and displays:
<pre>
// Previous record
$group_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays current site code
$group_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays current record number
$group_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays current modtype
$group_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record
$group_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Refresh View ====
<pre>
// Refresh button
$group_refresh[] =
array(
'name' => 'refresh',
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?disp_reset=default",
'css_class' => 'refresh',
'mkname' => 'reset',
'lightbox' => FALSE
);
</pre>

==== Administrator Tools ====
<pre>
// ADMIN TOOLS
// Delete record
$group_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit modtype
$group_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgtype',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgkey',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_record_nav =
array(
'record_nav' => $group_nav,
'record_refresh' => $group_refresh,
'record_admin' => $group_admin,
);
</pre>

==Map View==
This is optional, but needs to be configured correctly if you are using the mapping capabilities of ARK. It needs to be set up like other top level pages, but also a series of settings need to be configured.

===Map View Page Settings===
The page needs to be set up like all other standard top-level pages. If not using, or if you would like it to be inaccessible in the dynamic navigation set 'is_visible' to FALSE.

<pre>
// MAP VIEW PAGE SETTINGS
$conf_page_map_view =
array(
'name' =>'Map View',
'title' => 'Map View Page',
'file' => 'map_view.php',
'sgrp' => '1',
'navname' => 'mapviewnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/map_view/',
'is_visible' => TRUE
);
</pre>

===Map View Left Panel===
The first subform is to allow saving of maps from the left panel, and the second to allow downloads of maps as PDFs.
<pre>
// LEFT PANEL
// Subforms
$conf_map_wmcoverlay =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'nmedit',
'sf_title' => 'wmcoverlay',
'sf_html_id' => 'map_wmcoverlay', // Must be unique
'script' => 'php/map_admin/subforms/sf_savewmc_overlay.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);

$conf_maptopdf =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'full',
'sf_title' => 'interp',
'sf_html_id' => 'map_maptopdf', // Must be unique
'script' => 'php/map_view/subforms/sf_maptopdf.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);
</pre>
===Map View Main===
These are a series of settings that define the query layers and query maps displayed in the map view as well as the results map view.
====Map Timeout====
Mapping timeout in milliseconds- if you are using a slow WxS server set this to be high (default is 1500).
<pre>
$map_timeout = 5000;
</pre>
====WXS Query Layers====
$wxs_qlayers: mapping layers for mods - specify in this array the names of the wms/wfs layers that contain the spatial data for each mod. Bear in mind that these layers should contain an ark_id column that can be retrieved using a getFeatureInfo request.

<pre>
$wxs_qlayers =
array(
'sites' => array(
'mod' => 'cxt',
'geom' => 'pt',
'url' => 'http://localhost/ark/php/map/ark_wxs_server.php?',
'title_field' => 'conf_field_name',
'style_array' =>
array(
'fillOpacity' => 0.75,
'strokeColor' => '"black"',
'fillColor' => '"red"',
'pointRadius' => 10,
)
),
);
</pre>

===WXS Query Map===
$wxs_query_map - this is the name of a saved map (saved using the map_admin tools), that you want to be the background for the 'View Results as Map'. Admins should note: the $wxs_qlayers array is used to determine which layers can be used to display the spatial data for each mod - therefore those layers HAVE to be available in the saved $wxs_query_map. Also, the more info button - if you store information about your GIS layers as ARK items then set this to TRUE. Please note you will need to have a 'gis' module and you will need to name your WMS-served GIS layers in the format for instance,'contexts_PCO06_123'
<pre>
$wxs_query_map = 'QueryMap';

$map_more_info_button = FALSE;
</pre>

Page settings.php

2012-03-21T16:17:04Z

Jessogden: /* WXS Query Layers */

As of v1.0, all settings related to individual page displays, navigation, and toolbars are to be included in the [[page_settings.php]].
==Navigation==
===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',
'overlay_holder.php',
'export.php',
'alias_admin.php',
'markup_admin.php',
'import.php'
);
</pre>
===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>
==User Home==
These settings control the subforms and left panel in the user home. The user home needs configuration both for the left panel and for the subforms included in the main area.
===User Home Left Panel===
Configures the left panel in the user home pages, requires the administrator to configure the lpanel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $uhlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'user_home' in the [[sf_module]].
====Subforms Option Example====
Define the configuration type:
<pre>
$uhlpoutput = 'subforms';
</pre>
Configure the subform:
<pre>
$uhlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'user_home',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$user_home_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$uhlp_subform_module
)
);
</pre>
== Data Entry ==
These settings configure the data entry page. The data entry requires configuration for both the left panel and the record navigation bar appearing at the top of the main area. Further options for advanced file upload are also included below.
=== Data Entry Left Panel ===
This section gives examples for the left panel configuration in the data entry pages using either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation.
==== Minimiser Option ====
This tool condenses subforms and offers quick navigation in left panel. To use the minimiser on specific data entry pages you need to go to the mod_settings files (ex. mod_cxt_settings.php) and make sure that 'col_type' => 'collaps_col', instead of single_col in the $conf_dat_materi and $conf_dat_detfrm settings.
<pre>
$minimiser = TRUE;
</pre>

====Link list Option Example====

Define the configuration type:
<pre>
$delpoutput = 'linklist';
</pre>
Configure the links:
<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=files",
'mknname' => 'uplfile'
);
</pre>

====Subforms Option Example====

Define the configuration type:
<pre>
$delpoutput = 'subforms';
</pre>

Configure the linklist (in this case, a linklist is being used to display the upload files link and the sf_linklist is calling the link):
<pre>
$link_list_admin[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=files",
'mknname' => 'uplfile',
'img' => 'bigplus.png'
);
</pre>

Configure the subforms - Subform listing the modules:
<pre>
$delp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpmodlist',
'sf_html_id' => 'delpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'data_entry',
'fields' => array (
'cxt',
'smp',
'spf',
'sph',
)
);
</pre>
Admin Subform calling the file upload linklist from above:
<pre>
$delp_subform_admin =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpadmin',
'sf_html_id' => 'delpadmin', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_label' => 'space',
'op_input' => 'save',
'op_linktype' => 'icon',
'op_sf_cssclass' => 'module_list',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'fields' => $link_list_admin
);
</pre>
Load the subforms:
<pre>
$data_entry_left_panel =
array(
'col_id' => 'delp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$delp_subform_module,
$delp_subform_admin
)
);
</pre>

=== Data Entry Toolbar ===
Configure the tools for data entry. First form the individual buttons and displays:
==== User Navigation ====
<pre>
// Previous record button
$group_entry_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays site code
$group_entry_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays record number
$group_entry_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays module type
$group_entry_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record button
$group_entry_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Administrator tools ====
<pre>
// Delete record
$group_entry_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit module type
$group_entry_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chngmod',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_entry_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'DEL',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_entry_nav =
array(
'record_nav' => $group_entry_nav,
'record_admin' => $group_entry_admin,
);
</pre>

===Advanced File Upload===
The following includes instructions on how to configure the advanced file uploader which was developed as a mechanism for not only batch uploading files, but also registering and/or linking them to existing records on the fly.
*'''on''' - Set to TRUE, advanced file uploader dialog is displayed.
*'''pattern''' - This is a regex (Regular expression) designed to detect the file names and associate the files with the appropriate records (item_keys). These example expressions are set up to treat the first 3 letters of a file name as the relevant site code and the numbers following as the number. (For example: 'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-zA-Z0-9]*))\.[a-zA-Z]{2,4}\b/i" handles files xxx-1234.jpg, xxx-1234-yyy.jpg, where xxx can be any letter and yyy any alphanumeric combination, only number before first '-' is used as an ID)
<pre>
$fu =
array(
'on' => TRUE,
'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-z0-9A-Z]*))\.[a-z0-9]{2,4}\b/i",
);
</pre>

==Data View (Search)==
These settings configure the data view (or search) page. The data view requires configuration for the left panel, the search tools options (results views, download options, etc) as well as some general settings for search results.
===General Page Settings===
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>

And the number of pages to display on the data viewer:
<pre>
// Number of pages to display on the data viewer
$conf_num_res_pgs = 5; // best choose an odd number
</pre>

Also configure the index pages for Data View and Search pages:
<pre>
// 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 (options include: text, table, or map):
<pre>
// Default $output_mode for the data viewer
$default_output_mode = 'table';
</pre>
===Data View Left Panel===
This configures the left panel for the data view pages through a series of complex subforms including [[sf_linklist]], [[sf_buildfilter]], and [[sf_mysavedstuff]].
====Configure the linklist====
First configure the linklist, which requires the following:
*'''href''' - link to the output ({$_SERVER['PHP_SELF']} is on same page, and then links to the key ID in the relevant cor table of the designated data filter
*'''mknname''' - mark-up nickname will search the markup table for this nickname and print the markup
*'''img''' - optional image for the icon defined in the subform linklist:
<pre>
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=1&ftr_id=new",
'mknname' => 'filtercxt',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=6&ftr_id=new",
'mknname' => 'filtersmp',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=stecd&ftr_id=new",
'mknname' => 'filterstecd',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=action&ftr_id=new",
'mknname' => 'filteractor',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=ftx&ftr_id=new",
'mknname' => 'ftx',
'img' => 'view_mag.png'
);
</pre>

Configure the linklist subform:
<pre>
$dvlp_subform_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_linktype' => 'icon',
'op_sf_cssclass' => 'ftr_list',
'fields' => $link_list_filters
);
</pre>

====Filter Builders====
Various options exist for the types of filters administrators will want to make available to users- including different stages of pre-built or partially executed filters. For more information on this subform and options see [[sf_buildfilter]].
 
Subform for the filter builder to run in the left panel:
<pre>
$dvlp_filter_builder =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_condition' =>
array(
array(
'func'=> 'chkTmpFtr',
'args'=> FALSE
),
),
);
</pre>
Subform for the filter builder to run in the left panel preloaded with a filter:
<pre>
$dvlp_filter_builder_atridx =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_filter' => 'atr', // the filter to be used
'op_filter_args' =>
array(
// 'arg' => 'var', // example
'atrtype' => 1,
'op_display' => 'dd'
)
// 'op_condition' =>
// array(
// array(
// 'func'=> 'chkTmpFtr',
// 'args'=> FALSE
// ),
// ),
);

</pre>
Subform for user saved filters
<pre>
$dvlp_my_saved_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'savedfilters',
'sf_html_id' => 'dvlp_saved_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_mysavedstuff.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'op_sf_cssclass' => 'ftr_subform',
// 'op_condition' =>
// array(
// array(
// 'func'=> 'chkTmpFtr',
// 'args'=> FALSE
// ),
// ),
);
</pre>
Make a column to hold the subforms:
<pre>
$data_view_left_panel =
array(
'col_id' => 'dvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$dvlp_filter_builder,
$dvlp_filter_builder_atridx,
$dvlp_subform_filters,
$dvlp_my_saved_filters
)
);
</pre>

===Results Toolbar===
Configure the tools and display options for the search page (data_view). All of the toolbars require the following in the array:
*'''type''' - Options of 'img', 'text', or 'newpage' (used in the all record view to display function in a new page)
*'''href''' - The href link to the function being called
*'''css_class''' - The css class to style the button or display
*'''mkname''' - The name of markup contained within cor_tbl_markup used for buttons which combine text and images, are just text based. Set to FALSE if not used.
*'''lightbox''' - Option of using the lightbox when calling an overlay form, set to FALSE otherwise

First form the individual buttons:

==== Tools ====
<pre>
// TOOLS
$group_tools[] =
array(
'type' => 'img',
'href' => "overlay_holder.php?sf_conf=conf_mac_userconfigfields&lboxreload=1",
'css_class' => 'gears',
'mkname' => FALSE,
'lightbox' => 'lightbox'
);
</pre>

==== Displays ====
<pre>
// DISPs
$res = "results_mode=disp";
// Text view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=text",
'css_class' => 'text',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Table view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=table",
'css_class' => 'table',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Map view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=map",
'css_class' => 'map',
'mkname' => FALSE,
'lightbox' => FALSE
);
// All record view
$group_disp[] =
array(
'type' => 'newpage',
'href' => "resultsmicro_view.php?",
'css_class' => 'printall',
'mkname' => FALSE,
'lightbox' => FALSE
);
</pre>

==== Feeds ====
<pre>
// FEEDS
$res = "results_mode=feed";
// RSS feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=rss",
'css_class' => FALSE,
'mkname' => 'rss',
'lightbox' => FALSE
);
// Atom feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=atom",
'css_class' => FALSE,
'mkname' => 'atom',
'lightbox' => FALSE
);
</pre>

==== Downloads ====
<pre>
// DOWNLOADS
$res = "results_mode=dl";
// CSV download
$group_dls[] =
array(
'type' => 'text',
'href' => "overlay_holder.php?$res&dl_mode=csv&lboxreload=1&sf_conf=conf_mac_exportdownloadcsv",
'css_class' => FALSE,
'mkname' => 'csv',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_results_nav =
array(
'tools' => $group_tools,
'result_views' => $group_disp,
'result_feeds' => $group_feeds,
'result_downloads' => $group_dls,
);
</pre>
==Micro View (Record View)==
These settings configure the micro view (or record view) page. The micro view requires configuration for the left panel, and record nav options as well as some general settings.
===General Page Settings===
Configure the index page for the micro view:
<pre>
// Default Micro viewer page (used by search result handlers)
$conf_micro_viewer = $ark_dir."micro_view.php";
</pre>

===Micro View Left Panel===
Configures the left panel in the micro view pages, requires the administrator to configure the left panel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $mvlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'micro_view' in the [[sf_module]].

====Subforms Option Example====
Define the configuration type:
<pre>
$mvlpoutput = 'subforms';
</pre>
Configure the subform module to include the relevant modules:
<pre>
$mvlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'micro_view',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$micro_view_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$mvlp_subform_module
)
);
</pre>
===Record Toolbar===
Configure the tools for the record view toolbar. This tool bar controls what navigation and options which appear in data entry record toolbar.

==== Record Navigation ====
First form the individual buttons and displays:
<pre>
// Previous record
$group_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays current site code
$group_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays current record number
$group_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays current modtype
$group_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record
$group_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Refresh View ====
<pre>
// Refresh button
$group_refresh[] =
array(
'name' => 'refresh',
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?disp_reset=default",
'css_class' => 'refresh',
'mkname' => 'reset',
'lightbox' => FALSE
);
</pre>

==== Administrator Tools ====
<pre>
// ADMIN TOOLS
// Delete record
$group_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit modtype
$group_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgtype',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgkey',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_record_nav =
array(
'record_nav' => $group_nav,
'record_refresh' => $group_refresh,
'record_admin' => $group_admin,
);
</pre>

==Map View==
This is optional, but needs to be configured correctly if you are using the mapping capabilities of ARK. It needs to be set up like other top level pages, but also a series of settings need to be configured.

===Map View Page Settings===
The page needs to be set up like all other standard top-level pages. If not using, or if you would like it to be inaccessible in the dynamic navigation set 'is_visible' to FALSE.

<pre>
// MAP VIEW PAGE SETTINGS
$conf_page_map_view =
array(
'name' =>'Map View',
'title' => 'Map View Page',
'file' => 'map_view.php',
'sgrp' => '1',
'navname' => 'mapviewnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/map_view/',
'is_visible' => TRUE
);
</pre>

===Map View Left Panel===
The first subform is to allow saving of maps from the left panel, and the second to allow downloads of maps as PDFs.
<pre>
// LEFT PANEL
// Subforms
$conf_map_wmcoverlay =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'nmedit',
'sf_title' => 'wmcoverlay',
'sf_html_id' => 'map_wmcoverlay', // Must be unique
'script' => 'php/map_admin/subforms/sf_savewmc_overlay.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);

$conf_maptopdf =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'full',
'sf_title' => 'interp',
'sf_html_id' => 'map_maptopdf', // Must be unique
'script' => 'php/map_view/subforms/sf_maptopdf.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);
</pre>
===Map View Main===
These are a series of settings that define the query layers and query maps displayed in the map view as well as the results map view.
====Map Timeout====
Mapping timeout in milliseconds- if you are using a slow WxS server set this to be high (default is 1500).
<pre>
$map_timeout = 5000;
</pre>
====WXS Query Layers====
$wxs_qlayers: mapping layers for mods - specify in this array the names of the wms/wfs layers that contain the spatial data for each mod. Bear in mind that these layers should contain an ark_id column that can be retrieved using a getFeatureInfo request.
Each layer is a separate entry in the array containing an array of variables:
*mod - the mod of the item (without _cd) eg. 'cxt'
*geom - the geometry of the layer - eg. 'pt', 'pl' or 'pgn'
*url - the full url of the WMS/WFS server that is hosting the layer eg. http://localhost/ark/php/map/ark_wxs_server.php?
*title_field - this is the field_id of the field that you want to be displayed during the click to query, if this is set to 'GIS' then it will return the attributes in the remote GIS attribute table.
<pre>
$wxs_qlayers =
array(
'sites' => array(
'mod' => 'cxt',
'geom' => 'pt',
'url' => 'http://localhost/ark/php/map/ark_wxs_server.php?',
'title_field' => 'conf_field_name',
'style_array' =>
array(
'fillOpacity' => 0.75,
'strokeColor' => '"black"',
'fillColor' => '"red"',
'pointRadius' => 10,
)
),
);
</pre>

===WXS Query Map===
$wxs_query_map - this is the name of a saved map (saved using the map_admin tools), that you want to be the background for the 'View Results as Map'. Admins should note: the $wxs_qlayers array is used to determine which layers can be used to display the spatial data for each mod - therefore those layers HAVE to be available in the saved $wxs_query_map. Also, the more info button - if you store information about your GIS layers as ARK items then set this to TRUE. Please note you will need to have a 'gis' module and you will need to name your WMS-served GIS layers in the format for instance,'contexts_PCO06_123'
<pre>
$wxs_query_map = 'QueryMap';

$map_more_info_button = FALSE;
</pre>

Page settings.php

2012-03-21T16:15:16Z

Jessogden: /* Map View */

As of v1.0, all settings related to individual page displays, navigation, and toolbars are to be included in the [[page_settings.php]].
==Navigation==
===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',
'overlay_holder.php',
'export.php',
'alias_admin.php',
'markup_admin.php',
'import.php'
);
</pre>
===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>
==User Home==
These settings control the subforms and left panel in the user home. The user home needs configuration both for the left panel and for the subforms included in the main area.
===User Home Left Panel===
Configures the left panel in the user home pages, requires the administrator to configure the lpanel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $uhlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'user_home' in the [[sf_module]].
====Subforms Option Example====
Define the configuration type:
<pre>
$uhlpoutput = 'subforms';
</pre>
Configure the subform:
<pre>
$uhlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'user_home',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$user_home_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$uhlp_subform_module
)
);
</pre>
== Data Entry ==
These settings configure the data entry page. The data entry requires configuration for both the left panel and the record navigation bar appearing at the top of the main area. Further options for advanced file upload are also included below.
=== Data Entry Left Panel ===
This section gives examples for the left panel configuration in the data entry pages using either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation.
==== Minimiser Option ====
This tool condenses subforms and offers quick navigation in left panel. To use the minimiser on specific data entry pages you need to go to the mod_settings files (ex. mod_cxt_settings.php) and make sure that 'col_type' => 'collaps_col', instead of single_col in the $conf_dat_materi and $conf_dat_detfrm settings.
<pre>
$minimiser = TRUE;
</pre>

====Link list Option Example====

Define the configuration type:
<pre>
$delpoutput = 'linklist';
</pre>
Configure the links:
<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=files",
'mknname' => 'uplfile'
);
</pre>

====Subforms Option Example====

Define the configuration type:
<pre>
$delpoutput = 'subforms';
</pre>

Configure the linklist (in this case, a linklist is being used to display the upload files link and the sf_linklist is calling the link):
<pre>
$link_list_admin[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=files",
'mknname' => 'uplfile',
'img' => 'bigplus.png'
);
</pre>

Configure the subforms - Subform listing the modules:
<pre>
$delp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpmodlist',
'sf_html_id' => 'delpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'data_entry',
'fields' => array (
'cxt',
'smp',
'spf',
'sph',
)
);
</pre>
Admin Subform calling the file upload linklist from above:
<pre>
$delp_subform_admin =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpadmin',
'sf_html_id' => 'delpadmin', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_label' => 'space',
'op_input' => 'save',
'op_linktype' => 'icon',
'op_sf_cssclass' => 'module_list',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'fields' => $link_list_admin
);
</pre>
Load the subforms:
<pre>
$data_entry_left_panel =
array(
'col_id' => 'delp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$delp_subform_module,
$delp_subform_admin
)
);
</pre>

=== Data Entry Toolbar ===
Configure the tools for data entry. First form the individual buttons and displays:
==== User Navigation ====
<pre>
// Previous record button
$group_entry_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays site code
$group_entry_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays record number
$group_entry_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays module type
$group_entry_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record button
$group_entry_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Administrator tools ====
<pre>
// Delete record
$group_entry_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit module type
$group_entry_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chngmod',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_entry_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'DEL',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_entry_nav =
array(
'record_nav' => $group_entry_nav,
'record_admin' => $group_entry_admin,
);
</pre>

===Advanced File Upload===
The following includes instructions on how to configure the advanced file uploader which was developed as a mechanism for not only batch uploading files, but also registering and/or linking them to existing records on the fly.
*'''on''' - Set to TRUE, advanced file uploader dialog is displayed.
*'''pattern''' - This is a regex (Regular expression) designed to detect the file names and associate the files with the appropriate records (item_keys). These example expressions are set up to treat the first 3 letters of a file name as the relevant site code and the numbers following as the number. (For example: 'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-zA-Z0-9]*))\.[a-zA-Z]{2,4}\b/i" handles files xxx-1234.jpg, xxx-1234-yyy.jpg, where xxx can be any letter and yyy any alphanumeric combination, only number before first '-' is used as an ID)
<pre>
$fu =
array(
'on' => TRUE,
'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-z0-9A-Z]*))\.[a-z0-9]{2,4}\b/i",
);
</pre>

==Data View (Search)==
These settings configure the data view (or search) page. The data view requires configuration for the left panel, the search tools options (results views, download options, etc) as well as some general settings for search results.
===General Page Settings===
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>

And the number of pages to display on the data viewer:
<pre>
// Number of pages to display on the data viewer
$conf_num_res_pgs = 5; // best choose an odd number
</pre>

Also configure the index pages for Data View and Search pages:
<pre>
// 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 (options include: text, table, or map):
<pre>
// Default $output_mode for the data viewer
$default_output_mode = 'table';
</pre>
===Data View Left Panel===
This configures the left panel for the data view pages through a series of complex subforms including [[sf_linklist]], [[sf_buildfilter]], and [[sf_mysavedstuff]].
====Configure the linklist====
First configure the linklist, which requires the following:
*'''href''' - link to the output ({$_SERVER['PHP_SELF']} is on same page, and then links to the key ID in the relevant cor table of the designated data filter
*'''mknname''' - mark-up nickname will search the markup table for this nickname and print the markup
*'''img''' - optional image for the icon defined in the subform linklist:
<pre>
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=1&ftr_id=new",
'mknname' => 'filtercxt',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=6&ftr_id=new",
'mknname' => 'filtersmp',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=stecd&ftr_id=new",
'mknname' => 'filterstecd',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=action&ftr_id=new",
'mknname' => 'filteractor',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=ftx&ftr_id=new",
'mknname' => 'ftx',
'img' => 'view_mag.png'
);
</pre>

Configure the linklist subform:
<pre>
$dvlp_subform_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_linktype' => 'icon',
'op_sf_cssclass' => 'ftr_list',
'fields' => $link_list_filters
);
</pre>

====Filter Builders====
Various options exist for the types of filters administrators will want to make available to users- including different stages of pre-built or partially executed filters. For more information on this subform and options see [[sf_buildfilter]].
 
Subform for the filter builder to run in the left panel:
<pre>
$dvlp_filter_builder =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_condition' =>
array(
array(
'func'=> 'chkTmpFtr',
'args'=> FALSE
),
),
);
</pre>
Subform for the filter builder to run in the left panel preloaded with a filter:
<pre>
$dvlp_filter_builder_atridx =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_filter' => 'atr', // the filter to be used
'op_filter_args' =>
array(
// 'arg' => 'var', // example
'atrtype' => 1,
'op_display' => 'dd'
)
// 'op_condition' =>
// array(
// array(
// 'func'=> 'chkTmpFtr',
// 'args'=> FALSE
// ),
// ),
);

</pre>
Subform for user saved filters
<pre>
$dvlp_my_saved_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'savedfilters',
'sf_html_id' => 'dvlp_saved_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_mysavedstuff.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'op_sf_cssclass' => 'ftr_subform',
// 'op_condition' =>
// array(
// array(
// 'func'=> 'chkTmpFtr',
// 'args'=> FALSE
// ),
// ),
);
</pre>
Make a column to hold the subforms:
<pre>
$data_view_left_panel =
array(
'col_id' => 'dvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$dvlp_filter_builder,
$dvlp_filter_builder_atridx,
$dvlp_subform_filters,
$dvlp_my_saved_filters
)
);
</pre>

===Results Toolbar===
Configure the tools and display options for the search page (data_view). All of the toolbars require the following in the array:
*'''type''' - Options of 'img', 'text', or 'newpage' (used in the all record view to display function in a new page)
*'''href''' - The href link to the function being called
*'''css_class''' - The css class to style the button or display
*'''mkname''' - The name of markup contained within cor_tbl_markup used for buttons which combine text and images, are just text based. Set to FALSE if not used.
*'''lightbox''' - Option of using the lightbox when calling an overlay form, set to FALSE otherwise

First form the individual buttons:

==== Tools ====
<pre>
// TOOLS
$group_tools[] =
array(
'type' => 'img',
'href' => "overlay_holder.php?sf_conf=conf_mac_userconfigfields&lboxreload=1",
'css_class' => 'gears',
'mkname' => FALSE,
'lightbox' => 'lightbox'
);
</pre>

==== Displays ====
<pre>
// DISPs
$res = "results_mode=disp";
// Text view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=text",
'css_class' => 'text',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Table view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=table",
'css_class' => 'table',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Map view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=map",
'css_class' => 'map',
'mkname' => FALSE,
'lightbox' => FALSE
);
// All record view
$group_disp[] =
array(
'type' => 'newpage',
'href' => "resultsmicro_view.php?",
'css_class' => 'printall',
'mkname' => FALSE,
'lightbox' => FALSE
);
</pre>

==== Feeds ====
<pre>
// FEEDS
$res = "results_mode=feed";
// RSS feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=rss",
'css_class' => FALSE,
'mkname' => 'rss',
'lightbox' => FALSE
);
// Atom feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=atom",
'css_class' => FALSE,
'mkname' => 'atom',
'lightbox' => FALSE
);
</pre>

==== Downloads ====
<pre>
// DOWNLOADS
$res = "results_mode=dl";
// CSV download
$group_dls[] =
array(
'type' => 'text',
'href' => "overlay_holder.php?$res&dl_mode=csv&lboxreload=1&sf_conf=conf_mac_exportdownloadcsv",
'css_class' => FALSE,
'mkname' => 'csv',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_results_nav =
array(
'tools' => $group_tools,
'result_views' => $group_disp,
'result_feeds' => $group_feeds,
'result_downloads' => $group_dls,
);
</pre>
==Micro View (Record View)==
These settings configure the micro view (or record view) page. The micro view requires configuration for the left panel, and record nav options as well as some general settings.
===General Page Settings===
Configure the index page for the micro view:
<pre>
// Default Micro viewer page (used by search result handlers)
$conf_micro_viewer = $ark_dir."micro_view.php";
</pre>

===Micro View Left Panel===
Configures the left panel in the micro view pages, requires the administrator to configure the left panel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $mvlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'micro_view' in the [[sf_module]].

====Subforms Option Example====
Define the configuration type:
<pre>
$mvlpoutput = 'subforms';
</pre>
Configure the subform module to include the relevant modules:
<pre>
$mvlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'micro_view',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$micro_view_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$mvlp_subform_module
)
);
</pre>
===Record Toolbar===
Configure the tools for the record view toolbar. This tool bar controls what navigation and options which appear in data entry record toolbar.

==== Record Navigation ====
First form the individual buttons and displays:
<pre>
// Previous record
$group_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays current site code
$group_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays current record number
$group_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays current modtype
$group_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record
$group_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Refresh View ====
<pre>
// Refresh button
$group_refresh[] =
array(
'name' => 'refresh',
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?disp_reset=default",
'css_class' => 'refresh',
'mkname' => 'reset',
'lightbox' => FALSE
);
</pre>

==== Administrator Tools ====
<pre>
// ADMIN TOOLS
// Delete record
$group_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit modtype
$group_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgtype',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgkey',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_record_nav =
array(
'record_nav' => $group_nav,
'record_refresh' => $group_refresh,
'record_admin' => $group_admin,
);
</pre>

==Map View==
This is optional, but needs to be configured correctly if you are using the mapping capabilities of ARK. It needs to be set up like other top level pages, but also a series of settings need to be configured.

===Map View Page Settings===
The page needs to be set up like all other standard top-level pages. If not using, or if you would like it to be inaccessible in the dynamic navigation set 'is_visible' to FALSE.

<pre>
// MAP VIEW PAGE SETTINGS
$conf_page_map_view =
array(
'name' =>'Map View',
'title' => 'Map View Page',
'file' => 'map_view.php',
'sgrp' => '1',
'navname' => 'mapviewnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/map_view/',
'is_visible' => TRUE
);
</pre>

===Map View Left Panel===
The first subform is to allow saving of maps from the left panel, and the second to allow downloads of maps as PDFs.
<pre>
// LEFT PANEL
// Subforms
$conf_map_wmcoverlay =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'nmedit',
'sf_title' => 'wmcoverlay',
'sf_html_id' => 'map_wmcoverlay', // Must be unique
'script' => 'php/map_admin/subforms/sf_savewmc_overlay.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);

$conf_maptopdf =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'full',
'sf_title' => 'interp',
'sf_html_id' => 'map_maptopdf', // Must be unique
'script' => 'php/map_view/subforms/sf_maptopdf.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);
</pre>
===Map View Main===
These are a series of settings that define the query layers and query maps displayed in the map view as well as the results map view.
====Map Timeout====
Mapping timeout in milliseconds- if you are using a slow WxS server set this to be high (default is 1500).
<pre>
$map_timeout = 5000;
</pre>
====WXS Query Layers====
$wxs_qlayers: mapping layers for mods - specify in this array the names of the wms/wfs layers that contain the spatial data for each mod. Bear in mind that these layers should contain an ark_id column that can be retrieved using a getFeatureInfo request.
Each layer is a seperate entry in the array containing an array of variables:
*'mod' - the mod of the item (without _cd) eg. 'cxt'
*'geom' - the geometry of the layer - eg. 'pt', 'pl' or 'pgn'
*'url' - the full url of the WMS/WFS server that is hosting the layer eg. http://localhost/ark/php/map/ark_wxs_server.php?
*'title_field' - this is the field_id of the field that you want to be displayed during the click to query, if this is set to 'GIS' then it will return the attributes in the remote GIS attribute table.

$wxs_qlayers =
array(
'sites' => array(
'mod' => 'cxt',
'geom' => 'pt',
'url' => 'http://localhost/ark/php/map/ark_wxs_server.php?',
'title_field' => 'conf_field_name',
'style_array' =>
array(
'fillOpacity' => 0.75,
'strokeColor' => '"black"',
'fillColor' => '"red"',
'pointRadius' => 10,
)
),
);

===WXS Query Map===
$wxs_query_map - this is the name of a saved map (saved using the map_admin tools), that you want to be the background for the 'View Results as Map'. Admins should note: the $wxs_qlayers array is used to determine which layers can be used to display the spatial data for each mod - therefore those layers HAVE to be available in the saved $wxs_query_map. Also, the more info button - if you store information about your GIS layers as ARK items then set this to TRUE. Please note you will need to have a 'gis' module and you will need to name your WMS-served GIS layers in the format for instance,'contexts_PCO06_123'
<pre>
$wxs_query_map = 'QueryMap';

$map_more_info_button = FALSE;
</pre>

Page settings.php

2012-03-21T16:14:03Z

Jessogden: /* WXS Query Layers */

As of v1.0, all settings related to individual page displays, navigation, and toolbars are to be included in the [[page_settings.php]].
==Navigation==
===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',
'overlay_holder.php',
'export.php',
'alias_admin.php',
'markup_admin.php',
'import.php'
);
</pre>
===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>
==User Home==
These settings control the subforms and left panel in the user home. The user home needs configuration both for the left panel and for the subforms included in the main area.
===User Home Left Panel===
Configures the left panel in the user home pages, requires the administrator to configure the lpanel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $uhlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'user_home' in the [[sf_module]].
====Subforms Option Example====
Define the configuration type:
<pre>
$uhlpoutput = 'subforms';
</pre>
Configure the subform:
<pre>
$uhlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'user_home',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$user_home_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$uhlp_subform_module
)
);
</pre>
== Data Entry ==
These settings configure the data entry page. The data entry requires configuration for both the left panel and the record navigation bar appearing at the top of the main area. Further options for advanced file upload are also included below.
=== Data Entry Left Panel ===
This section gives examples for the left panel configuration in the data entry pages using either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation.
==== Minimiser Option ====
This tool condenses subforms and offers quick navigation in left panel. To use the minimiser on specific data entry pages you need to go to the mod_settings files (ex. mod_cxt_settings.php) and make sure that 'col_type' => 'collaps_col', instead of single_col in the $conf_dat_materi and $conf_dat_detfrm settings.
<pre>
$minimiser = TRUE;
</pre>

====Link list Option Example====

Define the configuration type:
<pre>
$delpoutput = 'linklist';
</pre>
Configure the links:
<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=files",
'mknname' => 'uplfile'
);
</pre>

====Subforms Option Example====

Define the configuration type:
<pre>
$delpoutput = 'subforms';
</pre>

Configure the linklist (in this case, a linklist is being used to display the upload files link and the sf_linklist is calling the link):
<pre>
$link_list_admin[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=files",
'mknname' => 'uplfile',
'img' => 'bigplus.png'
);
</pre>

Configure the subforms - Subform listing the modules:
<pre>
$delp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpmodlist',
'sf_html_id' => 'delpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'data_entry',
'fields' => array (
'cxt',
'smp',
'spf',
'sph',
)
);
</pre>
Admin Subform calling the file upload linklist from above:
<pre>
$delp_subform_admin =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpadmin',
'sf_html_id' => 'delpadmin', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_label' => 'space',
'op_input' => 'save',
'op_linktype' => 'icon',
'op_sf_cssclass' => 'module_list',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'fields' => $link_list_admin
);
</pre>
Load the subforms:
<pre>
$data_entry_left_panel =
array(
'col_id' => 'delp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$delp_subform_module,
$delp_subform_admin
)
);
</pre>

=== Data Entry Toolbar ===
Configure the tools for data entry. First form the individual buttons and displays:
==== User Navigation ====
<pre>
// Previous record button
$group_entry_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays site code
$group_entry_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays record number
$group_entry_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays module type
$group_entry_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record button
$group_entry_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Administrator tools ====
<pre>
// Delete record
$group_entry_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit module type
$group_entry_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chngmod',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_entry_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'DEL',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_entry_nav =
array(
'record_nav' => $group_entry_nav,
'record_admin' => $group_entry_admin,
);
</pre>

===Advanced File Upload===
The following includes instructions on how to configure the advanced file uploader which was developed as a mechanism for not only batch uploading files, but also registering and/or linking them to existing records on the fly.
*'''on''' - Set to TRUE, advanced file uploader dialog is displayed.
*'''pattern''' - This is a regex (Regular expression) designed to detect the file names and associate the files with the appropriate records (item_keys). These example expressions are set up to treat the first 3 letters of a file name as the relevant site code and the numbers following as the number. (For example: 'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-zA-Z0-9]*))\.[a-zA-Z]{2,4}\b/i" handles files xxx-1234.jpg, xxx-1234-yyy.jpg, where xxx can be any letter and yyy any alphanumeric combination, only number before first '-' is used as an ID)
<pre>
$fu =
array(
'on' => TRUE,
'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-z0-9A-Z]*))\.[a-z0-9]{2,4}\b/i",
);
</pre>

==Data View (Search)==
These settings configure the data view (or search) page. The data view requires configuration for the left panel, the search tools options (results views, download options, etc) as well as some general settings for search results.
===General Page Settings===
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>

And the number of pages to display on the data viewer:
<pre>
// Number of pages to display on the data viewer
$conf_num_res_pgs = 5; // best choose an odd number
</pre>

Also configure the index pages for Data View and Search pages:
<pre>
// 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 (options include: text, table, or map):
<pre>
// Default $output_mode for the data viewer
$default_output_mode = 'table';
</pre>
===Data View Left Panel===
This configures the left panel for the data view pages through a series of complex subforms including [[sf_linklist]], [[sf_buildfilter]], and [[sf_mysavedstuff]].
====Configure the linklist====
First configure the linklist, which requires the following:
*'''href''' - link to the output ({$_SERVER['PHP_SELF']} is on same page, and then links to the key ID in the relevant cor table of the designated data filter
*'''mknname''' - mark-up nickname will search the markup table for this nickname and print the markup
*'''img''' - optional image for the icon defined in the subform linklist:
<pre>
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=1&ftr_id=new",
'mknname' => 'filtercxt',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=6&ftr_id=new",
'mknname' => 'filtersmp',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=stecd&ftr_id=new",
'mknname' => 'filterstecd',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=action&ftr_id=new",
'mknname' => 'filteractor',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=ftx&ftr_id=new",
'mknname' => 'ftx',
'img' => 'view_mag.png'
);
</pre>

Configure the linklist subform:
<pre>
$dvlp_subform_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_linktype' => 'icon',
'op_sf_cssclass' => 'ftr_list',
'fields' => $link_list_filters
);
</pre>

====Filter Builders====
Various options exist for the types of filters administrators will want to make available to users- including different stages of pre-built or partially executed filters. For more information on this subform and options see [[sf_buildfilter]].
 
Subform for the filter builder to run in the left panel:
<pre>
$dvlp_filter_builder =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_condition' =>
array(
array(
'func'=> 'chkTmpFtr',
'args'=> FALSE
),
),
);
</pre>
Subform for the filter builder to run in the left panel preloaded with a filter:
<pre>
$dvlp_filter_builder_atridx =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_filter' => 'atr', // the filter to be used
'op_filter_args' =>
array(
// 'arg' => 'var', // example
'atrtype' => 1,
'op_display' => 'dd'
)
// 'op_condition' =>
// array(
// array(
// 'func'=> 'chkTmpFtr',
// 'args'=> FALSE
// ),
// ),
);

</pre>
Subform for user saved filters
<pre>
$dvlp_my_saved_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'savedfilters',
'sf_html_id' => 'dvlp_saved_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_mysavedstuff.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'op_sf_cssclass' => 'ftr_subform',
// 'op_condition' =>
// array(
// array(
// 'func'=> 'chkTmpFtr',
// 'args'=> FALSE
// ),
// ),
);
</pre>
Make a column to hold the subforms:
<pre>
$data_view_left_panel =
array(
'col_id' => 'dvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$dvlp_filter_builder,
$dvlp_filter_builder_atridx,
$dvlp_subform_filters,
$dvlp_my_saved_filters
)
);
</pre>

===Results Toolbar===
Configure the tools and display options for the search page (data_view). All of the toolbars require the following in the array:
*'''type''' - Options of 'img', 'text', or 'newpage' (used in the all record view to display function in a new page)
*'''href''' - The href link to the function being called
*'''css_class''' - The css class to style the button or display
*'''mkname''' - The name of markup contained within cor_tbl_markup used for buttons which combine text and images, are just text based. Set to FALSE if not used.
*'''lightbox''' - Option of using the lightbox when calling an overlay form, set to FALSE otherwise

First form the individual buttons:

==== Tools ====
<pre>
// TOOLS
$group_tools[] =
array(
'type' => 'img',
'href' => "overlay_holder.php?sf_conf=conf_mac_userconfigfields&lboxreload=1",
'css_class' => 'gears',
'mkname' => FALSE,
'lightbox' => 'lightbox'
);
</pre>

==== Displays ====
<pre>
// DISPs
$res = "results_mode=disp";
// Text view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=text",
'css_class' => 'text',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Table view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=table",
'css_class' => 'table',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Map view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=map",
'css_class' => 'map',
'mkname' => FALSE,
'lightbox' => FALSE
);
// All record view
$group_disp[] =
array(
'type' => 'newpage',
'href' => "resultsmicro_view.php?",
'css_class' => 'printall',
'mkname' => FALSE,
'lightbox' => FALSE
);
</pre>

==== Feeds ====
<pre>
// FEEDS
$res = "results_mode=feed";
// RSS feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=rss",
'css_class' => FALSE,
'mkname' => 'rss',
'lightbox' => FALSE
);
// Atom feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=atom",
'css_class' => FALSE,
'mkname' => 'atom',
'lightbox' => FALSE
);
</pre>

==== Downloads ====
<pre>
// DOWNLOADS
$res = "results_mode=dl";
// CSV download
$group_dls[] =
array(
'type' => 'text',
'href' => "overlay_holder.php?$res&dl_mode=csv&lboxreload=1&sf_conf=conf_mac_exportdownloadcsv",
'css_class' => FALSE,
'mkname' => 'csv',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_results_nav =
array(
'tools' => $group_tools,
'result_views' => $group_disp,
'result_feeds' => $group_feeds,
'result_downloads' => $group_dls,
);
</pre>
==Micro View (Record View)==
These settings configure the micro view (or record view) page. The micro view requires configuration for the left panel, and record nav options as well as some general settings.
===General Page Settings===
Configure the index page for the micro view:
<pre>
// Default Micro viewer page (used by search result handlers)
$conf_micro_viewer = $ark_dir."micro_view.php";
</pre>

===Micro View Left Panel===
Configures the left panel in the micro view pages, requires the administrator to configure the left panel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $mvlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'micro_view' in the [[sf_module]].

====Subforms Option Example====
Define the configuration type:
<pre>
$mvlpoutput = 'subforms';
</pre>
Configure the subform module to include the relevant modules:
<pre>
$mvlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'micro_view',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$micro_view_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$mvlp_subform_module
)
);
</pre>
===Record Toolbar===
Configure the tools for the record view toolbar. This tool bar controls what navigation and options which appear in data entry record toolbar.

==== Record Navigation ====
First form the individual buttons and displays:
<pre>
// Previous record
$group_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays current site code
$group_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays current record number
$group_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays current modtype
$group_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record
$group_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Refresh View ====
<pre>
// Refresh button
$group_refresh[] =
array(
'name' => 'refresh',
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?disp_reset=default",
'css_class' => 'refresh',
'mkname' => 'reset',
'lightbox' => FALSE
);
</pre>

==== Administrator Tools ====
<pre>
// ADMIN TOOLS
// Delete record
$group_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit modtype
$group_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgtype',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgkey',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_record_nav =
array(
'record_nav' => $group_nav,
'record_refresh' => $group_refresh,
'record_admin' => $group_admin,
);
</pre>

==Map View==
This is optional, but needs to be configured correctly if you are using the mapping capabilities of ARK. It needs to be set up like other top level pages, but also a series of settings need to be configured.

===Map View Page Settings===
The page needs to be set up like all other standard top-level pages. If not using, or if you would like it to be inaccessible in the dynamic navigation set 'is_visible' to FALSE.

<pre>
// MAP VIEW PAGE SETTINGS
$conf_page_map_view =
array(
'name' =>'Map View',
'title' => 'Map View Page',
'file' => 'map_view.php',
'sgrp' => '1',
'navname' => 'mapviewnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/map_view/',
'is_visible' => TRUE
);
</pre>

===Map View Left Panel===
The first subform is to allow saving of maps from the left panel, and the second to allow downloads of maps as PDFs.
<pre>
// LEFT PANEL
// Subforms
$conf_map_wmcoverlay =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'nmedit',
'sf_title' => 'wmcoverlay',
'sf_html_id' => 'map_wmcoverlay', // Must be unique
'script' => 'php/map_admin/subforms/sf_savewmc_overlay.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);

$conf_maptopdf =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'full',
'sf_title' => 'interp',
'sf_html_id' => 'map_maptopdf', // Must be unique
'script' => 'php/map_view/subforms/sf_maptopdf.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);
</pre>
===Map View Main===
These are a series of settings that define the query layers and query maps displayed in the map view as well as the results map view.
====Map Timeout====
Mapping timeout in milliseconds- if you are using a slow WxS server set this to be high (default is 1500).
<pre>
$map_timeout = 5000;
</pre>
====WXS Query Layers====
$wxs_qlayers: mapping layers for mods - specify in this array the names of the wms/wfs layers that contain the spatial data for each mod. Bear in mind that these layers should contain an ark_id column that can be retrieved using a getFeatureInfo request.
Each layer is a seperate entry in the array containing an array of variables:
*'mod' - the mod of the item (without _cd) eg. 'cxt'
*'geom' - the geometry of the layer - eg. 'pt', 'pl' or 'pgn'
*'url' - the full url of the WMS/WFS server that is hosting the layer eg.
http://localhost/ark/php/map/ark_wxs_server.php?
*'title_field' - this is the field_id of the field that you want to be displayed during the click to query, if this is set to 'GIS' then it will return the attributes in the remote GIS attribute table.
<pre>
$wxs_qlayers =
array(
'sites' => array(
'mod' => 'cxt',
'geom' => 'pt',
'url' => 'http://localhost/ark/php/map/ark_wxs_server.php?',
'title_field' => 'conf_field_name',
'style_array' =>
array(
'fillOpacity' => 0.75,
'strokeColor' => '"black"',
'fillColor' => '"red"',
'pointRadius' => 10,
)
),
);
</pre>

===WXS Query Map===
$wxs_query_map - this is the name of a saved map (saved using the map_admin tools), that you want to be the background for the 'View Results as Map'. Admins should note: the $wxs_qlayers array is used to determine which layers can be used to display the spatial data for each mod - therefore those layers HAVE to be available in the saved $wxs_query_map. Also, the more info button - if you store information about your GIS layers as ARK items then set this to TRUE. Please note you will need to have a 'gis' module and you will need to name your WMS-served GIS layers in the format for instance,'contexts_PCO06_123'
<pre>
$wxs_query_map = 'QueryMap';

$map_more_info_button = FALSE;
</pre>

Page settings.php

2012-03-21T16:13:11Z

Jessogden: /* WXS Query Layers */

As of v1.0, all settings related to individual page displays, navigation, and toolbars are to be included in the [[page_settings.php]].
==Navigation==
===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',
'overlay_holder.php',
'export.php',
'alias_admin.php',
'markup_admin.php',
'import.php'
);
</pre>
===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>
==User Home==
These settings control the subforms and left panel in the user home. The user home needs configuration both for the left panel and for the subforms included in the main area.
===User Home Left Panel===
Configures the left panel in the user home pages, requires the administrator to configure the lpanel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $uhlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'user_home' in the [[sf_module]].
====Subforms Option Example====
Define the configuration type:
<pre>
$uhlpoutput = 'subforms';
</pre>
Configure the subform:
<pre>
$uhlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'user_home',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$user_home_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$uhlp_subform_module
)
);
</pre>
== Data Entry ==
These settings configure the data entry page. The data entry requires configuration for both the left panel and the record navigation bar appearing at the top of the main area. Further options for advanced file upload are also included below.
=== Data Entry Left Panel ===
This section gives examples for the left panel configuration in the data entry pages using either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation.
==== Minimiser Option ====
This tool condenses subforms and offers quick navigation in left panel. To use the minimiser on specific data entry pages you need to go to the mod_settings files (ex. mod_cxt_settings.php) and make sure that 'col_type' => 'collaps_col', instead of single_col in the $conf_dat_materi and $conf_dat_detfrm settings.
<pre>
$minimiser = TRUE;
</pre>

====Link list Option Example====

Define the configuration type:
<pre>
$delpoutput = 'linklist';
</pre>
Configure the links:
<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=files",
'mknname' => 'uplfile'
);
</pre>

====Subforms Option Example====

Define the configuration type:
<pre>
$delpoutput = 'subforms';
</pre>

Configure the linklist (in this case, a linklist is being used to display the upload files link and the sf_linklist is calling the link):
<pre>
$link_list_admin[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=files",
'mknname' => 'uplfile',
'img' => 'bigplus.png'
);
</pre>

Configure the subforms - Subform listing the modules:
<pre>
$delp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpmodlist',
'sf_html_id' => 'delpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'data_entry',
'fields' => array (
'cxt',
'smp',
'spf',
'sph',
)
);
</pre>
Admin Subform calling the file upload linklist from above:
<pre>
$delp_subform_admin =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpadmin',
'sf_html_id' => 'delpadmin', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_label' => 'space',
'op_input' => 'save',
'op_linktype' => 'icon',
'op_sf_cssclass' => 'module_list',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'fields' => $link_list_admin
);
</pre>
Load the subforms:
<pre>
$data_entry_left_panel =
array(
'col_id' => 'delp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$delp_subform_module,
$delp_subform_admin
)
);
</pre>

=== Data Entry Toolbar ===
Configure the tools for data entry. First form the individual buttons and displays:
==== User Navigation ====
<pre>
// Previous record button
$group_entry_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays site code
$group_entry_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays record number
$group_entry_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays module type
$group_entry_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record button
$group_entry_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Administrator tools ====
<pre>
// Delete record
$group_entry_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit module type
$group_entry_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chngmod',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_entry_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'DEL',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_entry_nav =
array(
'record_nav' => $group_entry_nav,
'record_admin' => $group_entry_admin,
);
</pre>

===Advanced File Upload===
The following includes instructions on how to configure the advanced file uploader which was developed as a mechanism for not only batch uploading files, but also registering and/or linking them to existing records on the fly.
*'''on''' - Set to TRUE, advanced file uploader dialog is displayed.
*'''pattern''' - This is a regex (Regular expression) designed to detect the file names and associate the files with the appropriate records (item_keys). These example expressions are set up to treat the first 3 letters of a file name as the relevant site code and the numbers following as the number. (For example: 'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-zA-Z0-9]*))\.[a-zA-Z]{2,4}\b/i" handles files xxx-1234.jpg, xxx-1234-yyy.jpg, where xxx can be any letter and yyy any alphanumeric combination, only number before first '-' is used as an ID)
<pre>
$fu =
array(
'on' => TRUE,
'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-z0-9A-Z]*))\.[a-z0-9]{2,4}\b/i",
);
</pre>

==Data View (Search)==
These settings configure the data view (or search) page. The data view requires configuration for the left panel, the search tools options (results views, download options, etc) as well as some general settings for search results.
===General Page Settings===
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>

And the number of pages to display on the data viewer:
<pre>
// Number of pages to display on the data viewer
$conf_num_res_pgs = 5; // best choose an odd number
</pre>

Also configure the index pages for Data View and Search pages:
<pre>
// 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 (options include: text, table, or map):
<pre>
// Default $output_mode for the data viewer
$default_output_mode = 'table';
</pre>
===Data View Left Panel===
This configures the left panel for the data view pages through a series of complex subforms including [[sf_linklist]], [[sf_buildfilter]], and [[sf_mysavedstuff]].
====Configure the linklist====
First configure the linklist, which requires the following:
*'''href''' - link to the output ({$_SERVER['PHP_SELF']} is on same page, and then links to the key ID in the relevant cor table of the designated data filter
*'''mknname''' - mark-up nickname will search the markup table for this nickname and print the markup
*'''img''' - optional image for the icon defined in the subform linklist:
<pre>
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=1&ftr_id=new",
'mknname' => 'filtercxt',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=6&ftr_id=new",
'mknname' => 'filtersmp',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=stecd&ftr_id=new",
'mknname' => 'filterstecd',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=action&ftr_id=new",
'mknname' => 'filteractor',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=ftx&ftr_id=new",
'mknname' => 'ftx',
'img' => 'view_mag.png'
);
</pre>

Configure the linklist subform:
<pre>
$dvlp_subform_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_linktype' => 'icon',
'op_sf_cssclass' => 'ftr_list',
'fields' => $link_list_filters
);
</pre>

====Filter Builders====
Various options exist for the types of filters administrators will want to make available to users- including different stages of pre-built or partially executed filters. For more information on this subform and options see [[sf_buildfilter]].
 
Subform for the filter builder to run in the left panel:
<pre>
$dvlp_filter_builder =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_condition' =>
array(
array(
'func'=> 'chkTmpFtr',
'args'=> FALSE
),
),
);
</pre>
Subform for the filter builder to run in the left panel preloaded with a filter:
<pre>
$dvlp_filter_builder_atridx =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_filter' => 'atr', // the filter to be used
'op_filter_args' =>
array(
// 'arg' => 'var', // example
'atrtype' => 1,
'op_display' => 'dd'
)
// 'op_condition' =>
// array(
// array(
// 'func'=> 'chkTmpFtr',
// 'args'=> FALSE
// ),
// ),
);

</pre>
Subform for user saved filters
<pre>
$dvlp_my_saved_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'savedfilters',
'sf_html_id' => 'dvlp_saved_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_mysavedstuff.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'op_sf_cssclass' => 'ftr_subform',
// 'op_condition' =>
// array(
// array(
// 'func'=> 'chkTmpFtr',
// 'args'=> FALSE
// ),
// ),
);
</pre>
Make a column to hold the subforms:
<pre>
$data_view_left_panel =
array(
'col_id' => 'dvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$dvlp_filter_builder,
$dvlp_filter_builder_atridx,
$dvlp_subform_filters,
$dvlp_my_saved_filters
)
);
</pre>

===Results Toolbar===
Configure the tools and display options for the search page (data_view). All of the toolbars require the following in the array:
*'''type''' - Options of 'img', 'text', or 'newpage' (used in the all record view to display function in a new page)
*'''href''' - The href link to the function being called
*'''css_class''' - The css class to style the button or display
*'''mkname''' - The name of markup contained within cor_tbl_markup used for buttons which combine text and images, are just text based. Set to FALSE if not used.
*'''lightbox''' - Option of using the lightbox when calling an overlay form, set to FALSE otherwise

First form the individual buttons:

==== Tools ====
<pre>
// TOOLS
$group_tools[] =
array(
'type' => 'img',
'href' => "overlay_holder.php?sf_conf=conf_mac_userconfigfields&lboxreload=1",
'css_class' => 'gears',
'mkname' => FALSE,
'lightbox' => 'lightbox'
);
</pre>

==== Displays ====
<pre>
// DISPs
$res = "results_mode=disp";
// Text view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=text",
'css_class' => 'text',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Table view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=table",
'css_class' => 'table',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Map view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=map",
'css_class' => 'map',
'mkname' => FALSE,
'lightbox' => FALSE
);
// All record view
$group_disp[] =
array(
'type' => 'newpage',
'href' => "resultsmicro_view.php?",
'css_class' => 'printall',
'mkname' => FALSE,
'lightbox' => FALSE
);
</pre>

==== Feeds ====
<pre>
// FEEDS
$res = "results_mode=feed";
// RSS feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=rss",
'css_class' => FALSE,
'mkname' => 'rss',
'lightbox' => FALSE
);
// Atom feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=atom",
'css_class' => FALSE,
'mkname' => 'atom',
'lightbox' => FALSE
);
</pre>

==== Downloads ====
<pre>
// DOWNLOADS
$res = "results_mode=dl";
// CSV download
$group_dls[] =
array(
'type' => 'text',
'href' => "overlay_holder.php?$res&dl_mode=csv&lboxreload=1&sf_conf=conf_mac_exportdownloadcsv",
'css_class' => FALSE,
'mkname' => 'csv',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_results_nav =
array(
'tools' => $group_tools,
'result_views' => $group_disp,
'result_feeds' => $group_feeds,
'result_downloads' => $group_dls,
);
</pre>
==Micro View (Record View)==
These settings configure the micro view (or record view) page. The micro view requires configuration for the left panel, and record nav options as well as some general settings.
===General Page Settings===
Configure the index page for the micro view:
<pre>
// Default Micro viewer page (used by search result handlers)
$conf_micro_viewer = $ark_dir."micro_view.php";
</pre>

===Micro View Left Panel===
Configures the left panel in the micro view pages, requires the administrator to configure the left panel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $mvlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'micro_view' in the [[sf_module]].

====Subforms Option Example====
Define the configuration type:
<pre>
$mvlpoutput = 'subforms';
</pre>
Configure the subform module to include the relevant modules:
<pre>
$mvlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'micro_view',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$micro_view_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$mvlp_subform_module
)
);
</pre>
===Record Toolbar===
Configure the tools for the record view toolbar. This tool bar controls what navigation and options which appear in data entry record toolbar.

==== Record Navigation ====
First form the individual buttons and displays:
<pre>
// Previous record
$group_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays current site code
$group_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays current record number
$group_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays current modtype
$group_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record
$group_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Refresh View ====
<pre>
// Refresh button
$group_refresh[] =
array(
'name' => 'refresh',
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?disp_reset=default",
'css_class' => 'refresh',
'mkname' => 'reset',
'lightbox' => FALSE
);
</pre>

==== Administrator Tools ====
<pre>
// ADMIN TOOLS
// Delete record
$group_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit modtype
$group_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgtype',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgkey',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_record_nav =
array(
'record_nav' => $group_nav,
'record_refresh' => $group_refresh,
'record_admin' => $group_admin,
);
</pre>

==Map View==
This is optional, but needs to be configured correctly if you are using the mapping capabilities of ARK. It needs to be set up like other top level pages, but also a series of settings need to be configured.

===Map View Page Settings===
The page needs to be set up like all other standard top-level pages. If not using, or if you would like it to be inaccessible in the dynamic navigation set 'is_visible' to FALSE.

<pre>
// MAP VIEW PAGE SETTINGS
$conf_page_map_view =
array(
'name' =>'Map View',
'title' => 'Map View Page',
'file' => 'map_view.php',
'sgrp' => '1',
'navname' => 'mapviewnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/map_view/',
'is_visible' => TRUE
);
</pre>

===Map View Left Panel===
The first subform is to allow saving of maps from the left panel, and the second to allow downloads of maps as PDFs.
<pre>
// LEFT PANEL
// Subforms
$conf_map_wmcoverlay =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'nmedit',
'sf_title' => 'wmcoverlay',
'sf_html_id' => 'map_wmcoverlay', // Must be unique
'script' => 'php/map_admin/subforms/sf_savewmc_overlay.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);

$conf_maptopdf =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'full',
'sf_title' => 'interp',
'sf_html_id' => 'map_maptopdf', // Must be unique
'script' => 'php/map_view/subforms/sf_maptopdf.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);
</pre>
===Map View Main===
These are a series of settings that define the query layers and query maps displayed in the map view as well as the results map view.
====Map Timeout====
Mapping timeout in milliseconds- if you are using a slow WxS server set this to be high (default is 1500).
<pre>
$map_timeout = 5000;
</pre>
====WXS Query Layers====
$wxs_qlayers: mapping layers for mods - specify in this array the names of the wms/wfs layers that contain the spatial data for each mod. Bear in mind that these layers should contain an ark_id column that can be retrieved using a getFeatureInfo request.
Each layer is a seperate entry in the array containing an array of variables:
*'mod' - the mod of the item (without _cd) eg. 'cxt'
*'geom' - the geometry of the layer - eg. 'pt', 'pl' or 'pgn'
*'url' - the full url of the WMS/WFS server that is hosting the layer eg. http://localhost/ark/php/map/ark_wxs_server.php?
*'title_field' - this is the field_id of the field that you want to be displayed during the click to query, if this is set to 'GIS' then it will return the attributes in the remote GIS attribute table.
<pre>
$wxs_qlayers =
array(
'sites' => array(
'mod' => 'cxt',
'geom' => 'pt',
'url' => 'http://localhost/ark/php/map/ark_wxs_server.php?',
'title_field' => 'conf_field_name',
'style_array' =>
array(
'fillOpacity' => 0.75,
'strokeColor' => '"black"',
'fillColor' => '"red"',
'pointRadius' => 10,
)
),
);
</pre>

===WXS Query Map===
$wxs_query_map - this is the name of a saved map (saved using the map_admin tools), that you want to be the background for the 'View Results as Map'. Admins should note: the $wxs_qlayers array is used to determine which layers can be used to display the spatial data for each mod - therefore those layers HAVE to be available in the saved $wxs_query_map. Also, the more info button - if you store information about your GIS layers as ARK items then set this to TRUE. Please note you will need to have a 'gis' module and you will need to name your WMS-served GIS layers in the format for instance,'contexts_PCO06_123'
<pre>
$wxs_query_map = 'QueryMap';

$map_more_info_button = FALSE;
</pre>

Page settings.php

2012-03-21T16:12:09Z

Jessogden: /* Map View */

As of v1.0, all settings related to individual page displays, navigation, and toolbars are to be included in the [[page_settings.php]].
==Navigation==
===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',
'overlay_holder.php',
'export.php',
'alias_admin.php',
'markup_admin.php',
'import.php'
);
</pre>
===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>
==User Home==
These settings control the subforms and left panel in the user home. The user home needs configuration both for the left panel and for the subforms included in the main area.
===User Home Left Panel===
Configures the left panel in the user home pages, requires the administrator to configure the lpanel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $uhlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'user_home' in the [[sf_module]].
====Subforms Option Example====
Define the configuration type:
<pre>
$uhlpoutput = 'subforms';
</pre>
Configure the subform:
<pre>
$uhlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'user_home',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$user_home_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$uhlp_subform_module
)
);
</pre>
== Data Entry ==
These settings configure the data entry page. The data entry requires configuration for both the left panel and the record navigation bar appearing at the top of the main area. Further options for advanced file upload are also included below.
=== Data Entry Left Panel ===
This section gives examples for the left panel configuration in the data entry pages using either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation.
==== Minimiser Option ====
This tool condenses subforms and offers quick navigation in left panel. To use the minimiser on specific data entry pages you need to go to the mod_settings files (ex. mod_cxt_settings.php) and make sure that 'col_type' => 'collaps_col', instead of single_col in the $conf_dat_materi and $conf_dat_detfrm settings.
<pre>
$minimiser = TRUE;
</pre>

====Link list Option Example====

Define the configuration type:
<pre>
$delpoutput = 'linklist';
</pre>
Configure the links:
<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=files",
'mknname' => 'uplfile'
);
</pre>

====Subforms Option Example====

Define the configuration type:
<pre>
$delpoutput = 'subforms';
</pre>

Configure the linklist (in this case, a linklist is being used to display the upload files link and the sf_linklist is calling the link):
<pre>
$link_list_admin[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=files",
'mknname' => 'uplfile',
'img' => 'bigplus.png'
);
</pre>

Configure the subforms - Subform listing the modules:
<pre>
$delp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpmodlist',
'sf_html_id' => 'delpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'data_entry',
'fields' => array (
'cxt',
'smp',
'spf',
'sph',
)
);
</pre>
Admin Subform calling the file upload linklist from above:
<pre>
$delp_subform_admin =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpadmin',
'sf_html_id' => 'delpadmin', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_label' => 'space',
'op_input' => 'save',
'op_linktype' => 'icon',
'op_sf_cssclass' => 'module_list',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'fields' => $link_list_admin
);
</pre>
Load the subforms:
<pre>
$data_entry_left_panel =
array(
'col_id' => 'delp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$delp_subform_module,
$delp_subform_admin
)
);
</pre>

=== Data Entry Toolbar ===
Configure the tools for data entry. First form the individual buttons and displays:
==== User Navigation ====
<pre>
// Previous record button
$group_entry_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays site code
$group_entry_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays record number
$group_entry_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays module type
$group_entry_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record button
$group_entry_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Administrator tools ====
<pre>
// Delete record
$group_entry_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit module type
$group_entry_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chngmod',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_entry_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'DEL',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_entry_nav =
array(
'record_nav' => $group_entry_nav,
'record_admin' => $group_entry_admin,
);
</pre>

===Advanced File Upload===
The following includes instructions on how to configure the advanced file uploader which was developed as a mechanism for not only batch uploading files, but also registering and/or linking them to existing records on the fly.
*'''on''' - Set to TRUE, advanced file uploader dialog is displayed.
*'''pattern''' - This is a regex (Regular expression) designed to detect the file names and associate the files with the appropriate records (item_keys). These example expressions are set up to treat the first 3 letters of a file name as the relevant site code and the numbers following as the number. (For example: 'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-zA-Z0-9]*))\.[a-zA-Z]{2,4}\b/i" handles files xxx-1234.jpg, xxx-1234-yyy.jpg, where xxx can be any letter and yyy any alphanumeric combination, only number before first '-' is used as an ID)
<pre>
$fu =
array(
'on' => TRUE,
'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-z0-9A-Z]*))\.[a-z0-9]{2,4}\b/i",
);
</pre>

==Data View (Search)==
These settings configure the data view (or search) page. The data view requires configuration for the left panel, the search tools options (results views, download options, etc) as well as some general settings for search results.
===General Page Settings===
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>

And the number of pages to display on the data viewer:
<pre>
// Number of pages to display on the data viewer
$conf_num_res_pgs = 5; // best choose an odd number
</pre>

Also configure the index pages for Data View and Search pages:
<pre>
// 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 (options include: text, table, or map):
<pre>
// Default $output_mode for the data viewer
$default_output_mode = 'table';
</pre>
===Data View Left Panel===
This configures the left panel for the data view pages through a series of complex subforms including [[sf_linklist]], [[sf_buildfilter]], and [[sf_mysavedstuff]].
====Configure the linklist====
First configure the linklist, which requires the following:
*'''href''' - link to the output ({$_SERVER['PHP_SELF']} is on same page, and then links to the key ID in the relevant cor table of the designated data filter
*'''mknname''' - mark-up nickname will search the markup table for this nickname and print the markup
*'''img''' - optional image for the icon defined in the subform linklist:
<pre>
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=1&ftr_id=new",
'mknname' => 'filtercxt',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=6&ftr_id=new",
'mknname' => 'filtersmp',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=stecd&ftr_id=new",
'mknname' => 'filterstecd',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=action&ftr_id=new",
'mknname' => 'filteractor',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=ftx&ftr_id=new",
'mknname' => 'ftx',
'img' => 'view_mag.png'
);
</pre>

Configure the linklist subform:
<pre>
$dvlp_subform_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_linktype' => 'icon',
'op_sf_cssclass' => 'ftr_list',
'fields' => $link_list_filters
);
</pre>

====Filter Builders====
Various options exist for the types of filters administrators will want to make available to users- including different stages of pre-built or partially executed filters. For more information on this subform and options see [[sf_buildfilter]].
 
Subform for the filter builder to run in the left panel:
<pre>
$dvlp_filter_builder =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_condition' =>
array(
array(
'func'=> 'chkTmpFtr',
'args'=> FALSE
),
),
);
</pre>
Subform for the filter builder to run in the left panel preloaded with a filter:
<pre>
$dvlp_filter_builder_atridx =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_filter' => 'atr', // the filter to be used
'op_filter_args' =>
array(
// 'arg' => 'var', // example
'atrtype' => 1,
'op_display' => 'dd'
)
// 'op_condition' =>
// array(
// array(
// 'func'=> 'chkTmpFtr',
// 'args'=> FALSE
// ),
// ),
);

</pre>
Subform for user saved filters
<pre>
$dvlp_my_saved_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'savedfilters',
'sf_html_id' => 'dvlp_saved_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_mysavedstuff.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'op_sf_cssclass' => 'ftr_subform',
// 'op_condition' =>
// array(
// array(
// 'func'=> 'chkTmpFtr',
// 'args'=> FALSE
// ),
// ),
);
</pre>
Make a column to hold the subforms:
<pre>
$data_view_left_panel =
array(
'col_id' => 'dvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$dvlp_filter_builder,
$dvlp_filter_builder_atridx,
$dvlp_subform_filters,
$dvlp_my_saved_filters
)
);
</pre>

===Results Toolbar===
Configure the tools and display options for the search page (data_view). All of the toolbars require the following in the array:
*'''type''' - Options of 'img', 'text', or 'newpage' (used in the all record view to display function in a new page)
*'''href''' - The href link to the function being called
*'''css_class''' - The css class to style the button or display
*'''mkname''' - The name of markup contained within cor_tbl_markup used for buttons which combine text and images, are just text based. Set to FALSE if not used.
*'''lightbox''' - Option of using the lightbox when calling an overlay form, set to FALSE otherwise

First form the individual buttons:

==== Tools ====
<pre>
// TOOLS
$group_tools[] =
array(
'type' => 'img',
'href' => "overlay_holder.php?sf_conf=conf_mac_userconfigfields&lboxreload=1",
'css_class' => 'gears',
'mkname' => FALSE,
'lightbox' => 'lightbox'
);
</pre>

==== Displays ====
<pre>
// DISPs
$res = "results_mode=disp";
// Text view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=text",
'css_class' => 'text',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Table view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=table",
'css_class' => 'table',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Map view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=map",
'css_class' => 'map',
'mkname' => FALSE,
'lightbox' => FALSE
);
// All record view
$group_disp[] =
array(
'type' => 'newpage',
'href' => "resultsmicro_view.php?",
'css_class' => 'printall',
'mkname' => FALSE,
'lightbox' => FALSE
);
</pre>

==== Feeds ====
<pre>
// FEEDS
$res = "results_mode=feed";
// RSS feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=rss",
'css_class' => FALSE,
'mkname' => 'rss',
'lightbox' => FALSE
);
// Atom feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=atom",
'css_class' => FALSE,
'mkname' => 'atom',
'lightbox' => FALSE
);
</pre>

==== Downloads ====
<pre>
// DOWNLOADS
$res = "results_mode=dl";
// CSV download
$group_dls[] =
array(
'type' => 'text',
'href' => "overlay_holder.php?$res&dl_mode=csv&lboxreload=1&sf_conf=conf_mac_exportdownloadcsv",
'css_class' => FALSE,
'mkname' => 'csv',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_results_nav =
array(
'tools' => $group_tools,
'result_views' => $group_disp,
'result_feeds' => $group_feeds,
'result_downloads' => $group_dls,
);
</pre>
==Micro View (Record View)==
These settings configure the micro view (or record view) page. The micro view requires configuration for the left panel, and record nav options as well as some general settings.
===General Page Settings===
Configure the index page for the micro view:
<pre>
// Default Micro viewer page (used by search result handlers)
$conf_micro_viewer = $ark_dir."micro_view.php";
</pre>

===Micro View Left Panel===
Configures the left panel in the micro view pages, requires the administrator to configure the left panel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $mvlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'micro_view' in the [[sf_module]].

====Subforms Option Example====
Define the configuration type:
<pre>
$mvlpoutput = 'subforms';
</pre>
Configure the subform module to include the relevant modules:
<pre>
$mvlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'micro_view',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$micro_view_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$mvlp_subform_module
)
);
</pre>
===Record Toolbar===
Configure the tools for the record view toolbar. This tool bar controls what navigation and options which appear in data entry record toolbar.

==== Record Navigation ====
First form the individual buttons and displays:
<pre>
// Previous record
$group_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays current site code
$group_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays current record number
$group_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays current modtype
$group_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record
$group_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Refresh View ====
<pre>
// Refresh button
$group_refresh[] =
array(
'name' => 'refresh',
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?disp_reset=default",
'css_class' => 'refresh',
'mkname' => 'reset',
'lightbox' => FALSE
);
</pre>

==== Administrator Tools ====
<pre>
// ADMIN TOOLS
// Delete record
$group_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit modtype
$group_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgtype',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgkey',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_record_nav =
array(
'record_nav' => $group_nav,
'record_refresh' => $group_refresh,
'record_admin' => $group_admin,
);
</pre>

==Map View==
This is optional, but needs to be configured correctly if you are using the mapping capabilities of ARK. It needs to be set up like other top level pages, but also a series of settings need to be configured.

===Map View Page Settings===
The page needs to be set up like all other standard top-level pages. If not using, or if you would like it to be inaccessible in the dynamic navigation set 'is_visible' to FALSE.

<pre>
// MAP VIEW PAGE SETTINGS
$conf_page_map_view =
array(
'name' =>'Map View',
'title' => 'Map View Page',
'file' => 'map_view.php',
'sgrp' => '1',
'navname' => 'mapviewnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/map_view/',
'is_visible' => TRUE
);
</pre>

===Map View Left Panel===
The first subform is to allow saving of maps from the left panel, and the second to allow downloads of maps as PDFs.
<pre>
// LEFT PANEL
// Subforms
$conf_map_wmcoverlay =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'nmedit',
'sf_title' => 'wmcoverlay',
'sf_html_id' => 'map_wmcoverlay', // Must be unique
'script' => 'php/map_admin/subforms/sf_savewmc_overlay.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);

$conf_maptopdf =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'full',
'sf_title' => 'interp',
'sf_html_id' => 'map_maptopdf', // Must be unique
'script' => 'php/map_view/subforms/sf_maptopdf.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);
</pre>
===Map View Main===
These are a series of settings that define the query layers and query maps displayed in the map view as well as the results map view.
====Map Timeout====
Mapping timeout in milliseconds- if you are using a slow WxS server set this to be high (default is 1500).
<pre>
$map_timeout = 5000;
</pre>
====WXS Query Layers====
$wxs_qlayers: mapping layers for mods - specify in this array the names of the wms/wfs layers that contain the spatial data for each mod. Bear in mind that these layers should contain an ark_id column that can be retrieved using a getFeatureInfo request.
Each layer is a seperate entry in the array containing an array of variables:
*'mod' - the mod of the item (without _cd) eg. 'cxt'
*'geom' - the geometry of the layer - eg. 'pt', 'pl' or 'pgn'
*'url' - the full url of the WMS/WFS server that is hosting the layer eg. http://localhost/ark/php/map/ark_wxs_server.php?
*'title_field' - this is the field_id of the field that you want to be displayed during the click to query, if this is set to 'GIS' then it will return the attributes in the remote GIS attribute table.
<pre>
$wxs_qlayers =
array(
'sites' => array(
'mod' => 'cxt',
'geom' => 'pt',
'url' => 'http://localhost/ark/php/map/ark_wxs_server.php?',
'title_field' => 'conf_field_name',
'style_array' =>
array(
'fillOpacity' => 0.75,
'strokeColor' => '"black"',
'fillColor' => '"red"',
'pointRadius' => 10,
)
),
);
</pre>
===WXS Query Map===
$wxs_query_map - this is the name of a saved map (saved using the map_admin tools), that you want to be the background for the 'View Results as Map'. Admins should note: the $wxs_qlayers array is used to determine which layers can be used to display the spatial data for each mod - therefore those layers HAVE to be available in the saved $wxs_query_map. Also, the more info button - if you store information about your GIS layers as ARK items then set this to TRUE. Please note you will need to have a 'gis' module and you will need to name your WMS-served GIS layers in the format for instance,'contexts_PCO06_123'
<pre>
$wxs_query_map = 'QueryMap';

$map_more_info_button = FALSE;
</pre>

Page settings.php

2012-03-21T15:57:08Z

Jessogden:

As of v1.0, all settings related to individual page displays, navigation, and toolbars are to be included in the [[page_settings.php]].
==Navigation==
===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',
'overlay_holder.php',
'export.php',
'alias_admin.php',
'markup_admin.php',
'import.php'
);
</pre>
===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>
==User Home==
These settings control the subforms and left panel in the user home. The user home needs configuration both for the left panel and for the subforms included in the main area.
===User Home Left Panel===
Configures the left panel in the user home pages, requires the administrator to configure the lpanel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $uhlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'user_home' in the [[sf_module]].
====Subforms Option Example====
Define the configuration type:
<pre>
$uhlpoutput = 'subforms';
</pre>
Configure the subform:
<pre>
$uhlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'user_home',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$user_home_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$uhlp_subform_module
)
);
</pre>
== Data Entry ==
These settings configure the data entry page. The data entry requires configuration for both the left panel and the record navigation bar appearing at the top of the main area. Further options for advanced file upload are also included below.
=== Data Entry Left Panel ===
This section gives examples for the left panel configuration in the data entry pages using either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation.
==== Minimiser Option ====
This tool condenses subforms and offers quick navigation in left panel. To use the minimiser on specific data entry pages you need to go to the mod_settings files (ex. mod_cxt_settings.php) and make sure that 'col_type' => 'collaps_col', instead of single_col in the $conf_dat_materi and $conf_dat_detfrm settings.
<pre>
$minimiser = TRUE;
</pre>

====Link list Option Example====

Define the configuration type:
<pre>
$delpoutput = 'linklist';
</pre>
Configure the links:
<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=files",
'mknname' => 'uplfile'
);
</pre>

====Subforms Option Example====

Define the configuration type:
<pre>
$delpoutput = 'subforms';
</pre>

Configure the linklist (in this case, a linklist is being used to display the upload files link and the sf_linklist is calling the link):
<pre>
$link_list_admin[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?view=files",
'mknname' => 'uplfile',
'img' => 'bigplus.png'
);
</pre>

Configure the subforms - Subform listing the modules:
<pre>
$delp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpmodlist',
'sf_html_id' => 'delpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'data_entry',
'fields' => array (
'cxt',
'smp',
'spf',
'sph',
)
);
</pre>
Admin Subform calling the file upload linklist from above:
<pre>
$delp_subform_admin =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'delpadmin',
'sf_html_id' => 'delpadmin', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_label' => 'space',
'op_input' => 'save',
'op_linktype' => 'icon',
'op_sf_cssclass' => 'module_list',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'fields' => $link_list_admin
);
</pre>
Load the subforms:
<pre>
$data_entry_left_panel =
array(
'col_id' => 'delp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$delp_subform_module,
$delp_subform_admin
)
);
</pre>

=== Data Entry Toolbar ===
Configure the tools for data entry. First form the individual buttons and displays:
==== User Navigation ====
<pre>
// Previous record button
$group_entry_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays site code
$group_entry_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays record number
$group_entry_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays module type
$group_entry_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record button
$group_entry_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Administrator tools ====
<pre>
// Delete record
$group_entry_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit module type
$group_entry_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chngmod',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_entry_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'DEL',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_entry_nav =
array(
'record_nav' => $group_entry_nav,
'record_admin' => $group_entry_admin,
);
</pre>

===Advanced File Upload===
The following includes instructions on how to configure the advanced file uploader which was developed as a mechanism for not only batch uploading files, but also registering and/or linking them to existing records on the fly.
*'''on''' - Set to TRUE, advanced file uploader dialog is displayed.
*'''pattern''' - This is a regex (Regular expression) designed to detect the file names and associate the files with the appropriate records (item_keys). These example expressions are set up to treat the first 3 letters of a file name as the relevant site code and the numbers following as the number. (For example: 'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-zA-Z0-9]*))\.[a-zA-Z]{2,4}\b/i" handles files xxx-1234.jpg, xxx-1234-yyy.jpg, where xxx can be any letter and yyy any alphanumeric combination, only number before first '-' is used as an ID)
<pre>
$fu =
array(
'on' => TRUE,
'pattern' => "/\b[a-zA-Z]*\-(([0-9]*)|(([0-9]*)-[a-z0-9A-Z]*))\.[a-z0-9]{2,4}\b/i",
);
</pre>

==Data View (Search)==
These settings configure the data view (or search) page. The data view requires configuration for the left panel, the search tools options (results views, download options, etc) as well as some general settings for search results.
===General Page Settings===
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>

And the number of pages to display on the data viewer:
<pre>
// Number of pages to display on the data viewer
$conf_num_res_pgs = 5; // best choose an odd number
</pre>

Also configure the index pages for Data View and Search pages:
<pre>
// 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 (options include: text, table, or map):
<pre>
// Default $output_mode for the data viewer
$default_output_mode = 'table';
</pre>
===Data View Left Panel===
This configures the left panel for the data view pages through a series of complex subforms including [[sf_linklist]], [[sf_buildfilter]], and [[sf_mysavedstuff]].
====Configure the linklist====
First configure the linklist, which requires the following:
*'''href''' - link to the output ({$_SERVER['PHP_SELF']} is on same page, and then links to the key ID in the relevant cor table of the designated data filter
*'''mknname''' - mark-up nickname will search the markup table for this nickname and print the markup
*'''img''' - optional image for the icon defined in the subform linklist:
<pre>
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=1&ftr_id=new",
'mknname' => 'filtercxt',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=key&key=6&ftr_id=new",
'mknname' => 'filtersmp',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=stecd&ftr_id=new",
'mknname' => 'filterstecd',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=action&ftr_id=new",
'mknname' => 'filteractor',
'img' => 'view_mag.png'
);
$link_list_filters[] =
array(
'href' => "{$_SERVER['PHP_SELF']}?ftype=ftx&ftr_id=new",
'mknname' => 'ftx',
'img' => 'view_mag.png'
);
</pre>

Configure the linklist subform:
<pre>
$dvlp_subform_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/subforms/sf_linklist.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_linktype' => 'icon',
'op_sf_cssclass' => 'ftr_list',
'fields' => $link_list_filters
);
</pre>

====Filter Builders====
Various options exist for the types of filters administrators will want to make available to users- including different stages of pre-built or partially executed filters. For more information on this subform and options see [[sf_buildfilter]].
 
Subform for the filter builder to run in the left panel:
<pre>
$dvlp_filter_builder =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_condition' =>
array(
array(
'func'=> 'chkTmpFtr',
'args'=> FALSE
),
),
);
</pre>
Subform for the filter builder to run in the left panel preloaded with a filter:
<pre>
$dvlp_filter_builder_atridx =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'dvlp_filters',
'sf_html_id' => 'dvlp_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_buildfilter.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
// Does the linklist use an icon instead of a label as link
'op_sf_cssclass' => 'ftr_subform',
'op_filter' => 'atr', // the filter to be used
'op_filter_args' =>
array(
// 'arg' => 'var', // example
'atrtype' => 1,
'op_display' => 'dd'
)
// 'op_condition' =>
// array(
// array(
// 'func'=> 'chkTmpFtr',
// 'args'=> FALSE
// ),
// ),
);

</pre>
Subform for user saved filters
<pre>
$dvlp_my_saved_filters =
array(
'view_state' => 'min',
'edit_state' => 'view',
'sf_nav_type' => 'name',
'sf_title' => 'savedfilters',
'sf_html_id' => 'dvlp_saved_filters', // Must be unique
'script' => 'php/data_view/subforms/sf_mysavedstuff.php',
'op_modtype' => FALSE, //if each modtype uses same fields (see below)
'op_sf_cssclass' => 'ftr_subform',
// 'op_condition' =>
// array(
// array(
// 'func'=> 'chkTmpFtr',
// 'args'=> FALSE
// ),
// ),
);
</pre>
Make a column to hold the subforms:
<pre>
$data_view_left_panel =
array(
'col_id' => 'dvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$dvlp_filter_builder,
$dvlp_filter_builder_atridx,
$dvlp_subform_filters,
$dvlp_my_saved_filters
)
);
</pre>

===Results Toolbar===
Configure the tools and display options for the search page (data_view). All of the toolbars require the following in the array:
*'''type''' - Options of 'img', 'text', or 'newpage' (used in the all record view to display function in a new page)
*'''href''' - The href link to the function being called
*'''css_class''' - The css class to style the button or display
*'''mkname''' - The name of markup contained within cor_tbl_markup used for buttons which combine text and images, are just text based. Set to FALSE if not used.
*'''lightbox''' - Option of using the lightbox when calling an overlay form, set to FALSE otherwise

First form the individual buttons:

==== Tools ====
<pre>
// TOOLS
$group_tools[] =
array(
'type' => 'img',
'href' => "overlay_holder.php?sf_conf=conf_mac_userconfigfields&lboxreload=1",
'css_class' => 'gears',
'mkname' => FALSE,
'lightbox' => 'lightbox'
);
</pre>

==== Displays ====
<pre>
// DISPs
$res = "results_mode=disp";
// Text view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=text",
'css_class' => 'text',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Table view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=table",
'css_class' => 'table',
'mkname' => FALSE,
'lightbox' => FALSE
);
// Map view
$group_disp[] =
array(
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?$res&disp_mode=map",
'css_class' => 'map',
'mkname' => FALSE,
'lightbox' => FALSE
);
// All record view
$group_disp[] =
array(
'type' => 'newpage',
'href' => "resultsmicro_view.php?",
'css_class' => 'printall',
'mkname' => FALSE,
'lightbox' => FALSE
);
</pre>

==== Feeds ====
<pre>
// FEEDS
$res = "results_mode=feed";
// RSS feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=rss",
'css_class' => FALSE,
'mkname' => 'rss',
'lightbox' => FALSE
);
// Atom feed
$group_feeds[] =
array(
'type' => 'text',
'href' => "{$_SERVER['PHP_SELF']}?$res&feed_mode=atom",
'css_class' => FALSE,
'mkname' => 'atom',
'lightbox' => FALSE
);
</pre>

==== Downloads ====
<pre>
// DOWNLOADS
$res = "results_mode=dl";
// CSV download
$group_dls[] =
array(
'type' => 'text',
'href' => "overlay_holder.php?$res&dl_mode=csv&lboxreload=1&sf_conf=conf_mac_exportdownloadcsv",
'css_class' => FALSE,
'mkname' => 'csv',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_results_nav =
array(
'tools' => $group_tools,
'result_views' => $group_disp,
'result_feeds' => $group_feeds,
'result_downloads' => $group_dls,
);
</pre>
==Micro View (Record View)==
These settings configure the micro view (or record view) page. The micro view requires configuration for the left panel, and record nav options as well as some general settings.
===General Page Settings===
Configure the index page for the micro view:
<pre>
// Default Micro viewer page (used by search result handlers)
$conf_micro_viewer = $ark_dir."micro_view.php";
</pre>

===Micro View Left Panel===
Configures the left panel in the micro view pages, requires the administrator to configure the left panel with either Option 1 (linklists) or Option 2 (subforms) as defined in the [[left_panel]] documentation. Requires the $mvlpoutput to be set, and when using the subform option requires the 'ark_page' to be set to 'micro_view' in the [[sf_module]].

====Subforms Option Example====
Define the configuration type:
<pre>
$mvlpoutput = 'subforms';
</pre>
Configure the subform module to include the relevant modules:
<pre>
$mvlp_subform_module =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'none',
'sf_title' => 'mvlpmodlist',
'sf_html_id' => 'mvlpmodlist', // Must be unique
'script' => 'php/subforms/sf_module.php',
'ark_page'=> 'micro_view',
'fields' => array (
'cxt',
'smp',
'spf',
'sph'
)
);
</pre>
Load the subform:
<pre>
$micro_view_left_panel =
array(
'col_id' => 'mvlp',
'col_alias' => FALSE,
'col_type' => 'primary_col',
'subforms' =>
array(
$mvlp_subform_module
)
);
</pre>
===Record Toolbar===
Configure the tools for the record view toolbar. This tool bar controls what navigation and options which appear in data entry record toolbar.

==== Record Navigation ====
First form the individual buttons and displays:
<pre>
// Previous record
$group_nav[] =
array(
'name' => 'prev',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'prev',
'lightbox' => FALSE
);
// Displays current site code
$group_nav[] =
array(
'name' => 'ste_cd',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'ste_cd',
'lightbox' => FALSE
);
// Displays current record number
$group_nav[] =
array(
'name' => 'current',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'current',
'lightbox' => FALSE
);
// Displays current modtype
$group_nav[] =
array(
'name' => 'modtype',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'modtype',
'lightbox' => FALSE
);
// Next record
$group_nav[] =
array(
'name' => 'next',
'type' => 'text',
'href' => "",
'css_class' => FALSE,
'mkname' => 'next',
'lightbox' => FALSE
);
</pre>

==== Refresh View ====
<pre>
// Refresh button
$group_refresh[] =
array(
'name' => 'refresh',
'type' => 'img',
'href' => "{$_SERVER['PHP_SELF']}?disp_reset=default",
'css_class' => 'refresh',
'mkname' => 'reset',
'lightbox' => FALSE
);
</pre>

==== Administrator Tools ====
<pre>
// ADMIN TOOLS
// Delete record
$group_admin[] =
array(
'name' => 'delete',
'type' => 'img',
'href' => FALSE,
'css_class' => 'delimg',
'mkname' => 'del',
'lightbox' => 'lightbox|200'
);
// Edit modtype
$group_admin[] =
array(
'name' => 'changemod',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgtype',
'lightbox' => 'lightbox|200'
);
// Edit record number
$group_admin[] =
array(
'name' => 'changeval',
'type' => 'text',
'href' => FALSE,
'css_class' => 'recedit',
'mkname' => 'chgkey',
'lightbox' => 'lightbox|200'
);
</pre>

And then put them in the toolbar conf array:
<pre>
// Package these button groups up into a toolbar
$conf_record_nav =
array(
'record_nav' => $group_nav,
'record_refresh' => $group_refresh,
'record_admin' => $group_admin,
);
</pre>

==Map View==
This is optional, but needs to be configured correctly if you are using the mapping capabilities of ARK. It needs to be set up like other top level pages, but also a series of settings need to be configured.

<pre>
// MAP VIEW PAGE SETTINGS
$conf_page_map_view =
array(
'name' =>'Map View',
'title' => 'Map View Page',
'file' => 'map_view.php',
'sgrp' => '1',
'navname' => 'mapviewnav',
'navlinkvars' => '?view=home',
'cur_code_dir' => 'php/map_view/',
'is_visible' => TRUE
);
</pre>

<pre>
// LEFT PANEL
// Subforms
$conf_map_wmcoverlay =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'full',
'sf_title' => 'interp',
'sf_html_id' => 'map_wmcoverlay', // Must be unique
'script' => 'php/map_admin/subforms/sf_savewmc_overlay.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);

$conf_maptopdf =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'full',
'sf_title' => 'interp',
'sf_html_id' => 'map_maptopdf', // Must be unique
'script' => 'php/map_view/subforms/sf_maptopdf.php',
'op_label' => 'space',
'op_input' => 'save',
'fields' => array(
)
);
</pre>

<pre>
// MAIN PANEL
//mapping timeout in milliseconds- if you are using a slow WxS server set this to be high (default is 1500)
$map_timeout = 5000;
</pre>

<pre>
/*
$wxs_qlayers:
mapping layers for mods - specify in this array the names of the wms/wfs layers
that contain the spatial data for each mod. Bear in mind that these layers should
contain an ark_id column that can be retrieved using a getFeatureInfo request.
Each layer is a seperate entry in the array containing an array of variables
'mod' - the mod of the item (without _cd) eg. 'cxt'
'geom' - the geometry of the layer - eg. 'pt', 'pl' or 'pgn'
'url' - the full url of the WMS/WFS server that is hosting the layer eg. http://localhost/ark/php/map/ark_wxs_server.php?
'title_field' - this is the field_id of the field that you want to be displayed during the click to query
if this is set to 'GIS' then it will return the attributes in the remote GIS attribute table
*/
$wxs_qlayers =
array(
'sites' => array(
'mod' => 'fst',
'geom' => 'pt',
'url' => 'http://lpisolde.dyndns.org/fastiadmin/php/map/ark_wxs_server.php?',
'title_field' => 'conf_field_sitename',
'style_array' =>
array(
'fillOpacity' => 0.75,
'strokeColor' => '"black"',
'fillColor' => '"red"',
'pointRadius' => 10,
)
),
);
</pre>

<pre>
/*
$wxs_query_map - this is the name of a saved map (saved using the map_admin tools),
that you want to be the background for the 'View Results as Map'.
ADMIN NOTE: the $wxs_qlayers array is used to determine which layers can be used to
display the spatial data for each mod - therefore those layers HAVE to be available in the saved
$wxs_query_map
*/

$wxs_query_map = 'QueryMap';

//the more info button - if you store information about your GIS layers as ARK items then set this to true.
//Please note you will need to have a 'gis' module and you will need to name your WMS-served GIS layers in the format -
//'contexts_PCO06_123';
$map_more_info_button = FALSE;
</pre>

Settings.php

2012-03-21T15:49:11Z

Jessogden:

This is the main settings file for administrators to set defaults for security settings and permissions, loaded modules, etc. for each instance of ARK. As of v1.0, for settings related to page display and navigation see [[page_settings.php]], and those related to server settings see [[env_settings.php]].

==Server Setup==
The server setup being used (can include"ms4w", "mac", or "linux"):
<pre>
$server="ms4w";
</pre>

And include the settings related to your server environment contained within the [[env_settings.php]]:
<pre>
// Include settings related to your server environment
include('env_settings.php');
</pre>

==ARK Name and Markup==
The name of this instance of ARK - can not contain spaces!
<pre>
// The Ark name
$ark_name = 'Tutorial';
</pre>
The name of this instance of ARK - as markup. Appears on the index (home) page and in the browser window/tab title. Should be entered in cor_tbl_markup accordingly.
<pre>
// The nickname for the markup ARK name that appears on the index page and
// as browser window/tab title
$arkname_mk = 'arkname';
</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>

'''NB- Controls for xmi live search should not be included in the global settings, this has been moved to the subform configuration as of v0.7'''

<strike>Also the controls for live search for XMI </strike>
<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>

==Fancy Text Search==
The controls for fancy text search, using boolean functions such as +, -, "search term", etc (like Google).
<pre>
// Free text search mode
/*
* fancy - this allows complex search options such as +, -, "" (like Google!)
* plain = plain free text search, no fancy options
*/
$ftx_mode = "fancy";
</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 and Permissions==
The security and permissions for ARK is handled by LiveUser.
===Security===
The liveuser settings need to be set, as well as the variables for allowing anonymous logins. The liveuser configuration is as follows:
<pre>
// -- SECURITY -- //
// 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 for this to work - you will also need to make a new user (using the ARK user_admin tools).
$anonymous_login['username'] = 'anon';
$anonymous_login['password'] = 'anon';
</pre>

===Permissions===
A variety of permissions need to be set to ensure the appropriate users are making use of advanced functions. All permissions are based on the numerical id of security groups (from the cor_lvu_groups table). For instance, it is possible to allow some users to make their personal saved filters public for all to use. As of v0.8, adding to control lists (adding attributes), and perhaps most importantly, advanced record functions such as edit module types and delete entire records need to also have sgrps defined.
<pre>
// Filter permissions
// Members of the following (sgrp) groups will have permission to make their own filters public
// and permission to make other users (and their own) filters got private
$ftr_admin_grps =
array(
1
);

// Control list permissions
// Members of the following (sgrp) groups will have permission to add items to controlled lists
$ctrllist_admin_grps =
array(
1
);
// Record admin permissions
// Members of the following (sgrp) groups will have access to the advanced record functions
$record_admin_grps =
array(
2
);
</pre>

==Forms==
===Form Methods===
Choose between 'get' or 'post' form methods.
<pre>
// -- FORMS -- //
// Method used in forms:
// get = form messages sent via get method - visible in browser bar.
// post = form message sent via post method - invisible to the user.
$form_method = 'get';
</pre>
===Form Defaults===
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>

==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>

==Logging==
Configures logging levels to record logging into database and changes to data. Set to 'on' to turn the logging on, otherwise set to FALSE.
<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>

[[Category: Administrator]]

Subform Options

2011-11-20T12:41:30Z

Jessogden:

Optional settings should all be defined using the 'op_' prefix. The optional settings described here are generic to all subforms. Other script specific settings should be documented IN THAT SCRIPT.

This is a rough and ready list of op_ setting that can be added to subforms. Options are by their nature optional. Do NOT add any options that must be set (these should be given proper names and descibed under [[Subform Requirements]]).

*'''op_label''' - the label for the options row of the form (markup nname)
*'''op_input''' - the label to appear in the button (markup nname)
*'''op_register_mod''' - used to change sf_key of the register sf, embedded registers need this (note this is fundamental in overlays as you would only use this to add records in a different module)
*'''op_modtype''' - TRUE (using different fields for each modtype) or FALSE (using one fields list for all different modtypes)
*'''op_src_meta_display''' - required in any subform with a mini search box made by mkSearchSimple(), requires an array ($conf_''mod''_res_meta_fields) to be setup for the module being searched, this option switches on the display of meta fields for the module being searched (eg always show a contact's name when searching the ABK)

[[Category: Developer]][[Category: Administrator]]

Subform Options

2011-11-20T12:40:42Z

Jessogden:

Optional settings should all be defined using the 'op_' prefix. The optional settings described here are generic to all subforms. Other script specific settings should be documented IN THAT SCRIPT.

This is a rough and ready list of op_ setting that can be added to subforms. Options are by their nature optional. Do NOT add any options that must be set (these should be given proper names and descibed under [[Subform Requirements]]).

*'''op_label''' - the label for the options row of the form (markup nname)
*'''op_input''' - the label to appear in the button (markup nname)
*'''op_register_mod''' - used to change sf_key of the register sf, embedded registers need this (note this is fundamental in overlays as you would only use this to add records in a different module)
*'''op_modtype - TRUE (using different fields for each modtype) or FALSE (using one fields list for all different modtypes)
*'''op_lightbox''' - using lightbox in this subform (TRUE/FALSE)
*'''op_src_meta_display''' - required in any subform with a mini search box made by mkSearchSimple(), requires an array ($conf_''mod''_res_meta_fields) to be setup for the module being searched, this option switches on the display of meta fields for the module being searched (eg always show a contact's name when searching the ABK)

[[Category: Developer]][[Category: Administrator]]