|
Table of Contents
The asciidoctor tool converts the ascidoc documentation format to various backend formats for either viewing or further processing by documentation tools. This tool supports the baseline asciidoctor distribution (i.e. the Ruby based tool).
Defines arbitrary asciidoctor attributes. The value of the feature should be specified with the CLI syntax for attributes. For example to use as a target requirement:
html example : example.adoc :
<asciidoctor-attribute>idprefix=ex ;
This is a free feature and is not propagated. I.e. it applies only to the
target it’s specified on.
Specifies the doctype to use for generating the output format. Allowed
doctype values are: article, book, manpage, and inline.
Specifies the backend to use to produce output from the source asciidoc.
This feature is automatically applied to fit the build target type. For
example, when specifying an html target for an asciidoc source:
html example : example.adoc ;
The target will by default acquire the <asciidoctor-backend>html5
requirement. The default for each target type are:
html: <asciidoctor-backend>html5
docbook: <asciidoctor-backend>docbook45
man: <asciidoctor-backend>manpage
pdf: <asciidoctor-backend>pdf
To override the defaults you specify it as a requirement on the target:
docbook example : example.adoc :
<asciidoctor-backend>docbook5 ;
Allowed backend values are: html5, docbook45, docbook5, pdf.
To use the asciidoctor tool you need to declare it in a configuration file
with the using rule. The initialiation takes the following arguments:
command: The command, with any extra arguments, to execute.For example you could insert the following in your user-config.jam:
using asciidoctor : "/usr/local/bin/asciidoctor" ;
If no command is given it defaults to just asciidoctor with assumption
that the asciidoctor is available in the search PATH.