Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

guidelines: add captions to verovio and listings for chapter 1–3 #1635

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from

Conversation

krHERO
Copy link
Contributor

@krHERO krHERO commented Feb 13, 2025

this PR adds missing captions to all listings for chapter 1–3

Refs #1217

@github-actions github-actions bot added the Component: Guidelines & Documentation changes to source: docs, examples or web (assigned automatically) label Feb 13, 2025
@krHERO krHERO changed the title Ftr/1217 add caption to verovio and listings Ftr/1217 add caption to verovio and listings for chapter 1–3 Feb 13, 2025
@musicEnfanthen musicEnfanthen changed the title Ftr/1217 add caption to verovio and listings for chapter 1–3 guidelines: add captions to verovio and listings for chapter 1–3 Feb 13, 2025
@musicEnfanthen musicEnfanthen added this to the MEI 6 milestone Feb 13, 2025
Copy link
Member

@rettinghaus rettinghaus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the great work. I noticed that some captions end with a full stop, others don't. It's a quite common practice to have none there (see https://www.stylemanual.gov.au/content-types/images/alt-text-captions-and-titles-images).

@krHERO
Copy link
Contributor Author

krHERO commented Feb 24, 2025

https://www.stylemanual.gov.au/content-types/images/alt-text-captions-and-titles-images

thanks for pointing to this. I also was wondering what might be the "most correct" way how to do this and found some discussions stating, a full stop should be added when it is a full sentence and not to add one when it is just a word or some single words but no complete sentence. i tried to do this in this kind of way.

since duden says "Auch Bildunterschriften werden nicht mit Punkt versehen, vor allem wenn es sich nicht um vollständige Sätze handelt. Bestehen Bildunterschriften allerdings aus mehreren Sätzen, wird im Allgemeinen der Punkt gesetzt." and i am absolutely not attached to this full stop, despite there is more than one sentence, i can easily update the commit by deleting all of them.

would that be a suggestion that makes most of us happy?

this commit deletes full stops. full stops are only provided, if the caption contains more than one sentence.

Refs music-encoding#1635
@krHERO
Copy link
Contributor Author

krHERO commented Feb 27, 2025

i did an update regarding full stop. i am happy to get two reviews

@musicEnfanthen
Copy link
Member

@rettinghaus Is this good to go?

rettinghaus
rettinghaus previously approved these changes Feb 27, 2025
<egXML xmlns="http://www.tei-c.org/ns/Examples" rend="code" xml:space="preserve"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../examples/header/header-sample089.txt" parse="text"/></egXML>
</figure>
</p>
<p>A slightly more structured form would be:</p>
<p>
<figure>
<head/>
<head><gi scheme="MEI">addDesc</gi> with a little bit more structure</head>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<head><gi scheme="MEI">addDesc</gi> with a little bit more structure</head>
<head>Example of <gi scheme="MEI">addDesc</gi> with a little bit more structure</head>

<egXML xmlns="http://www.tei-c.org/ns/Examples" rend="code" xml:space="preserve"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../examples/header/header-sample090.txt" parse="text"/></egXML>
</figure>
</p>
<p>These transcriptions – as in the musical text – can also be marked by means of <gi scheme="MEI">add</gi>, <gi scheme="MEI">del</gi>, (see module MEI.edittrans) etc. (see <ptr target="#editTrans"/>) and assigned to a specific scribe by <att>hand</att> (see <gi scheme="MEI">handList</gi>):</p>
<p>
<figure>
<head/>
<head><gi scheme="MEI">addDesc</gi> with <gi scheme="MEI">add</gi> and <att>hand</att> attribute</head>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<head><gi scheme="MEI">addDesc</gi> with <gi scheme="MEI">add</gi> and <att>hand</att> attribute</head>
<head>Example of <gi scheme="MEI">addDesc</gi> with <gi scheme="MEI">add</gi> and <att>hand</att> attribute</head>

@@ -1844,7 +1844,7 @@
<p>The following example demonstrates how to structure detailed information about a repository (including the use of <gi scheme="MEI">identifier</gi>):</p>
<p>
<figure>
<head/>
<head><gi scheme="MEI">repository</gi></head>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<head><gi scheme="MEI">repository</gi></head>
<head>Example of <gi scheme="MEI">repository</gi></head>

@@ -1891,7 +1891,7 @@
<p>The <gi scheme="MEI">extMeta</gi> element may be contained by <gi scheme="MEI">expression</gi>, <gi scheme="MEI">item</gi>, <gi scheme="MEI">manifestation</gi>, <gi scheme="MEI">work</gi> and <gi scheme="MEI">meiHead</gi> elements. It may include text and any number of well-formed XML fragments, XML comments, and CDATA sections, except for MEI markup, which is prohibited. The document element of each fragment must explicitly declare its namespace.</p>
<p>
<figure>
<head/>
<head><gi scheme="MEI">extMeta</gi></head>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<head><gi scheme="MEI">extMeta</gi></head>
<head>Example of <gi scheme="MEI">extMeta</gi></head>

@@ -1945,7 +1945,7 @@
<p>The <gi scheme="MEI">meiCorpus</gi> element is intended for the encoding of corpora, though it may also be useful in encoding any collection of disparate materials. The individual samples in the corpus are encoded as separate <gi scheme="MEI">mei</gi> elements, and the entire corpus is enclosed in an <gi scheme="MEI">meiCorpus</gi> element. Each sample has the usual structure for a <gi scheme="MEI">mei</gi> document, comprising an <gi scheme="MEI">meiHead</gi> followed by a <gi scheme="MEI">music</gi> element. The corpus, too, has a corpus-level <gi scheme="MEI">meiHead</gi> element, in which the corpus as a whole, and encoding practices common to multiple samples may be described. The overall structure of an MEI-conformant corpus is thus:</p>
<p>
<figure>
<head/>
<head><gi scheme="MEI">meiCorpus</gi></head>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<head><gi scheme="MEI">meiCorpus</gi></head>
<head>Example of <gi scheme="MEI">meiCorpus</gi></head>

Co-authored-by: Stefan Münnich <stefan.muennich@unibas.ch>
@krHERO
Copy link
Contributor Author

krHERO commented Feb 28, 2025

thanks for your reviews, i accepted all suggestions and i am happy if you merge this PR :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Guidelines & Documentation changes to source: docs, examples or web (assigned automatically)
Projects
Status: 👀 Ready for review
Development

Successfully merging this pull request may close these issues.

4 participants