Tutorial

This tutorial guides you through using MIK to create a set of Islandora basic image objects from metadata in a CSV file. When you finish the tutorial, you will be able to import the objects into Islandora.

To do the tutorial, you will need a computer that has MIK installed on it. A zip file containing the sample images, metadata, and configuration files used in the tutorial can be downloaded here.

You will also need a text editor. Any decent editor will do (which means Windows Notepad will not). If you don't already have a favourite text editor, check out Atom. It's free, it works well on all major operating systems, and it's easy to use.

Finally, you will also need to know a little bit about Islandora. In particular, the tutorial below assumes that you know what Islandora objects are, and that you are familiar with some of the different types of Islandora objects, like Basic Image objects.

Getting ready

Everything you need to create the Islandora import packages is included in the sample data zip: some images, some metadata, and the two MIK configuration files you will need (the mappings file and the .ini file):

To get ready to start the tutorial,

1. Unzip the file
2. copy the files that aren't images (tutorial_config.ini, tutorial_mappings.csv, and tutorial_metadata.csv) into the same directory where MIK is installed.
3. Edit tutorial_config.ini to define your input and output directories.

We will cover editing your .ini file in detail in Step 3, below.

Step 1 (Create your metadata CSV file) and Step 2 (Create your mappings file) have already been done for you. We include them here to represent a typical MIK workflow. In real life, if you weren't using prepackaged content included in a tutorial, you would need to complete those steps. In the Step 1 and Step 2 sections, we'll describe what you would need to do if you were preparing your own content for use with MIK.

Step 1: Create your metadata CSV file

Identifier,File,Title,Creator,Date taken,Subjects,Note
"image01","IMG_1410.JPG","Small boats in Havana Harbour","Jordan, Mark","2015-03-08","Boats; water","Taken on vacation in Cuba."
"image02","IMG_2549.JPG","Manhatten Island","Jordan, Mark","2015-09-13","Cityscapes","Taken from the ferry from downtown New York to Highlands, NJ. Weather was windy."
"image03","IMG_2940.JPG","Looking across Burrard Inlet","Jordan, Mark","2011-08-01",,"View from Deep Cove to Burnaby Mountain. Simon Fraser University is visible on the top of the mountain in the distance."
"image04","IMG_2958.JPG","Amsterdam waterfront","Jordan, Mark","2013-01-17",,"Amsterdam waterfront on an overcast day."
"image05","IMG_5083.JPG","Alcatraz Island","Jordan, Mark","2014-01-14","Alcatraz Federal Penitentiary; islands","Taken from Fisherman's Wharf, San Francisco."

Step 2: Create your mappings file

Title,"<titleInfo><title>%value%</title></titleInfo>"
Creator,"<name type=""personal""><namePart>%value%</namePart><role><roleTerm type=""text"">photographer</roleTerm></role></name>"
Date taken,"<originInfo><dateCreated encoding=""w3cdtf"" keyDate=""yes"">%value%</dateCreated></originInfo>"
Subjects,"<subject><topic>%value%</topic></subject>"
Identifier,"<identifier type=""local"" displayLabel=""Local identifier"">%value%</identifier>"
Note, "<note>%value%</note>"
null0,"<genre authority=""marcgt"">picture</genre>"
null1,"<typeOfResource>still image</typeOfResource>"
null2,"<physicalDescription><digitalOrigin>born digital</digitalOrigin></physicalDescription>"

Step 3: Create an .ini file

The MIK documentation describes "toolchains", which are groups of MIK components that are brought together to convert a specific type of input (like CSV metadata) into a specific type of output (like import packages for Islandora Basic Image objects). A toolchain is defined in an MIK configuration file, also known as an .ini file since that's the format the files take. The .ini file below is the one that we'll be using in this tutorial. All it really contains are groups of configuration settings for your toolchain, and also some comment lines that begin with a semicolon (;). These lines are ignored by MIK and really only function as inline documentation within the .ini file.

The only things you will need to modify in the .ini file are the paths to your input directory, your output directory, and your log file. Different operating systems define paths differently. The .ini file below contains paths Linux paths, which look like this:

temp_directory = "/tmp/miktutorial_temp"

The values for the input_directory, output_directory, and path_to_log settings will need to be compatible with your operating system. For example, on Windows they look like this:

temp_directory = "c:\temp\miktutorial_temp"

whereas on a Mac they look like this:

temp_directory = "/Users/mark/miktutorial_temp"

Here is the .ini file as it is provided in the tutorial sample data. Assuming that MIK is installed correctly on your computer, and that you have copied tutorial_config.ini, tutorial_mappings.csv, and tutorial_metadata.csv into the same directory where MIK is installed, you should be able to run MIK after you have updated the .ini file with your own paths.

; MIK configuration file for the MIK Tutorial.

[CONFIG]
config_id = MIK tutorial
last_updated_on = "2016-02-03"
last_update_by = "Mark Jordan"

[FETCHER]
class = Csv
input_file = "tutorial_metadata.csv"
temp_directory = "/tmp/miktutorial_temp"
record_key = Identifier

[METADATA_PARSER]
class = mods\CsvToMods
mapping_csv_path = "tutorial_mappings.csv"

[FILE_GETTER]
class = CsvSingleFile
input_directory = "/home/mark/Downloads/mik_tutorial_data"
temp_directory = "/tmp/miktutorial_temp"
file_name_field = File

[WRITER]
class = CsvSingleFile
preserve_content_filenames = true
output_directory = "/tmp/miktutorial_output"
; Note that you will need to adjust the path to your system's php executable.
postwritehooks[] = "/usr/bin/php extras/scripts/postwritehooks/validate_mods.php"
; During testing, we only want to create the MODS XML file.
; datastreams[] = "MODS"

[MANIPULATORS]
metadatamanipulators[] = "FilterModsTopic|subject"

[LOGGING]
path_to_log = "/tmp/miktutorial_output/mik.log"

Activity: Editing the .ini file

1. Open tutorial_config.ini in your text editor.
2. In the [FETCHER] section, modify the value of "temp_directory" so that....
3. In the [FILE_GETTER] section, modify the value of "temp_directory" so that is has the same value as...
4. In the [WRITER] section, modify the value of "output_directory" so that.....
5. In the [LOGGING] section, modify the value of "path_to_log" so that ...
6. Save your file in the same directory in the MIK installation directory.

Step 4: Test (--checkconfig and MODS.xml)

Step 5: Run MIK and create packages

Step 6: Perform QA on packages

Step 7: Load into Islandora

Learning on your own

• Modify the values in the metadata file (but for now, keep the same column structure) and rerun MIK. Open the XML files that MIK creates to see your values in the MODS.
• Add a new field to the mappings file that will have the same value for all objects. For example, add the following line to the end of the file: null3,"<accessCondition type=""use and reproduction"">Images are in the public domain.</accessCondition>"
• Add a new column to the CSV metadata file and populate it with different values for each image. Then add a mapping for the new field using the special %value% token so that your MODS will use the value of the new field for each image.