https://github.com/lb803/access-aide

Calibre plug-in to enhance EPUB accessibility features
https://github.com/lb803/access-aide

accessibility calibre-plugin epub

Last synced: 2 months ago
JSON representation

Calibre plug-in to enhance EPUB accessibility features

• Host: GitHub
• URL: https://github.com/lb803/access-aide
• Owner: lb803
• License: gpl-3.0
• Created: 2020-06-20T11:50:23.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-04-06T15:50:54.000Z (almost 2 years ago)
• Last Synced: 2024-08-04T13:06:51.307Z (6 months ago)
• Topics: accessibility, calibre-plugin, epub
• Language: Python
• Homepage:
• Size: 319 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Access Aide

_Access Aide_ is a Calibre (book editor) plug-in to enhance EPUBs with accessibility features and help comply with the WCAG guidelines.

This plug-in is especially suited for people producing EPUBs through InDesign, but other users might find _Access Aide_ useful. At the time of writing, InDesign is capable of adding language information to OPF files and appropriate epub:type to HTML tags. Access Aide reads this information and adds language declarations, aria roles and metadata statements to comply with the WCAG guidelines for accessible publications.

## Features

 -  Add language declaration to `` tags;

 -  Find tags with `epub:type` attributes and add corresponding aria roles;

 -  Add accessibility declarations to book metadata:

    + schema:accessMode, schema:accessibilityFeature, schema:accessibilityHazard, schema:accessibilitySummary, schema:accessModeSufficient;

    + a11y:certifiedBy, a11y:certifierCredential, a11y:certifierReport;

    + dcterms:conformsTo.

# Installation

You can either:

 - Install this plugin via the [plug-in manager tool](https://manual.calibre-ebook.com/customize.html#customizing-calibre-with-plugins) in your Calibre client `Preferences -> Advanced -> Plug-ins -> Get new plug-ins`;

 - Manually download a release from this repository and then load the zip file by `Preferences -> Advanced -> Plug-ins -> Load plugin from file`.

## Config

Plugin behaviour can be fine tuned via plugin config dialogue.

![Access Aide config dialogue](docs/config_dialogue.png)

## Use

Open the book to enhance in the [Calibre ebook editor](https://manual.calibre-ebook.com/edit.html) and start Access Aide. This can be performed clicking Plugins -> Access Aide, or via Ctrl+Shift+a.

![Access Aide confirm dialogue](docs/confirm_dialogue.png)

# License

Copyright (C) 2020-2022 Luca Baffa

GPL v3.0

## Acknowledgements

This project originally aimed at porting the functionalities of the excellent [Access-Aide](https://github.com/kevinhendricks/Access-Aide) LGPL v2.1 Sigil plugin to Calibre.

The plugin icon (`./icon/icon.png`) comes from the `adwaita-icon-theme` pack ([gitlab page](https://gitlab.gnome.org/GNOME/adwaita-icon-theme) of the project), released as LGPL v3 by the GNOME Project.

The GitHub icon (`./icon/GitHub-Mark-32px.png`) was downloaded from the [dedicated web page](https://github.com/logos) and it is used to link to this GitHub repository.