Skip to content

Commit

Permalink
all rules in english
Browse files Browse the repository at this point in the history
On the fly deepl translation with very quick and partial verification.
Deep proofreading will be needed.
  • Loading branch information
gautierchomel committed Sep 18, 2024
1 parent d255014 commit 9c925d8
Show file tree
Hide file tree
Showing 86 changed files with 2,241 additions and 0 deletions.
31 changes: 31 additions & 0 deletions content/english/rules/002.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
Rubrique: Contents
title: "The source code of each Content Document contains metadata that describes its content"
abstract: "Metadata is information contained in the source code that allows it to be described or provided with information about it. This rule concerns the description metadata which, as its name suggests, allows you to describe the page."
categories: ["Contents"]
opquast: '4 003'
indiceebook: '002'
description: "Rule n° 002"
before: "001"
weight: "002"
after: "003"
actif: '1'
layout: rules
date: 2024-09-18
objectif: [
"Allow search and indexing tools to extract information about page content.",
"Improve the presentation of search results to users.",
"Improve the consideration of content by search engines and indexing tools."]
Meo: ["Enter the tag <code>meta name=&#34;description&#34; content=&#34;&#34;</code>, or failing that a specific element having the same function, with a description of the content of the page or site."]
Controle: ["In the source code of each page examined
<ul>
<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>"]
Source: ["Opquast"]
Referentiel: [""]
Steps: ["Editorial", "Development"]
tags: ["", ""]
---

Vocabulary : [Content Document](../../vocabulaire#contentdocument)
27 changes: 27 additions & 0 deletions content/english/rules/003.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
N: '4'
Rubrique: Contents
title: Dates are presented in self-explanatory formats.
abstract: Does 12/11/10 refer to November 12, 2010 (European date format) or December 11, 2010 (American format)? It's up to you to ensure that your users never have to ask themselves this question.
categories: ["Contents"]
agrege: O4004-E003
opquast: '4 004'
indiceebook: '003'
description: "Rule n° 003"
before: "002"
weight: "003"
after: "004"
actif: '1'
layout: rules
date: 2024-09-18
tags: ["", ""]
objectif: [
"To prevent users from misunderstanding the meaning of a date.",
"Facilitate the understanding and reuse of the content concerned."]
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)."]
Source: ["Opquast"]
Referentiel: [""]
Steps: ["Conception", "Editorial"]
---
39 changes: 39 additions & 0 deletions content/english/rules/004.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
N: '5'
Rubrique: Contents
title: The first occurrence of an abbreviation or acronym in the body of each Content Document provides access to its meaning.
abstract: SIG, VAT, AVT, DTC, XML… abbreviations, acronyms and acronyms abound on the Web, particularly in technical and administrative fields. By explaining them, you are doing your users a great service and improving your SEO.
categories: ["Contents"]
agrege: O4005-E004
opquast: '4 005'
indiceebook: '004'
description: "Rule n° 004"
before: "003"
weight: "004"
after: "005"
actif: '1'
layout: rules
date: 2024-09-18
tags: ["Accessibility"]
objectif: [
"Allow the user to quickly access the meaning of an acronym. ",
"Allow the exploitation of the content by a robot (for the establishment of an index of acronyms). ",
"Promote content SEO.",
"Improve the accessibility of content to people with disabilities."
]
Meo: ["At least when an acronym, acronym or abbreviation first appears on the page, you should ensure that you use at least one of the methods below:

Explain its meaning within the text itself, for example: “a DTD (document type declaration)”.
Provide a link giving access to its meaning in a glossary page or via dynamic display (JavaScript tooltip).
Mark up with the HTML element abbr and fill in its title attribute to indicate its meaning.

Good practice only makes this requirement for the first occurrence on the page: this may or may not be done for subsequent occurrences."]
Control: ["In each page examined, visually identify each acronym, abbreviation or acronym present on the page, then check, for its first occurrence on the page, the presence, at least:
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.
"]
Source: ["Opquast"]
Referentiel: [""]
Steps: ["Development", "Conception", "Editorial"]
---
28 changes: 28 additions & 0 deletions content/english/rules/005.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
N: '6'
Rubrique: Contents
title: The date of publication of content requiring it is indicated.
abstract: In real life, when you find a magazine or an old newspaper, the first thing you look at is the publication date. This is normal, you absolutely need this information to understand the content and to put it into context. On the Web, it's the same thing, certain information absolutely must be accompanied by its publication date.
categories: ["Contents"]
agrege: O4006-E005
opquast: '4 006'
indiceebook: '005'
description: "Rule n° 005"
before: "004"
weight: "005"
after: "006"
actif: '1'
layout: rules
date: 2024-09-18
tags: []
objectif: [
"Allow the user to put the information into context.",
"Building confidence in information and facilitating citations."
]
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."
]
Source: ["Opquast"]
Referentiel: [""]
Steps: ["Conception"]
---
37 changes: 37 additions & 0 deletions content/english/rules/006.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
N: '7'
Rubrique: Contents
title: A lexicon or glossary adapted to the target audience explains sectoral or technical vocabulary.
abstract: "The authors of this book are living examples of the almost instantaneous capacity of human beings to jargon as soon as they accumulate some knowledge. A small lexicon or glossary, and presto, the site visitor can understand the contents."
categories: ["Contents"]
agrege: O4007-E006
opquast: '4 007'
indiceebook: '6'
description: "Rule n° 006"
before: "005"
weight: "006"
after: "007"
actif: '1'
layout: rules
date: 2024-09-18
tags: ["Accessibility"]
objectif: [
"Allow users to understand sectoral or technical content.",
"Make it easier to use a service.",
"Improve SEO on technical keywords or expressions.",
"Improve the accessibility of content to people with disabilities.",
"Improve the way content is taken into account by search engines and indexing tools."]
Meo: [
"A section, page or series of glossary pages explaining the technical or sectoral vocabulary used in the content of the site. This glossary must be available directly from each page of the site.",
"Or a mechanism allowing the user to access the definition of technical or sectoral vocabulary terms, from at least their first occurrence on each page of the site."]
Controle: ["For each page containing specific vocabulary, check that it is possible to access:

A section acting as a glossary on each page concerned.
A single page or series of glossary pages available via navigation menus.
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.
"
]
Source: ["Opquast"]
Referentiel: [""]
Steps: ["Contents", "Editorial"]
---
35 changes: 35 additions & 0 deletions content/english/rules/007.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
N: '8'
Rubrique: Contents
title: Advertising or sponsored content is identified as such.
abstract: Editorial or advertising content? Feature article or advertorial? Impartial opinion or sponsored post? It is better to specify what it is about, so Internet users will know what to expect and will have nothing to reproach you for.
categories: ["Contents"]
agrege: O4008-E007
opquast: '4 008'
indiceebook: '7'
description: "Rule n° 007"
before: "006"
weight: "007"
after: "008"
actif: '1'
layout: rules
date: 2024-09-18
tags: ["Sustainability"]
objectif: ["", ""]
Meo: ["
<ul>
<li>Indicate advertisements with a notice allowing them to be identified (advertising, advertising, partnerships, etc.).</li>
<li>Where possible, graphically separate advertising from the rest of the content.</li>
</ul>
"]
Controle: ["Within the book reviewed:
<ul>
<li>Identify advertising content.</li>
<li>Check that all spaces dedicated to advertising are different from the rest of the content and include a notice allowing them to be unambiguously identified; : typically, the mention “advertising”; » displayed above or below the relevant content.</li>
</ul>
"
]
Source: ["Opquast"]
Referentiel: [""]
Steps: ["Conception", "Editorial"]
---
30 changes: 30 additions & 0 deletions content/english/rules/008.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
N: '12'
Rubrique: Contents
title: Each graph is accompanied by its numerical data
abstract: A picture is often worth more than a long speech. Certainly, but first of all, it can be difficult to truly understand a graph (curve, diagram, histogram, pie chart, etc.) if you do not have the data that allowed it to be created. On the other hand, some users will not be able to access the graphic rendering, and access to the data will allow them to understand the content.
categories: ["Images and media"]
agrege: O4012-E008
opquast: '4 012'
indiceebook: '8'
description: "Rule n° 008"
before: "007"
weight: "008"
after: "009"
actif: '1'
layout: rules
date: 2024-09-18
tags: ["Accessibility", ""]
objectif: ["Enable or improve the understanding of the graph.", "Facilitate data sharing.", "Improve the accessibility of content to people with disabilities. ", "Improve the way content is taken into account by search engines and indexing tools."]
Meo: ["For each graph representing numerical data (curve, diagram, histogram, pie chart, etc.):
<ul>
<li>Display in a structured way, in the immediate context of the graph, all the numerical data it represents, for example in the form of a data table.</li>
<li>Or provide in the immediate context of the graphic a link to content of the same type.
</li>
</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."]
Source: ["Opquast"]
Referentiel: [""]
Steps: ["Conception", "Editorial"]
---
28 changes: 28 additions & 0 deletions content/english/rules/009.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
N: '94'
Rubrique: Identification et contact
title: The OPF file sets out the nature of the content and services offered.
abstract: Faites gagner du temps à vos lecteurs, expliquez-leur ce qu’ils pourront trouver dans votre livre.
categories: ["Identification and contact"]
agrege: O4094-E009
opquast: '4 094'
indiceebook: '9'
description: "Rule n° 009"
before: "008"
weight: "009"
after: "010"
actif: '1'
layout: rules
date: 2024-09-18
tags: ["Accessibility", "Identification"]
objectif: ["Give users an immediate vision of the nature of the book and the content offered."]
Meo: ["Provide on the home page information, a sentence, content summarizing the content and services offered on the site."]
Controle: ["On the home page:

Check the presence of information, a sentence or content summarizing the content and services offered on the site.
"
]
Source: ["Opquast"]
Referentiel: [""]
Steps: ["Conception", "Editorial"]
---
25 changes: 25 additions & 0 deletions content/english/rules/010.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
N: '95'
Rubrique: Identification et contact
title: If the digital book is reserved or intended for a specific audience, this audience is mentioned.
abstract: This rule applies when the content to be consulted is intended for certain categories of people. For example, the target audience for a children's documentary is a child while the target audience for an ultra-violent book is an adult.
categories: ["Information before consultation"]
agrege: O4095-E010
opquast: '4 095'
indiceebook: '10'
description: "Rule n° 010"
before: "009"
weight: "010"
after: "011"
actif: '1'
layout: rules
date: 2024-07-08
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."]
Source: ["Opquast", "SNE"]
Referentiel: [""]
Steps: ["", ""]
pertinence: 1
---
25 changes: 25 additions & 0 deletions content/english/rules/011.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
N: '96'
Rubrique: Identification et contact
title: The identity of the author, company or organization is indicated.
abstract: In many countries this is a legal requirement. But beyond local legal aspects, it is good for a person to vouch for the content of the site and for this person to be identified.
categories: ["Identification and contact"]
agrege: O4096-E011
opquast: '4 096'
indiceebook: '11'
description: "Rule n° 011"
before: "010"
weight: "011"
after: "012"
actif: '1'
layout: rules
date: 2024-09-18
tags: ["Identification and contact", "Conception", "Editorial"]
objectif: ["Allow users to unambiguously identify a physical contact capable of answering any questions about the content offered, or of assuming responsibilities linked to this content.", "Reassure the user by allowing them to directly identify the author (in the broad sense).", "Limit the risks of distrust.", "Improve the way content is taken into account by search engines and indexing tools"]
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: [""
]
Source: ["Opquast"]
Referentiel: [""]
Steps: ["", ""]
---
25 changes: 25 additions & 0 deletions content/english/rules/012.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
N: '97'
Rubrique: Identification et contact
title: The title of each Content Document helps identify the book.
abstract:
categories: ["Identification and contact"]
agrege: O4097-E012
opquast: '4 097'
indiceebook: '12'
description: "Rule n° 012"
before: "011"
weight: "012"
after: "013"
actif: '1'
layout: rules
date: 2024-09-18
tags: ["", ""]
objectif: ["Improve the accessibility of content to people with disabilities. ", "Improve the consideration of content by search engines and indexing tools"]
Meo: ["Write the content of the title element of each Content Document to indicate the name of the site."]
Controle: [""
]
Source: ["Opquast"]
Referentiel: [""]
Steps: ["Conception", "Editorial"]
---
25 changes: 25 additions & 0 deletions content/english/rules/013.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
N: '98'
Rubrique: Identification et contact
title: The title of each Content Document allows its content to be identified.
abstract:
categories: ["Identification and contact"]
agrege: O4098-E013
opquast: '4 098'
indiceebook: '13'
description: "Rule n° 013"
before: "012"
weight: "013"
after: "014"
actif: '1'
layout: rules
date: 2024-09-18
tags: ["Accessibility", ""]
objectif: ["Allow users to immediately identify the nature of the content of each page in the reading system window or in screen readers.", "Improve the accessibility of content to people with disabilities."]
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."
]
Source: ["Opquast", "SNE"]
Referentiel: [""]
Steps: ["Editorial", ""]
---
Loading

0 comments on commit 9c925d8

Please sign in to comment.