AsciidoctorJ: Java bindings for AsciidoctorJ
AsciidoctorJ is the official library for running Asciidoctor on the JVM. Using AsciidoctorJ, you can convert AsciiDoc content or analyze the structure of a parsed AsciiDoc document from Java and other JVM languages.
Distribution
The version of AsciidoctorJ matches the version of Asciidoctor RubyGem it bundles. AsciidoctorJ is published to Maven Central and Bintray. The artifact information can be found in the tables below.
Group Id | Artifact Id | Version | Download |
---|---|---|---|
org.asciidoctor |
|||
org.asciidoctor |
asciidoctorj-epub3 |
1.5.0-alpha.4 |
|
org.asciidoctor |
asciidoctorj-pdf |
1.5.0-alpha.6 |
Group Id | Artifact Id | Version | Download |
---|---|---|---|
org.asciidoctor |
|||
org.asciidoctor |
asciidoctorj-epub3 |
1.5.0-alpha.4 |
|
org.asciidoctor |
asciidoctorj-pdf |
1.5.0-alpha.6 |
Caution
|
The artifactId changed to asciidoctorj starting in 1.5.0.
|
Installation
AsciidoctorJ is a standard .jar
file.
To start using it, you need to add the library to your project’s classpath.
<dependencies>
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctorj</artifactId>
<version>1.5.2</version> (1)
</dependency>
</dependencies>
dependencies {
compile 'org.asciidoctor:asciidoctorj:1.5.2'
}
libraryDependencies += "org.asciidoctor" % "asciidoctorj" % "1.5.2" (1)
-
Specifying the version of AsciidoctorJ implicitly selects the version of Asciidoctor
Tip
|
In addition to using AsciidoctorJ directly, you can invoke it as part of your build using the Maven or Gradle plugin. |
Converting documents
The main entry point for AsciidoctorJ is the Asciidoctor
Java interface.
This interface provides four methods for converting AsciiDoc content.
-
convert
-
convertFile
-
convertFiles
-
convertDirectory
You’ll learn about these methods in the converting documents section.
Important
|
Prior to Asciidoctor 1.5.0, the term render was used in these method names instead of convert (i.e., render , renderFile , renderFiles and renderDirectory ).
AsciidoctorJ continues to support the old method names for backwards compatibility.
|
Asciidoctor
interface
Method Name | Return Type | Description |
---|---|---|
|
|
Parses AsciiDoc content read from a string or stream and converts it to the format specified by the |
|
|
Parses AsciiDoc content read from a file and converts it to the format specified by the |
|
|
Parses a collection of AsciiDoc files and converts them to the format specified by the |
|
|
Parses all AsciiDoc files found in the specified directory (using the provided strategy) and converts them to the format specified by the |
Note
|
All the methods listed in Table 3 are overloaded to accomodate various input types and options. |
You retrieve an instance of the Asciidoctor
interface from the factory method provided.
import static org.asciidoctor.Asciidoctor.Factory.create;
import org.asciidoctor.Asciidoctor;
Asciidoctor asciidoctor = create();
Once you retrieve an instance of the Asciidoctor
interface, you can use it to convert AsciiDoc content.
Here’s an example of using AsciidoctorJ to convert an AsciiDoc string.
//...
import java.util.HashMap;
//...
String html = asciidoctor.convert(
"Writing AsciiDoc is _easy_!",
new HashMap<String, Object>());
System.out.println(html);
The convertFile
method will convert the contents of an AsciiDoc file.
//...
import java.util.HashMap;
//...
String html = asciidoctor.convertFile(
new File("sample.adoc"),
new HashMap<String, Object>());
System.out.println(html);
The convertFiles
method will convert a collection of AsciiDoc files:
//...
import java.util.Arrays;
//...
String[] result = asciidoctor.convertFiles(
Arrays.asList(new File("sample.adoc")),
new HashMap<String, Object>());
for (String html : result) {
System.out.println(html);
}
Warning
|
If the converted content is written to files, the convertFiles method will return a String Array (i.e., String[] ) with the names of all the converted documents.
|
Another method provided by the Asciidoctor
interface is convertDirectory
.
This method converts all of the files with AsciiDoc extensions (.adoc
(preferred), .ad
, .asciidoc
, .asc
) that are present within a specified folder and following given strategy.
An instance of the DirectoryWalker
interface, which provides a strategy for locating files to process, must be passed as the first parameter of the convertDirectory
method.
Currently Asciidoctor
provides two built-in implementations of the DirectoryWalker
interface:
DirectoryWalker
implementations
Class | Description |
---|---|
|
Converts all files of given folder and all its subfolders. Ignores files starting with underscore (_). |
|
Converts all files of given folder following a glob expression. |
If the converted content is not written into files, convertDirectory
will return an array listing all the documents converted.
//...
import org.asciidoctor.AsciiDocDirectoryWalker;
//...
String[] result = asciidoctor.convertDirectory(
new AsciiDocDirectoryWalker("src/asciidoc"),
new HashMap<String, Object>());
for (String html : result) {
System.out.println(html);
}
Another way to convert AsciiDoc content is by calling the convert
method and providing a standard Java java.io.Reader
and java.io.Writer
.
The Reader
interface is used as the source, and the converted content is written to the Writer
interface.
//...
import java.io.FileReader;
import java.io.StringWriter;
//...
FileReader reader = new FileReader(new File("sample.adoc"));
StringWriter writer = new StringWriter();
asciidoctor.convert(reader, writer, options().asMap());
StringBuffer htmlBuffer = writer.getBuffer();
System.out.println(htmlBuffer.toString());
Conversion options
Asciidoctor supports numerous options, such as:
in_place
-
Converts the output to a file adjacent to the input file.
template_dirs
-
Specifies a directory of Tilt-compatible templates to be used instead of the default built-in templates
attributes
-
A Hash (key-value pairs) of attributes to configure various aspects of the AsciiDoc processor
The second parameter of the convert
method is java.util.Map
.
The options listed above can be set in java.util.Map
.
in_place
option and the backend
attributeMap<String, Object> attributes = new HashMap<String, Object>();
attributes.put("backend", "docbook"); (1)
Map<String, Object> options = new HashMap<String, Object>();
options.put("attributes", attributes); (2)
options.put("in_place", true); (3)
String outfile = asciidoctor.convertFile(new File("sample.adoc"), options);
-
Defines the
backend
attribute asdocbook
in the attributes map -
Registers the attributes map as the
attributes
option in the options map -
Defines the
in_place
option in the options map
Another way for setting options is by using org.asciidoctor.Options
class.
Options
is a simple Java class which contains methods for setting required options.
Note that related with org.asciidoctor.Options
class, there is org.asciidoctor.Attributes
class, which can be used for setting attributes.
The convert
method is overloaded so org.asciidoctor.Options
can be passed instead of a java.util.Map
.
Attributes attributes = new Attributes();
attributes.setBackend("docbook"); (1)
Options options = new Options();
options.setAttributes(attributes); (2)
options.setInPlace(true); (3)
String outfile = asciidoctor.convertFile(new File("sample.adoc"), options);
-
Defines the
backend
attribute asdocbook
in the attributes class -
Registers the attributes class as the
attributes
option in the options class -
Defines the
in_place
option in the options class
AsciidoctorJ also provides two builder classes to create these maps and classes in a more readable form.
AttributesBuilder
-
Used to define attributes with a fluent API
OptionsBuilder
-
Used to define options with a fluent API
The code below results in the same output as the previous example but uses the builder classes.
import static org.asciidoctor.AttributesBuilder.attributes;
import static org.asciidoctor.OptionsBuilder.options;
//...
Map<String, Object> attributes = attributes().backend("docbook") (1)
.asMap();
Map<String, Object> options = options().inPlace(true)
.attributes(attributes) (2)
.asMap(); (3)
String outfile = asciidoctor.convertFile(new File("sample.adoc"), options);
-
Defines the
backend
attribute asdocbook
using fluent API. -
Registers the attributes map as
attributes
. -
Converts options to
java.util.Map
instance.
import static org.asciidoctor.AttributesBuilder.attributes;
import static org.asciidoctor.OptionsBuilder.options;
//...
Attributes attributes = attributes().backend("docbook").get(); (1)
Options options = options().inPlace(true).attributes(attributes).get(); (2)
String outfile = asciidoctor.convertFile(new File("sample.adoc"), options); (3)
-
Defines and returns an
Attributes
class instead ofjava.util.Map
by callingget()
method instead ofasMap()
. -
Defines and returns an
Options
class instead ofjava.util.Map
by callingget()
method instead ofasMap()
. -
Converts the document passing
Options
class.
Tip
|
All methods used to convert content are overloaded with OptionsBuilder parameter, so it is no longer required to call get nor asMap methods.
|
Warning
|
The icons attribute requires a String to set the value used to “draw” icons.
At this time, you can use two constants org.asciidoctor.Attributes.IMAGE_ICONS for using the same approach as AsciiDoc, that is using img tags, or org.asciidoctor.Attributes.FONT_ICONS for using icons from Font Awesome.
|
Attributes can be specified as String
or Array
instead of pair key/value by using org.asciidoctor.Attributes.setAttributes(String)
or org.asciidoctor.Attributes.setAttributes(String...)
and AttributesBuilder
methods.
//...
Attributes attributes = attributes().attributes("toc numbered").get();
Options options = options().attributes(attributes).get();
Passing attributes as a string is equivalent to passing individual attributes.
//...
Attributes attributes = attributes().tableOfContents(true).sectionNumbers(true).get();
Options options = options().attributes(attributes).get();
You can also use an array.
//...
String[] attributesArray = new String[]{"toc", "source-highlighter=coderay"};
Attributes attributes = attributes().attributes(attributesArray).sectionNumbers(true).get();
Options options = options().attributes(attributes).get();
Passing attributes as an array is equivalent to passing individual attribute.
//...
Attributes attributes = attributes().tableOfContents(true).sectionNumbers(true).sourceHighlighter("coderay").get();
Options options = options().attributes(attributes).get();
Locating files
A utility class AsciiDocDirectoryWalker
is available for searching the AsciiDoc files present in a root folder and its subfolders.
AsciiDocDirectoryWalker
locates all files that end with .adoc
, .ad
, .asciidoc
or .asc
.
Also it ignores all files starting with underscore (_
).
AsciiDocDirectoryWalker
import java.util.List;
import org.asciidoctor.AsciiDocDirectoryWalker;
DirectoryWalker directoryWalker = new AsciiDocDirectoryWalker("docs"); (1)
List<File> asciidocFiles = directoryWalker.scan(); (2)
-
Defines which parent directory is used for searching.
-
Returns a list of all AsciiDoc files found in root folder and its subfolders.
A utility class GlobDirectoryWalker
is available for searching the AsciiDoc files present in a root folder and scanning using a Glob
expression.
GlobDirectoryWalker
locates all files that end with .adoc
, .ad
, .asciidoc
or .asc
.
GlobDirectoryWalker
import java.util.List;
import org.asciidoctor.GlobDirectoryWalker;
DirectoryWalker directoryWalker = new GlobDirectoryWalker("docs", "**/*.adoc"); (1)
List<File> asciidocFiles = directoryWalker.scan(); (2)
-
Defines which parent directory is used for searching and the glob expression.
-
Returns a list of all AsciiDoc files matching given glob expression.
Reading the document tree
Instead of converting an AsciiDoc document, you may want to parse the document to read information it contains or navigate the document’s structure. AsciidoctorJ let’s you do this!
There are two approaches you can take to read the structure of an AsciiDoc document with AsciidoctorJ.
- Using wrapper classes not connected with Ruby internal model
-
The structure is copied in Java non-proxied classes so any change does not modify the original document.
- Using JRuby Java wrapper classes
-
The Java classes are linked to Ruby internal classes. Any modifications done here are reflected to the original document.
Wrapping classes
= Sample Document
Doc Writer <[hidden email]>; John Smith <[hidden email]>
v1.0, 2013-05-20: First draft
:title: Sample Document
:tags: [document, example]
Preamble...
The readDocumentHeader
method on the Asciidoctor
interface retrieves information from the header of an AsciiDoc document without parsing or converting the entire document.
This method returns an instance of org.asciidoctor.ast.DocumentHeader
with all information from the header filled.
//...
import org.asciidoctor.ast.DocumentHeader;
//...
DocumentHeader header = asciidoctor.readDocumentHeader(
new File("header-sample.adoc"));
System.out.println(header.getDocumentTitle().getMain()); (1)
Author author = header.getAuthor(); (2)
System.out.println(author.getEmail()); (3)
System.out.println(author.getFullName()); (4)
RevisionInfo revisionInfo = header.getRevisionInfo();
System.out.println(revisionInfo.getDate()); (5)
System.out.println(revisionInfo.getNumber()); (6)
System.out.println(revisionInfo.getRemark()); (7)
-
prints
Sample Document
-
prints
Doc Writer
-
prints
[hidden email]
-
prints
Doc Writer
-
prints
2013-05-20
-
prints
1.0
-
prints
First draft
The readDocumentHeader
method can be extremely useful for building an index of documents.
import java.io.File;
import java.util.HashSet;
import java.util.Set;
import org.asciidoctor.Asciidoctor;
import org.asciidoctor.AsciiDocDirectoryWalker;
import org.asciidoctor.DirectoryWalker;
import org.asciidoctor.DocumentHeader;
//...
Asciidoctor asciidoctor = Asciidoctor.Factory.create();
Set<DocumentHeader> documentIndex = new HashSet<DocumentHeader>();
DirectoryWalker directoryWalker = new AsciiDocDirectoryWalker("docs"); (1)
for (File file : directoryWalker.scan()) {
documentIndex.add(asciidoctor.readDocumentHeader(file));
}
-
Converts all files in the
docs
folder and its subfolders.
You can also load the document inside a Document
object.
This object represents the whole document, including its headers.
You can use it to navigate through the internals of a parsed document.
To load a document, use the load
or loadFile
methods.
The readDocumentStructure
method provides a useful way of parsing an AsciiDoc file into the structured object.
First, it gathers the same information as readDocumentHeader
and puts it in the header
field of the StructuredDocument
object.
The actual content of the file is split into separate ContentParts based on blocks of the content.
This feature provides several usecases.
= Sample Document
== Section one
This is content of section one
== Section two
And content of section two
...
Each section defines new content part.
List of all parts can be get by getParts
method on StructuredDocument
.
Each part will than contain of title (ie. "Section one") and converted text content as html.
for (ContentPart part : document.getParts()){
System.out.println(part.getTitle());
System.out.println("----");
System.out.println(part.getContent);
System.out.println("----");
}
= Sample Document
[style one]
This is content of first content part
[[partId]]
[style two,role=partRole]
--
And content of second content part
This block can be as long as you want.
--
This way you can then use methods like getPartByStyle
to retrieve particular content parts.
ContentPart style_two = document.getPartByStyle("style two");
// other possible way of retrieving parts:
ContentPart style_two = document.getPartById("partId")
ContentPart style_two = document.getPartByRole("partRole")
//and also for lists
List<ContentPart> parts = document.getPartsByStyle("style two");
List<ContentPart> parts = document.getPartsByRole("partRole");
List<ContentPart> parts = document.getPartsByContext("open");
Really nice thing about it is possibility to parse images to Image
object that you can use
later to embed in html page directly from your java code or manipulate in any other way.
[Images]
image::src/some{sp}image{sp}1.JPG[TODO title1,link="link1.html"]
image::src/some{sp}image{sp}2.JPG[TODO title2,link="link2.html"]
to get a list of images defined in the document and then to process images:
List<ContentPart> images = document.getPartsByContext("image");
for (ContentPart image : images){
String src = (String) image.getAttributes().get("target");
String alt = (String) image.getAttributes().get("alt");
String link = (String) image.getAttributes().get("link");
}
As of final example consider following complete use case:
= Sample product
v1.0, 2013-10-12
:hardbreaks:
:price: 70 pln
:smallImage: photos/small/small_image.jpg
[Description]
short product description
[Images]
image::photos/image1.jpg[title]
image::photos/image2.jpg[title]
[Detail]
--
Detail information about product. Note that you can use all asciidoc features here like:
.simple list
* lists
* images
* titles
* further blocks
[role=text-center]
also you can also add css style by assigning role to the text.
--
and the way it can be than transformed to java object:
Product product = new Product();
product.setTitle(document.getHeader().getDocumentTitle());
product.setPrice(new Price((String) document.getHeader().getAttributes().get("price")));
product.setSmallImage(new Image((String)document.getHeader().getAttributes().get("smallImage"),product.getTitle()));
product.setDescription(document.getPartByStyle("description").getContent());
List<ContentPart> images = document.getPartsByContext("image");
for (ContentPart image : images) {
Image image = new Image();
image.setSrc((String) image.getAttributes().get("target"));
image.setAlt((String) image.getAttributes().get("alt"));
product.getImages().add(image);
}
product.setDetail(document.getPartByStyle("detail").getContent());
Last feature of structure document is possibility to configure how deeply should blocks be processed.
Default is one level only so if you want to have more nested structure add STRUCTURE_MAX_LEVEL
parameter to processing options.
Map<String,Object> parameters = new HashMap<String, Object>();
parameters.put(Asciidoctor.STRUCTURE_MAX_LEVEL, 2);
StructuredDocument document = asciidoctor.readDocumentStructure(
new File("target/test-classes/documentblocks.asciidoc"),
parameters);
JRuby wrapping classes
import org.asciidoctor.ast.Document;
//...
Document document = asciidoctor.load(DOCUMENT, new HashMap<String, Object>()); (1)
assertThat(document.doctitle(), is("Document Title")); (2)
-
Document from an String is loaded into
Document
object. -
Title of the document is retrieved.
But also all blocks that conforms the document can be retrieved.
Currently there are support for three kinds of blocks.
Blocks
itself, Section
for sections of the document and AbstractBlock
which is the base type where all kind of blocks (including those not mapped as Java class) are mapped.
import org.asciidoctor.ast.Document;
import org.asciidoctor.ast.Section;
//...
Document document = asciidoctor.load(DOCUMENT, new HashMap<String, Object>()); (1)
Section section = (Section) document.blocks().get(1); (2)
assertThat(section.index(), is(0)); (3)
assertThat(section.sectname(), is("sect1"));
assertThat(section.special(), is(false));
-
Document from an String is loaded into
Document
object. -
All blocks are get and because in this example the first block is a Section block, we cast it directly.
-
Concrete methods for sections can be called.
Blocks can also be retrieved from query using findBy
method.
Document document = asciidoctor.load(DOCUMENT, new HashMap<String, Object>());
Map<Object, Object> selector = new HashMap<Object, Object>(); (1)
selector.put("context", ":image"); (2)
List<AbstractBlock> findBy = document.findBy(selector);
assertThat(findBy, hasSize(2)); (3)
-
To make queries you need to use a
map
approach. Currently this is because of the Asciidoctor API but it will change in near future. -
In this example all blocks with context as image is returned. Notice that the colon (
:
) must be added in the value part. -
Document used as example contains two images.
Extension API
One of the major improvements to Asciidoctor recently is the extensions API. AsciidoctorJ brings this extension API to the JVM environment. AsciidoctorJ allows us to write extensions in Java instead of Ruby.
Asciidoctor provides seven types of extension points. Each extension point has an abstract class in Java that maps to the extension API in Ruby.
Name | Class |
---|---|
|
org.asciidoctor.extension.Preprocessor |
|
org.asciidoctor.extension.Treeprocessor |
|
org.asciidoctor.extension.Postprocessor |
|
org.asciidoctor.extension.BlockProcessor |
|
org.asciidoctor.extension.BlockMacroProcessor |
|
org.asciidoctor.extension.InlineMacroProcessor |
|
org.asciidoctor.extension.IncludeProcessor |
To create an extension two things are required:
-
Create a class implementing an extension class (this will depend on the kind of interface being developed)
-
Register your class using the
JavaExtensionRegistry
class
An extension can be registered by:
-
Passing as String a fully qualified class.
-
Passing a Class object of the extension.
-
Passing an instance of the extension object.
Note
|
In the first two cases, the lifecycle of the instance is managed by JRuby. In the last case, the caller is the owner of the lifeycle of the object. |
Tip
|
Using an already created instance as an extension is useful when using CDI. For example, you can inject any extension inside the code and then register that instance as an extension. |
Preprocessor
This extension updates an attribute value defined in a document.
public class ChangeAttributeValuePreprocessor extends Preprocessor { (1)
public ChangeAttributeValuePreprocessor(Map<String, Object> config) { (2)
super(config);
}
@Override
public PreprocessorReader process(Document document, PreprocessorReader reader) { (3)
document.getAttributes().put("content", "Alex");
return reader;
}
}
-
Class must extend from
Preprocessor
. -
A constructor receiving a
Map
must be provided in case you want to send options to the preprocessor. -
The
process
method receives aDocument
andPreprocessorReader
.
JavaExtensionRegistry extensionRegistry = this.asciidoctor.javaExtensionRegistry(); (1)
extensionRegistry.preprocessor(ChangeAttributeValuePreprocessor.class); (2)
String content = asciidoctor.convertFile(new File(
"target/test-classes/changeattribute.adoc"),
new Options()); (3)
-
JavaExtensionRegistry
class is created. -
Preprocessor
extension is registered by usingClass
approach. -
We can call any
convert
method as usual; no extra parameters are required.
Treeprocessor
This extension detects literal blocks that contain terminal commands. It strips the prompt character and styles the command.
public class TerminalCommandTreeprocessor extends Treeprocessor { (1)
private Document document;
public TerminalCommandTreeprocessor(Map<String, Object> config) {
super(config);
}
@Override
public Document process(Document document) {
this.document = document;
final List<AbstractBlock> blocks = this.document.blocks(); (2)
for (int i = 0; i < blocks.size(); i++) {
final AbstractBlock currentBlock = blocks.get(i);
if(currentBlock instanceof Block) {
Block block = (Block)currentBlock;
List<String> lines = block.lines(); (3)
if (lines.size() > 0 && lines.get(0).startsWith("$")) {
blocks.set(i, convertToTerminalListing(block));
}
}
}
return this.document;
}
public Block convertToTerminalListing(Block block) {
Map<String, Object> attributes = block.attributes();
attributes.put("role", "terminal");
StringBuilder resultLines = new StringBuilder();
List<String> lines = block.lines();
for (String line : lines) {
if (line.startsWith("$")) {
resultLines.append("<span class=\"command\">")
.append(line.substring(2, line.length()))
.append("</command");
}
else {
resultLines.append(line);
}
}
return createBlock(this.document, "listing", Arrays.asList(resultLines.toString()), attributes,
new HashMap<Object, Object>()); (4)
}
}
-
Class must extend from
Treeprocessor
. -
The
document
instance can be used to retrieve all blocks of the current document. -
All of the selcect block’s lines are retrieved.
-
To create a new block, you must use the
createBlock
method. Set the parent document, the context (listing), the text content, attributes and options.
JavaExtensionRegistry extensionRegistry = this.asciidoctor.javaExtensionRegistry(); (1)
extensionRegistry.treeprocessor("org.asciidoctor.extension.TerminalCommandTreeprocessor"); (2)
String content = asciidoctor.convertFile(new File(
"target/test-classes/sample-with-terminal-command.adoc"),
new Options()); (3)
-
JavaExtensionRegistry
class is created. -
Treeprocessor
extension is registered using fully qualified class name asString
. -
We can call any
convert
method as usually, no extra parameters are required.
Postprocessor
This extension inserts custom footer text.
public class CustomFooterPostProcessor extends Postprocessor { (1)
public CustomFooterPostProcessor(Map<String, Object> config) {
super(config);
}
@Override
public String process(Document document, String output) { (2)
String copyright = "Copyright Acme, Inc.";
if(document.basebackend("html")) {
org.jsoup.nodes.Document doc = Jsoup.parse(output, "UTF-8");
Element contentElement = doc.getElementById("footer-text");
contentElement.append(copyright);
output = doc.html();
}
return output; (3)
}
}
-
Class must extend from
Postprocessor
. -
process
method receives theDocument
instance and the document converted asString
. -
The content that will be written in document is returned.
JavaExtensionRegistry extensionRegistry = this.asciidoctor.javaExtensionRegistry(); (1)
extensionRegistry.postprocessor(new CustomFooterPostProcessor(
new HashMap<String, Object>())); (2)
String content = asciidoctor.convertFile(new File(
"sample.adoc"),
options); (3)
-
JavaExtensionRegistry
class is created. -
Postprocessor
extension is registered using an already created instance approach. -
We can call any
convert
method as usually, no extra parameters are required.
DocinfoProcessor
This extension inserts custom content on header or footer of the document.
For example can be used for adding meta
tags on <head>
tags.
public class MetaRobotsDocinfoProcessor extends DocinfoProcessor { (1)
public MetaRobotsDocinfoProcessor() {
super();
}
public MetaRobotsDocinfoProcessor(Map<String, Object> config) {
super(config);
}
@Override
public String process(Document document) {
return "<meta name=\"robots\" content=\"index,follow\">"; (2)
}
}
-
Class must extend from
DocinfoProcessor
. -
In this case a meta tag is returned. By default docinfo is placed on header.
To register the DocinfoProcessor extension just use the JavaExtensionRegistry
.
JavaExtensionRegistry javaExtensionRegistry = this.asciidoctor.javaExtensionRegistry(); (1)
javaExtensionRegistry.docinfoProcessor(MetaRobotsDocinfoProcessor.class); (2)
String content = asciidoctor.renderFile(
classpath.getResource("simple.adoc"),
options().headerFooter(true).safe(SafeMode.SERVER).toFile(false).get());
-
JavaExtensionRegistry
class is created. -
DocinfoProcessor
extension is registered using an already created instance approach.
If you want to place docinfo on footer you need to set location
option to footer
.
JavaExtensionRegistry javaExtensionRegistry = this.asciidoctor.javaExtensionRegistry();
Map<String, Object> options = new HashMap<String, Object>();
options.put("location", ":footer"); (1)
MetaRobotsDocinfoProcessor metaRobotsDocinfoProcessor = new MetaRobotsDocinfoProcessor(options);
javaExtensionRegistry.docinfoProcessor(metaRobotsDocinfoProcessor);
String content = asciidoctor.renderFile(
classpath.getResource("simple.adoc"),
options().headerFooter(true).safe(SafeMode.SERVER).toFile(false).get());
-
Sets the location option to footer. Note that a colon (:) is placed before footer.
Block processor
This extension registers a custom block style named yell that uppercases all the words.
public class YellBlock extends BlockProcessor { (1)
public YellBlock(String name, Map<String, Object> config) { (2)
super(name, config);
}
@Override
public Object process(AbstractBlock parent, Reader reader, Map<String, Object> attributes) { (3)
List<String> lines = reader.readLines();
String upperLines = null;
for (String line : lines) {
if (upperLines == null) {
upperLines = line.toUpperCase();
}
else {
upperLines = upperLines + "\n" + line.toUpperCase();
}
}
return createBlock(parent, "paragraph", Arrays.asList(upperLines), attributes, new HashMap<Object, Object>()); (4)
}
}
-
Class must extend from
BlockProcessor
. -
Constructor must receive the name of the block and a
Map
for sending options to block. -
process
method receives the parent block, a reader, and attributes defined in block. -
To create a new block we must use
createBlock
method. We must set the parent document, the context (listing), the text content, attributes and options.
JavaExtensionRegistry extensionRegistry = this.asciidoctor.javaExtensionRegistry(); (1)
extensionRegistry.block("yell", YellBlock.class); (2)
String content = asciidoctor.convertFile(new File(
"target/test-classes/sample-with-yell-block.adoc"),
new Options()); (3)
-
JavaExtensionRegistry
class is created. -
BlockProcessor
extension is registered with the context of block. -
We can call any
convert
method as usually, no extra parameters are required.
[yell] (1)
The time is now. Get a move on.
-
Note that yell is the context where block lives and is the same as the first parameter of
block
method ofExtensionRegistry
class.
Block macro processor
This extension creates a block macro named gist for embedding a gist.
public class GistMacro extends BlockMacroProcessor { (1)
public GistMacro(String macroName, Map<String, Object> config) { (2)
super(macroName, config);
}
@Override
public Block process(AbstractBlock parent, String target,
Map<String, Object> attributes) { (3)
String content = "<div class=\"content\">\n" +
"<script src=\"https://gist.github.com/"+target+".js\"></script>\n" +
"</div>";
return createBlock(parent, "pass", Arrays.asList(content), attributes,
this.getConfig()); (4)
}
}
-
Class must extend from
BlockMacroProcessor
. -
Constructor must receive the macro name, and a
Map
for sending options to block.. -
process
method receives the parent document, the content of the macro, and attributes defined in macro. -
To create a new block we must use
createBlock
method. We must set the parent document, the context (listing), the text content, attributes and options.
JavaExtensionRegistry extensionRegistry = this.asciidoctor.javaExtensionRegistry(); (1)
extensionRegistry.blockMacro("gist", GistMacro.class); (2)
String content = asciidoctor.convertFile(new File(
"target/test-classes/sample-with-gist-macro.adoc"),
new Options()); (3)
-
JavaExtensionRegistry
class is created. -
BlockMacroProcessor
extension is registered with the name of the macro. -
We can call any
convert
method as usually, no extra parameters are required.
.My Gist
gist::123456[] (1)
-
Note that gist is the name of the macro and is the same as the first parameter of
blockMacro
method ofExtensionRegistry
class.
Inline macro processor
This extension creates an inline macro named man that links to a manpage.
public class ManpageMacro extends InlineMacroProcessor { (1)
public ManpageMacro(String macroName, Map<String, Object> config) { (2)
super(macroName, config);
}
@Override
protected String process(AbstractBlock parent, String target, Map<String, Object> attributes) { (3)
Map<String, Object> options = new HashMap<String, Object>();
options.put("type", ":link");
options.put("target", target + ".html");
return createInline(parent, "anchor", target, attributes, options).convert(); (4)
}
}
-
Class must extend from
InlineMacroProcessor
. -
Constructor must receive the macro name, and a
Map
for passing options to extension. -
process
method receives the parent document, the content of the macro, and attributes defined in macro. -
Because it is an inline macro, only a replacement string must be returned.
JavaExtensionRegistry extensionRegistry = this.asciidoctor.javaExtensionRegistry(); (1)
extensionRegistry.inlineMacro("man", ManpageMacro.class); (2)
String content = asciidoctor.convertFile(new File(
"target/test-classes/sample-with-man-link.adoc"),
new Options()); (3)
-
ExtensionRegistry
class is created. -
InlineMacroProcessor
extension is registered with the name of the macro. -
We can call any
convert
method as usually, no extra parameters are required.
See man:gittutorial[7] to get started. (1)
-
Note that man is the name of the macro and is the same as the first parameter of
inlineMacro
method ofExtensionRegistry
class.
Include processor
Include a file from a URI.
public class UriIncludeProcessor extends IncludeProcessor { (1)
public UriIncludeProcessor(Map<String, Object> config) {
super(config);
}
@Override
public boolean handles(String target) {
return target.startsWith("http://") || target.startsWith("https://"); (2)
}
@Override
public void process(DocumentRuby document, PreprocessorReader reader, String target,
Map<String, Object> attributes) {
StringBuilder content = readContent(target);
reader.push_include(content.toString(), target, target, 1, attributes); (3)
}
private StringBuilder readContent(String target) {
StringBuilder content = new StringBuilder();
try {
URL url = new URL(target);
InputStream openStream = url.openStream();
BufferedReader bufferedReader = new BufferedReader(
new InputStreamReader(openStream));
String line = null;
while ((line = bufferedReader.readLine()) != null) {
content.append(line);
}
bufferedReader.close();
} catch (MalformedURLException e) {
throw new IllegalArgumentException(e);
} catch (IOException e) {
throw new IllegalArgumentException(e);
}
return content;
}
}
-
Class must extend from
IncludeProcessor
. -
handles
method is used by processor to decide if included element should be converted by this processor or not.target
attribute is the value ofinclude
macro. -
push_include
method inserts new content (retrieved from the url) in current position of document.
JavaExtensionRegistry extensionRegistry = this.asciidoctor.javaExtensionRegistry(); (1)
extensionRegistry.includeProcessor(UriIncludeProcessor.class); (2)
String content = asciidoctor.convertFile(new File(
"target/test-classes/sample-with-uri-include.adoc"),
new Options()); (3)
-
ExtensionRegistry
class is created. -
IncludeProcessor
extension is registered. -
We can call any
convert
method as usually; no extra parameters are required.
= Example of URI
.Gemfile
[source,ruby]
----
include::https://raw.githubusercontent.com/asciidoctor/asciidoctor/master/Gemfile[]
----
Unregistering extensions
You can unregister all extensions by calling the org.asciidoctor.Asciidoctor.unregisterAllExtensions()
method.
Ruby extensions
You can even register extensions written in Ruby using AsciidoctorJ.
To register a Ruby extension you must get a RubyExtensionRegistry
class instead of JavaExtensionRegistry
.
RubyExtensionRegistry rubyExtensionRegistry = this.asciidoctor.rubyExtensionRegistry(); (1)
rubyExtensionRegistry.loadClass(Class.class.getResourceAsStream("/YellRubyBlock.rb")).block("rubyyell", "YellRubyBlock"); (2)
String content = asciidoctor.convertFile(new File(
"target/test-classes/sample-with-ruby-yell-block.ad"),
options().toFile(false).get());
-
rubyExtensionRegistry
method is called to get a rubyExtensionRegistry instance. -
Ruby file containing a class implementing a Block extension is loaded inside the Ruby runtime. Then the block is registered with a name (rubyyell), and we pass the name of the class to be instantiated.
require 'asciidoctor'
require 'asciidoctor/extensions'
class YellRubyBlock < Asciidoctor::Extensions::BlockProcessor
option :contexts, [:paragraph]
option :content_model, :simple
def process parent, reader, attributes
lines = reader.lines.map {|line| line.upcase.gsub(/\.( |$)/, '!\\1') }
Asciidoctor::Block.new parent, :paragraph, :source => lines, :attributes => attributes
end
end
Extension SPI
In previous examples, the extensions were registered manually. However, AsciidoctorJ provides another way to register extensions. If any implementation of the SPI interface is present on the classpath, it will be executed.
To create an autoloadable extension you should do next steps.
Create a class that implements org.asciidoctor.extension.spi.ExtensionRegistry
.
public class ArrowsAndBoxesExtension implements ExtensionRegistry { (1)
@Override
public void register(Asciidoctor asciidoctor) { (2)
JavaExtensionRegistry javaExtensionRegistry = asciidoctor.javaExtensionRegistry();
javaExtensionRegistry.postprocessor(ArrowsAndBoxesIncludesPostProcessor.class); (3)
javaExtensionRegistry.block("arrowsAndBoxes", ArrowsAndBoxesBlock.class);
}
}
-
To autoload extensions you need to implement
ExtensionRegistry
. -
AsciidoctorJ will automatically run the
register
method. The method is responsible for registering all extensions. -
All required Java extensions are registered.
Next, you need to create a file called org.asciidoctor.extension.spi.ExtensionRegistry
inside META-INF/services
with the implementation’s full qualified name.
org.asciidoctor.extension.ArrowsAndBoxesExtension
And that’s all.
Now when a .jar
file containing the previous structure is dropped inside classpath of AsciidoctorJ, the register
method will be executed automatically and the extensions will be registered.
Converting to EPUB3
The Asciidoctor EPUB3 gem (asciidoctor-epub3) is bundled inside the AsciidoctorJ EPUB3 jar (asciidoctorj-epub3). To use it, simply add the asciidoctorj-epub3 jar to your dependencies. The version of the AsciidoctorJ EPUB3 jar aligns with the version of the Asciidoctor EPUB3 gem.
Here’s how you can add the AsciidoctorJ EPUB3 jar to your Maven dependencies:
<dependencies>
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctorj-epub3</artifactId>
<version>1.5.0-alpha.4</version>
<scope>runtime</scope>
</dependency>
</dependencies>
Once you’ve added the AsciidoctorJ EPUB3 jar to your classpath, you can set the backend
attribute to epub3
.
The document will be converted to the EPUB3 format.
Caution
|
The asciidoctor-epub3 gem is alpha. While it can be used successfully, there may be bugs and its functionality may change in incompatible ways before the first stable release. In other words, by using it, you are also testing it ;) |
Let’s see an example of how to use AsciidoctorJ with the EPUB3 converter.
= Book Title
Author Name
:imagesdir: images (1)
include::content-document.adoc[] (2)
-
The EPUB3 converter requires the value of the
imagesdir
attribute to beimages
. -
The EPUB3 converter must be run on a spine document that has at least one include directive (and no other body content) in order to function properly.
= Content Title
Author Name
[abstract]
This is the actual content.
== First Section
And off we go.
And finally we can convert the document to EPUB3 using AsciidoctorJ.
asciidoctor.convertFile(new File("spine.adoc"),
options().safe(SafeMode.SAFE).backend("epub3").get()); (1) (2)
assertThat(new File("target/test-classes/index.epub").exists(), is(true));
-
Currently, the EPUB3 converter must be run in
SAFE
orUNSAFE
mode due to a bug -
epub3
is the name of the backend that must be set to convert to EPUB3.
Loading Ruby libraries
Simple extensions may be fully implemented in Java, but if you want to create complex extensions you can mix Ruby and Java code. This means that you may need to execute a Ruby file or a RubyGem (i.e., gem) inside your extension.
To load a Ruby file inside the Ruby runtime, you can use org.asciidoctor.internal.RubyUtils.loadRubyClass(Ruby, InputStream)
.
You can also load a gem using an API that wraps Ruby’s require
command.
The gem must be available inside the classpath.
Next run org.asciidoctor.internal.RubyUtils.requireLibrary(Ruby, String)
, passing the name of the gem as the second argument.
JRuby instance
Sometimes you may need the Ruby runtime used inside AsciidoctorJ. One reason is because you are using JRuby outside AsciidoctorJ and you want to reuse the same instance. Another reason is that you need to instantiate by yourself an Asciidoctor Ruby object.
To get this instance you can use org.asciidoctor.internal.JRubyRuntimeContext.get()
to get it.
GEM_PATH
By default, AsciidoctorJ comes with all required gems bundled within the jar.
But in some circumstances like OSGi environments you may require to store gems in an external folder and be loaded by AsciidoctorJ.
To accomplish this scenario, create
method provides a parameter to set folder where gems are present.
Internally, AsciidoctorJ will set GEM_PATH
environment variable to given path.
import static org.asciidoctor.Asciidoctor.Factory.create;
import org.asciidoctor.Asciidoctor;
Asciidoctor asciidoctor = create("/my/gem/path"); (1)
-
Creates an
Asciidoctor
instance with givenGEM_PATH
location.
Optimization
JRuby may start slower than expected versus the C-based Ruby implementation (MRI). Fortunately, JRuby offers flags that can improve the start time and tune applications. Several Java flags can also be used in conjunction with or apart from the JRuby flags in order to improve the start time even more.
For small tasks such as converting an AsciiDoc document, two JRuby flags can drastically improve the start time:
Name | Value |
---|---|
|
RUBY1_9 |
|
OFF |
Both flags are set by default inside AsciidoctorJ.
The Java flags available for improving start time depend on whether your working on a 32- or 64-bit processor and your JDK version.
These flags are set by using the JRUBY_OPTS
environment variable.
Let’s see a summary of these flags and in which environments they can be used.
Name | JDK |
---|---|
|
32 bit Java |
|
32/64 bit Java |
|
32/64 bit Java SE 7 |
|
32/64 bit Java SE 7 |
export JRUBY_OPTS="-J-Xverify:none -J-client" (1)
-
Note that you should add
-J
before the flag.
You can find a full explanation on how to improve the start time of JRuby applications in [Optimization].
Running AsciidoctorJ on WildFly AS
If you want to use AsciidoctorJ in an application deployed on WildFly AS, you have to follow the instruction below:
-
Create an Asciidoctor module for WildFly AS.
-
Create the following folder tree: $JBOSS_HOME/modules/org/asciidoctor/main.
-
Create the module descriptor file module.xml.
Asciidoctor module descriptor for WildFly AS<?xml version="1.0" encoding="UTF-8"?> <module xmlns="urn:jboss:module:1.0" name="org.asciidoctor"> <resources> <resource-root path="asciidoctorj-1.5.0.jar"/> <resource-root path="jcommander-1.32.jar"/> <resource-root path="jruby-complete-1.7.9.jar"/> </resources> <dependencies> <module name="javax.management.j2ee.api"/> <module name="javax.api"/> </dependencies> </module>
-
Add a dependency on your Java archive to this WildFly module using one of the following options:
-
Add the dependency just into the MANIFEST.MF file.
MANIFEST.MF file example with dependency to Asciidoctor moduleManifest-Version: 1.0 Dependencies: org.asciidoctor ...
-
Or, configure the dependency into the pom.xml with the Maven JAR/WAR plugin.
pom.xml file example with Maven WAR plugin configuration to add a dependency... <dependencies> <dependency> <groupId>org.asciidoctor</groupId> <artifactId>asciidoctorj</artifactId> <version>1.5.2</version> <scope>provided</scope> (1) ... </dependency> </dependencies> ... <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-war-plugin</artifactId> <version>2.4</version> <configuration> <archive> <manifestEntries> <Dependencies>org.asciidoctor</Dependencies> (2) </manifestEntries> </archive> </configuration> </plugin> ...
-
The AsciidoctorJ dependency and the transitives dependencies don’t need to be added to the final WAR since all JARs are available through the module.
-
The module dependency will be added to the MANIFEST.MF file.
-
-
Using a pre-release version
Pre-release versions of AsciidoctorJ
are published to Bintray.
You can find them in https://bintray.com/asciidoctor/maven/asciidoctorj/view.
Final releases are released to both Maven Central and Bintray.
Here’s how to use a pre-release version in Maven:
<repositories>
<repository>
<id>central</id>
<name>bintray</name>
<url>http://dl.bintray.com/asciidoctor/maven</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
</repositories>
Development
AsciidoctorJ is built using Gradle. The project is structured as a multi-module build.
Project layout
The root folder is the root project and there are several subproject folders, each prefixed with asciidoctorj-. Each subproject produces a primary artifact (e.g., jar or zip) and its supporting artifacts (e.g., javadoc, sources, etc).
The subprojects are as follows:
- asciidoctorj
-
The main Java bindings for the Asciidoctor RubyGem (asciidoctor). Also bundles optional RubyGems needed at runtime, such as coderay, tilt, haml and slim. Produces the asciidoctorj jar.
- asciidoctorj-distribution
-
Produces the distribution zip that provides the standalone
asciidoctorj
command. - asciidoctorj-epub3
-
Bundles the Asciidoctor EPUB3 RubyGem (asciidoctor-pdf) and its dependencies as the asciidoctorj-epub3 jar.
- asciidoctorj-pdf
-
Bundles the Asciidoctor PDF RubyGem (asciidoctor-pdf) and its dependencies as the asciidoctorj-pdf jar.
The Gradle build is partitioned into the following files:
build.gradle gradle.properties settings.gradle gradle/ wrapper/ ... deploy.gradle eclipse.gradle idea.gradle publish.gradle sign.gradle asciidoctorj-core/ build.gradle asciidoctorj-distribution/ build.gradle asciidoctorj-epub3/ build.gradle asciidoctorj-pdf/ build.gradle
Build the project
You invoke Gradle on this project using the gradlew
command (i.e., the Gradle Wrapper).
Tip
|
We strongly recommend that you use Gradle via the Gradle daemon. |
To clone the project, compile the source and build the artifacts (i.e., jars) locally, run:
$ git clone https://github.com/asciidoctor/asciidoctorj cd asciidoctorj ./gradlew assemble
You can find the built artifacts in the asciidoctorj-*/build/libs folders.
To execute tests when running the build, use:
$ ./gradlew build
To only execute the tests, run:
$ ./gradlew check
You can also run tests for a single module:
$ cd asciidoctorj-core ../gradlew check
To run a single test in the asciidoctorj-core subproject, use:
$ ../gradlew -Dsingle.test=NameOfTestClass test
To create the distribution, run:
$ ./gradlew distZip
You can find the distribution in the asciidoctorj-distribution/build/distributions folder.
Develop in an IDE
IntelliJ IDEA
To import the project into IntelliJ IDEA 14, simply import the project using the import wizard. For more information, see the Gradle page in the IntelliJ IDEA Web Help.
Eclipse
To open the project in Eclipse, first generate the Eclipse project files:
$ cd asciidoctorj-core ./gradlew eclipse
Then, import the project into Eclipse using File ▸ Import ▸ General ▸ Existing Project into Workspace.
Continuous integration
Continuous integration for the AsciidoctorJ project is performed by Travis CI. You can find recent build results, including the build status of pull requests, on the asciidoctor/asciidoctorj page.
Publish the artifacts
Artifacts are published to Maven Central and jCenter by way of Bintray’s Distribution as a Service platform.
Before publishing, you need to configure your gpg signing and Bintray credentials. Create the file $HOME/.gradle/gradle.properties and populate the following properties.
signing.keyId= signing.password= signing.secretKeyRingFile=/home/YOUR_USERNAME/.gnupg/secring.gpg bintrayUsername= bintrayApiKey=
To build, assemble and sign the archives (jars and distribution zip), run:
$ ./gradlew -PpublishRelease=true signJars
Tip
|
The publishRelease=true property is technically only required if the version is a snapshot.
|
To build, assemble (but not sign) and install the archives (jars and distribution zip) into the local Maven repository, run:
$ ./gradlew -PpublishRelease=true install
To build, assemble, sign and publish the archives (jars and distribution zip) to Bintray, run:
$ ./gradlew clean ./gradlew -i -x pMNPTML bintrayUpload
Caution
|
Don’t run the clean task in the same execution as the bintrayUpload because it will not upload one of the signatures.
|
If you want to first perform a dry run of the upload, add the dryRun=true
property.
$ ./gradlew -i -PdryRun=true -x pMNPTML bintrayUpload
Note
|
The -x pMNPTML is necessary to work around a bug in the publishing plugin that prevents it from signing the archives.
|
Important
|
Bintray does not allow you to publish snapshots. You have to first update the version in gradle.properties to a release (or pre-release) version number. Currently, Gradle is not configured to automatically tag a release, so you have to create the git tag manually. |
Resources
The source code for AsciidoctorJ, including the latest developments and issues, can be found in the project’s repository on GitHub. If you identify an issue while using AsciidoctorJ, please don’t hesitate to file a bug report. Also, don’t forget to join the Asciidoctor discussion list, where you can ask questions and leave comments.