Skip to content

Commit

Permalink
Merge pull request #15 from edrlab/contents
Browse files Browse the repository at this point in the history
Contents
  • Loading branch information
gautierchomel authored Dec 3, 2024
2 parents 6dd255e + f91bde5 commit 774dfe7
Show file tree
Hide file tree
Showing 6 changed files with 97 additions and 55 deletions.
11 changes: 3 additions & 8 deletions content/english/rules/034.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ N: '123'
Rubrique: Internationalisation
title: The international dialing code is available for all telephone numbers
detail: The international dialing code is available for all telephone numbers
abstract: The digital book, whatever its language of writing, is an object that can be consulted, downloaded and shared from any point on the globe. It therefore goes without saying that all telephone numbers mentioned there must bear their international codes, so that contact is established without fail (particularly in the case of travel guides, directories, international manuals, professional books , or more generally contact information included in the body of the digital book).
abstract: "The digital book, whatever its language of writing, is an object that can be consulted, downloaded and shared from any point on the globe. It therefore goes without saying that all telephone numbers mentioned there must bear their international codes, so that contact is established without fail (particularly in the case of travel guides, directories, international manuals, professional books , or more generally contact information included in the body of the digital book)."
categories: ["Internationalisation"]
agrege: O4123-E034
opquast: '4 123'
Expand All @@ -17,13 +17,8 @@ layout: rules
date: 2024-12-03
tags: ["Contact"]
objectif: ["Allow immediate use of telephone contact regardless of user context"]
Meo: ["Start each phone number with the two-digit country code preceded by a plus symbol, for example '+33' for France. Replace the zero, which may appear as the first digit, with the country code.
Present the telephone number as a series of pairs of numbers separated by a non-breaking space, where the first pair, corresponding to the country code, begins with a plus symbol, and the second pair contains only a figure, to harmonize the rest. For example, '+33 1 00 00 00 00'.
"]
Controle: ["For each phone number:
<ul><li>Check that the two-digit country code appears first, preceded by a plus symbol, for example '+33' for France.</li>
<li>Check that the zero, which may appear as the first digit, is replaced by the country code.</li>
<li>Check that in its overall form it is a sequence of pairs of numbers separated by a non-breaking space, where the first pair, corresponding to the country code, begins with a plus symbol, and the second pair contains only one digit. For example, '+33 1 00 00 00 00'</li></ul>."]
Meo: ["Start each phone number with the two-digit country code preceded by a plus symbol, for example &#34;+33&#34; for France. Replace the zero, which may appear as the first digit, with the country code. Present the telephone number as a series of pairs of numbers separated by a non-breaking space, where the first pair, corresponding to the country code, begins with a plus symbol, and the second pair contains only a figure, to harmonize the rest. For example, &#34;+33 1 00 00 00 00&#34;."]
Controle: ["For each phone number: <ul><li>Check that the two-digit country code appears first, preceded by a plus symbol, for example &#34;+33&#34; for France.</li> <li>Check that the zero, which may appear as the first digit, is replaced by the country code.</li> <li>Check that in its overall form it is a sequence of pairs of numbers separated by a non-breaking space, where the first pair, corresponding to the country code, begins with a plus symbol, and the second pair contains only one digit. For example, &#34;+33 1 00 00 00 00&#34;</li></ul>."]
epubcheck: false
ace: false
humancheck: true
Expand Down
37 changes: 26 additions & 11 deletions content/english/rules/036.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,41 @@
---
N: '125'
Rubrique: Internationalisation
title: The source code of each Content Document indicates the primary language of the content.
abstract:
title: The source code of each Content Document indicates the primary language of the content.
detail:
abstract: The Content Document read by speech synthesis tools does not automatically adapt to the language of these documents, which cannot be identified by these tools which analyze the pages. This information must therefore be provided in the source code of the Content Document in question.
categories: [" Internationalisation"]
agrege: O4125-E036
opquast: '4 125'
indiceebook: '36'
description: "Rule n° 036"
description: "Règle n° 036"
before: "035"
weight: "036"
after: "037"
actif: '1'
layout: rules
date: 2024-09-18
tags: ["", ""]
objectif: ["", ""]
Meo: [""]
Controle: [""
]
epubcheck:
ace:
date: 2024-12-03
tags: ["Langue", "Accessibilité"]
objectif: ["Allow correct reading of the content by a speech synthesis tool.", "
Facilitate automatic translation.", "
Promote the indexing of content according to their language."]
Meo:
["
The lang attribute must be added to the root </code>html</code> element of the Content Document to indicate the primary language of the text. The language code must conform to the language subtag registry maintained by the Internet Assigned Numbers Authority (<a href=&#34;http://www.iana.org/assignments/language-subtag-registry&#34;>IANA< /a>). In practice, for French, this gives: <code>html lang=&#34;fr&#34;</code> (in HTML) and <code>html lang=&#34;fr&#34; xml:lang=&#34;fr&#34;</code> (in XHTML).
If the language varies within a book (for example, English text in a French chapter), you can also use the <code>lang</code> attribute (and <code>xml: lang</code> for XHTML) on specific elements of the document to indicate a language change within a section. This can be done on tags like <code>p</code>, <code>div</code>, or even <code>span</code>, to indicate a passage in a different language:
<code><p lang=&#34;en&#34;>This text is in English.</p></code>
<code><p lang=&#34;fr&#34;>This text is in French.</p></code>
If the primary language of the document changes in different parts of the content, you can set the lang attribute (or xml:lang for XHTML) at multiple parent elements, like <code>head</code>, <code>body< /code>, <code>title</code>, etc., to indicate the dominant language in the sections in question."]
Controle: ["
* Check that the root element <code>html</code> of the Content Document has the lang attribute, for example <code>html lang=&#34;fr&#34;</code> (in HTML) and <code>html lang =&#34;fr&#34; xml:lang=&#34;fr&#34;</code> (in XHTML), to indicate the main language of the document.

* Verify that the xml:lang attribute is also present in XHTML documents to ensure compatibility with older systems and tools requiring this additional specification.
* Verify that all multilingual content uses the lang attribute on relevant elements, such as `p`, `div`, or `span`, to indicate language changes within the document.

* Check that the languages ​​of metadata and content in sections like `head`, `title`, and `body` are specified with the lang attribute to ensure consistency of linguistic information.
* Verify that the language code used in the lang attribute meets the standards established by the IANA registry of language subtags, and matches the language of the content. Please note that the codes mul for “multiple languages” and und for “undetermined language” should not be used. Finally, the xml:lang attribute can also be entered in addition to the lang attribute, but it is not sufficient to comply with this good practice."]
epubcheck: true
ace: false
humancheck: true
Source: ["Opquast"]
Referentiel: [""]
Expand Down
28 changes: 18 additions & 10 deletions content/english/rules/037.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,34 @@
---
N: '126'
Rubrique: Internationalisation
title: The primary language of the target content of a link is identifiable when it differs from that of the original content.
abstract:
title: The main language of the target page of a link is identifiable when it differs from that of the original page.
detail: The main language of the target page of a link is identifiable when it differs from that of the original page.
abstract: Arriving by surprise on a section in the dialect of the Ñoldor Elves when you don't speak their language is never very pleasant. In an e-book, it is important to provide clear information so the reader knows what to expect when they click on a link, whether internal or external. Identifying the language of the target section or content in advance helps avoid surprises and improves the reading experience. Specifying the language of the sections in the links helps to limit unnecessary or frustrating clicks for readers.
categories: [" Internationalisation"]
agrege: O4126-E037
opquast: '4 126'
indiceebook: '37'
description: "Rule n° 037"
description: "Règle n° 037"
before: "036"
weight: "037"
after: "038"
actif: '1'
layout: rules
date: 2024-09-18
tags: ["", ""]
objectif: ["", ""]
Meo: [""]
Controle: [""
date: 2024-12-03
tags: ["Langue", "Accessibility"]
objectif: ["Allow readers and reading tools, particularly text-to-speech tools, to anticipate a language change when navigating a digital book.", "
Prevent readers from accessing a section or content whose language they do not understand, by clearly indicating the target language in advance."]
Meo: ["The target language of a link can be indicated in several ways:

*Via the wording of the link, written in the target language, which allows the reader to anticipate the language change
*Optionally using an appropriate icon, such as a symbol or visual indicator (such as a flag), although the use of icons is less common in digital books and may depend on the context of publication page.
*Possibly explicitly in the wording of the link or in its immediate context, by clearly mentioning the target language directly in the text or information around the link."]
Controle: ["
*Manually identify links whose target section or document content is not written in the same language as the current section.
*Check, for each of these links, that the reader is immediately informed of the language of the target content, either through the wording of the link (written in the target language), or by an appropriate visual indicator, or by an explicit indication in the context of the link."
]
epubcheck:
ace:
epubcheck: false
ace: false
humancheck: true
Source: ["Opquast"]
Referentiel: [""]
Expand Down
40 changes: 29 additions & 11 deletions content/french/rules/036.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
N: '125'
Rubrique: Internationalisation
title: Le code source de chaque Document de Contenu (Content Document) indique la langue principale du contenu.
detail: Le code source de chaque page indique la langue principale du contenu.
abstract:
title: Le code source de chaque Document de Contenu (Content Document) indique la langue principale du contenu.
detail:
abstract: Le Document de Contenu (Content Document) lu par les outils de synthèse vocale ne s'adapte pas automatiquement à la langue de ces documents, non-identifiable par ces outils qui analysent les pages. Cette information doit donc être fournie dans le code source du Document de Contenu en question.
categories: [" Internationalisation"]
agrege: O4125-E036
opquast: '4 125'
Expand All @@ -14,14 +14,32 @@ weight: "036"
after: "037"
actif: '1'
layout: rules
date: 2023-09-28
tags: ["", ""]
objectif: ["", ""]
Meo: [""]
Controle: [""
]
epubcheck:
ace:
date: 2024-12-03
tags: ["Langue", "Accessibilité"]
objectif: ["Permettre une lecture correcte du contenu par un outil de synthèse vocale.", "
Faciliter la traduction automatique.", "
Favoriser l'indexation des contenus selon leur langue."]
Meo:
["L'attribut lang doit être ajouté à l'élément racine </code>html</code> du Document de Contenu pour indiquer la langue principale du texte. Le code de langue doit être conforme au registre des sous-tags de langue géré par l'Internet Assigned Numbers Authority (<a href=&#34;http://www.iana.org/assignments/language-subtag-registry&#34;>IANA</a>). En pratique, pour le français, cela donne : <code>html lang=&#34;fr&#34;</code> (en HTML) et <code>html lang=&#34;fr&#34; xml:lang=&#34;fr&#34;</code> (en XHTML).


Si la langue varie à l'intérieur d'un livre (par exemple, un texte en anglais dans un chapitre rédigé en français), vous pouvez également utiliser l'attribut <code>lang</code> (et <code>xml:lang</code> pour XHTML) sur des éléments spécifiques du document pour indiquer un changement de langue au sein d'une section. Cela peut être fait sur des balises comme <code>p</code>, <code>div</code>, ou même <code>span</code>, pour signaler un passage en une langue différente :
<code>&#60;p lang=&#34;en&#34;>This text is in English.&#60;/p></code>
<code>&#60;p lang=&#34;fr&#34;>Ce texte est en français.&#60;/p></code>
Si la langue principale du document change dans différentes parties du contenu, vous pouvez définir l'attribut lang (ou xml:lang pour XHTML) au niveau de plusieurs éléments parentaux, comme <code>head</code>, <code>body</code>, <code>title</code>, etc., pour indiquer la langue dominante dans les sections en question."]
Controle: ["

* Vérifier que l'élément racine <code>html</code> du Document de Contenu porte l'attribut lang, par exemple <code>html lang=&#34;fr&#34;</code> (en HTML) et <code>html lang=&#34;fr&#34; xml:lang=&#34;fr&#34;</code> (en XHTML), pour indiquer la langue principale du document.

* Vérifier que l'attribut xml:lang est également présent dans les documents XHTML afin de garantir la compatibilité avec les systèmes plus anciens et les outils nécessitant cette spécification supplémentaire.

* Vérifier que tout contenu multilingue utilise l'attribut lang sur les éléments pertinents, tels que `p`, `div`, ou `span`, pour indiquer les changements de langue à l'intérieur du document.

* Vérifier que les langues des métadonnées et du contenu dans les sections comme `head`, `title`, et `body` sont bien spécifiées avec l'attribut lang pour garantir une cohérence de l'information linguistique.

* Vérifier que le code de langue utilisé dans l'attribut lang respecte les normes établies par le registre IANA des sous-tags de langue, et correspond à la langue du contenu. Il est à noter que les codes mul pour « langues multiples » et und pour « langue indéterminée » ne doivent pas être utilisés. Enfin, l'attribut xml:lang peut être également renseigné en complément de l'attribut lang, mais il n'est pas suffisant pour rendre conforme cette bonne pratique."]
epubcheck: true
ace: false
humancheck: true
Source: ["Opquast"]
Referentiel: [""]
Expand Down
28 changes: 17 additions & 11 deletions content/french/rules/037.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
N: '126'
Rubrique: Internationalisation
title: La langue principale de la page cible d'un lien est identifiable lorsqu'elle
diffère de celle de la page d'origine.
detail: La langue principale du contenu cible d'un lien est identifiable lorsqu'elle diffère de celle du contenu d'origine.
abstract:
title: La langue principale de la page cible d'un lien est identifiable lorsqu'elle diffère de celle de la page d'origine.
detail: La langue principale de la page cible d'un lien est identifiable lorsqu'elle diffère de celle de la page d'origine.
abstract: Arriver par surprise sur une section en dialecte des Elfes Ñoldor lorsqu’on ne parle pas leur langue n’est jamais très agréable. Dans un livre numérique, il est important de fournir des informations claires pour que le lecteur sache à quoi s'attendre lorsqu'il clique sur un lien, qu'il soit interne ou externe. Identifier à l'avance la langue de la section ou du contenu cible permet d'éviter des surprises et d'améliorer l'expérience de lecture. Préciser la langue des sections dans les liens aide ainsi à limiter les clics inutiles ou frustrants pour les lecteurs.
categories: [" Internationalisation"]
agrege: O4126-E037
opquast: '4 126'
Expand All @@ -15,14 +14,21 @@ weight: "037"
after: "038"
actif: '1'
layout: rules
date: 2023-09-28
tags: ["", ""]
objectif: ["", ""]
Meo: [""]
Controle: [""
date: 2024-12-03
tags: ["Langue", "Accessibilité"]
objectif: ["Permettre aux lecteurs et aux outils de lecture, notamment les outils de synthèse vocale, d'anticiper un changement de langue lors de la navigation dans un livre numérique.", "
Éviter que les lecteurs accèdent à une section ou un contenu dont ils ne comprennent pas la langue, en indiquant clairement la langue cible à l'avance."]
Meo: ["La langue cible d'un lien peut être indiquée de plusieurs manières :

* Via le libellé du lien, rédigé dans la langue cible, ce qui permet au lecteur d'anticiper le changement de langue
* Éventuellement à l'aide d'une icône appropriée, telle qu'un symbole ou un indicateur visuel (comme un drapeau), bien que l'usage d'icônes soit moins courant dans les livres numériques et puisse dépendre du contexte de mise en page.
* Éventuellement de manière explicite dans le libellé du lien ou dans son contexte immédiat, en mentionnant clairement la langue cible directement dans le texte ou les informations autour du lien."]
Controle: ["
* Identifier manuellement les liens dont le contenu de la section ou du document cible n'est pas rédigé dans la même langue que celle de la section actuelle.
* Vérifier, pour chacun de ces liens, que le lecteur est immédiatement informé de la langue du contenu cible, soit à travers le libellé du lien (rédigé dans la langue cible), soit par un indicateur visuel approprié, soit par une indication explicite dans le contexte du lien."
]
epubcheck:
ace:
epubcheck: false
ace: false
humancheck: true
Source: ["Opquast"]
Referentiel: [""]
Expand Down
8 changes: 4 additions & 4 deletions layouts/rules/single.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,11 @@ <h2>{{ i18n "meo" }}</h2>
<ul>
{{ $meo:= .Params.meo }}
{{ range $i,$p:= $meo }}
<li class="">


{{ . | safeHTML }}
{{ . | markdownify }}

</li>

{{ end }}
</ul>
<h2>{{ i18n "control" }}</h2>
Expand All @@ -64,7 +64,7 @@ <h2>{{ i18n "control" }}</h2>
{{ range $i,$p:= $controle }}
<li class="inline-block">

{{ . | safeHTML }}
{{ . | markdownify }}

</li>
{{ end }}
Expand Down

0 comments on commit 774dfe7

Please sign in to comment.