Skip to content

Metadata Editor

Daniel Weck edited this page Feb 28, 2020 · 9 revisions

Ace by DAISY App, user guide for the accessibility metadata editor

Introduction

Please make sure to take a look at the "quick start" user guide.

Note that the "metadata editor" feature is not available in the official v1.0.1 release yet. Please visit the GitHub release page in order to download the latest application installer labelled "continuous test build (prerelease)" specific to your platform (Windows, OSX / MacOS, or Linux).

For example, the downloadable "assets" in the [latest-windows] section contains the file Ace.by.DAISY.Setup.1.0.2-alpha.1.57.exe (the build number 1.57 may have incremented since the time of writing this article).

Workflow (screenshots)

Accessibility evaluation, unzipped EPUB

screenshot 11

Ace App can run accessibility evaluations on a packaged / zipped EPUB, as well as on a unpackaged / unzipped publication (i.e. a folder). In the former case, Ace App will unzip the EPUB package into a temporary folder, in order to perform the accessibility checks on individual publication resources. Note that ; as shown in the screenshot above ; this temporary folder also contains the most recent report (JSON, HTML and other "data" files, which can be saved as a zip file using the "export" function in Ace App). In the latter case (i.e. the EPUB is already unzipped), Ace App runs the accessibility checks directly from the unpackaged publication.

In this test / pre-release build of Ace App, the filesystem explorer is automatically open so that advanced users (early adopters / testers) can take a look at the publication contents (for example, to update the ISBN/identifier according to the changes made to accessibility metadata). In a future release, Ace App will provide a function to automatically zip the publication back into a single EPUB file.

Accessibility metadata in the publication's OPF file (XML)

screenshot 12

Ace App will edit metadata directly inside the publication's OPF file (XML syntax). The screenshot above shows the file named package.opf, and the screenshot below shows the default metadata it contains.

screenshot 14

Once metadata is edited from the Ace App user interface, changes are reflected in the OPF / XML file, as shown in the screenshot below.

screenshot 16

So, let's now walk through the relevant workflow steps.

Accessibility evaluation report

screenshot 10

As the screenshot above shows, the "violations" tab can be used to discover metadata-related issues, by setting the filter to the "EPUB" category, and by sorting the "Rule" column alphabetically to group together the rows where the label starts with "metadata-".

screenshot 1

The metadata tab gives more detailed insight, and the "accessibility" column can be used to identify which metadata items are present (here in this example, none).

screenshot 2

Scrolling down to the bottom of the page reveals the summary of issues found, such as missing accessibility metadata. The "edit" button will open the metadata editor (which is a modal popup dialog).

screenshot 3 screenshot 4 screenshot 5 screenshot 6 screenshot 7 screenshot 8 screenshot 9

screenshot 15

Clone this wiki locally