The Archaeological Recording Kit: An open source solution to project recording

The Archaeological Recording Kit

An open source solution to project recording

Jessica Ogden Stuart EveAndrew Dufton

ark.lparchaeology.com

ARK Workshop Agenda1. Introducing ARK

2. Example projects and live demo

3. Installing ARK

4. Getting started with customising ARK

Questions throughout!

}

1. The Origins of ARK

2. The Aims of ARK

3. What is ARK

4. Beyond ARK

Introducing ARK

Introducing ARK : Origins

Introducing ARK : Origins

Introducing ARK : Origins

Introducing ARK : Origins

Introducing ARK : Origins

Introducing ARK : Aims

• To be completely adaptable to any project’s recording system, be it digital or paper-based

• Does not impose data standards (but can be imposed if you want them!)

Reflexivity and Multi-Vocality

Introducing ARK : Aims

• A tool for digital storage, collection, collaboration, and dissemination.

• Everyone is together in the field, but after the season is over people return to their institutions.

Collaborative from Start to Finish

Introducing ARK : Aims

• Open source - ARK code is hosted on a SVN repository, and all code is released on Sourceforge under a GNU GPL license

• Improvements and Enhancements made on one project are rolled out to all projects

Open-Source

Introducing ARK : What is it?

• Runs on industry standard, cross-platform, open source web technologies

• Uses modules, fields, subforms, and pages to display data through a web browser as XHTML

• WFS/WMS (web mapping) capable

Introducing ARK : What is it?

• Uses ‘main pages’, subforms, and configuration files

• Multi-user, with highly customisable security settings. As open or closed as you like!

• Multi-lingual through the use of markup and aliases

Introducing ARK : & Beyond• Has export tools to view data in

CSV, XML, RSS and Atom feeds, and linked data as RDF

• Uses industry standard spatial data interoperability toolkits: GeoRSS, KML, WFS/WMS, and GeoNames API

• Transclusion of ARK subforms

• Hybrid publication and seamless integration with web-based project outputs

Introducing ARK : & Beyond

• Since its release in August 2011, ARK v1.0 has had over 625 downloads from 60 countries around the world

• +1,350 downloads since Sourceforge

Introducing ARK : Demos

1. Setup a web server

2. Download ARK

3. Adjust environment settings

4. Create database and import SQL

5. Login!

Installing ARK ... in 5 easy steps!

“I connected my food processor to my word processor in case I have to

eat my words.”

Installing ARK : Server

• MAMP: www.mamp.info

• MS4W: www.maptools.org/ms4w/

• WAMP: www.wampserver.com/

• LAMP or

• XAMPP: www.apachefriends.org/en/xampp.html

Linux:

All of Above:

Mac OSx:

Windows:

Download:

Installing ARK : MS4W

• MS4W does not include:

phpMyAdmin: http://www.phpmyadmin.net/home_page/downloads.php

MySQL: http://dev.mysql.com/downloads/mysql

• See walkthrough

Windows

Download:

Installing ARK : Download 1. Locate your htdocs folder

Applications/MAMP/htdocs

C:\ms4w\Apache\htdocs

2. Download / Copy Over ARK v1.1:

http://sourceforge.net/projects/arkdb/files/arkdb

3. Place ARK v1.1 in the root of the htdocs folder - call the

Mac OSx:

Windows:

You will need a good text editor for the next step: TextMate (free trial), Text Wrangler, JEdit, etc.

Installing ARK : Env Settings 1. Locate the ARK environment settings (env_settings.php):

ark/config/env_settings.php

2. Adjust according to your setup:

#1

$server = "mac"; $sql_user = 'sqluser';

$sql_pwd = 'sqlpassword';

Setup Case Setup SQL#2

Installing ARK : Env Settings #1

#2

Installing ARK : SQL dbase 1. Locate the ARK v1.1 SQL (ark.sql):

ark/ark.sql

2. Locate your phpMyAdmin interface through the browser:

http://localhost/phpMyAdmin

3. Create a new empty database: ark_db / UTF-8 Unicode

4. Import the ark.sql to create the required ARK tables

Installing ARK : SQL dbase

Create a new empty database: ark_db UTF-8 Unicode

Installing ARK : SQL dbase Import the ark.sql

Installing ARK : SQL dbase

• cor tables (data)

• cor lut tables (lookup)

• cor lvu tables (live user)

• mod specific tables

A brief word about tables..

Installing ARK : SQL dbase

• cor tables (data)

• cor lut tables (lookup)

• cor lvu tables (live user)

• mod specific tables

one for each dataclass, holds the data

A brief word about tables..

Installing ARK : SQL dbase

• cor tables (data)

• cor lut tables (lookup)

• cor lvu tables (live user)

• mod specific tables

one for each dataclass, holds the data

