Updates readme.md

readme.md

@@ -5,9 +5,15 @@ Note: This is a provider bundle, but it currently exports some classes that can
 provided. These classes may be moved to a separate library bundle in the future.
 
 # dotify.task.impl #
-Provides implementations for converting:
-- DTBook, epub, html, xml and text to OBFL
-- OBFL to PEF and text
+This component provides implementations for
+* idenfiying XML formats with root element name and namespace
+* validating OBFL and PEF files
+* converting
+  - DTBook, epub, html, xml and text to OBFL
+  - OBFL to PEF and text
+
+## Techniques ##
+Java, StAX, XSLT, OBFL, Schematron, RelaxNG
 
 ## Using ##
 Download the [latest release](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.daisy.dotify%22%20%20a%3A%22dotify.task.impl%22) from maven central and add it to your runtime environment.

src/org/daisy/dotify/tasks/impl/input/readme.md

@@ -0,0 +1,23 @@
+# Overview
+There are three main entry points to the converters. XML, Epub 3 and text.
+
+![https://docs.google.com/drawings/d/1u4GGmxszKkIZySu1Fw4lIWGn_jMbAYt6cdQk0u4mgME/pub?w=814&h=592&dummy=.jpg](https://docs.google.com/drawings/d/1u4GGmxszKkIZySu1Fw4lIWGn_jMbAYt6cdQk0u4mgME/pub?w=814&h=592&dummy=.jpg)
+
+## XML
+The XML-component can handle any XML-based format if an XSLT-transformation and a validation (optional) is provided for it. Two things determine which path to run:
+  * The root element and namespace
+  * The selected template (not shown in the image above). The template option is provided to support several implementations for the same format that are profoundly different and cannot be expressed using parameters (e.g. page width, page height, etc).
+
+Note that:
+- The OBFL path doesn't change the file in any way.
+- The XML path is provided as a way to get the text from an XML-based format into braille, but it offers very little value in terms of layout. For any real use cases, a proper conversion path is highly recommended.
+
+### Functionality and features
+For DTbook, Epub 3 and XHTML:
+  * Many configurable parameters, for example
+    * page dimensions
+    * inner and outer margins
+    * row spacing
+    * maximum volume size
+    * duplex/simplex
+  * Localization of injected texts, e.g. “caption”, “table of contents”, “image description”. The localizations can include variable data, such as volume number, page number etc, e.g. “volume 1”, “volume three”