cx:asciidoctor

Name

cx:asciidoctor — Convert AsciiDoc text to XML.

Synopsis

<p:declare-step type="cx:asciidoctor" xmlns:cx="http://xmlcalabash.com/ns/extensions">
     <p:input port="source"/>
     <p:output port="result"/>
     <p:option name="allow-read-uri"/>                             
     <p:option name="attribute-missing"/>                          
     <p:option name="attribute-undefined"/>                        
     <p:option name="backend"/>                                    
     <p:option name="title"/>                                      
     <p:option name="doctype"/>                                    
     <p:option name="imagesdir"/>                                  
     <p:option name="source-language"/>                            
     <p:option name="source-highlighter"/>                         
     <p:option name="max-include-depth"/>                          
     <p:option name="sectnumlevels"/>                              
     <p:option name="hardbreaks"/>                                 
     <p:option name="cache-uri"/>                                  
     <p:option name="hide-uri-scheme"/>                            
     <p:option name="appendix-caption"/>                           
     <p:option name="math"/>                                       
     <p:option name="skip-front-matter"/>                          
     <p:option name="setanchors"/>                                 
     <p:option name="untitled-label"/>                             
     <p:option name="ignore-undefined"/>                           
     <p:option name="toc-placement"/>                              
     <p:option name="toc2-placement"/>                             
     <p:option name="showtitle"/>                                  
     <p:option name="toc"/>                                        
     <p:option name="localdate"/>                                  
     <p:option name="localtime"/>                                  
     <p:option name="docdate"/>                                    
     <p:option name="doctime"/>                                    
     <p:option name="stylesheet"/>                                 
     <p:option name="stylesdir"/>                                  
     <p:option name="linkcss"/>                                    
     <p:option name="copycss"/>                                    
     <p:option name="icons"/>                                      
     <p:option name="iconfont-remote"/>                            
     <p:option name="iconfont-cdn"/>                               
     <p:option name="iconfont-name"/>                              
     <p:option name="data-uri"/>                                   
     <p:option name="iconsdir"/>                                   
     <p:option name="numbered"/>                                   
     <p:option name="linkattrs"/>                                  
     <p:option name="experimental"/>                               
     <p:option name="nofooter"/>                                   
     <p:option name="compat-mode"/>                                
     <p:option name="header-footer" select="'true'"/>              
     <p:option name="template-dirs"/>                              
     <p:option name="template-engine"/>                            
     <p:option name="safe"/>                                       
     <p:option name="eruby"/>                                      
     <p:option name="compact"/>                                    
     <p:option name="base-dir"/>                                   
     <p:option name="template-cache"/>                             
     <p:option name="parse-header-only"/>                          
</p:declare-step>

Description

This step converts AsciiDoc documents into XML or HTML.

The cx:asciidoctor step defines a rather startling number of options. The list is intended to be comprehensive with respect to the attributes and options that can be passed to the asciidoctorj formatter. The names reflect the names used by the project, as far as I can tell. They are: allow-read-uri, appendix-caption, attribute-missing, attribute-undefined, backend, base-dir, cache-uri, compact, compat-mode, copycss, data-uri, docdate, doctime, doctype, eruby, experimental, hardbreaks, header-footer, hide-uri-scheme, iconfont-cdn, iconfont-name, iconfont-remote, icons, iconsdir, ignore-undefined, imagesdir, linkattrs, linkcss, localdate, localtime, math, max-include-depth, nofooter, numbered, parse-header-only, safe, sectnumlevels, setanchors, showtitle, skip-front-matter, source-highlighter, source-language, stylesdir, stylesheet, template-cache, template-dirs, template-engine, title, toc, toc-placement, toc2-placement, untitled-label

This step sets the “header-footer” option to “true” by default because otherwise the resulting XML is often not well-formed.

It's quite possible that some of the options are non-sensical in this context. You can't, for example, parse and then interrogate the resulting Java object that represents document so options designed for that purpose aren't going to do anything useful. Options that don't make sense may be removed in the future. Once I've figured out which ones they are.

Usage

To use this step, you must include its declaration in your pipeline. You can copy the declaration above or import a library that defines this step, such as

http://xmlcalabash.com/extension/steps/asciidoctor.xpl

Implementation

This step is implemented by the xmlcalabash1-asciidoctor module. The jar file from that project must be in the class path in order to use this step.


XML Calabash Extension Steps		cx:collection-manager