SobekCM METS Editor Application Guide for Version 1.0.1

Transcription

1 SobekCM METS Editor Application Guide for Version Guide created by Mark Sullivan and Laurie Taylor,

2 TABLE OF CONTENTS Introduction Downloads Concepts and Preparation Using the METS Editor Creating a New Metadata File Editing an Existing METS File Creating and Editing the Structure Map Saving in Different Formats Batch Processes Batch Processing from Spreadsheet or CSV File Batch Processing from a MARC21 Data File Batch Processing from an OAI-PMH Feed Batch Processing through a Set of Directories Image Derivative Creation Preferences and Settings First Launch Configuration Changing your Preferences METS Editor Development Page 2 of 57

3 INTRODUCTION ABOUT THE METS EDITOR This application is used to view and edit METS files for digital resources which will ultimately appear under the UFDC technology. This allows users to edit nearly all of the possible data fields for an item, and update data for an existing item. When this application is installed, the extension.mets is associated with this application. Once installed, you can open or edit METS files using this application by clicking on the file in the windows directory. There are several default templates installed with the application. Each template can present a very different look. A template dictates which elements to show and, in the case where there are several different formats available, which format to use. The template also determines how the exposed elements are grouped. Finally, templates can also set defaults and possible values. Page 3 of 57

4 DOWNLOADS DOWNLOADS AND OPTIONS VERSION AUGUST 24, 2011 This tool is free-standing and allows the creation of METS from a folder of items. It additionally allows the user to enter all of the bibliographic information, and assign page names and divisions to the structure map. This windows application can be downloaded in the following formats: Install File (MSI) installs this application on your machine. Source code is available on the sourceforge project page. INSTALLATION REQUIREMENTS AND PERMISSIONS The download will be a MSI windows installer file. Run this application to install the METS Editor application on your local computer. This windows application will run on any machine running a Microsoft operating system from Windows XP up to Windows 7 or Server This application requires that.net framework version 3.5 is also installed on the machine. This can be downloaded from the Microsoft Download Center if it is missing on your machine. It is recommended that after installation you navigate to the application's folder ( by default this is C:\Program Files (x86)\sobekcm or C:\Program Files\SobekCM ). Selecting the main application folder ( SobekCM METS Editor ), use the right button on the mouse to pull up the context menu and then select Properties. On the properties menu, select Security. Then edit the security to give either yourself or everyone read/write access to the directory, subdirectories, and files. To use some features of the METS Editor, in particular the ability to create default project files, the editor will need access to write into the subfolder. Initialization will continue the first time you launch the application. Page 4 of 57

5 CONCEPTS AND PREPARATION DIRECTORY NAMING In preparation for creating your first digital resource package, you should have the files for your item in the same folder. The folder can be named in any format. The folder name is automatically added in the METS file as the object identifier (OBJID). FILE NAMING AND FILE TYPES Files which represent the same portion of the intellectual entity should be named with the same filename, although of course the extension will be different. For example, images of the same page in different formats should share the same root filename, so jpg, tif, jp2, and jp2 should all be images of the same page. The following files types are considered page images: TIFF images ( *.tif, *.tiff ) JPEG images ( *.jpg, *.jpeg ) JPEG2000 images ( *.jp2 ) GIF images ( *.gif ) Text images - OCR text ( *.txt ) PRO files - Prime Recognition OCR files ( *.pro ) Page images will form their own structure map in the resultant METS which represents the structure of the actual item and for books and newspapers is analogous to a table of contents for the item. Any file which is not a page image is considered additional resource files and will be included in a second structure map. These files can still be organized hierarchically and be placed into divisions. Where page is the bottom layer of the page image hierarchy into which page images are placed, additional resource files are organized into file groups. Again, all files with the same root name will be organized into the same file group. METS OBJECTID AND BIBID:VID This application was originally written in support of a SobekCM digital repository. Within SobekCM digital repositories, each resource is assigned two identifiers: 1. BibID (or Bibliographic Identifier) This is essentially analogous to an identifier for the title, and can be parent to many individual volumes. As such, the BibID is usually directly related to the main bibliographic information regarding all the volumes, such as for newspapers. This is not necessarily or always true, but is generally true in practice. Bibliographic identifiers are 10 digital alpha-numeric values which start with two letters and ends in four numbers. The digits between can be either letters or numbers. 2. VID (or Volume Identifier) This identifies an individual volume within the bibliographic unit (or BibID). This is a five digit number, usually represented with leading zeros. Page 5 of 57

