2009-04-18T14:43:53Z

Andydufton:

===Description===
The sf_frame groups together several subforms for inclusion in a single frame in the data view and micro view pages. This is primarily an issue of display and user interface rather than a subform that handles db requests.

===Additional Fields===
Instead of a 'field' array, the frame subform requires an 'subform' array.

===Example Configuration===
<pre>
$conf_mcd_consframe =
array(
'view_state' => 'max',
'edit_state' => 'view',
'sf_nav_type' => 'full',
'sf_title' => 'consattr',
'sf_html_id' => 'mus_consframe', // Must be unique
'script' => 'php/subforms/sf_frame.php',
'op_label' => 'space',
'op_input' => 'save',
'op_condition' => array(
array(
'func'=> 'chkGroupPerm',
'args'=> array(
2
)
),
),
'subforms' => array(
$conf_mcd_consattr,
$conf_mcd_constxt,
)
);
</pre>

[[category:Administrator]]

Subform Reference

2009-04-18T14:34:56Z

Andydufton:

The following is a list of all current ARK subforms. Each subform page includes detailed configuration information and an example subform setup.

'''NB - AS OF ARK 0.7 THE CONFIGURATION OF SUBFORMS USING MODTYPES WILL CHANGE TO RELY SOLELY ON THE [[Conditional Subforms]] OPTION.'''

===Text Subforms===
*'''[[sf_txt]]''' - subform to enter text data

===Number Subforms===
*'''[[sf_number]]''' - subform to add number data

===Attribute Subforms===
*'''[[sf_finds]]''' - subform to attach attributes of a given type (findtypes) and to set a boolean for each one
*'''[[sf_attr_bytype]]''' - subform to attach attributes of a given type
*'''[[sf_attr_boolean]]''' - subform to set boolean attribute

===Spatial Subforms===
*'''[[sf_spat]]''' - a subform to display spatial data about an item ''THIS SUBFORM IS DEPRECATED AND SHOULD NOT BE USED FOR ANY NEW ARK SYSTEMS''
*'''[[sf_wfs_spat]]''' - the new subform to display spatial data about an item

===Span Subforms===
*'''[[sf_span_rel]]''' - subform to enter span relationships not in matrix form
*'''[[sf_spanmatrix]]''' - subform to enter span relationships in matrix form

===File Subforms===
*'''[[sf_file]]''' - subform to handle files

===XMI Subforms===
*'''[[sf_xmi]]''' - subform to enter XMI links between records

===Complex Subforms===
Complex subforms combine different data classes.

*'''[[sf_modtype]]''' - subform to handle modules with different item types
*'''[[sf_interp]]''' - subform to handle interpretive text fragments with actor/date pairings
*'''[[sf_assemblage]]''' - a subform to handle bulk assemblages
*'''[[sf_event]]''' - subform to handle actor/date pairs
*'''[[sf_frame]]''' - subform to display many subforms within a single subform

[[category:administrator]]

2008-11-14T16:01:38Z

Andydufton:

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

===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 securuty 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. For details on how to install and configure live user, and the associated database tables required, please see the [http://pear.php.net/package/LiveUser/ PEAR] website.

====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 andDELETE privileges to the new db.

===Update the DB Settings===

You will now need to update the DB settings in [[settings.php]].

===Browse to ARK directory===

In browsing to the ARK directory you should now be able to see the login pages for the database. 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]]

Administrator Manual

2008-11-14T15:08:11Z

Andydufton: /* Mapping */

__TOC__

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

===Key Concepts===

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

Information about the navigation tools used within ARK.

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

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

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

The different 'Views' of ARK.

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

An overview of the key administration concepts.

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

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

===Installation and Setup===

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

A description of the ARK installation process.

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

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

=====[[Basic Installation#Browse to ARK directory|Browse to ARK]]=====

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

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

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

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

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

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

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

===ARK Customisation===

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

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

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

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

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

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

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

Instructions on how to configure the field_settings.php file.

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

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

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

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

Instructions on how to configure module specific settings files.

=====[[mod_settings.php#Display Options|Display Options]]=====

=====[[mod_settings.php#Custom Fields|Custom Fields]]=====

=====[[mod_settings.php#Subforms|Subforms]]=====

=====[[mod_settings.php#Spatial Data|Spatial Data]]=====

=====[[mod_settings.php#Data Entry Forms|Data Entry Forms]]=====

=====[[mod_settings.php#Micro View|Micro View]]=====

=====[[mod_settings.php#Data View|Data View]]=====

=====[[mod_settings.php#XMI View|XMI View]]=====

=====[[mod_settings.php#Export|Export]]=====

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

The general settings for ARK.

=====[[settings.php#Server Setup|Server Setup]]=====

=====[[settings.php#General|General]]=====

=====[[settings.php#Live Search|Live Search]]=====

=====[[settings.php#Modules|Modules]]=====

=====[[settings.php#Security|Security]]=====

=====[[settings.php#Skin|Skin]]=====

=====[[settings.php#Thumbnails|Thumbnails]]=====

=====[[settings.php#Forms|Forms]]=====

=====[[settings.php#Viewers|Viewers]]=====

=====[[settings.php#Mapping|Mapping]]=====

=====[[settings.php#Logging|Logging]]=====

=====[[settings.php#Search Engine|Search Engine]]=====

=====[[settings.php#Languages|Languages]]=====

=====[[settings.php#Fields|Fields]]=====

=====[[settings.php#Document Type|Document Type]]=====

=====[[settings.php#Navigation|Navigation]]=====

=====[[settings.php#Left Panel Configuration|Left Panel Configuration]]=====

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

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

===Subforms===

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

A general overview of ARK Subforms and their configuration.

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

The required fields for configuration of subforms.

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

Some optional subform fields generic to all modules and subform types.

====[[Subform Reference]]====

A list of all the current subforms with example configurations.

=====[[Subform Reference#Text Subforms|Text Subforms]]=====

=====[[Subform Reference#Number Subforms|Number Subforms]]=====

=====[[Subform Reference#Attribute Subforms|Attribute Subforms]]=====

=====[[Subform Reference#Spatial Subforms|Spatial Subforms]]=====

=====[[Subform Reference#Span Subforms|Span Subforms]]=====

=====[[Subform Reference#File Subforms|File Subforms]]=====

=====[[Subform Reference#XMI Subforms|XMI Subforms]]=====

=====[[Subform Reference#Complex Subforms|Complex Subforms]]=====

===Mapping===

====[[Mapping Overview]]====
Some general information about mapping in ARK.

====[[Configuring the Mapfile]]====
Instructions on how to configure the mapfile.

===Administration===

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

Some tools for administering user accounts.

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

How to update the Address Book module.

====[[Alias Administration]]====

How to add aliases to the database.

====[[Markup Administration]]====

How to add markup to the database.

====[[Exporting Data]]====

Some basic tips for exporting data.

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

Information about the ongoing development of import tools.

===Custom Configuration===

The following are examples of custom configurations and may be specific to previous installations of ARK. Only use these for reference if you are upgrading from development code prior to the v0.6 release. Please contact the [http://ark.lparchaeology.com/contact ARK Development Team] for more information on any of the following.

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

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

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

[[category: Administrator]]