<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
    <title>Using Field Helper (v 0.4 07/11/2007)</title>
    <authorblurb>
        <para>Field Helper was developed with APSR funding by Steven Hayes, Tom Honeyman and Kim
            Jackson all from Sydney University. The application is based on an original idea by Ian
            Johnson and considerable input has been received from Linda Barwick and Tom Murtagh.
            Please direct any questions or comments to Steven Hayes (0293513142 -
            <email>shayes@usyd.edu.au</email>)
        </para>
        <para>This document was written by Steven Hayes as a DocBook 4.4 document within Oxygen 9.0
            and transformed with the standard DocBook stylesheets. The untransformed XML is
            available
            <ulink url="application/doco4.xml">here</ulink>.</para>
    </authorblurb>
    <sect1>
        <title>What is Field Helper?</title>
        <mediaobject>
            <imageobject>
                <imagedata fileref="images/fh03main.png" format="PNG"/>
            </imageobject>
        </mediaobject>
        <para>Field Helper is a desktop application that enables you to quickly view and categorise
            groups of related digital files and then submit the resulting package to a repository
            for long term preservation and access. Digital repositories require a submission to be
            formated in a specific way and be described according to a standard meta data encoding
            schema. Working with Field Helper results in a ZIP file containing compressed versions
            of your files along with a METS (Metadata Encoding and Transmission Standard) file which
            contains a detailed description of each file and its relationship to other files in the
            submission. METS is a standard that works with most repositories and - where required -
            can be easily translated into a form that non METS compliant repositories can work with.
        </para>
    </sect1>
    <sect1>
        <title>Getting started</title>
        <sect2>
            <title>Downloading and installing</title>
            <para>There is no install process for Field Helper, however Java 1.4 or later must be
                installed before the application will run. Once this is done simply unzip the
                package to a new directory on your computer.
            </para>
            <para>Download the Windows version of Field Helper covered by this document by clicking
                <ulink url="http://acl.arts.usyd.edu.au/FIDAS/application/fh04win.zip">here</ulink>.
                Start Filed Helper by double clicking on the file called fieldhelper.bat in the
                directory where you installed the application.</para>
            <para>Download the Mac version of Field Helper covered by the document by clicking
                <ulink url="appliation/fh04mac.dmg">here</ulink>.</para>
            <para/>
        </sect2>
        <sect2>
            <title>Creating a project</title>
            <para>Field Helper stores your collections as projects. When you start Field Helper
                you'll be asked if you want to create a new project or open one of your existing
                projects. Choosing to create a new project presents you with the following form:</para>
            <para/>
            <para>
                <mediaobject>
                    <imageobject>
                        <imagedata format="PNG" fileref="images/new_project.png" align=""/>
                    </imageobject>
                </mediaobject>
            </para>
            <para>Supply a unique project name - you will be told if a project with the name
                supplied already exists and you will not be able to continue until you supply
                another name.</para>
            <para>Click the add button to browse the folders on your computer. Add as many folders
                as you like. You can remove folders at any time by selecting the folder and clicking
                the remove button.</para>
            <para>The Fieldwork start and end dates will be automatically deduced from the creation
                date of the first and last file found in the folders supplied for the project. You
                can override this by changing either date.
            </para>
            <para>When you are ready click the finish button. The application will now scan all the
                folders you have nominated and will harvest basic metadata (creation time, file
                name, mime type) . Note that at any time you can return to this form and make
                modifications to all but the project name by selecting project > properties from the
                menu.</para>
        </sect2>
        <sect2>
            <title>Navigating around</title>
            <para>
                The following illustration names the various parts of the application. Each part is
                explained in detail below.
                <mediaobject>
                    <imageobject>
                        <imagedata fileref="images/interface_labled.png" format="PNG"/>
                    </imageobject>
                </mediaobject>
            </para>
            <orderedlist>
                <listitem>
                    <para>
                        <emphasis role="bold">Timeline</emphasis>
                    </para>
                    <para>Represents the time span of your project. In this example data was only
                        gathered on four days. The height of the bar represents the density of data
                        gathered on a particular day. Dotted lines, if they appear, show the start
                        and end of the actually field work period.</para>
                </listitem>
                <listitem>
                    <para>
                        <emphasis role="bold">Time selector</emphasis>
                    </para>
                    <para>You can click and drag this highlighted area around the timeline. The
                        dates within the time selector are shown in detail in the
                        <emphasis role="italic">calendar view</emphasis>
                        in the
                        <emphasis role="italic">source pane</emphasis>.</para>
                </listitem>
                <listitem>
                    <para>
                        <emphasis role="bold">Source pane</emphasis>
                    </para>
                    <para>This right hand area shows your files arranged in a calendar format. Most
                        of the time you will be selecting files from the source pane and dragging
                        them to regions in the
                        <emphasis role="italic">target pane</emphasis>.</para>
                </listitem>
                <listitem>
                    <para>
                        <emphasis role="bold">Target pane</emphasis>
                    </para>
                    <para>This right hand area displays the properties your files have been
                        assigned. This pane shows not only coloured property value regions but also
                        geographical maps by way of an inbuilt connection to GoogleMaps.</para>
                </listitem>
                <listitem>
                    <para>
                        <emphasis role="bold">Filter control</emphasis>
                    </para>
                    <para>Displays and controls how your data is filtered. To apply a filter right
                        click on a
                        <emphasis role="italic">property value</emphasis>
                        in the
                        <emphasis role="italic">target pane</emphasis>
                        and select "<emphasis role="italic">filter on this value</emphasis>". You
                        chan show the relevant files in the
                        <emphasis role="italic">source pane</emphasis>
                        highlighted in bold in amongst all other values or you can hide all the non
                        relevant files by clicking the "<emphasis role="italic">show
                            filtered only</emphasis>"
                        button.
                    </para>
                </listitem>
                <listitem>
                    <para>
                        <emphasis role="bold">Time control</emphasis>
                    </para>
                    <para>The time control allows you to scroll the calendar view forward and
                        backward in time by clicking the left and right arrows. The time selector on
                        the timeline will reflect these movements. The plus and minus buttons
                        increase or decrease the period of time shown in the calendar view. The
                        maximum viewable range is 7 days and the minimum is 1 second. As you click
                        the plus button the display range will step from 7 days to 1 day and then to
                        three six hour periods and so on. Note that time selector does not display
                        less than a day so it can be difficult to find files without scrolling when
                        less than a day is displayed in the calendar view. This limitation will be
                        removed in future releases.</para>
                </listitem>
                <listitem>
                    <para>
                        <emphasis role="bold">Calendar view</emphasis>
                    </para>
                    <para>The calendar view displays the files in your project based on their
                        creation date and time. Files are shown with an icon denoting their MIME
                        type (see key to icons). Next shown is a number which is unique in the
                        context of a project and is based on the order the files were scanned in.
                        Finally, the file name is shown. Right clicking on the file item provides
                        access to a form based metadata editor for the file and a function that will
                        allow the file to be opened for viewing using the default handling
                        application configured on your machine for files of this type.</para>
                    <para>You can select files from the
                        <emphasis role="italic">calendar view</emphasis>
                        and drag them to regions in the
                        <emphasis role="italic">target pane</emphasis>. This process applies
                        metadata to the file and is referred to as "<emphasis role="italic">drag'n'tag</emphasis>".
                        Note that the current version of Field Helper supports the use of the CTRL key (and Mac equivalent) to select multiple files but does not support SHIFT and
                        marque selecting. This limitation will be removed in future releases.</para>
                </listitem>
                <listitem>
                    <para>
                        <emphasis role="bold">Item preview</emphasis>
                    </para>
                    <para>To aid identification of files a preview function is provided under the
                        <emphasis role="italic">calendar view</emphasis>. This function can be
                        toggled on and off by clicking the icon in the top right hand corner of the
                        pane.</para>
                </listitem>
                <listitem>
                    <para>
                        <emphasis role="bold">Property tab</emphasis>
                    </para>
                    <para>Field Helper allows you to quickly define sets of metadata properties that
                        your files may exhibit. To assign a file to a property you simply select it
                        and drag it onto the property value. Each set of property values is
                        contained within a named property tab. This example shows one property -
                        namely mods:typeOfResource. A property tab may contain zero or more property
                        values which are represented by coloured regions as described below.</para>
                    <para>You can add new property values at any time by right clicking on the grey
                        area to the right of the property tabs. When you do this you will see and
                        option to add a new property or add an existing property. All the properties
                        you define are available via the second option from all projects. This
                        provides you with the ability to build up a useful properties library over
                        time. Future versions of Field Helper will allow these libraries to be
                        shared with other users.</para>
                    <para>The properties tab can also contain a GoogleMap. The current version of
                        Field Helper does not support drag and drop to the map, instead users of
                        this function must first click the file item and then click the relevant
                        location on the map. Performing this operation adds a mods based location
                        attribute to the metadata for file. More detail on the GoogleMaps function
                        and other specialised properties is provided later in this document.</para>
                </listitem>
                <listitem>
                    <para>
                        <emphasis role="bold">Property values</emphasis>
                    </para>
                    <para>When you drop a file on a property value that value is added to the
                        metadata of the file. For example, dropping IMG_6939.JPG (shown in the
                        example)onto the "still image" property value (the purple box on the right)
                        assigns a value of "still image" to the "mods:typeOfResource" property for
                        the file. Files can be removed from property values by right clicking and
                        selecting "remove". To aid in the visual synchronisation of source and
                        target panes, clicking on a file in one pane highlights it in the other
                        pane.</para>
                    <para>Note that the property value display is sensitive to the overall time
                        context of the application. This means that only tagged files with a
                        creation date within the bounds of the current calendar display will be
                        shown.</para>
                </listitem>
            </orderedlist>
        </sect2>
    </sect1>
    <sect1>
        <title>Working with properties</title>
        <para>Properties are at the core of Field Helper so it is important to read and understand
            this section if you want to do anything remotely clever with the application.</para>
        <sect2>
            <title>Adding a new property</title>
            <para>Before describing how to add a properties it is necessary to have some
                understanding of what Field Helper does with the metadata created by dragging fields
                onto property values.
            </para>
            <para>The end result of using Field Helper is a submission package in the form of a ZIP
                archive which contains compressed versions of all the files in a given project along
                with a mets.xml file. The idea is that once you have created this file you send it
                off to your repository of choice and they deal with the rest. The file contains all
                descriptive, administrative and structural metadata about your project and it is
                encoded according to the
                <ulink url="http://www.loc.gov/standards/mets/">METS standard</ulink>. The standard
                is maintained by the Library of Congress for the purpose of describing and
                transmitting complex objects between digital libraries. The standard is increasingly
                being adopted by digital repositories and various translators are available for
                those repositories that don't yet support METS. METS is a complex format and it is
                beyond the scope of this document to describe it in any detail however, METS allows
                users to embed various other metadata structures within an overall package and this
                is what Field Helper does - primarily, though not exclusively using
                <ulink url="http://www.loc.gov/standards/mods/">MODS</ulink>.</para>
            <para>MODS specifies some 20 elements such as location, classification and language.
                Unlike older metadata standards like Dublin Core, some elements in MODS have sub
                elements and can become quite complex. The following XML snippet shows an example of
                encoding the performer of a musical recording.</para>
            <para>
                <mediaobject>
                    <imageobject>
                        <imagedata fileref="images/mods_namerole.png" format="PNG"/>
                    </imageobject>
                </mediaobject>
            </para>
            <para>While the Field Helper model is based on simplicity users create property/value
                configurations in the target pane that allow this kind of metadata structure to be
                handled with a simple drag'n'tag operation.
                <segmentedlist>
                    <segtitle>Create the property</segtitle>
                    <seglistitem>
                        <seg>Right click on the space to the right of the existing property tabs and
                            select the
                            <emphasis role="bold">add new property</emphasis>
                            option and the
                            <emphasis role="bold">Enumeration</emphasis>
                            sub option
                        </seg>
                    </seglistitem>
                    <seglistitem>
                        <seg>Give the property and name that makes sense to you - perhaps in this
                            case
                            <emphasis role="bold">Name and role</emphasis>.</seg>
                    </seglistitem>
                    <seglistitem>
                        <seg>In the METS XML Element box type
                            <emphasis role="bold">name</emphasis>. Note that in the current version
                            you cannot add an XML attribute at this point so you will have to ignore
                            the type="corporate" attribute in the example above. This limitation
                            will be removed in future versions.
                        </seg>
                    </seglistitem>
                </segmentedlist>
                <screenshot>
                    <mediaobject>
                        <imageobject>
                            <imagedata fileref="images/add_property.png" format="PNG"/>
                        </imageobject>
                    </mediaobject>
                </screenshot>
                <segmentedlist>
                    <segtitle>Create the property value</segtitle>
                    <seglistitem>
                        <seg>You should now see a new property tab called name and it should have
                            been automatically selected. You'll need to right click in the yellow
                            area below the tab and select
                            <menuchoice><guimenuitem>add value</guimenuitem></menuchoice>.</seg>
                        <seg>Once again provide a name that is meaningful to you in the
                            <emphasis role="bold">value</emphasis>
                            box. In the
                            <emphasis role="bold">METS XML Content</emphasis>
                            area type the entire XML snippet from
                            <emphasis role="bold">namePart</emphasis>
                            to the closing
                            <emphasis role="bold">role</emphasis>
                            tag.</seg>
                    </seglistitem>
                </segmentedlist>
                <screenshot>
                    <mediaobject>
                        <imageobject>
                            <imagedata fileref="images/add_value.png" format="PNG"/>
                        </imageobject>
                    </mediaobject>
                </screenshot>
            </para>
            <para>
                You should now see a new property value named Roustabouts - performers and if you
                drag a file onto the area then export to a METS file (explained later in this
                document) the resulting METS document will contain a MODS section with a set of
                nested elements encoded exactly as shown in the XML snippet at the beginning of this
                section.</para>
        </sect2>
        <sect2>
            <title>Adding your own user defined properties</title>
            <para>If you read the explaination above of how Field Helper works with METS and MODS
                you may be thinking "what if I want to tag my files with properties not defined in
                MODS?". Well this is actually pretty simple and involves following exactly the same
                procedure as outlined above but omiting the
                <emphasis role="bold">METS XML Element</emphasis>
                value in the
                <emphasis role="bold">Add Property</emphasis>
                step and omiting the
                <emphasis role="bold">METS XML Content</emphasis>
                value in the
                <emphasis role="bold">Add Value
                </emphasis>step.</para>
            <para>The METS standard allows you to include several different metadata sections based
                around different encoding standards. In actuall fact the sections don't even have to
                follow a standard and so any properties that are defined by you that are not
                accompanied by a specific XML Element definiton get stored in a fairly free form
                Field Helper section. When you submit a METS package to a repository the Field
                Helper section may be stripped out but there is no particular reason why this should
                be so. If in doubt contact the user support section where the repository is housed.
            </para>
        </sect2>
        <sect2>
            <title>Working with maps</title>
            <para>You can use Field Helper to create geographic metadata for your files. GoogleMaps
                access is built into Feild Helper and there are a number of ways the publically
                available mapping tool can be used to add geographic metadata to your files. The
                first step however is to create a map property.</para>
        </sect2>
        <sect2>
            <title>Adding a new map property</title>
            <para/>
            <para>From the menu select
                <emphasis role="bold">Add new property</emphasis>
                and then select
                <emphasis role="bold">map</emphasis>
                from the sub menu.</para>
            <para>
                <orderedlist>
                    <listitem>
                        <para>As when you create other property types, right click on the blank area
                            to the right of the
                            <emphasis role="bold">property tabs</emphasis>
                            in the
                            <emphasis role="bold">target pane</emphasis>.</para>
                    </listitem>
                    <listitem>
                        <para>You'll see something like this</para>
                        <para>
                            <mediaobject>
                                <imageobject>
                                    <imagedata fileref="images/map_setup_1.png"/>
                                </imageobject>
                            </mediaobject>
                        </para>
                    </listitem>
                    <listitem>
                        <para>Provide a map name that is meaningful to you. This wont be used in any
                            output but will appear as the name of the tab.</para>
                    </listitem>
                    <listitem>
                        <para>For the moment dont worry about the other fields but increase the size
                            of the window and then zoom and pan the map to the general area where
                            your files were creates.</para>
                        <para>The resulting map property should look something like this</para>
                        <para>
                            <mediaobject>
                                <imageobject>
                                    <imagedata fileref="images/example_map.png"/>
                                </imageobject>
                            </mediaobject>
                        </para>
                    </listitem>
                    <listitem>
                        <para>To place an file from the source pane on the map first select the file
                            then click on the position on the map you wish it to appear. Note that
                            the current version of Field Helper does not allow you to drag and drop
                            onto a GoogleMap. We hope to rectify this in future versions.
                        </para>
                    </listitem>
                </orderedlist>
            </para>
        </sect2>
        <sect2>
            <title>More sophisticated map functions</title>
            <sect3>
                <title>Creating regions on the map</title>
                <para>You can draw your own polygons on the map and assign values and instructions
                    on how to build these values into the resulting
                </para>
            </sect3>
            <sect3>
                <title>Automated geocoding from GPX files</title>
                <para>aa</para>
            </sect3>
        </sect2>
    </sect1>
</article>