Difference between revisions of "Administrator Manual"

From ARK
Jump to: navigation, search
(Installation and Setup)
 
(51 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 
__TOC__
 
__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.
+
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 via the [http://groups.google.com/group/arkusers Google Group].
  
 
===Key Concepts===
 
===Key Concepts===
Line 8: Line 8:
  
 
Information about the navigation tools used within ARK.
 
Information about the navigation tools used within ARK.
 
=====[[Navigation#Basic Navigation|Basic Navigation]]=====
 
 
=====[[Navigation#Subform Navigation|Subform Navigation]]=====
 
  
 
====[[Views]]====
 
====[[Views]]====
Line 20: Line 16:
  
 
An overview of the 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===
 
===Installation and Setup===
Line 30: Line 22:
  
 
A description of the ARK installation process.
 
A description of the ARK installation process.
 
=====[[Basic Installation#Dependencies|Dependencies]]=====
 
 
=====[[Basic Installation#Installing ARK|Installing ARK]]=====
 
 
====[[Initial setup]]====
 
 
Some things to consider when completing the initial setup of your ARK.
 
 
=====[[Initial setup#A Name|ARK Name]]=====
 
 
=====[[Initial setup#What do you want to record?|What to record?]]=====
 
 
=====[[Initial setup#What subforms do you want?|What Subforms?]]=====
 
  
 
====[[Database Tables]]====
 
====[[Database Tables]]====
Line 49: Line 27:
 
A list of the standard ARK tables, with a basic explanation for each.
 
A list of the standard ARK tables, with a basic explanation for each.
  
===[[ARK Customisation]]===
+
===ARK Customisation===
  
The detailed setup guidelines for your ARK.
+
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]].
 
 
====[[Settings Overview]]====
 
 
 
An overview of the different settings files, and how to customise ARK.
 
  
 
====[[env_settings.php]]====
 
====[[env_settings.php]]====
  
A description of the env_settings.php file.
+
A description of the env_settings.php file for three different operating systems.
  
 
====[[field_settings.php]]====
 
====[[field_settings.php]]====
Line 65: Line 39:
 
Instructions on how to configure the field_settings.php file.
 
Instructions on how to configure the field_settings.php file.
  
====[[mod_settings.pnp]]====
+
====[[mod_settings.php]]====
  
 
Instructions on how to configure module specific settings files.
 
Instructions on how to configure module specific settings files.
Line 72: Line 46:
  
 
The general settings for ARK.
 
The general settings for ARK.
 +
 +
====[[page_settings.php]]====
 +
 +
The settings for page based displays and navigation.
  
 
====[[vd_settings.php]]====
 
====[[vd_settings.php]]====
  
 
A description of information found within the vd_settings.php file.
 
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.
 +
 +
====[[Conditional Subforms]]====
 +
 +
Conditional subforms is a more complex subform option that allows specific subforms to only be displayed if a set of pre-configured conditions are met
 +
 +
====[[Subform Reference]]====
 +
 +
A list of all the current subforms with example configurations.
 +
 +
===Mapping===
 +
 +
====[[Mapping Overview]]====
 +
Some general information about mapping in ARK.
 +
 +
====[[Configuring the Mapfile]]====
 +
Instructions on how to configure the mapfile.
 +
 +
====[[OpenStreetMap and ARK]]====
 +
Instructions on how to use OpenStreetmap as your mapping BaseLayer
 +
 +
====[[Google Maps and ARK]]====
 +
Instructions on how to use Google Maps as your mapping BaseLayer
  
 
===Administration===
 
===Administration===
Line 87: Line 101:
 
How to update the Address Book module.
 
How to update the Address Book module.
  
===Subforms===
+
====[[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.
 +
 
 +
====[[The ARK Help System]]====
 +
 
 +
How to use and administer the Help system.
 +
 
 +
====[[Setting up the Wordpress Plugin]]====
  
====[[Subforms Overview]]====
+
This is how to setup and use the ARK Wordpress plugin
  
A general overview of ARK Subforms and their configuration.
+
===Configuring Clean URLs===
  
=====[[Subforms Overview#Subform Reference|Subform Reference List]]=====
+
ARK can be configured to use clean URLs, that is instead of visiting a page using a URL like: http://www.myark.com/ark/micro_view.php?item_key=cxt_cd&itemvalue=ABC12_1234 you can visit: http://www.myark.com/ark/view/cxt/ABC12_1234. This allows for persistent clean URLs and also aids in Search Engine Optimisation, etc. If you are still not sure you want to do this, [http://www.hochmanconsultants.com/articles/clean-urls.shtml here] is an article explaining it a bit further.
  
====[[Subform Requirements]]====
+
If you still want to do it there are a number of steps to go through:
  
The required fields for configuration of subforms.
+
1. [[Set up your webserver to enable mod_rewrite]]
  
====[[Subform Options]]====
+
2. [[Set up your Rewrite Rules]]
  
Some optional subform fields.
+
3. [[Check the setup and adjust your main pages]]
  
 
===Custom Configuration===
 
===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.
+
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 file registration]]====
Line 111: Line 147:
 
====[[Configuring the Mapping]]====
 
====[[Configuring the Mapping]]====
  
====[[Configuring the Export Functionality]]====
+
====[[Configuring RSS Feeds]]====
  
 
[[category: Administrator]]
 
[[category: Administrator]]

Latest revision as of 08:45, 16 November 2015

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 via the Google Group.

Key Concepts

Navigation

Information about the navigation tools used within ARK.

Views

The different 'Views' of ARK.

Key Administration Concepts

An overview of the key administration concepts.

Installation and Setup

Basic Installation

A description of the ARK installation process.

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 Settings Files.

env_settings.php

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

field_settings.php

Instructions on how to configure the field_settings.php file.

mod_settings.php

Instructions on how to configure module specific settings files.

settings.php

The general settings for ARK.

page_settings.php

The settings for page based displays and navigation.

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.

Conditional Subforms

Conditional subforms is a more complex subform option that allows specific subforms to only be displayed if a set of pre-configured conditions are met

Subform Reference

A list of all the current subforms with example configurations.

Mapping

Mapping Overview

Some general information about mapping in ARK.

Configuring the Mapfile

Instructions on how to configure the mapfile.

OpenStreetMap and ARK

Instructions on how to use OpenStreetmap as your mapping BaseLayer

Google Maps and ARK

Instructions on how to use Google Maps as your mapping BaseLayer

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.

The ARK Help System

How to use and administer the Help system.

Setting up the Wordpress Plugin

This is how to setup and use the ARK Wordpress plugin

Configuring Clean URLs

ARK can be configured to use clean URLs, that is instead of visiting a page using a URL like: http://www.myark.com/ark/micro_view.php?item_key=cxt_cd&itemvalue=ABC12_1234 you can visit: http://www.myark.com/ark/view/cxt/ABC12_1234. This allows for persistent clean URLs and also aids in Search Engine Optimisation, etc. If you are still not sure you want to do this, here is an article explaining it a bit further.

If you still want to do it there are a number of steps to go through:

1. Set up your webserver to enable mod_rewrite

2. Set up your Rewrite Rules

3. Check the setup and adjust your main pages

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 ARK Development Team for more information on any of the following.

Transcluding

Configuring file registration

Configuring the Mapping

Configuring RSS Feeds