Skip to content

Commit

Permalink
apply minor fixes to documentation pages
Browse files Browse the repository at this point in the history
  • Loading branch information
Peter Provaznik committed Jan 17, 2024
1 parent f374ff9 commit b55bb55
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 18 deletions.
8 changes: 4 additions & 4 deletions manual/basics.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,17 @@
<h2><a name="basics" id="basics">MerMEId
basics</a></h2>
<p>MerMEId (Metadata Editor and Repository for MEI data) is a
tool for editing, (pre-)viewing and handling of music metadata based on
<a href="http://www.music-encoding.org" target="_blank" title="Music Encoding Initiative">MEI</a>. </p>
tool for editing, (pre-)viewing and handling <a href="http://www.music-encoding.org" target="_blank" title="Music Encoding Initiative">MEI</a> metadata.</p>
<p>The user interface has three main components: the MEI file browser,
the metadata editing tool, and the HTML preview. </p>
<h3><a name="File" id="File">Document list</a></h3>
<p>The usual way to start working with MerMEId would be to open
the document list, usually located at <a href="../modules/list_files.xq" target="_blank"
the document list, usually located at <a href="../index.html" target="_blank"
title="Go to the document list on this server">http://[your hostname
here]/modules/list_files.xq</a>. You should then see a list
here]/index.html</a>. You should then see a list
of existing documents in your collection (if any):</p>
<p><img alt="" src="../resources/images/manual/list_files.png" class="illustration"/></p>
<p>Please note that you need to <strong>Login</strong> ("mermeid" // "mermeid" are the demo credentials) at the top right corner of the page to be able to edit documents or make changes of any kind.</p>
<p><strong>Creating a new document: </strong>To create a new document, click the add
button <img alt="New file" src="../resources/images/new.gif" height="16" width="16"/> located in the upper right corner.
This will open a new document in the metadata editor.</p>
Expand Down
12 changes: 6 additions & 6 deletions manual/document_structure.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ <h2>The structure of the work: Work, versions, and movements</h2>
version is created. </p>
<p>See also the tutorial: <a href="../manual/tutorial_versions.html"
title="Tutorial: Works having multiple versions">Works having multiple
version</a></p>
versions</a></p>
<p><span class="heading">Movements:</span> The movements of a work are encoded as
components of a version. They are defined at the bottom of each 'version' block at
the <span class="music tab">Music</span> tab. MerMEId calls them 'components' rather
Expand Down Expand Up @@ -141,10 +141,10 @@ <h2>Organizing source material: Sources and items</h2>
particular edition and therefore should be entered at source level.</p>
<p>The distinction between sources and items may seem particularly confusing when
describing manuscript sources which obviously are unique. However, the same encoding
pratice should be applied to manuscripts and prints to ensure the same
practice should be applied to manuscripts and prints to ensure the same
functionality; thinking of manuscripts as printed sources with only one surviving
copy may be helpful when deciding where to enter what information.</p>
<p>To minimize redundancy no information given at source level should be repeated at
<p>To minimize redundancy, no information given at source level should be repeated at
item level. As a rule of thumb, we recommend putting information at the highest
possible level. For instance, the title page of a manuscript should be cited at
source level rather than at item level. The description of other features like paper
Expand All @@ -158,7 +158,7 @@ <h2>Organizing source material: Sources and items</h2>
versions they embody (see also the tutorial: <a
href="../manual/tutorial_versions.html"
title="Tutorial: Works having multiple versions">Works having multiple
version</a>). </p>
versions</a>). </p>
<h3>Source components</h3>
<p>Both sources and items can have components to be described indivdually. For example,
a set of orchestral parts can be defined as a source with some shared features (such
Expand Down Expand Up @@ -194,7 +194,7 @@ <h3>Source components</h3>
either work or version level. See also the tutorial: <a
href="../manual/tutorial_versions.html"
title="Tutorial: Works having multiple versions">Works having multiple
version</a></p>
versions</a></p>
<h2>Bibliographic references</h2>
<p>The <span class="bibliography tab">Bibliography</span> tab allows the user to add a
list of other material related to the musical work but not regarded as sources to
Expand All @@ -209,7 +209,7 @@ <h2><a name="tech_adm_metadata">Technical and administrative metadata</a></h2>
<p>These metadata include information about the persons, institutions, and software
involved in the creation of the file. Also a project description and a note aboout
use restrictions - such as copyright or license information - may be given. </p>
<p>Technical/adminsitrative metadata are edited at the <span class="file tab"
<p>Technical/administrative metadata are edited at the <span class="file tab"
>File</span> tab.</p>
<p>File metadata also include the name of the 'file collection' (usually the short name
of the catalogue or project) which MerMEId uses to organize files into different
Expand Down
14 changes: 6 additions & 8 deletions manual/workflow.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ <h1>Recommended workflow</h1>
<p>This page described a workflow intended to make working with MerMEId as efficient as possible.</p>

<p>MerMEId is designed for editing and storing metadata in MEI files; usually each file describes one musical work.
The list shown when <a href="../modules/list_files.xq" title="MerMEId file list">entering
The list shown when <a href="../index.html" title="MerMEId file list">entering
MerMEId</a> is basically a list of the MEI files stored in the database at any time.</p>
<p>Assuming that you want to create a number of files all belonging to the same project or catalogue,
we recommend the following workflow for creating the files and entering the data.</p>
Expand Down Expand Up @@ -95,7 +95,7 @@ <h2>Starting a new file from template</h2>
</ul>
<h2>Content editing</h2>
<ul>
<li>Add any data you want to the file (see <a href="../manual/">tutorials and other help pages</a>
<li>Add any data you want to the file (see <a href="../manual/index.html">tutorials and other help pages</a>
on how to use the editor and how to enter certain types of information).</li>
<li>To verify or proofread your data, use the HTML preview by clicking the document button <img alt="HTML preview"
src="../resources/images/html.gif" /> to generate a human-readable HTML page from the file.</li>
Expand All @@ -106,12 +106,10 @@ <h2>Creating a printed catalogue</h2>
potentially very large, HTML document.</p>
<p>The use of the tool is explained in the manual's section on <a title="Displaying multiple records"
href="../manual/merge.html">Displaying or printing multiple (or all) records</a>.</p>
<p>By default, MerMEId will output the almost the same way as in the HTML preview only improved for printing
(by unfolding all hidden sections, for instance), but you can specify another XSL transformation to customize the
results for your needs. </p>
<p>The remaining steps to prepare a print catalogue are up to you. For the <a title="Printed CNW" target="_blank"
href="https://www.mtp.dk/langset.asp?sitelan=e&amp;url=https://www.mtp.dk/details.asp?eln=203742">printed
catalogue of Carl Nielsen's works</a>,
<p>By default, the output will be almost the same as in the HTML preview, but improved for printing
(by unfolding all hidden sections, for example), but you can specify another XSL transformation to customize the
results for your needs.</p>
<p>The remaining steps to prepare a print catalogue are up to you. For the printed catalogue of Carl Nielsen's works,
we chose a quick but dirty approach: we simply copied the resulting HTML into a Word document which was imported
into InDesign for the final layout. A more elegant way would be to write a transformation from MEI to
<a href="https://www.latex-project.org/" title="LaTeX" target="_blank">LaTeX</a>, for instance.</p>
Expand Down

0 comments on commit b55bb55

Please sign in to comment.