/epubtools

Outils d'aide au développement d'EPUB3

Primary LanguageJavaScriptGNU Lesser General Public License v2.1LGPL-2.1

EpubTools LISEZMOI

Licence VS Code Marketplace Rating Installs Downloads

Outils destinés à faciliter le travail sur les EPUB.

(English README) merci garconvacher

Table des matières

À savoir

Le fichier EPUB doit être décompressé. Ensuite vous pouvez travailler dans les répertoires de celui-ci.

EpubTools contenu (ctrl+shift+P)

  • EpubTools : Insertion nav

    (Si titre dans le <nav> celui-ci est conservé)
    Liste déroulante avec :

    • TDM : Insère la table des matières. Il faut être dans le fichier (toc).xhtml ou (toc).ncx
      Utilise le <spine> de l'opf
      Ajoute si besoin des id="toc-epubtools-XX" dans les titres (<h.>) pour créer des ancres ;
    • Page List : Récupère les balises avec l'attribut epub:type="pagebreak". Crée ou modifie <nav epub:type="page-list"> dans le fichier de la table des matière (toc).xhtml ;
    • Table List : Crée ou modifie la liste des tableaux (<tables>) ;
    • Illustration List : Crée ou modifie la liste des illustrations/images. Ne prends que les balises <figure> contenant <img> ;
    • Audio List : Crée ou modifie la liste des balises <audio>. Récupère le aria-label de la balise sinon affiche l'id ;
    • Video List : Crée ou modifie la liste des balises <video>. Récupère le aria-label de la balise sinon affiche l'id.

  • EpubTools : A11Y

    Ouvre une liste d'outils pour améliorer l'accessibilité :

  • EpubTools : Création Page Liste

    Récupère les balises avec l'attribut epub:type="pagebreak". Crée ou modifie <nav epub:type="page-list"> dans le fichier de la table des matière (toc).xhtml.

  • EpubTools : Manifest

    Reconstruit le manifest dans l'OPF suivant les fichiers présents dans l'EPUB. La commande doit être lancée dans le fichier .opf.
    Renomme les fichiers contenant des caractères accentués ou des espaces

  • EpubTools : Récriture Spine

    Récrit le spine dans le fichier .opf. La commande doit être lancée dans le fichier .opf.

  • EpubTools : premier <h.> => <title>

    Copie le premier titre (s'il y en a) de chaque page xhtml dans la balise <title> de celle-ci.

  • EpubTools : Problèmes ?

    Affiche les problèmes ou avertissements dans l'onglet SORTIE :

    • Pages sans titre <h>
    • Hiérarchie des titres illogique (h1 suivi d'un h3 sans h2 par exemple)
    • Problèmes dans le <spine> de l'opf si un idref dans un <itemref> manque dans le <manifest>
    • Tableaux sans <th>, scope ou <thead>.

  • EpubTools : <span...>{numPage}</span> => <span {epub:type} />

    Transforme les ...

    <span class="epubTools-numPage">{numéro}</span>

    ... en

     <span id="page{numéro}" title="{numéro}" epub:type="pagebreak" role="doc-pagebreak"></span>

    Astuce : Utiliser le script InDesign epubTools-numPage avant l'export en EPUB.

EpubTools Configuration (ctrl+,)

  • epub.activerA11ylint (A11yLint)

    Active a11ylint (défaut true)

  • epub.ancreTDM

    • ajouterAncre : boolean (défaut : true)
    • nomAncre : préfixe du nom de l'ancre (défaut : toc-epubtools)

  • epub.classeTDM

    Classe appliquée à la balise <ol> de la table des matières (défaut : ol-toc)

  • epub.coverImage

    Nom du fichier pour la couverture de l'ouvrage (Permet d'ajouter properties="cover-image" à l'image dans le <manifest> - défaut : cover)

  • epub.emphaseStyleAChercher (A11yLint)

    Classes CSS contenant la chaîne de caractères dans son nom. Permet de trouver les classes à changer.

    • italique (défaut ["italique","italic"])
    • gras (défaut ["bold", "gras", "strong"])
    • emphase (défaut ["emphase", "emphasis"])

    Exemple : <span class="italique-sympa"> déclenchera une alerte dans a11yLint.

  • epub.emphaseStyleAEviter (A11yLint)

    Chaînes de caractères non pris en compte par epub.emphaseStyleAChercher (default ["no-bold", "no-italique","no-emphase"])

    Exemple : <span class="no-italique-sympa"> ne déclenchera pas d'alerte dans a11yLint.

  • epub.navTDM

    Nom du fichier pour la table des matières (Permet d'ajouter properties="nav" à l'<item> référençant la TDM dans le <manifest> - défaut : toc)

  • epub.niveauTitre

    Niveau de titre dans la table des matières (défaut : 3)

  • epub.titreTDM

    • titre : titre de la table des matières (défaut : Table des matières)
    • balise : balise pour le titre (défaut : h1)
    • classe : classe pour le titre (défaut : titre1)

  • epub.styleNumPage

    Classe CSS recherchée pour EpubTools : <span...>{numPage}</span> => <span {epub:type} />

A11yLint

Référence : Accessible Publishing Knowledge Base

  • Vérification des images <img> :
    • alt vide
    • pas de alt
  • Vérification des <span> avec classe italique, gras, etc. => transformer en <em> ?
  • Vérification des noteref dans des <sup> => retirer <sup>
  • Vérification des aria-label et controls dans les balises <audio> et <video>

Release Notes

2.3.2

  • ajout de svg dans properties

Toutes les release notes.