如何在Java或Groovy中使用asciidoctorj-diagram?

时间:2016-01-19 16:49:54

标签: groovy asciidoctor plantuml

PlantUML是Asciidoc的一个很好的扩展,但我无法弄清楚如何使用我的常规代码。

据我所知,asciidoctorj-diaram模块应该是当前asciidoctorj - Release的一部分,所以我想我不需要额外的依赖。但是我的代码使得asciidoc很好,不会渲染PlantUML图。它说:

invalid style for open block: plantuml

知道可能出现什么问题吗?我在网上找到的asciidoctorj-diagram示例都使用了gradle-plugin: - |

1 个答案:

答案 0 :(得分:1)

即使库是AsciidoctorJ项目的一部分,也有一个名为asciidoctorj-diagram的独立java库(asciidoctor-diagram的java版本)

您确定类路径上有asciidoctorj-diagram吗?这里maven坐标:

<dependency>
    <groupId>org.asciidoctor</groupId>
    <artifactId>asciidoctorj-diagram</artifactId>
    <version>1.3.1</version>
</dependency>

您还需要告诉Asciidoctor需要asciidoctor-diagram。请参阅以下普通java示例中的行<1>

public static void main(String[] args) {
    org.asciidoctor.Asciidoctor asciidoctor =
             org.asciidoctor.Asciidoctor.Factory.create();

    asciidoctor.requireLibrary("asciidoctor-diagram"); // <1>

    StringBuilder sb = new StringBuilder();
    sb.append("== Diagrams\n");
    sb.append("\n");
    sb.append("[plantuml,auth-protocol]\n");
    sb.append("....\n");
    sb.append("Alice -> Bob: Authentication Request\n");
    sb.append("Bob --> Alice: Authentication Response\n");
    sb.append("\n");
    sb.append("Alice -> Bob: Another authentication Request\n");
    sb.append("Alice <-- Bob: another authentication Response\n");
    sb.append("....\n");

    String html = asciidoctor.convert(sb.toString(), 
             new java.util.HashMap<String, Object>());
    System.out.println(html);
}

顺便说一下,还有一个maven示例:asciidoctor-diagram-example。但是这个例子需要asciidoctor-maven-plugin,它类似于gradle插件。