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

ark.lparchaeology.com

The Archaeological Recording Kit
An open source solution to
project recording
Jessica Ogden
Stuart Eve
Andrew Dufton

ARK Workshop Agenda

}
1. Introducing ARK

2. Example projects and
live demo

3. Installing ARK

4. Getting started with Questions
customising ARK throughout!

Introducing ARK
1. The Origins of ARK

2. The Aims of ARK

3. What is ARK

4. Beyond ARK

Introducing ARK : Aims
Reflexivity and Multi-Vocality

• 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!)

Collaborative from Start to Finish

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

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

Open-Source

• 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

Introducing ARK : What is it?
• Runs on industry standard, cross-
platform, open source web
technologies

• Uses modules, ﬁelds, 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
conﬁguration ﬁles

• 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

Installing ARK
1. Setup a web server ... in 5 easy steps!
2. Download ARK

3. Adjust environment
settings

4. Create database and
import SQL

5. Login! “I connected my food processor to
my word processor in case I have to
eat my words.”

Installing ARK : Server
Download:
Mac OSx: • MAMP: www.mamp.info

• MS4W: www.maptools.org/ms4w/
Windows:
• WAMP: www.wampserver.com/

Linux: • LAMP or

All of Above: • XAMPP: www.apachefriends.org/en/xampp.html

Windows
Installing ARK : MS4W
Download:
• MS4W does not include:

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

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

• See walkthrough

Installing ARK : Download
1. Locate your htdocs folder

Mac OSx: Applications/MAMP/htdocs
Windows: C:ms4wApachehtdocs

2. Download / Copy Over ARK v1.1:

http://sourceforge.net/projects/arkdb/ﬁles/arkdb

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

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/conﬁg/env_settings.php

2. Adjust according to your setup:

#1 Setup Case #2 Setup SQL
$server = "mac"; $sql_user = 'sqluser';

$sql_pwd = 'sqlpassword';

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


Create a new empty
database: ark_db
UTF-8 Unicode

Import the ark.sql

A brief word about tables..
• cor tables (data)
• cor lut tables (lookup)
• cor lvu tables (live user)
• mod speciﬁc tables

one for each dataclass, holds the data


one for each dataclass, holds info about that dataclass


holds live user (pear) security data

holds live user (pear) security data
one for each module, and lut for those that have types

Installing ARK : Login!
http://localhost/ark

User name: doe_jd
Password: janedoe

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 ﬁlters and save them, add
ﬁelds 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

Customise your ARK
Before getting stuck in, 1. Settings ﬁles are your
a few helpful hints... 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 ARK : Single Cxt
Included pre-configured Set up single
recording systems context system
• Single Context recording based on 1. Copy over the settings
Museum of London Archaeology files from ark_cxt into the
system config folder

• Stratigraphic Units, the Italian 2. Import the ark_cxt.sql into
flavor your ark_db database

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

Customise ARK : Settings
General Settings
• Environment
• Settings
• Page Settings
• Field Settings
• Validation Settings

General Settings
• Environment
server and directory settings
• Settings

• Page Settings
• Field Settings

General Settings
• Environment
• Settings
security, defaults, language settings
• Page Settings

• Field Settings

General Settings
• Environment
• Settings
• Page Settings
display, navigation, views
• Field Settings


General Settings
• Environment
• Settings
• Page Settings
• Field Settings
all ﬁelds

General Settings
• Environment
• Settings
• Page Settings
• Field Settings
all ﬁelds
validation settings for all ﬁelds

Customise ARK : Fields
Data Classtypes 5. Action - somebody doing
something, often combining
1. Text - text strings
with a person from the abk
2. Number
6. XMI - a link between two
different module items
3. Date
7. Span - matrices,
4. Attribute - control lists, drop comparanda, spanning ranges
downs, tick boxes and radio (e.g. date ranges)
buttons
8. File - ﬁles, media resources

mod_abk_settings.php

(line 169)

ﬁeld_settings.php

(line 169)

ﬁeld_settings.php

(line 169)
(line 119)

A register to add new abk items

ﬁeld_settings.php A register to add new abk items

A detailed form for abk items

A detailed form for abk items
column

subforms
ﬁelds

A record view for abk items

A record view for abk items
column
subform

ﬁelds subforms

columns

Customise ARK : Admin
Advanced..
1. Add new ﬁelds to ﬁeld_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
Get involved!
• 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

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

Recommandé

Recommandé

Contenu connexe

Tendances

Tendances (20)

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

Similaire à The Archaeological Recording Kit: An open source solution to project recording (20)

Plus de Jessica Ogden

Plus de Jessica Ogden (13)

Dernier

Dernier (20)

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