Skip to content

Commit

Permalink
Merge pull request #197 from Edirom/doc-fixes
Browse files Browse the repository at this point in the history
Minor fixes and additions in manual pages; updated footers for manual pages (part of #181)
  • Loading branch information
peterstadler committed Jan 18, 2024
2 parents f374ff9 + 3abe135 commit 02ed0ea
Show file tree
Hide file tree
Showing 17 changed files with 95 additions and 103 deletions.
10 changes: 4 additions & 6 deletions manual/attribute_editor.html
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,9 @@ <h2>Using the attribute editor</h2>
not available for all elements in use. To access all elements and their attributes, use
other tools like a generic XML or text editor.</p>
</div>

<p class="footer"><a href="http://www.kb.dk" title="DCM"><img
style="border: 0px; vertical-align:middle;" alt="DCM Logo"
src="../resources/images/dcm_logo_small_white.png" /></a> 2017 Danish Centre for Music Editing |
Royal Danish Library, Copenhagen | <a name="www.kb.dk" id="www.kb.dk"
href="http://www.kb.dk">www.kb.dk</a></p>
<div class="footer">
<div>2010-2019 Danish Centre for Music Editing | Royal Danish Library, Copenhagen | <a name="https://www.kb.dk/" id="www.kb.dk" href="http://www.kb.dk" title="Det Kgl. Bibliotek">www.kb.dk</a></div>
<div>2020 ff. <a href="https://github.com/Edirom/MerMEId/graphs/contributors" title="See contributors to MerMEId GitHub project"> MerMEId Community</a></div>
</div>
</body>
</html>
16 changes: 8 additions & 8 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 Expand Up @@ -180,9 +180,9 @@ <h3><a name="HTML" id="HTML">HTML Preview</a></h3>
<p>At the bottom of the page, in grey, metadata about the file
are displayed (i.e. the colophon).</p>
</div>
<p class="footer"><a href="http://www.kb.dk" title="DCM"><img style="border: 0px; vertical-align:middle;"
alt="DCM Logo" src="../resources/images/dcm_logo_small_white.png"/></a>
2017 Danish Centre for Music Editing | Royal Danish Library,
Copenhagen | <a name="www.kb.dk" id="www.kb.dk" href="http://www.kb.dk">www.kb.dk/en/nb/dcm</a></p>
<div class="footer">
<div>2010-2019 Danish Centre for Music Editing | Royal Danish Library, Copenhagen | <a name="https://www.kb.dk/" id="www.kb.dk" href="http://www.kb.dk" title="Det Kgl. Bibliotek">www.kb.dk</a></div>
<div>2020 ff. <a href="https://github.com/Edirom/MerMEId/graphs/contributors" title="See contributors to MerMEId GitHub project"> MerMEId Community</a></div>
</div>
</body>
</html>
11 changes: 5 additions & 6 deletions manual/batch_transform.html
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,9 @@ <h2>Batch transforming XML files in the database</h2>
result page will list the files changed and those that were unaffected by the
transformation.</p>
</div>
<p class="footer"><a href="http://www.kb.dk" title="DCM"><img
style="border: 0px; vertical-align:middle;" alt="DCM Logo"
src="../resources/images/dcm_logo_small_white.png" /></a> 2017 Danish Centre for Music
Editing | Royal Danish Library, Copenhagen | <a name="www.kb.dk" id="www.kb.dk"
href="http://www.kb.dk">www.kb.dk/en/nb/dcm</a></p>
</body>
<div class="footer">
<div>2010-2019 Danish Centre for Music Editing | Royal Danish Library, Copenhagen | <a name="https://www.kb.dk/" id="www.kb.dk" href="http://www.kb.dk" title="Det Kgl. Bibliotek">www.kb.dk</a></div>
<div>2020 ff. <a href="https://github.com/Edirom/MerMEId/graphs/contributors" title="See contributors to MerMEId GitHub project"> MerMEId Community</a></div>
</div>
</body>
</html>
11 changes: 5 additions & 6 deletions manual/code_inspector.html
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,9 @@ <h2>Using the code inspector</h2>
formatting into HTML markup on loading – and vice versa on saving.</li>
</ul>
</div>
<p class="footer"><a href="http://www.kb.dk" title="DCM"><img
style="border: 0px; vertical-align:middle;" alt="DCM Logo"
src="../resources/images/dcm_logo_small_white.png" /></a> 2017 Danish Centre for Music
Editing | Royal Danish Library, Copenhagen | <a name="www.kb.dk" id="www.kb.dk"
href="http://www.kb.dk">www.kb.dk/en/nb/dcm</a></p>
</body>
<div class="footer">
<div>2010-2019 Danish Centre for Music Editing | Royal Danish Library, Copenhagen | <a name="https://www.kb.dk/" id="www.kb.dk" href="http://www.kb.dk" title="Det Kgl. Bibliotek">www.kb.dk</a></div>
<div>2020 ff. <a href="https://github.com/Edirom/MerMEId/graphs/contributors" title="See contributors to MerMEId GitHub project"> MerMEId Community</a></div>
</div>
</body>
</html>
9 changes: 4 additions & 5 deletions manual/dates.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,9 @@ <h2>Entering dates</h2>
changing the original date. When the date editor closes, the machine-readable part will be
displayed on the main form in square brackets.</p>
</div>
<p class="footer"><a href="http://www.kb.dk" title="DCM"><img
style="border: 0px; vertical-align:middle;" alt="DCM Logo"
src="../resources/images/dcm_logo_small_white.png" /></a> 2017 Danish Centre for Music Editing |
Royal Danish Library, Copenhagen | <a name="www.kb.dk" id="www.kb.dk"
href="http://www.kb.dk">www.kb.dk/en/nb/dcm</a></p>
<div class="footer">
<div>2010-2019 Danish Centre for Music Editing | Royal Danish Library, Copenhagen | <a name="https://www.kb.dk/" id="www.kb.dk" href="http://www.kb.dk" title="Det Kgl. Bibliotek">www.kb.dk</a></div>
<div>2020 ff. <a href="https://github.com/Edirom/MerMEId/graphs/contributors" title="See contributors to MerMEId GitHub project"> MerMEId Community</a></div>
</div>
</body>
</html>
23 changes: 11 additions & 12 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,16 +209,15 @@ <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
catalogues/projects.</p>
</div>
<p class="footer"><a href="http://www.kb.dk" title="DCM"><img
style="border: 0px; vertical-align:middle;" alt="DCM Logo"
src="../resources/images/dcm_logo_small_white.png" /></a> 2017 Danish Centre for Music
Editing | Royal Danish Library, Copenhagen | <a name="www.kb.dk" id="www.kb.dk"
href="http://www.kb.dk">www.kb.dk/en/nb/dcm</a></p>
</body>
<div class="footer">
<div>2010-2019 Danish Centre for Music Editing | Royal Danish Library, Copenhagen | <a name="https://www.kb.dk/" id="www.kb.dk" href="http://www.kb.dk" title="Det Kgl. Bibliotek">www.kb.dk</a></div>
<div>2020 ff. <a href="https://github.com/Edirom/MerMEId/graphs/contributors" title="See contributors to MerMEId GitHub project"> MerMEId Community</a></div>
</div>
</body>
</html>
9 changes: 4 additions & 5 deletions manual/faq.html
Original file line number Diff line number Diff line change
Expand Up @@ -391,10 +391,9 @@ <h3>How do I get in touch with you if I have other questions?<a name="contact"><
target="_blank">web site</a>.</p>
</div>

<p class="footer"><a href="http://www.kb.dk" title="DCM"><img
style="border: 0px; vertical-align:middle;" alt="DCM Logo"
src="../resources/images/dcm_logo_small_white.png" /></a> 2017 Danish Centre for Music Editing |
Royal Danish Library, Copenhagen | <a name="www.kb.dk" id="www.kb.dk"
href="http://www.kb.dk">www.kb.dk/en/nb/dcm</a></p>
<div class="footer">
<div>2010-2019 Danish Centre for Music Editing | Royal Danish Library, Copenhagen | <a name="https://www.kb.dk/" id="www.kb.dk" href="http://www.kb.dk" title="Det Kgl. Bibliotek">www.kb.dk</a></div>
<div>2020 ff. <a href="https://github.com/Edirom/MerMEId/graphs/contributors" title="See contributors to MerMEId GitHub project"> MerMEId Community</a></div>
</div>
</body>
</html>
9 changes: 4 additions & 5 deletions manual/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,9 @@ <h3>Technical documentation</h3>
</ul>
</div>

<p class="footer"><a href="http://www.kb.dk" title="DCM"><img
style="border: 0px; vertical-align:middle;" alt="DCM Logo"
src="../resources/images/dcm_logo_small_white.png" /></a> 2017 Danish Centre for Music Editing |
Royal Danish Library, Copenhagen | <a name="www.kb.dk" id="www.kb.dk"
href="http://www.kb.dk">www.kb.dk/en/nb/dcm</a></p>
<div class="footer">
<div>2010-2019 Danish Centre for Music Editing | Royal Danish Library, Copenhagen | <a name="https://www.kb.dk/" id="www.kb.dk" href="http://www.kb.dk" title="Det Kgl. Bibliotek">www.kb.dk</a></div>
<div>2020 ff. <a href="https://github.com/Edirom/MerMEId/graphs/contributors" title="See contributors to MerMEId GitHub project"> MerMEId Community</a></div>
</div>
</body>
</html>
11 changes: 5 additions & 6 deletions manual/index_tools.html
Original file line number Diff line number Diff line change
Expand Up @@ -104,10 +104,9 @@ <h2>Tools for generating indexes</h2>
<h3>Generating drop-down lists for online catalogues</h3>
<p>[To be added]</p>-->
</div>
<p class="footer"><a href="http://www.kb.dk" title="DCM"><img
style="border: 0px; vertical-align:middle;" alt="DCM Logo"
src="../resources/images/dcm_logo_small_white.png" /></a> 2017 Danish Centre for Music
Editing | Royal Danish Library, Copenhagen | <a name="www.kb.dk" id="www.kb.dk"
href="http://www.kb.dk">www.kb.dk/en/nb/dcm</a></p>
</body>
<div class="footer">
<div>2010-2019 Danish Centre for Music Editing | Royal Danish Library, Copenhagen | <a name="https://www.kb.dk/" id="www.kb.dk" href="http://www.kb.dk" title="Det Kgl. Bibliotek">www.kb.dk</a></div>
<div>2020 ff. <a href="https://github.com/Edirom/MerMEId/graphs/contributors" title="See contributors to MerMEId GitHub project"> MerMEId Community</a></div>
</div>
</body>
</html>
11 changes: 5 additions & 6 deletions manual/merge.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,9 @@ <h2>Displaying or printing multiple (or all) records</h2>
(http://[your-server]/storage/style/) is referring to the collection /db/mermeid/style/ in your eXist database,
but your style sheet may also be located outside of the database or on some other server</p>
</div>
<p class="footer"><a href="http://www.kb.dk" title="DCM"><img
style="border: 0px; vertical-align:middle;" alt="DCM Logo"
src="../resources/images/dcm_logo_small_white.png" /></a> 2017 Danish Centre for Music
Editing | Royal Danish Library, Copenhagen | <a name="www.kb.dk" id="www.kb.dk"
href="http://www.kb.dk">www.kb.dk/en/nb/dcm</a></p>
</body>
<div class="footer">
<div>2010-2019 Danish Centre for Music Editing | Royal Danish Library, Copenhagen | <a name="https://www.kb.dk/" id="www.kb.dk" href="http://www.kb.dk" title="Det Kgl. Bibliotek">www.kb.dk</a></div>
<div>2020 ff. <a href="https://github.com/Edirom/MerMEId/graphs/contributors" title="See contributors to MerMEId GitHub project"> MerMEId Community</a></div>
</div>
</body>
</html>
9 changes: 4 additions & 5 deletions manual/special_characters.html
Original file line number Diff line number Diff line change
Expand Up @@ -342,10 +342,9 @@ <h4>Runes</h4>
</tbody>
</table>
</div>
<p class="footer"><a href="http://www.kb.dk" title="DCM"><img
style="border: 0px; vertical-align:middle;" alt="DCM Logo"
src="../resources/images/dcm_logo_small_white.png" /></a> 2017 Danish Centre for Music Editing |
Royal Danish Library, Copenhagen | <a name="www.kb.dk" id="www.kb.dk"
href="http://www.kb.dk">www.kb.dk/en/nb/dcm</a></p>
<div class="footer">
<div>2010-2019 Danish Centre for Music Editing | Royal Danish Library, Copenhagen | <a name="https://www.kb.dk/" id="www.kb.dk" href="http://www.kb.dk" title="Det Kgl. Bibliotek">www.kb.dk</a></div>
<div>2020 ff. <a href="https://github.com/Edirom/MerMEId/graphs/contributors" title="See contributors to MerMEId GitHub project"> MerMEId Community</a></div>
</div>
</body>
</html>
7 changes: 4 additions & 3 deletions manual/tutorial_anthology.html
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,9 @@ <h2>Working with relations: Creating a music anthology</h2>
<p><img src="../resources/images/manual/anthology_html.png" alt="work-to-work relations"
class="illustration" /></p>
</div>
<p class="footer"><a href="http://www.kb.dk" title="DCM"><img style="border: 0px; vertical-align:middle;" alt="DCM Logo" src="../resources/images/dcm_logo_small_white.png"/></a>
2017 Danish Centre for Music Editing | Royal Danish Library,
Copenhagen | <a name="www.kb.dk" id="www.kb.dk" href="http://www.kb.dk">www.kb.dk/en/nb/dcm</a></p>
<div class="footer">
<div>2010-2019 Danish Centre for Music Editing | Royal Danish Library, Copenhagen | <a name="https://www.kb.dk/" id="www.kb.dk" href="http://www.kb.dk" title="Det Kgl. Bibliotek">www.kb.dk</a></div>
<div>2020 ff. <a href="https://github.com/Edirom/MerMEId/graphs/contributors" title="See contributors to MerMEId GitHub project"> MerMEId Community</a></div>
</div>
</body>
</html>
9 changes: 5 additions & 4 deletions manual/tutorial_bibliography.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,9 @@ <h2>Using standard bibliographies</h2>
the reference.</li>
</ul>
</div>
<p class="footer"><a href="http://www.kb.dk" title="DCM"><img style="border: 0px; vertical-align:middle;" alt="DCM Logo" src="../resources/images/dcm_logo_small_white.png"/></a>
2017 Danish Centre for Music Editing | Royal Danish Library,
Copenhagen | <a name="www.kb.dk" id="www.kb.dk" href="http://www.kb.dk">www.kb.dk/en/nb/dcm</a></p>
</body>
<div class="footer">
<div>2010-2019 Danish Centre for Music Editing | Royal Danish Library, Copenhagen | <a name="https://www.kb.dk/" id="www.kb.dk" href="http://www.kb.dk" title="Det Kgl. Bibliotek">www.kb.dk</a></div>
<div>2020 ff. <a href="https://github.com/Edirom/MerMEId/graphs/contributors" title="See contributors to MerMEId GitHub project"> MerMEId Community</a></div>
</div>
</body>
</html>
10 changes: 6 additions & 4 deletions manual/tutorial_external_sources.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,9 @@ <h3>Copying source descriptions from another file</h3>
from the source adding menu. This places an independent copy of the external source description in your
current file, which can be freely edited.</p>
</div>
<p class="footer"><a href="http://www.kb.dk" title="DCM"><img style="border: 0px; vertical-align:middle;" alt="DCM Logo" src="../resources/images/dcm_logo_small_white.png"/></a>
2017 Danish Centre for Music Editing | Royal Danish Library,
Copenhagen | <a name="www.kb.dk" id="www.kb.dk" href="http://www.kb.dk">www.kb.dk/en/nb/dcm</a></p>
</body></html>
<div class="footer">
<div>2010-2019 Danish Centre for Music Editing | Royal Danish Library, Copenhagen | <a name="https://www.kb.dk/" id="www.kb.dk" href="http://www.kb.dk" title="Det Kgl. Bibliotek">www.kb.dk</a></div>
<div>2020 ff. <a href="https://github.com/Edirom/MerMEId/graphs/contributors" title="See contributors to MerMEId GitHub project"> MerMEId Community</a></div>
</div>
</body>
</html>
Loading

0 comments on commit 02ed0ea

Please sign in to comment.