#+TITLE: DTBook and EPUB Sample Books

* About
This project aims to provide a few comprehensive sample EPUB books The
defaultbook contains all elements from the [[https://en.wikipedia.org/wiki/DTBook][DTBook XML]] schema in order
to illustrate the usage of these elements.

* DTBook Files
The [[https://github.com/sbsdev/epub-sample-book/tree/0.1/dtbook][dtbook]] directory contains amongst others an XML file
[[https://github.com/sbsdev/epub-sample-book/blob/0.1/dtbook/defaultbook.xml][defaultbook.xml]] adhering to the DTBook schema. This file serves as
examples for different elements and structures found in DTBooks.

- DTBook Sample Book :: The first one an eBraille rendition of the
  [[https://github.com/sbsdev/epub-sample-book][DTBook Sample Book]], an artificial sample that contains all elements
  from the [[https://en.wikipedia.org/wiki/DTBook][DTBook XML]] schema
- Die Arena :: A book from the production
- Engel im zweiten Lehrjahr :: A book from the production

* Building

#+begin_src shell
  just filter die_arena
  just filter engel_im_zweiten_lehrjahr
  just zip die_arena
  just zip engel_im_zweiten_lehrjahr
  just build die_arena
  just build engel_im_zweiten_lehrjahr
#+end_src


* EPUB Files
The [[https://github.com/sbsdev/epub-sample-book/releases][latest release]] contains EPUB books that incorporates all elements
from the DTBook schema. There are three variants:

1) the default variant that is currently as it is currently produced by SBS
2) a variant of the same book using the latest version of the CSS from
   the [[https://github.com/sbsdev/nordic-accessible-epub-css][Nordic accessible epub CSS]] project
3) a variant of the same book using a CSS that is derived from
   ~mtm.css~ of the [[https://github.com/sbsdev/nordic-accessible-epub-css][Nordic accessible epub CSS]] project and adapted to
   the SBS requirements.

These files can be used as a reference or starting point for creating
accessible EPUB books.

* Elements
All elements from the [[https://en.wikipedia.org/wiki/DTBook][DTBook XML]] schema and from the [[https://daisy.org/guidance/info-help/guidance-training/standards/daisy-structure-guidelines/][DAISY Structure
Guidelines]] have been incorporated into the sample DTBook.

* COMMENT Elements [25/25]
- [X] Images
  - [X] ~img~
- [X] Imagegroup
  - [X] ~imggroup~
  - [X] ~caption~
- [X] Citation
  - [X] ~cite~
- [X] Abbreviation
  - [X] ~abbr~
- [X] Acronym
  - [X] ~acronym~
- [X] Pagenum
  - [X] ~pagenum~
- [X] Prodnote
  - [X] ~prodnote~
- [X] Sidebar
  - [X] ~sidebar~
- [X] Notes
  - [X] ~note~
  - [X] ~noteref~
- [X] Annotation
  - [X] ~annotation~
  - [X] ~annoref~
- [X] Epigraph
  - [X] ~epigraph~
- [X] Byline
  - [X] ~byline~
- [X] Dateline
  - [X] ~dateline~
- [X] Word
  - [X] ~w~
- [X] Link
  - [X] ~a~
- [X] Inline
  - [X] ~em~
  - [X] ~strong~
  - [X] ~dfn~
  - [X] ~kbd~
  - [X] ~code~
- [X] Sample
  - [X] ~samp~
- [X] List
  - [X] ~list~
    - [X] ~pl~
    - [X] ~ol~
    - [X] ~ul~
  - [X] ~li~
  - [X] ~dl~
    - [X] ~dt~
    - [X] ~dd~
- [X] Quotation
  - [X] ~blockquote~
  - [X] ~q~
- [X] Poem
  - [X] ~poem~
- [X] Lines
  - [X] ~line~
  - [X] ~linenum~
  - [X] ~linegroup~
- [X] Address
  - [X] ~address~
- [X] Table
  - [X] ~table~
  - [X] ~caption~
  - [X] ~thead~
  - [X] ~tbody~
  - [X] ~tfoot~
  - [X] ~tr~, ~th~, ~td~
- [X] Headings
  - [X] Tite
  - [X] Author
  - [X] ~doctitle~
  - [X] ~docauthor~
  - [X] ~bridgehead~
  - [X] ~level1~ - ~level6~
  - [X] ~h1~ - ~h6~
- [X] Special
  - [X] ~q~
  - [X] ~sub~
  - [X] ~sup~
  - [X] ~span~
  - [X] ~br~
  - [X] ~bdo~

* COMMENT Structure Guidelines
** Inline [16/16]
- [X] Anchor
- [X] Abbreviation
- [X] Acronym
- [X] Computer Code
- [X] Defining Instance
- [X] Emphasis
- [X] Keyboard Input
- [X] Line Break
- [X] Page Number
- [X] Producer’s Note
- [X] Quotation
- [X] Sample
- [X] Sentence
- [X] Span
- [X] Subscript and Superscript
- [X] Word
** Block [16/16]
- [X] Address
- [X] Author
- [X] Bridgehead
- [X] Byline
- [X] Computer Code
- [X] Dateline
- [X] Epigraph
- [X] Keyboard Input
- [X] Linegroup
- [X] Lists
- [X] Note
- [X] Paragraph
- [X] Producer’s Note
- [X] Quotation
- [X] Sample
- [X] Sidebar


* Contributing
Contributions to this project are welcome. If you find any issues or
have suggestions for improvement, please open an issue or submit a
pull request.

* License
This work is licensed under [[https://creativecommons.org/licenses/by-sa/4.0/?ref=chooser-v1][Creative Commons Attribution-ShareAlike
4.0 International]].