6 Generally the complete SobekCM Object ID or System ID is the BibID and VID separated by an underscore or colon. The METS Editor allows you to define any ObjectID for your METS files (usually matching the folder name though). Some of the batch processes may require that this type of numbering scheme is implemented, but it should be quite elementary to change the ObjectID's assigned after the batch process is used. I will be continuing to work on removing any requirements imposed by the historical use of this application. Page 6 of 57

7 USING THE METS EDITOR METADATA CREATION, EDITING, AND SAVING When the application is launched, the main screen below is displayed: Figure 1: SobekCM METS Editor Main Form Selecting one of the first two options on the main menu allows you create a new METS file or open an existing METS file. Once your metadata is created or open, you will be able to edit the metadata, create a structure map, and save the metadata in several different formats. Page 7 of 57

8 BATCH PROCESSING In addition to allowing a user to work with a single metadata file, there are several batch processing options available. These options allow for mass creation of metadata from spreadsheets or CSV files, MARC21 data files, or OAI-PMH feed. If you have digital resources folders with metadata and digital resources files, you can also batch process across a set of directories. All these batch processing options are accessible through the third link ( Batch METS file creation ) on the main menu of the SobekCM METS Editor. IMAGE DERIVATIVE CREATION The fourth link ( Create image derivatives for load ) allows the METS Editor to create image derivatives from archival TIFF files. This can be used for generally preparing images for loading in digital libraries. This works particularly well in preparation for loading into a SobekCM Digital Repository. Page 8 of 57

9 CREATING A NEW METADATA FILE OVERVIEW The METS Editor can be used to create a new METS file, either from scratch or from an existing record. You can choose which template to use, define defaults, and set a profile to control the metadata output. You can also use the batch processes to create many METS files at once from a variety of source files and directories. PROCESS INSTRUCTIONS Step 1: Initiate the process of creating a new METS file From the main screen, select the first option ( Create new METS file ). You may alternatively select: Action New METS File from the top menu to begin this process. Figure 1: SobekCM METS Editor Main Form Page 9 of 57

10 Step 2: Selecting the folder and initial files to include You will be prompted to select the folder for your new item: Figure 2: Browse For Folder Dialog The METS Application will automatically find any images and files in the folder, and ask if you would like them to be added to the METS file for the item. To add the images, click yes. You can avoid the dialog below and add all page images by default by selecting the Always add all page images when creating a new METS file? in the metadata preferences. ( Options Metadata Preferences Resource Files ) Or you can select the checkbox on this form to set the same setting. Figure 3: Existing Files Found Dialog If there are other files in the folder which may be included, but do not appear to be page images, you will receive a secondary prompt. This allows you to choose which files should be included in your new METS. If you wish to just add all the files in the folder, selecting ADD ALL will add them to the METS file and close this dialog box. Page 10 of 57

11 Figure 4: Existing Files Found Dialog After selecting the folder and agreeing or declining to add the files, the METS application automatically opens the default metadata editing template for a new item. If no images or files are found, the METS Application will still create a new METS file, and it automatically opens the default metadata editing template for a new item where you can add files manually if desired. Step 3: Enter or import metadata for your new digital resource This step will look different depending on your template and choices made through the metadata preferences and the first time you run the application. Figure 5: Example Metadata Template Form Page 11 of 57

12 In this stage, you will either enter the bibliographic metadata, or import from an existing metadata file. You will also want to create the appropriate structure map for this item. One you have entered all your information, proceed to the final step. Step 4: Save your METS file You can save your new METS file by either selecting the APPLY button or FINISH button. The APPLY button will save your changes, while leaving the metadata file open for editing. The FINISH button will save your latest changes and close this editing template, returning you to the main menu. For information on other options while saving, see saving in different formats. Page 12 of 57

