As of version 1.2 - a plugin has been written to enable easy interaction with ARK through Wordpress.

At the moment, this plugin allows a Wordpress user to write a shortcode into their post, which can either create a hyperlink to the record view of an item or can be used to transclude a subform. The functionality of this plugin may be extended in the future.

The plugin can be downloaded from [http://ark.lparchaeology.com/external_plugins/ark_transcluder.zip here].

===Installation===

The installation of the plugin is as simple as downloading it, unzipping the zip file and copying the resulting folder into your wp-plugins/ directory of the your Wordpress install.

You will then need to go to the Plugins menu of your Administrator Dashboard, click on Inactive plugins, and you should see 'ARK Transcluder'. Activate it.

===Set Up===

Provided everything went well with the activation of the plugin, a new menu should appear under the Settings menu on the left of the Dashboard (called 'ARK Transcluder Settings'). Click on this and a form will appear.

====ARK Settings====

This form should be self-explanatory. Please ensure that your ARK url does not have any page names in it, you should be just entering the base URL. For example, 'http://www.myark.com/ark/' NOT 'http://www.myark.com/ark/micro_view.php'.

The Quickname of the ARK is used to refer to a specific ARK, especially if you have more than one registered. If you are only using one ARK the quickname is not mandatory.

You will only need to enter username and password if you do not have anonymous logins setup. ''PLEASE NOTE:'' this username and password MAY be sent plaintext and give someone access to your ARK - so it is advisable to set up a special locked-down account on ARK that does not allow edits and only has limited access.

If you want to have access to more than one ARK within your Wordpress installation, you can add up to 4 other ARKs, using the Add Another ARK button.

[[File:Trancluder plugin1.png|500px]]

====CSS Settings====

It is also possible to set some custom CSS for the transcluded subforms, which will override the CSS used by the parent ARK. You can type the CSS statements within the CSS box. For example, if you want the headers of each form to turn 'red', you could use: <pre>div.sf_nav h4 {color:red};</pre>

[[File:File:Ark trancluder2.png|500px]]

====Save the Settings and check the ARK connection(s)====

Provided everything is working, once you have saved the values - you can click the Get ARK Info button. This includes the current name and version of the ARK and also the available modules and the names of the subforms (per module) that are available for use with the plugin.

If this information does not appear - Wordpress couldn't make a connection with your ARK installation. The best way to debug this is to open this url in your browser: http://www.myark.com/ark/api.php?req=describeARK&handle=YOUR_USERNAME&passwd=YOUR_PASSWORD. This should return an array with the version and name of the ARK, if it returns any errors then you'll need to fix those before you can properly use the plugin. Check out the [[API documentation]] for further information.

===Usage===

The plugin is very simple to use. Once it is installed properly, you can include shortcodes in your posts to make links or transclude subforms.

====Example 1 - A link to a Context====

Shortcode format to use: [ark_link mod=itemval]

In the Visual editor of Wordpress for a post you could write the following: "[ark_link cxt=MNO12_123] is a really interesting context, mainly because it is a good example of a pit". When this post is previewed it will replace the shortcode with a hyperlink to Context MNO12_123.

Please be aware the plugin does not check if the ARK item exists, so take care when filling in the values otherwise you will end up with dead links.

====Example 2 - A transcluded subform====

Shortcode format to use: [ark_tc mod=itemval sf=subform_name]

The post text could read: "When we look at the photos for this context, you will see the dark-brownish smear [ark_tc cxt=MNO12_123 sf=cxt_site_photo]". This will render the text, with the Site Photo subform replacing the location of the shortcode.

The plugin does not check the presence of the subform or the itemkey/itemval pair, so if you put something in incorrectly it will likely print out an ARK generated error message complaining that the form does not exist.

File:Ark trancluder2.png

2014-10-14T10:18:23Z

Stuarteve:

2014-10-14T09:54:32Z

Stuarteve: /* Installation */

Setting up the Wordpress Plugin

2014-10-07T15:48:12Z

Stuarteve:

Setting up the Wordpress Plugin

2014-10-07T13:49:20Z

Stuarteve: /* Set Up */

Setting up the Wordpress Plugin

2014-10-07T13:46:54Z

Stuarteve:

Setting up the Wordpress Plugin

2014-10-07T12:47:28Z

Stuarteve: Created page with "As of version 1.2 - a plugin has been written to enable easy interaction with ARK through Wordpress. At the moment, this plugin allows a Wordpress user to write a shortcode into..."

Administrator Manual

2014-10-07T12:25:30Z

Stuarteve: /* Administration */

__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 via the [http://groups.google.com/group/arkusers 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.

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

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

====[[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.

====[[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, [http://www.hochmanconsultants.com/articles/clean-urls.shtml 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 [http://ark.lparchaeology.com/contact ARK Development Team] for more information on any of the following.

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

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

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

====[[Configuring RSS Feeds]]====

[[category: Administrator]]

DescribeFields

2014-06-25T13:18:24Z

Stuarteve: /* Arguments */

DescribeFields

2014-06-25T13:06:04Z

Stuarteve: /* Example */

The ARK Help System

2014-06-09T14:46:25Z

Stuarteve:

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 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>

2013-12-03T14:48:58Z

Stuarteve:

Developer Manual

2013-12-03T14:44:34Z

Stuarteve: /* 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:

[[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

[[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]]

Transcluding

2013-12-03T14:39:38Z

Stuarteve:

=== 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.

The results of this can be seen below:

http://www.lparchaeology.com/prescot/journal/ark-and-the-art-of-tranclusion-mechanics

===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]]

Transcluding

2013-12-03T14:39:07Z

Stuarteve:

=== NOTE: As of ARK version equal to or greater than 1.1 transclusion is undertaken using the API - see [[transcludeSubforms()]] and [[describeSubforms()]]. 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.

The results of this can be seen below:

http://www.lparchaeology.com/prescot/journal/ark-and-the-art-of-tranclusion-mechanics

===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]]