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

tutorials: fix incipit tutorial #645

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

musicEnfanthen
Copy link
Member

@musicEnfanthen musicEnfanthen commented May 20, 2024

This PR adds some improvements for the incipit tutorial, including those proposed in #263 by @mfeustle .

This includes :

  • simplifying the note example in step 4;
  • simplifying and improving readability of the xml:ids used in the final step;
  • improving the explanation of the attributes used in the final step;
  • improving the explanation of the referencing mechanism with xml:ids in the final step;
  • fixing a typo in the title of the incipit tutorial in the Spanish translation.

Fixes #263

@musicEnfanthen
Copy link
Member Author

@martha-thomae May I ask you to have a look at the updated Spanish translations?

@musicEnfanthen musicEnfanthen requested a review from kepper May 21, 2024 07:27
@musicEnfanthen musicEnfanthen changed the title fix(tutorials): fix incipit tutorial tutorials: fix incipit tutorial Jul 21, 2024
@rettinghaus
Copy link
Member

@martha-thomae Could you have a look please?

@musicEnfanthen musicEnfanthen requested review from davidrizo and martha-thomae and removed request for martha-thomae September 27, 2024 14:37
@bwbohl
Copy link
Member

bwbohl commented Jan 8, 2025

pinging reviewers

@martha-thomae
Copy link
Contributor

Thanks, Benni, Klaus, and Stefan, I will look at this during this week to get it done :)

Copy link
Contributor

@martha-thomae martha-thomae left a comment

Choose a reason for hiding this comment

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

A few minor corrections for the writing in Spanish. And one extra paragraph that was missing in the Spanish translation of the English version. Thanks for all your work, @musicEnfanthen!

One small question (@musicEnfanthen, @rettinghaus, @bwbohl), do you remember how could I check from my own fork a branch of another person? Like this branch from Stefan, how can I see it on my fork to be able to run the website and see the changes locally? and also be able to actually make commits here? Thank you!


<p>Para indicar el punto inicial y el punto final de la ligadura, es posible aplicar una referencia al correspondiente <code>@xml:id</code> de un elemento <code>&lt;note&gt;</code> o <code>&lt;chord&gt;</code>. Los <code>@xml:id</code>s son identificadores con una secuencia de caracteres arbitraria pero única que regulariza la denominación de un elemento a lo largo de un documento y facilita así la construcción de enlaces entre elementos y otros recursos. En el caso de <code>&lt;slur&gt;</code>, la referencia al <code>@xml:id</code> de un elemento puede darse a través de los atributos <code>@startid</code> y <code>@endid</code>.</p>
<p>Para indicar el punto inicial y el punto final de la ligadura, se pueden usar los atributos <code>@startid</code> y <code>@endid</code>.
Para hacerlo, los valores de los atributos <code>@startid</code> y <code>@endid</code> deben referenciar un atributo llamado <code>@xml:id</code> de los elementos reales donde comienza y termina el ligado.
Copy link
Contributor

Choose a reason for hiding this comment

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

Change this: "deben referenciar un atributo llamado <code>@xml:id</code> de los elementos reales donde comienza y termina el ligado."

For this: "deben referenciar el valor del atributo llamado <code>@xml:id</code> de los elementos donde comienza y termina la ligadura."

The bold is just used to indicate the changes.

@@ -7,17 +7,36 @@
<li>Un elemento separado <code>&lt;slur&gt;</code>.</li>
</ol>

<p>En este último paso, se utilizará el segundo enfoque: Al igual que las dinámicas, los elementos <code>&lt;slur&gt;</code> son eventos de control. No se codifican como elementos hijos de los eventos correspondientes que deben controlar, sino que se colocan en la mayoría de los casos fuera de los elementos <code>staff</code>.</p>
<p>En este último paso, se utilizará el segundo enfoque: Al igual que las dinámicas, los elementos <code>&lt;slur&gt;</code> son <i>eventos de control</i>. No se codifican como elementos hijos de los eventos correspondientes que deben controlar, sino que se colocan en la mayoría de los casos fuera de los elementos <code>staff</code>.
Para permitir un control preciso sobre la colocación del ligado en relación con el pentagrama musical, se puede usar el atributo <code>@staff</code>. Este atributo identifica el número del pentagrama al que se aplica el elemento <code>&lt;slur&gt;</code>.</p>
Copy link
Contributor

Choose a reason for hiding this comment

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

Change this: "Para permitir un control preciso sobre la colocación del ligado en relación con el pentagrama musical,"

For this: "Para permitir un control preciso sobre la colocación de la ligadura en relación con el pentagrama,"

@@ -7,17 +7,36 @@
<li>Un elemento separado <code>&lt;slur&gt;</code>.</li>
</ol>