13 EDITING AN EXISTING METS FILE OVERVIEW The METS Editor can be used to edit existing METS files and can read many different formats of bibliographic metadata and can edit hierarchical structure maps within the METS files. You can also add or remove files from the METS package. PROCESS INSTRUCTIONS Step 1: Open an existing METS file From the main screen, select the second option ( Open existing METS file ). You may alternatively select: Action Open from the top menu to begin this process. Figure 1: SobekCM METS Editor Main Form Page 13 of 57

14 Step 2: Edit existing metadata This step will look different depending on your template and choices made through the metadata preferences and the first time you run the application. Figure 2: Example Metadata Template Form In this stage, you will either edit the bibliographic metadata, or import from an existing metadata file. You will also want to create the appropriate structure map for this item. One you have sufficiently edited all the information, proceed to the final step. Step 3: Save your METS file You can save your new METS file by either selecting the APPLY button or FINISH button. The APPLY button will save your changes, while leaving the metadata file open for editing. The FINISH button will save your latest changes and close this editing template, returning you to the main menu. For information on other options while saving, see saving in different formats. Page 14 of 57

15 CREATING AND EDITING THE STRUCTURE MAP OVERVIEW One of the most compelling features of the METS files is the structure map and file section which ties the bibliographic metadata to all the digital resource files and shows how those images related to the digital resource. For digital resources generated in the SobekCM METS Editor, all page image type files (including related text files and ALTO files) are organized within the first structure map, which is referred to as the "physical" map. This is essentially the table of contents for a book-type digital resource. This can provide chapters, sections, subsections, and name each page within the digital resource. All non-page image files are placed within a second structure map, which organizes files for downloading. If only one type of files are included, than only one structure map is included in the final METS file. STRUCTURE MAP VIEW When a new METS file is created, generally all the page image and related files are added to the METS file. Initially, they are all added within a Main division. You can view the structure map(s) by selecting the last tab Structure Map in any template. Figure 1: Structure Map Editing Tab Page 15 of 57

16 NAMING PAGES It is usually best to name/number all the pages and then assign the divisions. Right-clicking on the page label allows you to Edit Page Label which can name the page and the group of images which comprise that page. A small form will allow you to enter the page number. Figure 2: Page-Level Options Figure 3: Entering the Page Number Page 16 of 57

17 Just entering the number itself into the field and hitting enter will add 'Page ' and the number as the page label. In addition, all subsequent pages will be named correspondingly as well. Figure 4: All Pages Renumbered You can also enter any other label for the page, such as 'Map 2' or 'Plate i', etc.. Figure 5: Naming the Page Entering any value that either ends in a roman numeral or a number will cause all subsequent pages to be named sequentially and use the same beginning portion of the page label. For example, the value entered above ( 'Map i' ) would cause each subsequent page to be numbered 'Map ' followed by the next roman numeral. Page 17 of 57

18 Figure 6: All Pages Renamed You can set preferences on whether subsequent pages are automatically, sequentially numbered from the main menu. Figure 7: Setting the Automatic Page Numbering Page 18 of 57

19 EDITING AN EXISTING DIVISION Right-clicking on the division label allows you to Edit Division and to add other divisions (see next section). Figure 2: Division-Level Options Editing the division allows you to select from a menu of division types. Figure 3: Selecting the Division Type Page 19 of 57

20 The name field for the division is context sensitive. Thus, selecting divisions that can be named (Chapter, Section, Appendix, etc..) allows you to type the name for that division. Figure 4: Editing the Division Name For divisions that cannot be further named (Main, Title Page, Front Cover), the name segment will remain uneditable. Figure 5: Uneditable Division Name INSERT A NEW SIBLING, PARENT, OR CHILD DIVISION By using the ability to add new parent, sibling, or child divisions, you can arrange the pages of your digital resource into a deeply hierarchical table of contents. Page 20 of 57

