<p:declare-step xmlns:p="http://www.w3.org/ns/xproc" xmlns:px="http://www.daisy.org/ns/pipeline/xproc" xmlns:d="http://www.daisy.org/ns/pipeline/data" xmlns:c="http://www.w3.org/ns/xproc-step" xmlns:cx="http://xmlcalabash.com/ns/extensions" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:pef="http://www.daisy.org/ns/2008/pef" type="px:html-to-pef.script" version="1.0" exclude-inline-prefixes="#all" name="main" px:input-filesets="html" px:output-filesets="pef"> <p:documentation xmlns="http://www.w3.org/1999/xhtml"> <h1 px:role="name">HTML to braille</h1> <p px:role="desc">Transforms a HTML document into an embosser ready braille document.</p> <a px:role="homepage" href="http://daisy.github.io/pipeline/Get-Help/User-Guide/Scripts/html-to-pef/"> Online documentation </a> <address> Authors: <dl px:role="author"> <dt>Name:</dt> <dd px:role="name">Jostein Austvik Jacobsen</dd> <dt>E-mail:</dt> <dd><a px:role="contact" href="mailto:josteinaj@gmail.com">josteinaj@gmail.com</a></dd> <dt>Organization:</dt> <dd px:role="organization" href="http://www.nlb.no/">NLB</dd> </dl> </address> </p:documentation> <p:input port="source" px:media-type="application/xhtml+xml text/html"> <p:documentation xmlns="http://www.w3.org/1999/xhtml"> <h2 px:role="name">Input HTML</h2> <p px:role="desc" xml:space="preserve">The HTML you want to convert to braille.</p> </p:documentation> </p:input> <p:output port="status" px:media-type="application/vnd.pipeline.status+xml"> <p:pipe step="convert" port="status"/> </p:output> <p:option name="stylesheet" required="false" px:type="anyURI" select="''" px:sequence="true" px:separator=" " px:media-type="text/css text/x-scss"> <p:documentation xmlns="http://www.w3.org/1999/xhtml"><h2 px:role="name">Style sheets</h2> <p px:role="desc" xml:space="preserve">A list of CSS/Sass style sheets to take into account. Must be a space separated list of URIs, absolute or relative to the input. Style sheets specified through this option are called "[user style sheets](https://www.w3.org/TR/CSS2/cascade.html#cascade)". Style sheets can also be attached to the source document. These are referred to as "[author style sheets](https://www.w3.org/TR/CSS2/cascade.html#cascade)". They can be linked (using an ['xml-stylesheet' processing instruction](https://www.w3.org/TR/xml-stylesheet) or a ['link' element](https://www.w3.org/Style/styling-XML#External)), embedded (using a ['style' element](https://www.w3.org/Style/styling-XML#Embedded)) and/or inlined (using '[style' attributes](https://www.w3.org/TR/css-style-attr/)). Only author styles that apply to "embossed" media are taken into account. All style sheets are applied at once, but the order in which they are specified has an influence on the [cascading order](https://www.w3.org/TR/CSS2/cascade.html#cascading-order). Author styles take precedence over user styles. Style sheets are interpreted according to [braille CSS](http://braillespecs.github.io/braille-css) rules. For info on how to use Sass (Syntactically Awesome StyleSheets) see the [Sass manual](http://sass-lang.com/documentation/file.SASS_REFERENCE.html). A number of [partials](https://sass-lang.com/documentation/at-rules/import#partials) (helper style sheet modules) are available for use in Sass style sheets: - [http://www.daisy.org/pipeline/modules/braille/html-to-pef/_generate-toc.scss](http://daisy.github.io/pipeline/modules/braille/html-to-pef/src/main/resources/css/generate-toc): for generating a table of content - [http://www.daisy.org/pipeline/modules/braille/html-to-pef/_tables.scss](http://daisy.github.io/pipeline/modules/braille/html-to-pef/src/main/resources/css/tables): for styling tables - [http://www.daisy.org/pipeline/modules/braille/html-to-pef/_definition-lists.scss](http://daisy.github.io/pipeline/modules/braille/html-to-pef/src/main/resources/css/definition-lists): for styling definition lists - [http://www.daisy.org/pipeline/modules/braille/html-to-pef/_legacy.scss](http://daisy.github.io/pipeline/modules/braille/html-to-pef/src/main/resources/css/_legacy.scss/): collection of styles that used to be included by default </p> </p:documentation> </p:option> <p:option name="stylesheet-parameters" cx:as="xs:string*" required="false" px:type="stylesheet-parameters" select="'()'"><p:documentation xmlns="http://www.w3.org/1999/xhtml"> <h2 px:role="name">Style sheet parameters</h2> <p px:role="desc" xml:space="preserve">A list of parameters passed to the style sheets. Style sheets, whether they're user style sheets (specified with the "Style sheets" option) or author style sheets (associated with the source), may have parameters (Sass variables). This option, which takes a comma-separated list of key-value pairs enclosed in parenthesis, can be used to set these variables. For example, if a style sheet uses the Sass variable "foo": ~~~sass @if $foo { /* some style that should only be enabled when "foo" is truthy */ } ~~~ you can control that variable with the following parameters list: `(foo:true)`.</p> </p:documentation></p:option> <p:option name="braille-code" px:type="liblouis-table-query" required="false" select="''"><p:documentation xmlns="http://www.w3.org/1999/xhtml"> <h2 px:role="name">Braille code</h2> <p px:role="desc" xml:space="preserve">Braille code to be used for braille transcription. If set, [braille transcription](http://daisy.github.io/pipeline/Get-Help/User-Guide/Braille/) is done using the selected braille code. If left empty, the braille code is determined by the document language. Note that braille transcription can also be controlled through CSS `@text-transform` rules.</p> </p:documentation></p:option> <p:option name="transform" required="false" px:type="transform-query" select="'(translator:liblouis)(formatter:dotify)'"><p:documentation xmlns="http://www.w3.org/1999/xhtml"> <h2 px:role="name">Transformer features</h2> <p px:role="desc" xml:space="preserve">Features of the braille transformer. Features of the [braille transformer](http://daisy.github.io/pipeline/Get-Help/User-Guide/Braille/) to be used for creating the paginated braille document from the CSS styled input document. Together with the "Braille code" option this determines the transformer that is selected.</p> </p:documentation></p:option> <p:option name="include-preview" required="false" px:type="boolean" select="'false'"><p:documentation xmlns="http://www.w3.org/1999/xhtml"> <h2 px:role="name">Include preview</h2> <p px:role="desc" xml:space="preserve">Whether or not to include a HTML preview of the braille result.</p> </p:documentation></p:option> <p:option name="include-pdf" required="false" px:type="boolean" select="'false'"><p:documentation xmlns="http://www.w3.org/1999/xhtml"> <h2 px:role="name">Include PDF</h2> <p px:role="desc" xml:space="preserve">Whether or not to include a PDF version of the braille result showing ASCII braille.</p> </p:documentation></p:option> <p:option name="include-pef" required="false" px:type="boolean" select="'false'"><p:documentation xmlns="http://www.w3.org/1999/xhtml"> <h2 px:role="name">Include PEF</h2> <p px:role="desc" xml:space="preserve">Whether or not to keep the intermediary PEF file (for debugging).</p> </p:documentation></p:option> <p:option name="include-obfl" required="false" px:type="boolean" select="'false'"><p:documentation xmlns="http://www.w3.org/1999/xhtml"> <h2 px:role="name">Include OBFL</h2> <p px:role="desc" xml:space="preserve">Whether or not the keep the intermediary OBFL file (for debugging).</p> </p:documentation></p:option> <p:option name="include-css" px:type="boolean" select="'false'"> <p:documentation xmlns="http://www.w3.org/1999/xhtml"> <h2 px:role="name">Include HTML with inline CSS</h2> <p px:role="desc" xml:space="preserve">Whether or not the include the intermediary HTML with all CSS styles inlined (for debugging).</p> </p:documentation> </p:option> <p:option name="output-file-format" required="false" px:type="transform-query" select="''"><p:documentation xmlns="http://www.w3.org/1999/xhtml"> <h2 px:role="name">Output file format</h2> <p px:role="desc" xml:space="preserve">The file format in which to store the braille result. The file format must be expressed as a list of parenthesis enclosed key-value pairs. For example, to select a file format suited for the U.S., set the option to `(locale:en-US)`. To use the braille character set used in the Netherlands and store to a file with extension ".brl", set the option to `(locale:nl)(file-extension:'.brl')`. If left blank, the braille will be stored in PEF format.</p> </p:documentation></p:option> <p:option name="preview-table" required="false" px:type="preview-table" select="''"><p:documentation xmlns="http://www.w3.org/1999/xhtml"> <h2 px:role="name">ASCII braille table for HTML preview</h2> <p px:role="desc" xml:space="preserve">The ASCII braille table used to render the HTML and PDF previews. If left blank, the locale information in the input document will be used to select a suitable table.</p> </p:documentation></p:option> <p:option name="page-width" required="false" px:type="integer" select="'40'"><p:documentation xmlns="http://www.w3.org/1999/xhtml"> <h2 px:role="name">Page width</h2> <p px:role="desc" xml:space="preserve">The number of columns available for printing. Sets the default page width (this can be overwritten with `@page` rules) and affects media queries that use the 'width' feature. The variable `$page-width` is available in Sass style sheets. See the CSS specification for more info: - the [`@page`](http://braillespecs.github.io/braille-css/#h4_the-page-rule) rule - the [`size`](http://braillespecs.github.io/braille-css/#the-size-property) property - the [page dimensions media features](https://www.w3.org/TR/mediaqueries-4/#mf-dimensions) </p> </p:documentation></p:option> <p:option name="page-height" required="false" px:type="integer" select="'25'"><p:documentation xmlns="http://www.w3.org/1999/xhtml"> <h2 px:role="name">Page height</h2> <p px:role="desc" xml:space="preserve">The number of rows available for printing. Sets the default page height (this can be overwritten with `@page` rules) and affects media queries that use the 'height' feature. The variable `$page-height` is available in Sass style sheets. See the CSS specification for more info: - the [`@page`](http://braillespecs.github.io/braille-css/#h4_the-page-rule) rule - the [`size`](http://braillespecs.github.io/braille-css/#the-size-property) property - the [page dimensions media features](https://www.w3.org/TR/mediaqueries-4/#mf-dimensions) </p> </p:documentation></p:option> <p:option name="duplex" required="false" px:type="boolean" select="'true'"><p:documentation xmlns="http://www.w3.org/1999/xhtml"> <h2 px:role="name">Duplex</h2> <p px:role="desc" xml:space="preserve">When enabled, will print on both sides of the paper.</p> </p:documentation></p:option> <p:option name="hyphenation-at-page-breaks" required="false" select="'false'"><p:pipeinfo> <px:type> <choice xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0"> <value>false</value> <a:documentation xml:lang="en">Never hyphenate words at page boundaries</a:documentation> <value>except-at-volume-breaks</value> <a:documentation xml:lang="en">Allow hyphenation at page boundaries except when it's a volume boundary</a:documentation> <value>true</value> <a:documentation xml:lang="en">Allow hyphenation at page boundaries</a:documentation> </choice> </px:type></p:pipeinfo><p:documentation xmlns="http://www.w3.org/1999/xhtml"> <h2 px:role="name">Hyphenation at page boundaries</h2> <p px:role="desc" xml:space="preserve">Whether hyphenation of words at page boundaries is allowed or not. This option only determines whether hyphenation is allowed at page boundaries. The "Hyphenation" option and the CSS determine how the hyphenation is done, when allowed. </p> </p:documentation></p:option> <p:option name="allow-text-overflow-trimming" px:type="boolean" required="false" select="'false'"><p:documentation xmlns="http://www.w3.org/1999/xhtml"> <h2 px:role="name">Trimming of overflowing text</h2> <p px:role="desc" xml:space="preserve">Allow trimming of overflowing text. By default, text that overflows its containing box will result in an error. By selecting this option, overflowing text will be truncated and generate a warning instead whenever possible. Notably, this will happen with text within page margins (top, right, bottom and left) that is too long to fit the space. </p> </p:documentation></p:option> <p:option name="result" required="true" px:output="result" px:type="anyDirURI" px:media-type="text"><p:documentation xmlns="http://www.w3.org/1999/xhtml"> <h2 px:role="name">Output file</h2> <p px:role="desc">The output braille file.</p> </p:documentation></p:option> <p:option name="pef" required="false" px:output="result" px:type="anyDirURI" px:media-type="application/x-pef+xml" select="''"><p:documentation xmlns="http://www.w3.org/1999/xhtml"> <h2 px:role="name">PEF</h2> <p px:role="desc">The intermediary PEF file.</p> </p:documentation></p:option> <p:option name="preview" required="false" px:output="result" px:type="anyDirURI" px:media-type="text/html" select="''"><p:documentation xmlns="http://www.w3.org/1999/xhtml"> <h2 px:role="name">Preview</h2> <p px:role="desc">An HTML preview of the braille result.</p> </p:documentation></p:option> <p:option name="pdf" required="false" px:output="result" px:type="anyDirURI" px:media-type="application/pdf" select="''"><p:documentation xmlns="http://www.w3.org/1999/xhtml"> <h2 px:role="name">PDF</h2> <p px:role="desc">A PDF version of the braille showing ASCII braille.</p> </p:documentation></p:option> <p:option name="obfl" required="false" px:output="result" px:type="anyDirURI" px:media-type="application/x-obfl+xml" select="''"><p:documentation xmlns="http://www.w3.org/1999/xhtml"> <h2 px:role="name">OBFL</h2> <p px:role="desc">The intermediary OBFL file.</p> </p:documentation></p:option> <p:option name="html-with-css" px:output="result" px:type="anyDirURI" px:media-type="application/xhtml+xml" select="''"> <p:documentation xmlns="http://www.w3.org/1999/xhtml"> <h2 px:role="name">HTML with inline CSS</h2> <p px:role="desc">The intermediary HTML file with inline CSS.</p> </p:documentation> </p:option> <p:import href="http://www.daisy.org/pipeline/modules/braille/common-utils/library.xpl"> <p:documentation> px:delete-parameters </p:documentation> </p:import> <p:import href="library.xpl"> <p:documentation> px:html-to-pef px:html-to-pef.store </p:documentation> </p:import> <p:import href="http://www.daisy.org/pipeline/modules/fileset-utils/library.xpl"> <p:documentation> px:fileset-add-entry </p:documentation> </p:import> <p:import href="http://www.daisy.org/pipeline/modules/html-utils/library.xpl"> <p:documentation> px:html-load </p:documentation> </p:import> <p:in-scope-names name="in-scope-names"/> <px:delete-parameters name="input-options" px:message="Collecting parameters" px:message-severity="DEBUG" px:progress=".01" parameter-names="html stylesheet stylesheet-parameters transform braille-code output-file-format include-pef include-preview include-pdf include-obfl include-css result pef preview obfl html-with-css temp-dir"> <p:input port="source"> <p:pipe port="result" step="in-scope-names"/> </p:input> </px:delete-parameters> <p:sink/> <px:fileset-add-entry media-type="application/xhtml+xml" name="source"> <p:input port="source.fileset"> <p:inline><d:fileset/></p:inline> </p:input> <p:input port="entry"> <p:pipe step="main" port="source"/> </p:input> </px:fileset-add-entry> <px:html-load name="html" px:message="Loading HTML" px:progress=".03"> <p:input port="source.in-memory"> <p:pipe step="source" port="result.in-memory"/> </p:input> <p:with-option name="handle-xinclude" select="$handle-xinclude='true'"/> </px:html-load> <px:html-to-pef name="convert" px:message="Converting from HTML to PEF" px:progress=".90"> <p:input port="source.in-memory"> <p:pipe step="html" port="result.in-memory"/> </p:input> <p:with-option name="temp-dir" select="concat($temp-dir,'convert/')"/> <p:with-option name="stylesheet" select="$stylesheet"/> <p:with-option name="stylesheet-parameters" select="$stylesheet-parameters"/> <p:with-option name="transform" select="concat($braille-code,($transform,'(translator:liblouis)(formatter:dotify)')[not(.='')][1])"/> <p:with-option name="include-obfl" select="$include-obfl"/> <p:input port="parameters"> <p:pipe port="result" step="input-options"/> </p:input> </px:html-to-pef> <px:html-to-pef.store px:progress=".05"> <p:input port="obfl"> <p:pipe step="convert" port="obfl"/> </p:input> <p:input port="html"> <p:pipe step="html" port="result.in-memory"/> </p:input> <p:input port="css"> <p:pipe step="convert" port="css"/> </p:input> <p:with-option name="include-pef" select="$include-pef"/> <p:with-option name="include-preview" select="$include-preview"/> <p:with-option name="include-pdf" select="$include-pdf"/> <p:with-option name="include-css" select="$include-css"/> <p:with-option name="output-file-format" select="$output-file-format"/> <p:with-option name="preview-table" select="$preview-table"/> <p:with-option name="output-dir" select="$result"/> <p:with-option name="pef-output-dir" select="$pef"/> <p:with-option name="preview-output-dir" select="$preview"/> <p:with-option name="pdf-output-dir" select="$pdf"/> <p:with-option name="obfl-output-dir" select="$obfl"/> <p:with-option name="css-output-dir" select="$html-with-css"/> </px:html-to-pef.store> </p:declare-step>