Skip to content

Commit

Permalink
Merge pull request #8 from edrlab/contents
Browse files Browse the repository at this point in the history
Contents
  • Loading branch information
gautierchomel authored Sep 18, 2024
2 parents 6b59199 + 0f0a2a9 commit c4542dc
Show file tree
Hide file tree
Showing 183 changed files with 708 additions and 407 deletions.
8 changes: 7 additions & 1 deletion content/english/about/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,13 @@ draft: false
layout: about
---

*Work in progress*
Qualebook public presentations:
* <span lang="fr">Assises du livre numérique (France): [QUALINUM la liste de référence qualité du livre numérique, Youtube](https://youtu.be/zg6C0cuDUqE?list=PLY0BtmO03yYGQ8sQ7fwSw7IVaymmtp4Pm&t=2413)</span>
* Digital Publishing Summit 2024: [Quality of ebooks, Video of the presentation on the EDRLab website](https://www.edrlab.org/events/digital-publishing-summit-2024/#1708288836982-85ce3f99-0b0f)



*Qualebook, is a Work in progress*

Digital publishing has developed appropriate industrialization and standardization processes, such as the EPUB format, but is not immune to external injunctions linked to legal provisions and societal issues.

Expand Down
2 changes: 2 additions & 0 deletions content/english/rules/001.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ date: 2024-02-23
objectif: ["Inform users of the conditions under which content is published", "Inform users of the conditions for copying and reuse"]
Meo: ["Indicate the rights to copy and reuse the various elements of the book on one or more dedicated pages identified as such (copyrights page and credits page)."]
Controle: ["Verify the presence of complete mention of copy and reuse rights on one or more dedicated pages accessible via the table of contents or via one or more landmarks"]
epubcheck:
ace:
Source: ["Opquast"]
Referentiel: [""]
Steps: ["Design", "Editorial"]
Expand Down
2 changes: 2 additions & 0 deletions content/english/rules/002.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ Controle: ["In the source code of each page examined
<li>Check the presence of the tag <code>&lt;meta name=&#34;description&#34; content=&#34;&#34; /&gt;</code> or an equivalent using, for example, browser development tools.</li>
<li>Check that the text of this tag actually describes, in a specific or more generic way, the content of the page.</li>
</ul>"]
epubcheck:
ace:
Source: ["Opquast"]
Referentiel: [""]
Steps: ["Editorial", "Development"]
Expand Down
2 changes: 2 additions & 0 deletions content/english/rules/003.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ objectif: [
Meo: ["Make sure the month is written in full (“December”) or abbreviated (“Dec”), but not in numerical format.",
"Indicate the 4 digits of the year. This requirement should be provided for in content management systems where dating is automated."]
Controle: ["Identify the pages containing dates, and for each of the dates found: Check that the month is not indicated in a numerical format, but in letters (complete or abbreviated). Check that the year is indicated in four digits and not two. The dates to be entered by the end user in the forms are not affected by this good practice: their format, whatever it may be, is considered sufficiently explicit, as long as the entry is made via a datepicker or manually but with an indication of the expected format (like DD/MM/YY)."]
epubcheck:
ace:
Source: ["Opquast"]
Referentiel: [""]
Steps: ["Conception", "Editorial"]
Expand Down
2 changes: 2 additions & 0 deletions content/english/rules/004.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ its meaning immediately indicated in the context, for example in parentheses,
a link on the acronym giving access to its meaning, for example in a glossary,
or the abbr element with a title attribute explaining its meaning.
"]
epubcheck:
ace:
Source: ["Opquast"]
Referentiel: [""]
Steps: ["Development", "Conception", "Editorial"]
Expand Down
2 changes: 2 additions & 0 deletions content/english/rules/005.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ objectif: [
Meo: ["Associate each content that requires it (article, news, product, etc.) with its displayed publication date."]
Controle: ["Check that the content that requires it is all associated with a displayed publication date."
]
epubcheck:
ace:
Source: ["Opquast"]
Referentiel: [""]
Steps: ["Conception"]
Expand Down
2 changes: 2 additions & 0 deletions content/english/rules/006.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ Controle: ["For each page containing specific vocabulary, check that it is possi
Or directly to the definition of terms from at least their first occurrence on each page of the site via a link or a tooltip.
"
]
epubcheck:
ace:
Source: ["Opquast"]
Referentiel: [""]
Steps: ["Contents", "Editorial"]
Expand Down
2 changes: 2 additions & 0 deletions content/english/rules/007.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ Controle: ["Within the book reviewed:
</ul>
"
]
epubcheck:
ace:
Source: ["Opquast"]
Referentiel: [""]
Steps: ["Conception", "Editorial"]
Expand Down
2 changes: 2 additions & 0 deletions content/english/rules/008.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ Meo: ["For each graph representing numerical data (curve, diagram, histogram, pi
</ul>
"]
Controle: ["Check the presence, for each graph, of structured content indicating all the numerical data it represents, or of a link to a page providing them."]
epubcheck:
ace:
Source: ["Opquast"]
Referentiel: [""]
Steps: ["Conception", "Editorial"]
Expand Down
2 changes: 2 additions & 0 deletions content/english/rules/009.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ Controle: ["On the home page:
Check the presence of information, a sentence or content summarizing the content and services offered on the site.
"
]
epubcheck:
ace:
Source: ["Opquast"]
Referentiel: [""]
Steps: ["Conception", "Editorial"]
Expand Down
2 changes: 2 additions & 0 deletions content/english/rules/010.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ tags: ["", ""]
objectif: ["Avoid disappointment", "Warn users"]
Meo: ["Associate specific audience information with the book", "Include specific audience information on the book presentation page"]
Controle: ["For any book whose consultation may be shocking or not suitable for a certain category of the population (minors, etc.), check for the presence of an indication of the public for which the book is intended."]
epubcheck:
ace:
Source: ["Opquast", "SNE"]
Referentiel: [""]
Steps: ["", ""]
Expand Down
2 changes: 2 additions & 0 deletions content/english/rules/011.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ objectif: ["Allow users to unambiguously identify a physical contact capable of
Meo: ["The name and address of the publishing house is written in an identified section", "The name of the publishing house is indicated in the OPF file using the dc:publisher element", "The name of the publishing house is indicated in the ONIX file"]
Controle: [""
]
epubcheck:
ace:
Source: ["Opquast"]
Referentiel: [""]
Steps: ["", ""]
Expand Down
2 changes: 2 additions & 0 deletions content/english/rules/012.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ objectif: ["Improve the accessibility of content to people with disabilities. ",
Meo: ["Write the content of the title element of each Content Document to indicate the name of the site."]
Controle: [""
]
epubcheck:
ace:
Source: ["Opquast"]
Referentiel: [""]
Steps: ["Conception", "Editorial"]
Expand Down
2 changes: 2 additions & 0 deletions content/english/rules/013.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ objectif: ["Allow users to immediately identify the nature of the content of eac
Meo: ["Write the content of the title element of each page so that it describes, as concisely as possible, the content or function of the page"]
Controle: ["Check that each page title (title element) identifies the content or function of the page."
]
epubcheck:
ace:
Source: ["Opquast", "SNE"]
Referentiel: [""]
Steps: ["Editorial", ""]
Expand Down
2 changes: 2 additions & 0 deletions content/english/rules/014.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ objectif: ["", ""]
Meo: [""]
Controle: [""
]
epubcheck:
ace:
Source: ["Opquast"]
Referentiel: [""]
Steps: ["", ""]
Expand Down
2 changes: 2 additions & 0 deletions content/english/rules/015.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ objectif: ["", ""]
Meo: [""]
Controle: [""
]
epubcheck:
ace:
Source: ["Opquast"]
Referentiel: [""]
Steps: ["", ""]
Expand Down
2 changes: 2 additions & 0 deletions content/english/rules/016.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ objectif: ["", ""]
Meo: [""]
Controle: [""
]
epubcheck:
ace:
Source: ["Opquast"]
Referentiel: [""]
Steps: ["", ""]
Expand Down
2 changes: 2 additions & 0 deletions content/english/rules/017.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ objectif: ["", ""]
Meo: [""]
Controle: [""
]
epubcheck:
ace:
Source: ["Opquast"]
Referentiel: [""]
Steps: ["", ""]
Expand Down
2 changes: 2 additions & 0 deletions content/english/rules/018.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ objectif: ["", ""]
Meo: [""]
Controle: [""
]
epubcheck:
ace:
Source: ["Opquast"]
Referentiel: [""]
Steps: ["", ""]
Expand Down
2 changes: 2 additions & 0 deletions content/english/rules/019.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ objectif: ["", ""]
Meo: [""]
Controle: [""
]
epubcheck:
ace:
Source: ["Opquast"]
Referentiel: [""]
Steps: ["", ""]
Expand Down
2 changes: 2 additions & 0 deletions content/english/rules/020.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ objectif: ["", ""]
Meo: [""]
Controle: [""
]
epubcheck:
ace:
Source: ["Opquast"]
Referentiel: [""]
Steps: ["", ""]
Expand Down
2 changes: 2 additions & 0 deletions content/english/rules/021.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ objectif: ["", ""]
Meo: [""]
Controle: [""
]
epubcheck:
ace:
Source: ["Opquast"]
Referentiel: [""]
Steps: ["", ""]
Expand Down
17 changes: 10 additions & 7 deletions content/english/rules/022.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
N: '111'
Rubrique: Images et médias
title: Each decorative image has a suitable text alternative.
abstract:
title: "Each decorative image is tagged as it is"
abstract: "Digital book reading devices often allow synthetic voice reproduction and some users with disabilities use screen readers to obtain alternative audio or tactile reproduction. In these two cases, textual alternatives to the images are reproduced, which can confuse understanding or become annoying in the case of images for decorative purposes. To avoid making the reading cumbersome, it is necessary to correctly inform the decorative function."
categories: ["Images and media"]
agrege: O4111-E022
opquast: '4 111'
Expand All @@ -14,11 +14,14 @@ after: "023"
actif: '1'
layout: rules
date: 2024-09-18
tags: ["", ""]
objectif: ["", ""]
Meo: [""]
Controle: [""
]
tags: ["Accessibility", "Reading experience"]
objectif: ["Prevent users placed in contexts where images are not perceptible (synthetic voice, screen reader or immersive reading) from being disturbed by unnecessary information.", "Provide crawlers with only relevant information. ",
"Improve the accessibility of content to people with disabilities.",
"Improve the consideration of content by search engines and indexing tools"]
Meo: ["Give each decorative img element an empty alt attribute (alt=).","Give each decorative element an attribute (role=presentation)"]
Controle: ["Check the arguments of images that do not convey information necessary for understanding. This can be done in the code or using the table of images available in the ACE report"]
epubcheck: false
ace: true
Source: ["Opquast"]
Referentiel: [""]
Steps: ["", ""]
Expand Down
27 changes: 22 additions & 5 deletions content/english/rules/023.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
N: '112'
Rubrique: Images et médias
title: Each image link has an appropriate text alternative.
abstract:
abstract: Images can be provided with a URL directing the reader to a new page, in which case the destination of the link must be indicated
categories: ["Images and media"]
agrege: O4112-E023
opquast: '4 112'
Expand All @@ -14,11 +14,28 @@ after: "024"
actif: '1'
layout: rules
date: 2024-09-18
tags: ["", ""]
objectif: ["", ""]
Meo: [""]
Controle: [""
tags: ["Accessibility", ""]
objectif: ["Indicate the content of the image", "
Indicate where the link goes and avoid “click here” texts.
Indicate the navigation path explicitly", "
Understand the function of the image and the meaning of the URLs present on the images", "
Allow good indexing by the reading application."]
Meo: ["Décrire l’action associée au clic sur l’image", "
Indiquer l’adresse de la page cible ou le rôle du lien dans l’attribut alt de l’élément img ;", "
Indiquer l’adresse de la page cible ou le rôle du lien dans alt de l’élément area ;", "
Indiquer l’adresse de la page cible ou le rôle du lien dans alt de l’élément object ;", "
Indiquer l’adresse de la page cible ou le rôle du lien dans alt de l’élément canevas ;", "
Nommer le fichier de l’image avec des mots clés explicites
Indiquer l’adresse de la page cible de façon explicite"]
Controle: ["Verify that the alt attribute of each affected img element indicates the target or role of the link.", "
Verify that the alt attribute of each area element concerned indicates the target or role of the link.", "
Verify that the content of each affected object element indicates the target or role of the link.", "
Verify that the content of each affected canvas element indicates the target or role of the link.", "
Check the textual wording of any other element having the role of a link."
]
epubcheck: false
ace: true
necessaryhumancheck: true
Source: ["Opquast"]
Referentiel: [""]
Steps: ["", ""]
Expand Down
19 changes: 10 additions & 9 deletions content/english/rules/024.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
N: '113'
Rubrique: Images et médias
title: Each information-carrying image is provided with an appropriate textual alternative.
abstract:
title: "Each information-carrying image is provided with an appropriate textual alternative."
abstract: "Informative images can be illustrations (painting, drawing, photo, comic strip, map, timeline, label, etc.), graphs, data tables. In the case of illustrations, it is important to specify in the alternative text the nature of the document and the description."
categories: ["Images and media"]
agrege: O4113-E024
opquast: '4 113'
Expand All @@ -14,12 +14,13 @@ after: "025"
actif: '1'
layout: rules
date: 2024-09-18
tags: ["", ""]
objectif: ["", ""]
Meo: [""]
Controle: [""
]
tags: ["Accessbility", "Reading Experience"]
objectif: ["Allow readers placed in contexts where images are not perceptible (synthetic voice, screen reader, immersive reading) to understand the meaning of images that they cannot see."]
Meo: ["Give each img element concerned an alt attribute reproducing the information, a link adjacent to the image playing the same role, either in the content of the page, in the immediate context of the image. In the latter case, the alternative can indicate the presence of this description and refer to it."]
Controle: ["Check that the alt attribute of each img element concerned reproduces the information carried by the image.", "Check the presence and relevance of the extended description if applicable.", "Check understanding in the absence of the image."]
epubcheck: false
ace: true
Source: ["Opquast"]
Referentiel: [""]
Steps: ["", ""]
Referentiel: ["WCAG"]
Steps: ["Conception", "Editorial"]
---
8 changes: 5 additions & 3 deletions content/english/rules/025.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
N: '114'
Rubrique: Images et médias
title: Thumbnails and previews are not larger images resized on the client side.
abstract:
title: Images are not resized for no reason.
abstract: When including images in an EPUB (Electronic Publication) file, it's important to balance image quality with file size to ensure a good reading experience and efficient performance. Here are some guidelines for determining the appropriate resolution and format for images in an EPUB
categories: ["Images and media"]
agrege: O4114-E025
opquast: '4 114'
Expand All @@ -14,11 +14,13 @@ after: "026"
actif: '1'
layout: rules
date: 2024-09-18
tags: ["", ""]
tags: ["suggested deletion", ""]
objectif: ["", ""]
Meo: [""]
Controle: [""
]
epubcheck: false
ace: false
Source: ["Opquast"]
Referentiel: [""]
Steps: ["", ""]
Expand Down
18 changes: 11 additions & 7 deletions content/english/rules/026.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
N: '115'
Rubrique: Images et médias
title: Included objects have an appropriate text alternative.
abstract:
title: Included objects have an appropriate fallback.
abstract: Some digital books contain particular objects such as interactive javascript elements (form, map, etc.) which may be impossible to consult in certain contexts. An alternative allows access to their content.
categories: ["Images and media"]
agrege: O4115-E026
opquast: '4 115'
Expand All @@ -15,11 +15,15 @@ actif: '1'
layout: rules
date: 2024-09-18
tags: ["", ""]
objectif: ["", ""]
Meo: [""]
Controle: [""
]
objectif: ["Provide access to information for users whose reading device does not support the inclusion of objects or the technologies used in the included objects.", "
Facilitate the exploitation of this content by robots.", "
Improve the accessibility of content to people with disabilities.", "
Improve the consideration of content by search engines and indexing tools"]
Meo: ["Use intrinsic fallback mechanisms (such as those available for the [html] object and canvas elements) or, when an intrinsic fallback is not applicable, by using a manifest-level fallback. Fallback chains are created using the fallback attribute on manifest item elements. This attribute references the ID [xml] of another manifest item that is a fallback for the current item. "]
Controle: [""]
epubcheck: false
ace: false
Source: ["Opquast"]
Referentiel: [""]
Referentiel: ["https://www.w3.org/TR/epub-33/#sec-resource-fallbacks"]
Steps: ["", ""]
---
2 changes: 2 additions & 0 deletions content/english/rules/027.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ objectif: ["", ""]
Meo: [""]
Controle: [""
]
epubcheck:
ace:
Source: ["Opquast"]
Referentiel: [""]
Steps: ["", ""]
Expand Down
2 changes: 2 additions & 0 deletions content/english/rules/028.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ objectif: ["", ""]
Meo: [""]
Controle: [""
]
epubcheck:
ace:
Source: ["Opquast"]
Referentiel: [""]
Steps: ["", ""]
Expand Down
2 changes: 2 additions & 0 deletions content/english/rules/029.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ objectif: ["", ""]
Meo: [""]
Controle: [""
]
epubcheck:
ace:
Source: ["Opquast"]
Referentiel: [""]
Steps: ["", ""]
Expand Down
Loading

0 comments on commit c4542dc

Please sign in to comment.