21 Figure 6: Division-Level Options The option to Add new Parent Division adds a division above the current division and makes the current division a child of the new division. The option to Add new Sibling Division adds a new division below the current division and at the same level as the current division. This new division will have the same parent as the current division. The option to Add a new Child Division adds a new division below the current division and makes the new division a child of the current division. You can drag divisions around to change the order or drag pages around. You can only drag one page at a time right now, but this is currently on our development queue as a major improvement. By using all these options above, you can create a deeply hierarchical structure, like the one below: Page 21 of 57

22 Figure 7: Building a Hierarchical Structure Map RESOURCE FILES (DOWNLOADS) STRUCTURE MAP Editing the second structure map (with the downloadable files) is analogous to editing the page image structure map. Page 22 of 57

23 Figure 7: Working with the Resource Files Structure Map In the example above, you can see that the "page" is named, which names the collection of files of the same name. This allows multiple file types of the same object to be correctly tagged together. Instead of being called "pages" though, in this structure map they appear as a group of files. You can also organize these nodes hierarchically, although this is not currently utilized by the SobekCM digital repository. Page 23 of 57

24 SAVING IN DIFFERENT FORMATS OVERVIEW The primary purpose of this tool is to create METS files. However, the metadata can also be saved into a variety of other formats. SAVE AS METS Once you are editing an existing or a new METS file, saving your new information is quite simple. You can save your new METS file by either selecting the APPLY button or FINISH button. The APPLY button will save your changes, while leaving the metadata file open for editing. The FINISH button will save your latest changes and close this editing template, returning you to the main menu. You may also choose to save from the top menu by selecting Action Save. SAVE AS MARCXML, MODS, AND DUBLIN CORE From the top menu you may also save the bibliographic information in different formats, by selecting Action Save As.. Figure 1: Save As Options in Editing Form Page 24 of 57

25 Next, select the format in which you would like to save the metadata: METS (this allows you to save the METS in a different location or with a non-standard name) MarcXML MODS Dublin Core If you opt to save the bibliographic information as Dublin Core, you need to choose the Dublin Core format you wish to use: Dublin Core <records> RDF Dublin Core Trial and error with the two different formats should quickly reveal the differences between them. Page 25 of 57

26 BATCH PROCESSES SELECTING A BATCH PROCESS Batch processes are processes which can create or alter a large number of metadata files simultaneously. From the application main menu, select the third link ( Batch METS file creation ) to view the batching main menu displayed below: Figure 1: SobekCM METS Editor Batching Menu The following batch processes are available from this menu: Batch processing from a spreadsheet or CSV file This option creates many METS files, using an Excel spreadsheet or comma-seperated value (CSV) file as the source. Each row of the source file should contain information about a different digital resource and the first row of the worksheet or CSV file must be a header row with column labels. You will be able to manually map each column to the metadata file and add a limited number of constants as well. The result will be a directory with METS files for each row from your source file. Page 26 of 57

27 Batch processing from a MARC21 data file This option will read a MARC21 Data File containing one or more records and iterate through each record, creating METS file(s) containing all of the bibliographic information from the records. You will also be able to add a limited number of constants during this process. The result will be a directory with METS files for each record within the MARC21 data file. Batch processing through a set of directories This option steps through any number of subfolders, looking for a metadata file of your specification. METS, MODS, and Dublin Core files are accepted. If the metadata file is not in METS format, a METS file will be created from the data within the MODS or Dublin Core file. In all cases, any resource files in the same folder will be added to the structure map within the METS file. Batch processing from an OAI-PMH feed By pointing the application at a set within an OAI-PMH repository, METS files are created for each record within the feed. Again, you will also be able to add a limited number of constants during this process and the result will be a directory with METS files for each record within the feed. Page 27 of 57

