README.adoc in asciidoctor-epub3-1.5.0.alpha.17 vs README.adoc in asciidoctor-epub3-1.5.0.alpha.18
- old
+ new
@@ -1,8 +1,8 @@
= {project-name}: A _native_ EPUB3 converter for AsciiDoc
Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]>
-v1.5.0.alpha.17, 2020-05-25
+v1.5.0.alpha.18, 2020-07-27
// Settings:
:experimental:
:idprefix:
:idseparator: -
:imagesdir: data/samples/images
@@ -25,34 +25,34 @@
// Aliases:
:project-name: Asciidoctor EPUB3
:project-handle: asciidoctor-epub3
// URIs:
:uri-project: https://github.com/asciidoctor/{project-handle}
-:uri-gem: http://rubygems.org/gems/asciidoctor-epub3
+:uri-gem: https://rubygems.org/gems/asciidoctor-epub3
:uri-repo: {uri-project}
:uri-issues: {uri-repo}/issues
-:uri-ci: {uri-repo}/actions?query=workflow%3ACI
-:uri-discuss: http://discuss.asciidoctor.org
+:uri-ci: {uri-repo}/actions?query=branch%3Amaster
+:uri-discuss: https://discuss.asciidoctor.org/
:uri-rvm: https://rvm.io
-:uri-asciidoctor: http://asciidoctor.org
+:uri-asciidoctor: https://asciidoctor.org/
:uri-idpf: http://www.idpf.org/
:uri-epub: http://www.idpf.org/epub/31/spec/epub-spec.html
-:uri-epubcheck: https://github.com/idpf/epubcheck
-:uri-kindlegen: http://www.amazon.com/gp/feature.html?docId=1000765211
+:uri-epubcheck: https://github.com/w3c/epubcheck
+:uri-kindlegen: https://www.amazon.com/gp/feature.html?docId=1000765211
:uri-kf8: http://www.amazon.com/gp/feature.html?docId=1000729511
:uri-send-to-kindle: https://www.amazon.com/gp/sendtokindle/
:uri-metadata-elem: http://www.idpf.org/epub/30/spec/epub30-publications.html#sec-metadata-elem
-:uri-dc: http://dublincore.org/documents/2004/12/20/dces
+:uri-dc: https://www.dublincore.org/specifications/dublin-core/dces/2004-12-20/
:uri-github-guides: https://guides.github.com
:uri-github-guides-fork: https://github.com/opendevise/github-guides-asciidoc
-:uri-asciidoctor-i18n: http://asciidoctor.org/docs/user-manual/#builtin-attributes-i18n
+:uri-asciidoctor-i18n: https://asciidoctor.org/docs/user-manual/#builtin-attributes-i18n
:uri-epubreadingsystem: http://www.idpf.org/epub/301/spec/epub-contentdocs.html#app-epubReadingSystem
-:uri-android-sdk: http://developer.android.com/sdk/index.html
+:uri-android-sdk: https://developer.android.com/sdk/index.html
ifdef::status[]
image:https://img.shields.io/gem/v/asciidoctor-epub3.svg[Latest Release,link={uri-gem}]
-image:{uri-repo}/workflows/CI/badge.svg[GitHub Actions,link={uri-ci}]
+image:{uri-repo}/workflows/CI/badge.svg?branch=master[GitHub Actions,link={uri-ci}]
endif::[]
{project-name} is a set of Asciidoctor extensions for converting AsciiDoc documents directly to the EPUB3 and KF8/MOBI e-book formats.
== Introduction
@@ -106,10 +106,11 @@
* Unicode callout numbers
* Page breaks avoided in block content (so much as it's supported by the e-reader)
* Orphan section titles avoided (so much as it's supported by the e-reader)
* Table border settings honored
* Support for SVG images in the content
+* Stem blocks via AsciiMath
=== Project Status
CAUTION: {project-name} is currently _alpha_ software.
Use accordingly.
@@ -119,11 +120,11 @@
We may explore the use of fixed layout documents in the future if the need arises.
ifdef::env-github[]
=== Planned Features and Work In Progress
-See <<WORKLOG#,WORKLOG.adoc>>.
+See link:WORKLOG.adoc[].
endif::[]
== Converter Workflow
{project-name} takes an aggregate AsciiDoc document and any assets it references as input and produces an EPUB3 publication archive (often described as a “website in a box”).
@@ -319,10 +320,16 @@
|doctype
|Used to control the inclusion of special content in the generated HTML.
If set to a value other than book, the byline information (author and avatar) is included below the chapter header and a typographic end mark is added at the end of the last paragraph.
Suggested values include: book (default), article.
+
+|toc
+|Adds table of contents at the beginning of the book. Depth is controlled by `:toclevels:` attribute.
+
+|outlinelevels
+|Sets the depth of table of contents metadata. If not set, defaults to `:toclevels:`
|===
When using the EPUB3 converter, the `ebook-format` attribute resolves to the name of the e-book format being generated (epub3 or kf8) and the corresponding attribute `ebook-format-<name>` is defined, where `<name>` is `epub3` or `kf8`.
You can use these attributes in a preprocessor directive if you only want to show certain content to readers using a particular device.
For instance, if you want to display a message to readers on Kindle, you can use:
@@ -600,11 +607,11 @@
The theme's fonts are located in the [path]_data/fonts_ directory.
The M+ Outline fonts are used for titles, headings, literal (monospace) text, and annotation numbers.
The body text uses Noto Serif.
Admonition icons and the end-of-chapter mark are from the Font Awesome icon font.
-Refer to the <<NOTICE#,NOTICE>> file for further information about the fonts.
+Refer to the link:NOTICE.adoc[] file for further information about the fonts.
// TODO document command to generate the M+ 1p latin fonts
=== Device-specific Styles
@@ -896,10 +903,10 @@
Copyright (C) 2014-2019 OpenDevise Inc. and the Asciidoctor Project.
Free use of this software is granted under the terms of the MIT License.
For the full text of the license, see the link:LICENSE[] file.
-Refer to the <<NOTICE#,NOTICE>> file for information about third-party Open Source software in use.
+Refer to the link:NOTICE.adoc[] file for information about third-party Open Source software in use.
////
== Additional Points of Note
* uppercase chapter titles to work around line-height limitation in Kindle (1.4 minimum)