<p>En este último paso, se utilizará el segundo enfoque: Al igual que las dinámicas, los elementos <code>&lt;slur&gt;</code> son eventos de control. No se codifican como elementos hijos de los eventos correspondientes que deben controlar, sino que se colocan en la mayoría de los casos fuera de los elementos <code>staff</code>.</p>
<p>En este último paso, se utilizará el segundo enfoque: Al igual que las dinámicas, los elementos <code>&lt;slur&gt;</code> son <i>eventos de control</i>. No se codifican como elementos hijos de los eventos correspondientes que deben controlar, sino que se colocan en la mayoría de los casos fuera de los elementos <code>staff</code>.
Copy link
Contributor

Choose a reason for hiding this comment

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

Change this: "Al igual que las dinámicas, los elementos <code>&lt;slur&gt;</code> son..."

For this: "Al igual que las dinámicas, los elementos <code>&lt;slur&gt;</code> (ligaduras) son..."

This will clarify what these elements are representing in Spanish.


<p>Junto con <code>@startid</code> y <code>@endid</code>, se deben utilizar los siguientes atributos en este paso:</p>
<p>Debido a que los ligaduras pueden estar curvados en diferentes direcciones, el atributo <code>@curvedir</code> describe una curva con un término genérico que indica la dirección de la curvatura del ligado: <code>“above”</code>, <code>“below”</code> o <code>“mixed”</code>.</p>
Copy link
Contributor

Choose a reason for hiding this comment

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

Change to: "<p>Debido a que las ligaduras pueden estar curvadas en diferentes direcciones, el atributo <code>@curvedir</code> describe una curva con un término genérico que indica la dirección de la curvatura de la ligadura..."

</ul>

<p class="tutorialTask">Identifica la primera y la última nota a la que se une la ligadura (dentro del primer elemento <code>&lt;beam&gt;</code> del compás 3) y añade <code>@xml:id</code>s a ambos elementos <code>&lt;note&gt;</code>. Establece un valor único para cada <code>@xml:id</code>, para este ejemplo puedes utilizar los valores: <code>“d1e4614”</code>, <code>“d1e4615”</code>. Añade un elemento de control <code>&lt;slur&gt;</code> después de la etiqueta de cierre del elemento <code>&lt;staff&gt;</code> y aplica los atributos correspondientes.</p>
<p class="tutorialTask">Identifica la primera y la última nota a la que se une la ligadura (dentro del primer elemento <code>&lt;beam&gt;</code> del compás 3) y añade <code>@xml:id</code>s a ambos elementos <code>&lt;note&gt;</code>.
Copy link
Contributor

Choose a reason for hiding this comment

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

"a la que se une la" --> "que forman parte de la"

</ul>

<p class="tutorialTask">Identifica la primera y la última nota a la que se une la ligadura (dentro del primer elemento <code>&lt;beam&gt;</code> del compás 3) y añade <code>@xml:id</code>s a ambos elementos <code>&lt;note&gt;</code>. Establece un valor único para cada <code>@xml:id</code>, para este ejemplo puedes utilizar los valores: <code>“d1e4614”</code>, <code>“d1e4615”</code>. Añade un elemento de control <code>&lt;slur&gt;</code> después de la etiqueta de cierre del elemento <code>&lt;staff&gt;</code> y aplica los atributos correspondientes.</p>
<p class="tutorialTask">Identifica la primera y la última nota a la que se une la ligadura (dentro del primer elemento <code>&lt;beam&gt;</code> del compás 3) y añade <code>@xml:id</code>s a ambos elementos <code>&lt;note&gt;</code>.
Estos deben ser valores únicos para cada <code>@xml:id</code>, por lo que para este ejemplo usamos los valores: <code>"d4567"</code> para el <code>xml:id</code> de la nota inicial y <code>"d4568"</code> para el <code>xml:id</code> de la nota final del ligado.
Copy link
Contributor

Choose a reason for hiding this comment

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

de la nota finaldel ligado.

Para hacerlo, los valores de los atributos <code>@startid</code> y <code>@endid</code> deben referenciar un atributo llamado <code>@xml:id</code> de los elementos reales donde comienza y termina el ligado.
Los <code>@xml:id</code> son identificadores con una secuencia de caracteres arbitraria pero única que regularizan la denominación de un elemento a lo largo de un documento
y así facilitan la creación de enlaces entre elementos y otros recursos. Este es un mecanismo de referencia común en XML: aplicar un <code>@xml:id</code> a un elemento y referenciarlo desde otro elemento.</p>

Copy link
Contributor

Choose a reason for hiding this comment

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

The text corresponding to this English text seems to be missing:

<p>For <code>&lt;slur&gt;</code>s, the <code>@startid</code> attribute contains a reference to
the <code>@xml:id</code> of the element where the slur begins, and the <code>@endid</code> attribute
contains a reference to the <code>@xml:id</code> of the element where the slur ends.</p>

This would be:

<p>En el caso de una ligadura <code>&lt;slur&gt;</code>, el atributo <code>@startid</code> hace referencia al <code>@xml:id</code> del elemento donde la ligadura inicia y el atributo <code>@endid</code> hace referencia al <code>@xml:id</code> del elemento donde la ligadura termina.</p>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Technical issues
Development

Successfully merging this pull request may close these issues.

Tutorials: Suggestions on advanced/incipits tutorial
4 participants