28 BATCH PROCESSING FROM SPREADSHEET OR CSV FILE OVERVIEW Batch processing allows the data from a spreadsheet or comma-seperated value (CSV) file to create METS files. The top row (or line) of each input file must be a header row which contains the names of each column. These columns should be named in english if possible, as the mappings often may be auto-generated in this case. The processor will step through each of the remaining rows (or lines) in the input files and will create a METS file with all of the data from those files. PROCESS INSTRUCTIONS Selecting the first option ( Import from Excel or CSV File ) from the Batching Menu will launch the form: Figure 1: Spreadsheet Batch Processor Form Page 28 of 57

29 Select either an excel spreadsheet or a CSV file as the input file. Then, you will be prompted to select the worksheet within the workbook to import. If you selected a CSV file, there will only be one sheet (named 'Sheet 1') which you must select. Once you select the sheet, the column names will be read from the first row in the input file, and any automatic mappings will be applied. Figure 2: Spreadsheet Batch Processor Column Mapping You will want to verify the mappings and correct any mappings which were incorrect. You may also enter up to eight constants from the second tab under step 3. Page 29 of 57

30 Figure 3: Spreadsheet Batch Processor Constants If you do not have any column mapped to Material Type, you will need to select a value from the drop down. If you do not have a column mapped to BibID, you will also need to enter a value for the first bibid to be used as the ObjectID in the resulting METS files. The value you enter must adhere to the SobekCM BibID rules. SobekCM Bibliographic Identifier (BibID) Rules The BibID is a ten digit alphanumeric identifier used for SobekCM libraries which begins with at least two characters and ends with at least four numbers. Whatever you enter will be the beginning of the final BibID's, which also act as part of the ObjectID for the METS files. If you enter a string less than 10 characters long, this will be the prefix. For example, entering 'ca008' will cause the first BibID assigned to be 'CA ', the second 'CA ', the third 'CA ', etc.. Page 30 of 57

31 Entering a full BibID, such as 'MANIOC0123' will break the item into two parts and compute each BibID from the provided BibID. For example, entering 'MANIOC0123' will cause the first BibID assigned to be 'MANIOC0123', the second 'MANIOC0124', the third MANIOC0125', etc.. Press the EXECUTE button once you are ready to proceed. PROCESS DESCRIPTION Once the process is initiated, the processor will step through each row in your input file and perform the following steps: 1. Read the row of data from your input file 2. Input this data into a new METS object 3. Apply all the constants from the processor form 4. If no source institution code or source institution statement was included yet, the defaults from your metadata preferences are applied. 5. METS file is written to your destination folder Since most of your defaults are not included in the resulting metadata files, you will want to include these values in your input file. Once complete, some very simple information will be displayed in the results form, including the newly assigned Bibliographic Identifier (BibID) and Volume ID (VID) which combine to form the METS ObjectID's. Figure 4: Spreadsheet Batch Processor Results Form If your input file was an excel spreadsheet, a new worksheet named OUTPUT will be added to the workbook, which includes all the original fields as well as two new columns with the new BibID and VIDs. Page 31 of 57

32 Figure 5: New Output Sheet in Excel File If your input file was a CSV file, another file will be written ending with '_output' that will contain these two new columns. Page 32 of 57

33 BATCH PROCESSING FROM A MARC21 DATA FILE OVERVIEW Batch processing allows the data from a MARC21 export report file to create METS files. The processor will step through each record within the report, and generate a METS file for each per your specifications in the metadata preferences section. PROCESS INSTRUCTIONS Selecting the second option ( Convert a MARC21 file to METS ) from the Batching Menu will launch the form: Figure 1: MARC21 Batch Processor Form Select the input MARC21 file to use. Page 33 of 57

34 Next, you are given the opportunity to enter up to eight constants from the second tab under step 2. Finally, select the destination folder for all the resulting METS files. Figure 2: MARC21 Batch Processor Form #2 You will also need to enter a value for the first bibid to be used as the ObjectID in the resulting METS files. The value you enter must adhere to the SobekCM BibID rules. SobekCM Bibliographic Identifier (BibID) Rules The BibID is a ten digit alphanumeric identifier used for SobekCM libraries which begins with at least two characters and ends with at least four numbers. Whatever you enter will be the beginning of the final BibID's, which also act as part of the ObjectID for the METS files. If you enter a string less than 10 characters long, this will be the prefix. For example, entering 'ca008' will cause the first BibID assigned to be 'CA ', the second 'CA ', the third 'CA ', etc.. Entering a full BibID, such as 'MANIOC0123' will break the item into two parts and compute each BibID from the provided BibID. For example, entering 'MANIOC0123' will cause the first BibID assigned to be 'MANIOC0123', the second 'MANIOC0124', the third MANIOC0125', etc.. Press the EXECUTE button once you are ready to proceed. Page 34 of 57