one for each dataclass, holds info about that dataclass

A brief word about tables..

Installing ARK : SQL dbase

• cor tables (data)

• cor lut tables (lookup)

• cor lvu tables (live user)

• mod specific tables

one for each dataclass, holds the data

one for each dataclass, holds info about that dataclass

holds live user (pear) security data

A brief word about tables..

Installing ARK : SQL dbase

• cor tables (data)

• cor lut tables (lookup)

• cor lvu tables (live user)

• mod specific tables

one for each dataclass, holds the data

one for each dataclass, holds info about that dataclass

holds live user (pear) security data

one for each module, and lut for those that have types

A brief word about tables..

Installing ARK : Login!

User name: doe_jdPassword: janedoe

http://localhost/ark

Explore your ARK • User Admin: Create and manage your users

• Data Entry: Enter new data using the register, and add detailed info to the record in the form view

• Search: Create filters and save them, add fields to your view, export to CSV

• Record View: View your complete records in all their glory, edit data, delete a record, change a record number

1. Settings files are your friends! (And so is PHP)

2. Use the alias admin page to add new classtypes and aliases

3. It’s all about the subforms. If you want it, there’s probably a subform for it.

Customise your ARKBefore getting stuck in,

a few helpful hints...

• Single Context recording based on Museum of London Archaeology system

• Stratigraphic Units, the Italian flavor

**Disclaimer: SU settings have not yet been updated to v1.1, but continue to watch this space..

Customise ARK : Single Cxt

Included pre-configured

recording systems

1. Copy over the settings files from ark_cxt into the config folder

2. Import the ark_cxt.sql into your ark_db database

Set up single

context system

Customise ARK : Settings

General Settings

• Environment

• Settings

• Page Settings

• Field Settings

• Validation Settings

Customise ARK : Settings

General Settings

• Environment

• Settings

• Page Settings

• Field Settings

• Validation Settings

server and directory settings

Customise ARK : Settings

General Settings

• Environment

• Settings

• Page Settings

• Field Settings

• Validation Settings

server and directory settings

security, defaults, language settings

Customise ARK : Settings

General Settings

• Environment

• Settings

• Page Settings

• Field Settings

• Validation Settings

server and directory settings

security, defaults, language settings

display, navigation, views

Customise ARK : Settings

General Settings

• Environment

• Settings

• Page Settings

• Field Settings

• Validation Settings

server and directory settings

security, defaults, language settings

display, navigation, views

all fields

Customise ARK : Settings

General Settings

• Environment

• Settings

• Page Settings

• Field Settings

• Validation Settings

server and directory settings

security, defaults, language settings

display, navigation, views

all fields

validation settings for all fields

Customise ARK : FieldsData Classtypes

1. Text - text strings

2. Number

3. Date

4. Attribute - control lists, drop downs, tick boxes and radio buttons

5. Action - somebody doing something, often combining with a person from the abk

6. XMI - a link between two different module items

7. Span - matrices, comparanda, spanning ranges (e.g. date ranges)

8. File - files, media resources

Customise ARK : Settings

mod_abk_settings.php

(line 169)

Customise ARK : Settings

mod_abk_settings.php

(line 169)

Customise ARK : Settings

mod_abk_settings.php

field_settings.php

(line 169)

Customise ARK : Settings

mod_abk_settings.php

field_settings.php

(line 169)(line 119)

Customise ARK : Settingsmod_abk_settings.php

A register to add new abk items

Customise ARK : Settingsmod_abk_settings.php

A register to add new abk items

Customise ARK : Settingsmod_abk_settings.php

field_settings.php A register to add new abk items

Customise ARK : Settingsmod_abk_settings.php

field_settings.php A register to add new abk items

Customise ARK : Settingsmod_abk_settings.php

field_settings.php A register to add new abk items

Customise ARK : Settingsmod_abk_settings.php

field_settings.php A register to add new abk items

A detailed form for abk items

Customise ARK : Settingsmod_abk_settings.php

A detailed form for abk items

Customise ARK : Settingsmod_abk_settings.php

A detailed form for abk items

Customise ARK : Settingsmod_abk_settings.php

fieldssubforms

column

A record view for abk items

Customise ARK : Settingsmod_abk_settings.php

A record view for abk items

Customise ARK : Settingsmod_abk_settings.php

subforms

column

fields

columns

subform

Customise ARK : AdminAdvanced..

1. Add new fields to field_settings and new aliases via alias admin

2. Use the wiki to add example subforms to a module

3. Import legacy data..

4. Setup mapping..

Customise ARK : Resources

• Wiki: ark.lparchaeology.com/wiki

• Google Group(s):

ARK Users: groups.google.com/group/arkusers

ARK Developers: groups.google.com/group/arkdev

• Or just get in touch: j.ogden@lparchaeology.com

Get involved!