8000 EPUB accessibility additions by Iacobus1983 · Pull Request #9400 · jgm/pandoc · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

EPUB accessibility additions #9400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 1, 2024
Merged

EPUB accessibility additions #9400

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7828430
Update EPUB.hs
Iacobus1983 Feb 1, 2024
60d4a50
fix
Iacobus1983 Feb 1, 2024
b6ac1b1
Update EPUB.hs
Iacobus1983 Feb 1, 2024
99a7d7e
Update MANUAL.txt
Iacobus1983 Feb 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions MANUAL.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6848,6 +6848,10 @@ The following fields are recognized:
~ An array of strings ([schema][accessibility schema]).
Defaults to `["textual"]`.

`accessModeSufficient`
~ An array of strings ([schema][accessibility schema]).
Defaults to `["textual"]`.

`accessibilityHazards`
~ An array of strings ([schema][accessibility schema]).
Defaults to `["none"]`.
Expand All @@ -6861,6 +6865,9 @@ The following fields are recognized:
- "structuralNavigation"
- "tableOfContents"

`accessibilitySummary`
~ A string value.

`ibooks`
~ iBooks-specific metadata, with the following fields:

Expand Down
15 changes: 13 additions & 2 deletions src/Text/Pandoc/Writers/EPUB.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,10 @@ data EPUBMetadata = EPUBMetadata{
, epubIbooksFields :: [(Text, Text)]
, epubCalibreFields :: [(Text, Text)]
, epubAccessModes :: [Text] -- https://kb.daisy.org/publishing/docs/metadata/schema.org/accessMode.html
, epubAccessModeSufficient :: [Text] -- https://kb.daisy.org/publishing/docs/metadata/schema.org/accessModeSufficient.html
, epubAccessibilityFeatures :: [Text] -- https://kb.daisy.org/publishing/docs/metadata/schema.org/accessibilityFeature.html
, epubAccessibilityHazards :: [Text] -- https://kb.daisy.org/publishing/docs/metadata/schema.org/accessibilityHazard.html
, epubAccessibilitySummary :: Maybe Text -- https://kb.daisy.org/publishing/docs/metadata/schema.org/accessibilitySummary.html
} deriving Show

data Date = Date{
Expand Down Expand Up @@ -362,8 +364,10 @@ metadataFromMeta opts meta = EPUBMetadata{
, epubIbooksFields = ibooksFields
, epubCalibreFields = calibreFields
, epubAccessModes = accessModes
, epubAccessModeSufficient = accessModeSufficient
, epubAccessibilityFeatures = accessibilityFeatures
, epubAccessibilityHazards = accessibilityHazards
, epubAccessibilitySummary = accessibilitySummary
}
where identifiers = getIdentifier meta
titles = getTitle meta
Expand Down Expand Up @@ -410,6 +414,9 @@ metadataFromMeta opts meta = EPUBMetadata{
accessModes = case lookupMeta "accessModes" meta of
Just (MetaList xs) -> map metaValueToString xs
_ -> ["textual"]
accessModeSufficient = case lookupMeta "accessModeSufficient" meta of
Just (MetaList xs) -> map metaValueToString xs
_ -> ["textual"]
accessibilityFeatures =
case lookupMeta "accessibilityFeatures" meta of
Just (MetaList xs) -> map metaValueToString xs
Expand All @@ -419,6 +426,7 @@ metadataFromMeta opts meta = EPUBMetadata{
case lookupMeta "accessibilityHazards" meta of
Just (MetaList xs) -> map metaValueToString xs
_ -> ["none"]
accessibilitySummary = metaValueToString <$> lookupMeta "accessibilitySummary" meta

-- | Produce an EPUB2 file from a Pandoc document.
writeEPUB2 :: PandocMonad m
Expand Down Expand Up @@ -1000,8 +1008,8 @@ metadataElement version md currentTime =
++ publisherNodes ++ sourceNodes ++ relationNodes
++ coverageNodes ++ rightsNodes ++ coverImageNodes
++ modifiedNodes ++ belongsToCollectionNodes
++ accessModeNodes ++ accessibilityFeatureNodes
++ accessibilityHazardNodes
++ accessModeNodes ++ accessModeSufficientNodes ++ accessibilityFeatureNodes
++ accessibilityHazardNodes ++ accessibilitySummaryNodes
metaprop = if version == EPUB2 then "name" else "property"
withIds base f = concat . zipWith f (map (\x -> base <>
T.cons '-' (tshow x))
Expand Down Expand Up @@ -1053,10 +1061,13 @@ metadataElement version md currentTime =
(epubGroupPosition md)
schemanode k v = unode "meta" ! [(metaprop, "schema:" <> k)] $ v
accessModeNodes = map (schemanode "accessMode") (epubAccessModes md)
accessModeSufficientNodes = map (schemanode "accessModeSufficient") (epubAccessModeSufficient md)
accessibilityFeatureNodes = map (schemanode "accessibilityFeature")
(epubAccessibilityFeatures md)
accessibilityHazardNodes = map (schemanode "accessibilityHazard")
(epubAccessibilityHazards md)
accessibilitySummaryNodes = maybe [] (\summary -> [schemanode "accessibilitySummary" summary]) $ epubAccessibilitySummary md

dcTag n s = unode ("dc:" <> n) s
dcTag' n s = [dcTag n s]
toIdentifierNode id' (Identifier txt scheme)
Expand Down
0