Asciidoctor :: Discussion

Gradle/AsciiDoctor: Combining all AsciiDoc files in one?

_‹ Previous Topic Next Topic _›

Classic

List

Threaded

3 messages Options

bodiam

Jul 30, 2015; 12:33pm

Gradle/AsciiDoctor: Combining all AsciiDoc files in one?

Hi all,

I'm using the Gradle AsciiDoctor plugin, and I have a setup like the Griffon setup, where I have one AsciiDoc file, called index.adoc, and I use the include directive to import all other adoc files individually. However I create a couple of new AsciiDoc files every day for this project, and having to manually add them to the index.adoc is getting a bit cumbersome, especially since I also sometimes forget to add them. To fix this, I have a bash script in place to generate the index.adoc, but, while it works, it doesn't feel like the right approach.

So, I was wondering if there is a way to combine all adoc files in a directory without having to use explicit includes? Either with some AsciiDoc directive or with the Gradle support?

Thanks,

Erik

mojavelinux

Jul 30, 2015; 10:51pm

Re: Gradle/AsciiDoctor: Combining all AsciiDoc files in one?

Administrator

On Thu, Jul 30, 2015 at 6:33 AM, bodiam [via Asciidoctor :: Discussion] <[hidden email]> wrote:

So, I was wondering if there is a way to combine all adoc files in a directory without having to use explicit includes? Either with some AsciiDoc directive or with the Gradle support?

Sounds to me like a good case for a preprocessor. A preprocessor takes and input document (which can be blank) and returns a new reader which may contain any content you feed it. You could scan for files, read them and aggregate them into the reader. In particular, you'll be interested in the "push_include" method which emulates the behavior of an include directive.

What you need is an example. See:

* https://github.com/asciidoctor/asciidoctorj#preprocessor

* https://github.com/asciidoctor/asciidoctorj/blob/master/asciidoctorj-core/src/main/java/org/asciidoctor/extension/PreprocessorReader.java#L9

Cheers,

-Dan

Dan Allen | http://google.com/profiles/dan.j.allen

mojavelinux

Jul 30, 2015; 10:53pm

Re: Gradle/AsciiDoctor: Combining all AsciiDoc files in one?

Administrator

In reply to this post by bodiam

You can write extensions inline in your Gradle build, btw.

See http://blog.jdriven.com/2015/03/awesome-asciidoctor-use-inline-extension-dsl-with-gradle/

You'll want "preprocessor" as the DSL stanza.

For example:

extensions {

preprocessor { doc, reader ->

// do stuff

reader

}
}

You'll have to work around some issues until AsciidoctorJ 1.6.0...or you could try a snapshot (which is now available).

Cheers,

-Dan

On Thu, Jul 30, 2015 at 4:55 PM, Dan Allen <[hidden email]> wrote:

On Thu, Jul 30, 2015 at 6:33 AM, bodiam [via Asciidoctor :: Discussion] <[hidden email]> wrote:
So, I was wondering if there is a way to combine all adoc files in a directory without having to use explicit includes? Either with some AsciiDoc directive or with the Gradle support?

Sounds to me like a good case for a preprocessor. A preprocessor takes and input document (which can be blank) and returns a new reader which may contain any content you feed it. You could scan for files, read them and aggregate them into the reader. In particular, you'll be interested in the "push_include" method which emulates the behavior of an include directive.

What you need is an example. See:

* https://github.com/asciidoctor/asciidoctorj#preprocessor
* https://github.com/asciidoctor/asciidoctorj/blob/master/asciidoctorj-core/src/main/java/org/asciidoctor/extension/PreprocessorReader.java#L9

Cheers,

-Dan

--
Dan Allen | http://google.com/profiles/dan.j.allen

... [show rest of quote]

Dan Allen | http://google.com/profiles/dan.j.allen