35 PROCESS DESCRIPTION Once the process is initiated, the processor will step through each record in your input file and perform the following steps: 1. Read the next record from the MARC21 report 2. Input this data into a new METS object 3. Apply all the constants from the processor form 4. If no source institution code or source institution statement was included yet, the defaults from your metadata preferences are applied. 5. METS file is written to your destination folder Since most of your defaults are not included in the resulting metadata files, you will want to include these values in your input file. Once complete, some very simple information will be displayed in the results form, including the newly assigned Bibliographic Identifier (BibID) and Volume ID (VID) which combine to form the METS ObjectID's. Figure 3: MARC21 Batch Processor Results Form Page 35 of 57

36 BATCH PROCESSING FROM AN OAI-PMH FEED SELECTING AN OAI-PMH DATA PROVIDER Currently, the OAI-PMH batch processor will accept any OAI-PMH feed which includes 'oai_dc' as a possible metadata prefix. By selecting the fourth link ( Harvest metadata via OAi-PMH ) from the batch process menu, you will be shown the form to enter the URL for the OAI-PMH repository. You will want to enter the base URL only, do not include any of the OAI-PMH verbs or query strings. In addition, include the prefix, such as ' on the link. Figure 1: OAI-PMH Repository URL Form Once you enter a valid the URL for the data provider, you can select the TEST URL button to check the link. The system will perform a basic Identify against the data provider and validate the URL. If the URL is correct, you should see a form such as the one below: Figure 2: Successful test of a URL Selecting the CONTINUE button on the URL form will allow you to enter more details regarding the import on the OAI-PMH Import Form. REFINING YOUR INSTRUCTIONS AND METADATA The form below allows you to enter more specifics for the batch processing: Page 36 of 57

37 Figure 3: OAI-PMH Import Form This form allows you to select the set for which you would like to create METS files. In addition, you can enter a number of constants, which will be applied to all the resulting METS files. Finally, you must choose the destination folder for all the METS files created. Defaults that you have set in the metadata preferences are NOT applied to the resulting METS files, as it is assumed these records are from external libraries. So, your decisions on bibliographic format and add-ons is used, but no system-wide defaults are applied. Any defaults to be applied must be entered on this form. To continue you will also need to enter a value for the First BibID constant to be used as the ObjectID in the resulting METS files. The value you enter must adhere to the SobekCM BibID rules. SobekCM Bibliographic Identifier (BibID) Rules The BibID is a ten digit alphanumeric identifier used for SobekCM libraries which begins with at least two characters and ends with at least four numbers. Whatever you enter will be the beginning of the final BibID's, which also act as part of the ObjectID for the METS files. Page 37 of 57

38 If you enter a string less than 10 characters long, this will be the prefix. For example, entering 'ca008' will cause the first BibID assigned to be 'CA ', the second 'CA ', the third 'CA ', etc.. Entering a full BibID, such as 'MANIOC0123' will break the item into two parts and compute each BibID from the provided BibID. For example, entering 'MANIOC0123' will cause the first BibID assigned to be 'MANIOC0123', the second 'MANIOC0124', the third MANIOC0125', etc.. REPOSITORY DETAILS You can view the details of the repository from the main menu ( View Repository Details ), from the main OAI- PMH Import Form. Figure 4: OAI-PMH Repository Details PERFORMING BATCH PROCESS Once you have entered all the necessary data, select the EXECUTE button to begin this process. A progress bar will display progress as the METS files are created in the destination folder you provided. You may see the progress bar reset several times; if the provider uses resumption tokens, it may have to pull records several times to get the full set of records. This happens automatically, but resets the progress bar each time. Page 38 of 57

