source commit: 1e197b6

01-introduction.md

@@ -0,0 +1,81 @@
+---
+title: Introduction to MarcEdit
+teaching: 10
+exercises: 0
+---
+
+::::::::::::::::::::::::::::::::::::::: objectives
+
+- Explain what the MarcEdit software does
+- Explain how the MarcEdit software can help work with library bibliographic data and library MARC files
+
+::::::::::::::::::::::::::::::::::::::::::::::::::
+
+:::::::::::::::::::::::::::::::::::::::: questions
+
+- What is MarcEdit?
+- What can MarcEdit do?
+
+::::::::::::::::::::::::::::::::::::::::::::::::::
+
+## What is MarcEdit?
+
+MarcEdit is a suite of tools created and maintained by Terry Reese. The tools together form the MarcEdit software. These tools provide numerous functions which can be used to create, edit, and manipulate library metadata, particularly, though not limited to, records in a variety of MARC formats and standards. In this way, the MarcEdit software is MARC agnostic and can work with Unimarc or MARC21. MarcEdit can be used to:
+
+- make small, single, edits to individual MARC records
+- make edits across many MARC records at a single time
+- automate common edits/processes
+- validate your data against defined MARC rules
+- convert data between different formats
+- enhance your data
+- pull data from external sources
+
+The features offered by the suite of MarcEdit tools continue to evolve, with new features added as the software is updated by Terry Reese. [A comprehensive list of features](https://marcedit.reeset.net/features) is available on the MarcEdit website.
+
+Although the ability to create, view and edit MARC records is built into many pieces of library and bibliographic management software, MarcEdit is particularly flexible and powerful for manipulating MARC data in bulk. With MarcEdit's wide-ranging functionality and integration into other library software and services, it is a very powerful toolkit for anyone working with bibliographic data.
+
+## MarcEdit's Primary Features
+
+### Profiling MARC Data
+
+Before working with any data file, it is advantageous to understand that data. MarcEdit can help you answer common questions you might have of your data, such as:  How many records are in the file? Does the file contain MARC data that describes only books, and are those books print and/or electronic? Do the records follow national metadata standards and best practices needed for your local systems?
+
+Getting a profile of the MARC data in your file can help you make a plan on what changes need to be made to the file. Further, it can help you automate some of the changes if this type of file is one that you work with often.
+
+### Manipulating MARC Data
+
+MarcEdit is like the Swiss army knife for MARC data. You can perform single (one record) or global (all records) edits such as adding or deleting MARC fields, subfields and indicator values. Other edit functions include building fields using MARC data from other fields, or changing the case of data in a field. You can also run functions that update your MARC data to the content standard Resource Description and Access (RDA) or assign OCLC's FAST subject headings to records in the file.
+
+### Tasks and Automation
+
+If you have a list of changes to make, MarcEdit allows you to package these together to be run one after another in Tasks. These packages of changes can then be saved for future use. This is one of the ways to automate your work, making manipulating your MARC data easier and quicker.
+
+### Integrations
+
+MarcEdit can integrate with OCLC's WorldCat and Ex Libris' Alma library system platform. Thanks to these integrations, you can retrieve records from external services, manipulate the records, and then push the changes back to the system integration of your choice.
+
+Using MarcEdit you can harvest [OAI or Open Archives Initiative for Harvesting Metadata Protocol](https://www.openarchives.org/pmh/) Dublin Core or MARC21 records. Though not necessarily an integration, harvested records can also be manipulated.
+
+### Regular Expressions
+
+MarcEdit allows for the use of regular expressions in many of its MARC data manipulation features. Regular expressions are a sequence of text to identify a search pattern. This is a powerful tool that allows greater flexibility when manipulating MARC data.
+
+## Getting help
+
+If you encounter problems installing MarcEdit or using a MarcEdit feature, a good source of support is the [MarcEdit mailing list](https://listserv.gmu.edu/cgi-bin/wa?A0=marcedit-l). [The MarcEdit website has a list of places where you can get help using the software](https://marcedit.reeset.net/help) including:
+
+- [The MarcEdit Knowledgebase](https://marcedit.reeset.net/archives/category/knowledge_base)
+- [The MarcEdit 101 Webinar](https://marcedit.reeset.net/marcedit-101-workshop)
+- [A set of video tutorials on YouTube](https://www.youtube.com/playlist?list=PLrHRsJ91nVFScJLS91SWR5awtFfpewMWg)
+
+
+
+:::::::::::::::::::::::::::::::::::::::: keypoints
+
+- MarcEdit is a tool for working with bibliographic metadata, specifically in the MARC format
+- MarcEdit can be used to open, review and edit MARC files
+- MarcEdit provides advanced features and integrations to support the manipulation of MARC files
+
+::::::::::::::::::::::::::::::::::::::::::::::::::
+
+

02-top-level-menu-features.md

@@ -0,0 +1,100 @@
+---
+title: Getting Started with MarcEdit
+teaching: 17
+exercises: 3
+---
+
+::::::::::::::::::::::::::::::::::::::: objectives
+
+- Locate top-level menu features
+- Explain the top-level menu features
+
+::::::::::::::::::::::::::::::::::::::::::::::::::
+
+:::::::::::::::::::::::::::::::::::::::: questions
+
+- How is MarcEdit organized?
+- What are the top-level features?
+- Where are the top-level features located?
+
+::::::::::::::::::::::::::::::::::::::::::::::::::
+
+## Getting Started with MarcEdit
+
+## Top Level Menu Features
+
+When you launch MarcEdit, the main window opens. From here, you can access the suite of MarcEdit tools, features, plug-ins, quick links, or help.
+
+### MarcEdit Main Window: Top Level Menu
+
+In the main window top-level menu, there are three options: Tools, Plug-ins, and Help.
+
+### Tools
+
+The Tools menu allows you to access a number of different basic and advanced features. Features to highlight include:
+
+- Preferences
+- The MarcEdit regular expression store
+- OAI Harvester
+- Export either MARC records or records reformatted as a text delimited csv (comma-separated value) or tsv (tab-separated value) file
+- MARC Processing Tools: MARCsplit, MARCcompare, MARCjoin, MARCmerge, find duplicate records, RDA Helper, or MARCValidator
+- Delimited Text Translator
+- Utilities that include a verify URL tool
+
+One thing you'll notice is that there are both shortcuts, linked icons, and menu options that lead to the same features or tools. For example, to update your preferences, you can go to Tools → Preferences, use the keyboard shortcut of Ctrl+Shift+P, or click on the gearbox in the upper left-hand corner of the main window.
+
+#### Preferences
+
+In MarcEdit, Preferences allow you to configure the main window and various tools, such as the MarcEditor (the tool used to manipulate MARC data). For example, you can change the font, and font size, or select your most frequently used tools to display as shortcuts in the main window. In Preferences, you can also configure settings for other tools beyond the main window menu such as the MarcEditor where you can update the default character encoding for records that are opened in this tool (such as MARC8 or UTF-8), integrations with OCLC, or accessibility settings.
+
+:::::::::::::::::::::::::::::::::::::::  checklist
+
+## Let's add a shortcut to our main window
+
+1. Click on the gearbox in the top left corner or go to Tools → Preferences
+2. Select "Main Window" in the Preferences window in the left-hand pane
+3. In the right-hand pane, select RDA Helper
+4. Click Ok
+
+
+::::::::::::::::::::::::::::::::::::::::::::::::::
+
+:::::::::::::::::::::::::::::::::::::::  challenge
+
+## Name three other tools or features that can be changed in Preferences.
+
+:::::::::::::::  solution
+
+## Solution
+
+1. Click on the gear icon in the main window or go to Tools → Preferences
+2. In the left-hand pane, look at the names there
+3. Tools or features that can be changed in Preferences: Main Window, Bibframe, MarcEditor, MARCEngine, Ease of Use, File Associations, Language, Locations, Other, Updates, Configure Watcher, ILS Integration, OCLC API Integration.
+
+
+
+:::::::::::::::::::::::::
+
+::::::::::::::::::::::::::::::::::::::::::::::::::
+
+### Plug-Ins
+
+There are a number of useful plugins that can be added to MarcEdit to extend its functionality. An example is the MARC to [KBART or Knowledge bases and related tools](https://www.niso.org/standards-committees/kbart/kbart-frequently-asked-questions) converter. You can find more information on plugins on the [MarcEdit Plugin page](https://marcedit.reeset.net/managing-plugins-in-marcedit). To enable these and see the list in the MarcEdit main menu, click on Plug-ins and then select Plugin Manager. In the popup Plugin Manager window, you can select any of the plug-ins and then click Save. It should be noted that administrative permissions are not needed to enable plug-ins. When you click Save, only that Plugin Manager window closes and there is no need to close and reopen the MarcEdit application.
+
+### Help
+
+This top-level menu Help allows you to find information on updates, about your current MarcEdit installation, and links out to video tutorials or online help.
+
+### History
+
+MarcEdit remembers what you did last. You can see this history in the Quick Links section which is a drop-down of features and tools you frequently use. Although not related to a history of what you did last in MarcEdit, the "What would you like to do?" box in the upper right-hand corner is convenient for quickly finding tools and features in MarcEdit.
+
+:::::::::::::::::::::::::::::::::::::::: keypoints
+
+- MarcEdit offers the ability to add shortcuts to the main window
+- MarcEdit allows you to set preferences for features and tools such as the main window or the MarcEditor
+- Preferences can be accessed using the gearbox icon and selecting Tools → Preferences, or by using the keyboard shortcut Ctrl+Shift+P
+
+::::::::::::::::::::::::::::::::::::::::::::::::::
+
+

03-working-with-MARC-files.md

@@ -0,0 +1,193 @@
+---
+title: Working with MARC files
+teaching: 20
+exercises: 1
+---
+
+::::::::::::::::::::::::::::::::::::::: objectives
+
+- Explain the difference between mrc and mrk MARC file formats
+- Successfully break and open a file of MARC records in the MarcEditor
+- Explain character encoding and its importance
+- Understand how to read a MARC record in the MarcEditor
+
+::::::::::::::::::::::::::::::::::::::::::::::::::
+
+:::::::::::::::::::::::::::::::::::::::: questions
+
+- What is a MARC binary file?
+- What does it mean to break and make a MARC file and how do I open a file of MARC records in MARCedit?
+- Why is encoding important?
+- How does the MarcEditor display MARC records?
+
+::::::::::::::::::::::::::::::::::::::::::::::::::
+## Working with MARC files
+:::::::::::::::::::::::::::::::::::::::::  callout
+## MARC file types
+MarcEdit recognizes the following MARC file types:
+
+<table>
+ <tr>
+  <td><strong>File type</strong>
+  </td>
+  <td><strong>File extension</strong>
+  </td>
+  <td><strong>Usage</strong>
+  </td>
+ </tr>
+ <tr>
+  <td>Binary MARC file
+  </td>
+  <td>mrc
+  </td>
+  <td>File format typically used in an  ILS or LSP. Other file extensions provided by vendors (ex. marc, dat, bin) are equivalent. Binary is format consisting of a series of sequential bytes, each of which is eight bits in length.
+  </td>
+ </tr>
+ <tr>
+  <td>Mnemonic MARC Text File
+  </td>
+  <td>mrk
+  </td>
+  <td>File format used by MarcEdit that is a human readable version of the binary file.
+  </td>
+ </tr>
+ <tr>
+  <td>MARC UTF-8 Text File
+  </td>
+  <td>mrk8
+  </td>
+  <td>Legacy file format for MARC mnemonic files saved with UTF8 encoding.
+  </td>
+ </tr>
+ <tr>
+  <td>MARCXML file
+  </td>
+  <td>xml
+  </td>
+  <td>A MARC file expressed in the eXtensible Markup format or a text-based format for representing structured information.
+  </td>
+ </tr>
+ </table>
+To work with a MARC file in the MARCEditor your file needs to be in MARC mnemonic format. If you only have a binary file, then that file needs to be converted to the mnemonic format.
+
+::::::::::::::::::::::::::::::::::::::::::::::::::
+
+### MARC Tools
+
+To work with MARC data files or convert between metadata formats for library bibliographic data recognized by MarcEdit, click on the MARC Tools icon that has the crossed hammer and spanner in the upper left hand corner of the main menu. The available features are:
+
+- MarcBreaker: This "breaks" the MARC binary file into a readable (mnemonic) format that can be edited in the MarcEditor.
+- MarcMaker: This takes the readable (mnemonic) format MARC data file and creates the MARC binary file.
+- MARC21 to MARC21XML: This converts a MARC21 file to MARC21XML.
+- MARC21XML to MARC21: This converts a MARC21XML file to a MARC21 binary file.
+- MARC to JSON: This converts a MARC21 file to a JSON file.
+- JSON to MARC: This converts a JSON file to a MARC21 file.
+- JSON to XML: This converts a JSON file to XML.
+- XML to JSON: This converts an XML file to JSON.
+
+The conversions from one encoding standard to another, as in MARC21 to MARC21XML, rely on eXtensible stylesheets. MarcEdit comes with several default stylesheets which come from those maintained by the Library of Congress. If you are familiar with stylesheets, you can also create your own.
+
+:::::::::::::::::::::::::::::::::::::::::  callout
+
+## Character Encoding
+
+To ensure the integrity of your data you need to select the correct character encoding for your dataset. MarcEdit does not automatically detect character encoding, however, UTF8 is set as the default encoding scheme. You can update the encoding scheme when using the MarcBreaker, or you can update the default in Preferences → MarEditor → Default Encoding. For more information on character encoding and translating from one encoding to another, see [The MarcEdit Field Guide](https://marcedit.reeset.net/learning_marcedit/9-2/dealing-with-character-encodings-in-marcedit/)
+
+
+::::::::::::::::::::::::::::::::::::::::::::::::::
+
+:::::::::::::::::::::::::::::::::::::::  checklist
+
+## Break a MARC Binary File
+
+To transform our binary MARC file (.mrc) into MARC mnemonic human readable format (.mrk), you use the MarcBreaker.
+
+##### Break a MARC (.mrc) file to use in the MarcEditor
+
+1. Launch MarcEdit and from the main window click on the MARC Tools Icon.
+2. In the MARC Tools window, Select Operation → MARCBreaker.
+3. In the field, Select Data to Process, click the file folder image to the right of the Open box to browse for the sample MARC data file (.mrc). Double click the found file to select it.
+4. Next, you will need save your file in the MARC mnemonic format (.mrk) by clicking the file folder to the right of the Save As box. Select the location and name you would like to give your new file.
+5. Under Character encoding select UTF8 as default character encoding.
+6. Click execute.
+7. Once you click execute the newly created .mrk file will be available to open in the MarcEditor. Under Results at the bottom of the window you will see a count of the records in your file. Click Edit Records to open the .mrk file in the MarcEditor.
+
+**Note:** When you break a .mrc file and create a new .mrk file for editing in the MarcEditor, you are making a copy of your data in a new file format. As a result, any edits you make to the .mrk file in the MarcEditor will not automatically be reflected in the original .mrc file. We will cover saving and compiling (using the MarcMaker) to create an updated .mrc file in an upcoming lesson.
+
+::::::::::::::::::::::::::::::::::::::::::::::::::
+
+## MARC Record layout in the MarcEditor
+You should now see the MARC records from the file displaying in the MarcEditor:
+
+![](fig/marc_sample_data.png){alt='MarcEditor screen with file open'}
+
+The MarcEditor displays the records in what is called the 'Mnemonic MARC Text File' format (file extension \*.mrk). Each line in the file represents a field in a MARC record:
+
+```
+=245  14$aThe Lord of the Rings /$c J.R.R. Tolkien.
+```
+
+This example breaks down as follows:
+
+<table>
+  <tr>   <td><code>=</code>   </td>   <td>Each line/field starts with the '=' sign.
+   </td>
+  </tr>
+  <tr>   <td><code>245</code>   </td>   <td>The '=' is followed immediately by the three character MARC field code.
+   </td>
+  </tr>
+  <tr>   <td><code>[two spaces]</code>   </td>   <td>The MARC field is always followed by two spaces.
+   </td>
+  </tr>
+  <tr>   <td><code>14</code>   </td>   <td>The field indicators follow the spaces if the field has indicators. When an indicator is not coded a <code>\\</code> is used. For the control or fixed fields where no indicators are used, the field content starts directly after the spaces.
+   </td>
+  </tr>
+  <tr>   <td><code>\$aThe Lord of the Rings /\$c J.R.R. Tolkien.</code>   </td>   <td>The field content contains the subfields (indicated using the <code>\$</code> symbol) and the text. Because the subfields use the <code>\$</code> symbol, any real occurrences of the dollar symbol (e.g. for currency) is shown as <code>[dollar]</code> instead. Unlike in some cataloguing applications, there are no spaces between subfield codes and the subfield text.
+   </td>
+  </tr>
+</table>
+
+Records in the MarcEditor display are separated by a blank line.
+
+:::::::::::::::::::::::::::::::::::::::::  callout
+
+## MARC syntax in the MarcEditor
+
+Understanding the layout of MARC data in the MarcEditor is key to using the program's tools successfully. For instance, in some tools it is important to specify a field's indicators directly preceeding the first subfield. Throughout this workshop we will highlight how different tools rely on this syntax to apply edits. 
+
+
+::::::::::::::::::::::::::::::::::::::::::::::::::
+
+The MarcEditor divides a file of MARC records into 'pages' of 100 records. You can scroll up and down the page of MARC records using the scroll bar as usual, but to see the next 100 records you need to use the Next/Previous page controls which are at the bottom left of the screen. The MarcEditor can handle very large files of MARC records, because it never tries to load all the records at the same time.
+
+## Setting MarcEditor Preferences
+
+You can adjust the number of records displayed per 'page' through the MarcEditor preferences which can be accessed through the Edit → Preferences menu option from the MarcEditor, or through the 'Settings' icon on the opening screen of MarcEdit.
+
+Within the MarcEditor preferences you can adjust the font and font size within the MarcEditor. You can also set your character encoding defaults. If you navigate to File Associations within the Preferences window, you can select Associate (`*.mrc`) files with the MarcBreaker and Associate (`*.mrk`) files with the MarcEditor. Setting these file associations will make it easy to break `.mrc` files and edit `.mrk` files.
+
+If you change your preferences for the MarcEditor, the tool used to work with MARC data, you can always go back to the default settings.
+
+:::::::::::::::::::::::::::::::::::::::  checklist
+
+## Reset settings for the MarcEditor in Preferences
+
+1. Click Edit → Preferences
+2. Select "MarcEditor" in the Preferences window in the left hand pane
+3. In the right hand pane, select Set Defaults for either font or font size
+4. Click Ok
+
+
+::::::::::::::::::::::::::::::::::::::::::::::::::
+
+:::::::::::::::::::::::::::::::::::::::: keypoints
+
+- MarcEdit can work with a variety of file formats
+- The MARC Tools Icon allow you to convert data from one file format to another
+- The MarcEditor works with a MarcEdit specific mnemonic format of MARC records (.mrk)
+- It is necessary to break a MARC binary file to work with that MARC data in the MarcEditor. The extension of these easily readable MARC files are .mrk rather than the binary extension of .mrc
+- Understanding the layout (syntax) of MARC records in the MarcEditor is key to working with the records.
+
+::::::::::::::::::::::::::::::::::::::::::::::::::
+
+