Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Commit

Permalink
help page edits
Browse files Browse the repository at this point in the history
  • Loading branch information
@gregjan
gregjan committed Aug 30, 2012
1 parent 6d0b370 commit ca2bcf6
Show file tree
Hide file tree
Showing 6 changed files with 210 additions and 163 deletions.
16 changes: 11 additions & 5 deletions workbench_help/html/concepts/project_export.html
View file
Expand Up @@ -3,10 +3,10 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Export</title>
<title>Export and Import</title>
</head>
<body>
<h1>Export</h1>
<h1>Export and Import of Projects and Files</h1>
<p>Once arrangement and description has been completed to your
satisfaction, you may wish to export the project manifest. You may
wish to export for submission into a repository. Alternately, you may
Expand All @@ -17,9 +17,15 @@ <h1>Export</h1>
export format is a METS XML file, with MODS elements included from a
crosswalk or other user-added description.</p>
<p>Other forms of export are also available from the Export Menu. These
include export of the project's Arrangement to a CSV file and export
of the entire project to another location or a ZIP archive.</p>
<p>New forms of project export are possible to support work flow
include:
<ul>
<li>Export Arrangement to CSV file</li>
<li>Export (and Import) of project to ZIP archive</li>
<li>Export of Arrangement to BagIt ZIP Package</li>
<li>Export (and Import) of Crosswalks, Dictionaries, Forms and other individual project files</li>
</ul>
</p>
<p>Additional project exports are possible to support work flow
needs. Share your needs on GitHub or via the users forum.</p>
</body>
</html>
2 changes: 1 addition & 1 deletion workbench_help/tocconcepts.xml
View file
Expand Up @@ -14,7 +14,7 @@
</topic>
<topic href="html/concepts/arrangement.html" label="Arrangement">
</topic>
<topic href="html/concepts/project_export.html" label="Export">
<topic href="html/concepts/project_export.html" label="Export and Import">
</topic>
<topic href="html/concepts/crosswalks.html" label="Metadata Crosswalks">
</topic>
Expand Down
15 changes: 14 additions & 1 deletion workbench_plugin/intro/githubReleases.xml
View file
Expand Up @@ -14,13 +14,26 @@
style-id="group-description"
>These links takes you to lists of the issues resolved in each release, on GitHub. You can always see what features
are under development on the project GitHub site.</text>
<link
label="Issues Closed in Release 4"
url="https://github.com/UNC-Libraries/Curators-Workbench/issues?&amp;state=closed&amp;milestone=5"
id="github-milestone"
style-id="content-link"
>
<text>This is the current release and comes with many features requested by users. Several features will assist users in a team
environment, such as many project import/export options and more reusable metadata mapping in crosswalks and via
data dictionaries. Support for removable drives was expanded and we added support for alphabetized folders. There
is also now an image preview for originals or items in the arrangement. A new feature added for CDR work flow is
design of ad hoc deposit forms. A visual editor lets users build deposit forms, mapping input fields to MODS records.
These forms can be deployed to a form-hosting service and used to make repository deposits via SWORD.</text>
</link>
<link
label="Issues Closed in Release 3"
url="https://github.com/UNC-Libraries/Curators-Workbench/issues?&amp;state=closed&amp;milestone=4"
id="github-milestone"
style-id="content-link"
>
<text>This is the current release. It adds support for pre-staged originals and addressed some usability concerns
<text>This release added support for pre-staged originals and addressed some usability concerns
raised by production use. You can also now use the context menu to "open a temporary copy" of any original or
arranged item in your system's default editor.</text>
</link>
Expand Down
268 changes: 144 additions & 124 deletions workbench_plugin/intro/overview.xml
View file
@@ -1,149 +1,169 @@
<?xml version="1.0" encoding="UTF-8"?>
<introContent>
<extensionContent
id="overview-workbench-id"
name="Workbench Overview"
path="overview/@"
>
<group
label="Overview"
id="overview-workbench-group"
style-id="content-group"
>
<text
style-id="group-description"
>The Curator’s Workbench is a collection preparation and work flow tool for digital materials. It is designed to
acquire and process file structures efficiently while giving archivists and other curators control over their work.
The workbench can assist with accession, arrangement, description and staging of digital objects and is commonly
used to prepare batch submissions to a repository. The workbench provides information and controls to help you
select and arrange. It handles routine accessioning tasks for you, such as staging files, generating checksums and
building a manifest file. The main workbench window is divided into three parts. The Project Navigator area is on
the left side of the workbench. It displays all the projects in your workspace and their contents. Each project is
divided into three sections, which are Originals, the Arrangement and Crosswalks.</text>
<extensionContent id="overview-workbench-id" name="Workbench Overview"
path="overview/@">
<group label="Overview" id="overview-workbench-group" style-id="content-group">
<text style-id="group-description">The Curator’s Workbench is a
collection preparation and work flow tool for digital materials. It
is designed to
acquire and process file structures efficiently while
giving archivists and other curators control over their work.
The
workbench can assist with accession, arrangement, description and
staging of digital objects and is commonly
used to prepare batch
submissions to a repository. The workbench provides information and
controls to help you
select and arrange. It handles routine
accessioning tasks for you, such as staging files, generating
checksums and
building a manifest file. The main workbench window is
divided into three parts. The Project Navigator area is on
the left
side of the workbench. It displays all the projects in your
workspace and their contents. Each project is
divided into three
sections, which are Originals, the Arrangement and Crosswalks.
</text>
</group>
</extensionContent>
<extensionContent
id="standards-workbench"
name="Standards"
path="overview/@"
>
<group
label="Design &amp; Standards"
id="standards-group"
style-id="content-group"
>
<link
style-id="content-link"
label="Metadata Encoding and Transmission Standard (METS)"
url="http://www.loc.gov/standards/mets/"
id="java"
>
<text>Each project in the workbench has a corresponding METS XML document within the project folder. This METS
document is the manifest in which the workbench records all the information about captured materials and
descriptive records. You will not normally need to edit this file, but you may find it interesting to view.</text>
<extensionContent id="standards-workbench" name="Standards"
path="overview/@">
<group label="Design &amp; Standards" id="standards-group"
style-id="content-group">
<link style-id="content-link"
label="Metadata Encoding and Transmission Standard (METS)" url="http://www.loc.gov/standards/mets/"
id="java">
<text>Each project in the workbench has a corresponding METS XML
document within the project folder. This METS
document is the
manifest in which the workbench records all the information about
captured materials and
descriptive records. You will not normally
need to edit this file, but you may find it interesting to view.
</text>
</link>
<link
style-id="content-link"
label="Metadata Object Description Schema (MODS)"
url="http://www.loc.gov/standards/mods/"
id="java"
>
<text>The workbench supports schema-driven editing of MODS records for all captured objects. It also includes a
unique crosswalk feature that can help you migrate tabular metadata to MODS records and match these records with
captured files or folders.</text>
<link style-id="content-link" label="Metadata Object Description Schema (MODS)"
url="http://www.loc.gov/standards/mods/" id="java">
<text>The workbench supports schema-driven editing of MODS records
for all captured objects. It also includes a
unique crosswalk
feature that can help you migrate tabular metadata to MODS records
and match these records with
captured files or folders.
</text>
</link>
<link
style-id="content-link"
label="Extending the Workbench"
url="https://github.com/UNC-Libraries/Curators-Workbench"
id="java"
>
<text>The workbench was originally created to facilitate repository ingest at UNC Chapel Hill and was designed with
that repository in mind. Others will have different systems in mind and different metadata needs. If you have
questions about extending the software, please get in touch with us. The workbench itself is an extension of the
Eclipse software platform and was designed with future extensions in mind.</text>
<link style-id="content-link" label="Extending the Workbench"
url="https://github.com/UNC-Libraries/Curators-Workbench" id="java">
<text>The workbench was originally created to facilitate repository
ingest at UNC Chapel Hill and was designed with
that repository in
mind. Others will have different systems in mind and different
metadata needs. If you have
questions about extending the software,
please get in touch with us. The workbench itself is an extension
of the
Eclipse software platform and was designed with future
extensions in mind.
</text>
</link>
</group>
</extensionContent>
<extensionContent
id="concepts-workbench"
name="Concepts"
path="overview/@"
>
<group
label="Concepts"
id="concepts-group"
style-id="content-group"
>
<link
style-id="content-link"
label="Projects"
<extensionContent id="concepts-workbench" name="Concepts"
path="overview/@">
<group label="Concepts" id="concepts-group" style-id="content-group">
<link style-id="content-link" label="Projects"
url="http://org.eclipse.ui.intro/showHelpTopic?id=/workbench_help/html/concepts/projects.html"
id="java"
>
<text>Materials in the workbench are divided into projects within a work space. You may choose to use one or many
projects to capture a collection. Each project is represented in a METS manifest file that contains an arrangement
of the captured material. While you may work on many projects at once, inactive may be closed to improve workbench
performance.</text>
id="java">
<text>Materials in the workbench are divided into projects within a
work space. You may choose to use one or many
projects to capture a
collection. Each project is represented in a METS manifest file
that contains an arrangement
of the captured material. While you may
work on many projects at once, inactive may be closed to improve
workbench
performance.
</text>
</link>
<link
style-id="content-link"
label="Originals"
<link style-id="content-link" label="Originals"
url="http://org.eclipse.ui.intro/showHelpTopic?id=/workbench_help/html/concepts/originals.html"
id="java"
>
<text>Originals are the incoming source of data. This is data that the workbench will allow you to inspect and
capture. The workbench will not provide any means to delete or alter originals.</text>
id="java">
<text>Originals are the incoming source of data. This is data that
the workbench will allow you to inspect and
capture. The workbench
will not provide any means to delete or alter originals.
</text>
</link>
<link
style-id="content-link"
label="Capture"
<link style-id="content-link" label="Capture"
url="http://org.eclipse.ui.intro/showHelpTopic?id=/workbench_help/html/concepts/capture.html"
id="java"
>
<text>Capture makes an original part of your manifest, including it in the arrangement and recording the original
location of the file or folder.</text>
id="java">
<text>Capture makes an original part of your manifest, including it
in the arrangement and recording the original
location of the file
or folder.
</text>
</link>
<link
style-id="content-link"
label="Staging"
<link style-id="content-link" label="Staging"
url="http://org.eclipse.ui.intro/showHelpTopic?id=/workbench_help/html/concepts/staging.html"
id="java"
>
<text>When you capture a file, the workbench can copy it to a staging location. Checksums are calculated before and
after each file is copied and are verified. The checksum and staged location are added to the workbench manifest.
You may also specify a pre-staged location for a set of originals. When pre-staged files are captured, the staged
location for the manifest is inferred and the file is checksummed, but not copied.</text>
id="java">
<text>When you capture a file, the workbench can copy it to a
staging location. Checksums are calculated before and
after each
file is copied and are verified. The checksum and staged location
are added to the workbench manifest.
You may also specify a
pre-staged location for a set of originals. When pre-staged files
are captured, the staged
location for the manifest is inferred and
the file is checksummed, but not copied.
</text>
</link>
<link
style-id="content-link"
label="Arrangement"
<link style-id="content-link" label="Arrangement"
url="http://org.eclipse.ui.intro/showHelpTopic?id=/workbench_help/html/concepts/arrangement.html"
id="java"
>
<text>An arrangement is the logical hierarchy within which captured folders and files are organized and described.
When files are first captured their arrangement reflects the original file system. You may choose to modify the
arrangement to organize materials differently.</text>
id="java">
<text>An arrangement is the logical hierarchy within which captured
folders and files are organized and described.
When files are first
captured their arrangement reflects the original file system. You
may choose to modify the
arrangement to organize materials
differently.
</text>
</link>
<link
style-id="content-link"
label="Metadata Crosswalks"
<link style-id="content-link" label="Metadata Crosswalks"
url="http://org.eclipse.ui.intro/showHelpTopic?id=/workbench_help/html/concepts/crosswalks.html"
id="java"
>
<text>A crosswalk allows you to define custom mappings between tabular metadata records (such as spreadsheets) and
descriptive records. Crosswalk mappings are created through a schema-driven visual editor. Crosswalked records are
regenerated each time the crosswalk mappings are saved.</text>
id="java">
<text>A crosswalk allows you to define custom mappings between
tabular metadata records (such as spreadsheets) and
descriptive
records. Crosswalk mappings are created through a schema-driven
visual editor. Crosswalked records are
regenerated each time the
crosswalk mappings are saved.
</text>
</link>
<link style-id="content-link" label="Metadata Dictionaries"
url="http://org.eclipse.ui.intro/showHelpTopic?id=/workbench_help/html/concepts/dictionaries.html"
id="java">
<text>Dictionaries allows users and groups to share and reuse
standard
MODS patterns without having to build complex crosswalks for each
project. Dictionaries include labels and descriptive text to guide
their use. They can be stored on network drives and shared by
teams.
</text>
</link>
<link
style-id="content-link"
label="Project Export"
<link style-id="content-link" label="Project Export"
url="http://org.eclipse.ui.intro/showHelpTopic?id=/workbench_help/html/concepts/project_export.html"
id="java"
>
<text>When you are satisfied with the arrangement and description of your materials, you may want to export the
project. Export will save the project manifest into another format, usually a submission format for a repository.
Currently the workbench supports one export format, which is for submission to the Carolina Digital Repository.
id="java">
<text>When you are satisfied with the arrangement and description of
your materials, you may want to export the
project. Export will save
the project manifest into another format, usually a submission
format for a repository.
Currently the workbench supports one export
format, which is for submission to the Carolina Digital Repository.
</text>
</link>
</group>
Expand Down
9 changes: 1 addition & 8 deletions workbench_plugin/intro/webresources.xml
View file
Expand Up @@ -13,13 +13,6 @@
<text
style-id="group-description"
>These are links to more resources related to the Curator's Workbench.</text>
<link
label="Basic User's Guide (PDF)"
url="http://www.lib.unc.edu/software/workbench/basic_user_guide.pdf"
style-id="content-link"
>
<text>This document covers the core concepts and tasks.</text>
</link>
<link
label="Users Group on Google Groups™"
url="http://groups.google.com/group/curators-workbench-users"
Expand Down Expand Up @@ -65,7 +58,7 @@
>Other links related to the Curator's Workbench.</text>
<link
label="Curator's Workbench GitHub™ Project"
url="http://cdr.lib.unc.edu/"
url="https://github.com/UNC-Libraries/Curators-Workbench"
style-id="content-link"
>
<text>The GitHub software project site, including code, upcoming milestones and issue tracking.</text>
Expand Down

0 comments on commit ca2bcf6

Please sign in to comment.