39 If you are preparing these METS files for inclusion in a SobekCM library, you can simply move all the created METS files into the bulk loader's drop box and they should all load within a couple minutes. IDENTIFIER MAPPING To allow you to update records ingested through this method, a mapping is retained between the OAI Identifier for a digital resource and the resulting METS ObjectID. This mapping is retained as a XML file for each repository processed. Depending on file permissions, the mapping file will either be under the application folder in an OAI subfolder, or in your My Documents folder. These mappings will automatically be found and you will be prompted to reuse them on subsequent runs of the process. Page 39 of 57

40 BATCH PROCESSING THROUGH A SET OF DIRECTORIES OVERVIEW By selecting the third option ( Step through a series of directories ) from the Batching Menu, the SobekCM METS Editor can either create or update METS files through a deep folder structure. All resource files in the folders will be added to the METS file as well. This is a particularly useful way to take METS files generated from spreadsheets, csv files, or a marc21 data report and add related resource files in bulk. PROCESS INSTRUCTIONS Selecting the third option ( Step through a series of directories ) from the Batching Menu will launch the form: Figure 1: Batch Import Directory Recursion Form This form allows you to select the parent directory to recurse through. You must also select the type of metadata source file to read. This can either be a pre-existing METS file, a MODS file, a MarcXML file, or a Dublin Core description file. After selecting the type, either enter or select the filter used to determine which file to read. This can be a wildcarded type entry, such as in the populated examples, such as '*.mets', '*.mets.xml', or '*_dc.xml'. If all your metadata files are named the same, you can also enter the full name, such as 'dc.xml'. If you select any source file other than METS, you will also need to chose how the METS ObjectID should be assigned. If you chose to have consecutive ObjectID's assigned in accordance to the SobekCM BibID pattern, the first BibID you enter must adhere to the following rules. SobekCM Bibliographic Identifier (BibID) Rules The BibID is a ten digit alphanumeric identifier used for SobekCM libraries which begins with at least two characters and ends with at least four numbers. Whatever you enter will be the beginning of the final BibID's, which also act as part of the ObjectID for the METS files. Page 40 of 57

41 If you enter a string less than 10 characters long, this will be the prefix. For example, entering 'ca008' will cause the first BibID assigned to be 'CA ', the second 'CA ', the third 'CA ', etc.. Entering a full BibID, such as 'MANIOC0123' will break the item into two parts and compute each BibID from the provided BibID. For example, entering 'MANIOC0123' will cause the first BibID assigned to be 'MANIOC0123', the second 'MANIOC0124', the third MANIOC0125', etc.. When you are done entering the necessary information, press the CONTINUE button. PROCESS DESCRIPTION Once the process begins, the form will become larger, and a progress bar and current status will be displayed throughout the process. The process will run through the following steps: Figure 2: Batch Processing 1. Metadata File Read (one of two options here) o METS file read o MODS, MarcXML, or Dublin Core file read. In this case, since we are building a new METS file, all your defaults set within your metadata preferences are applied. In addition, an ObjectID is assigned according to the rule you just set in this form. 2. All files added to the METS, either in the page image or download structure maps 3. If your current settings are to compute the checksums, checksums are computed 4. METS file is written within the directory Page 41 of 57

42 IMAGE DERIVATIVE CREATION OVERVIEW By selecting the fourth option ( Create image derivatives for load ) from the Batching Menu, the SobekCM METS Editor can be used to create image derivates from archival TIFF files. This process can create jpegs, jpeg2000, and jpeg thumbnails. These image derivatives may be useful for loading into any digital repository, but are particularly useful for loading into a SobekCM Digital Repository. You can control which files are generated as well as the dimensions for the jpeg and jpeg thumbnails. The defaults are the values used by the Digital Library of the Caribbean and University of Florida Digital Collections. The JPEG2000s are generated per the NDNP specifications. PREPARATION The METS Editor uses the free Kakadu encoder which installs with the software for creating JPEG2000s. However, you will need to install a version of ImageMagick for creation of the JPEG images. Once you install any version of ImageMagick, you will need to restart your computer (although it won't prompt you to). The first time you run the image derivative option, you will eventually be asked to browse to your installation of ImageMagick. Figure 1: ImageMagick Settings Form Once you enter this value once, you will not be prompted again, unless you uninstall ImageMagick. PROCESS INSTRUCTIONS Selecting the fourth option ( Create image derivatives for load ) from the Batching Menu will launch the Image Derivative Creation Form: Page 42 of 57

43 Figure 2: Image Derivative Creation Form Once you enter your desired settings, press CREATE. A dialog box will appear to allow you to set the top-level folder. Every file and folder under that top-level folder will be processed and image derivatives will be created as necessary. Progress will be displayed at the bottom of the form: Figure 3: Processing Image Derivative Creation Form Page 43 of 57

44 A message will be displayed once the process is complete: Figure 4: Processing Complete Message Page 44 of 57

45 PREFERENCES AND SETTINGS OVERVIEW The settings determine many aspects of the application, from metadata template forms to the resulting metadata formats. You can also define many default values which will be applied when you create a new METS file through the application. SCOPE OF PREFERENCES All of the application and metadata preferences are user-specific; if you have multiple users using the same application on the same machine, they can all have different defaults. The settings are stored in the user's Isolated Storage application settings location in XML format. SETTING YOUR PREFERENCES Your preferences are set in two ways: When you first launch the application, a series of preference forms appear to allow you to enter your preferences. You can always edit these settingds by launching the application and metadata preferences form from the main menu. ( Options Metadata Preferences ) Figure 1: Launching the preferences forms These two methods are very analogous and often present a very similar looking interface, although the look and feel may vary slightly. Page 45 of 57

46 FIRST LAUNCH CONFIGURATION INITIAL SETTINGS SCREENS Figure 1: Initial Welcome Screen Figure 2: Initialization: General Use Page 46 of 57

47 Figure 3: Initialization: Primary Bibliographic Metadata Scheme Figure 4: Initialization: Primary Metadata Template Page 47 of 57

48 Figure 5: Initialization: Select Template Add-Ons Figure 6: Initialization: SobekCM Add-On Settings Page 48 of 57

49 Figure 7: Initialization: FCLA Add-On Settings Figure 8: Initialization: Resource Files Page 49 of 57

50 Figure 9: Initialization: Localization and Defaults Page 50 of 57

51 CHANGING YOUR PREFERENCES METADATA PREFERENCES SCREENS Figure 1: Metadata Preferences - General Options Page 51 of 57

52 Figure 2: Metadata Preferences - Metadata Scheme Figure 3: Metadata Preferences - Template Page 52 of 57

53 Figure 4: Metadata Preferences - Add-Ons Figure 5: Metadata Preferences - SobekCM Add-On Settings Page 53 of 57

54 Figure 6: Metadata Preferences - FCLA Add-On Settings Figure 7: Metadata Preferences - Resource Files Page 54 of 57

55 Figure 8: Metadata Preferences - Localization Figure 9: Metadata Preferences - Project Page 55 of 57

56 Figure 10: Metadata Preferences - Controlled Lists Page 56 of 57

57 METS EDITOR DEVELOPMENT FUTURE PLANS Almost all planned features have now been completed. Only a few pending ideas remain as of now. Add ability to drag multiple pages around the structure map simultaneously. Introduction of quality control panel for visually validating images and creating table of contents while viewing thumbnails for each page, rather than just the tree views Moving all translations to external language packs for easy introduction of new languages ( such as Kreyol, Italian, Dutch, etc.. ) If there is a feature you are interested in seeing introduced, please contact the primary programmer at Mark.V.Sullivan@gmail.com. The source code is also freely available, so feel free to have a crack at it. If you do add new features, please contact the primary programmer so your features can be re-introduced into the code base for others. METS EDITOR RELEASE HISTORY The complete release and versioning history for the SobekCM METS Editor is available online. Page 57 of 57