Asciidoctor :: Discussion

"MonoTree" extension

_‹ Previous Topic Next Topic _›

Classic

List

Threaded

10 messages Options

vdmitriev

Mar 31, 2015; 10:55pm

"MonoTree" extension

7 posts

Hi!

Concluding discussion that I've started in Asciidoctorj API questions, I finally patched up usable version of the extension (I called it "MonoTree") that outputs trees like the following

[tree]
----
> A             A
>> B            ├── B
>>> C           │   ├── C
>>> D   =>      │   └── D
>> E            ├── E
>>> F           │   └── F
>> G            ├── G
>> H            └── H
----

I wonder however if it will be deprecated by PlantUML/Salt even before a release :) I'll be grateful for ideas, code review, suggestions of making this extension more of the "asciidoc way", etc.

Source code is available on GitHub.
Binaries are (or should be at least) available on Bintray. It's the first time I publish maven artifacts on Bintray, so I may have missed something essential.

~ Regards, Vadim

Robert.Panzer

Apr 01, 2015; 7:04am

Re: "MonoTree" extension

70 posts

I don't think that PlantUML/Salt will supersede this plugin.
If you want to render file trees PlantUML has the drawback that it renders images, so you can't cut and paste from them.

So I would definitely want to see an extension like this!

And in fact I had a similar idea but did not start it because computing the tree lines is really a tedious task :)

wimalopaan

Apr 01, 2015; 1:39pm

Re: "MonoTree" extension

108 posts

In reply to this post by vdmitriev

Is this available as asciidoctor extension too?

Robert.Panzer

Apr 01, 2015; 1:44pm

Re: "MonoTree" extension

70 posts

No, I didn't come beyond thinking about it :)

mojavelinux

Apr 02, 2015; 12:59pm

Re: "MonoTree" extension

Administrator

2681 posts

In reply to this post by wimalopaan

On Wed, Apr 1, 2015 at 3:39 PM, wimalopaan [via Asciidoctor :: Discussion] <[hidden email]> wrote:

Is this available as asciidoctor extension too?

Something similar for Ruby can be found here (perhaps more primitive) https://github.com/asciidoctor/asciidoctor-extensions-lab/tree/master/lib/tree-block-macro

-Dan

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

mojavelinux

Apr 02, 2015; 1:02pm

Re: "MonoTree" extension

Administrator

2681 posts

In reply to this post by Robert.Panzer

On Wed, Apr 1, 2015 at 9:04 AM, Robert.Panzer [via Asciidoctor :: Discussion] <[hidden email]> wrote:

I don't think that PlantUML/Salt will supersede this plugin.
If you want to render file trees PlantUML has the drawback that it renders images, so you can't cut and paste from them.

Ideally the AsciiDoc source could be handled by different interpreters. One could be to feed it through Asciidoctor Diagram / salt (after some text conversion). Another is to output it as text.

What's important is that we try to find the best way to represent the source document. I like the simplicity of the nested arrows. However, we could also consider supporting nested asterisks. That way, it would render in plain AsciiDoc output (up to the max depth of an AsciiDoc list). Others might like the idea of being about to feed output from the tree command directly into the block. Possible enhancements for the future.

Nice work!

Cheers,

-Dan

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

mojavelinux

Apr 02, 2015; 1:04pm

Re: "MonoTree" extension

Administrator

2681 posts

In reply to this post by vdmitriev

On Wed, Apr 1, 2015 at 12:55 AM, vdmitriev [via Asciidoctor :: Discussion] <[hidden email]> wrote:

Source code is available on GitHub.
Binaries are (or should be at least) available on Bintray. It's the first time I publish maven artifacts on Bintray, so I may have missed something essential.

You should consider promoting it by adding a link to asciidoctor.org/docs. (for now put it at the bottom of "Integration and Plugins"). Send a pull request and we'll merge it in.

Cheers!

-Dan

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

wimalopaan

Apr 02, 2015; 2:17pm

Re: "MonoTree" extension

108 posts

In reply to this post by mojavelinux

Am 02.04.2015 um 14:59 schrieb mojavelinux [via Asciidoctor :: Discussion]:

>
> On Wed, Apr 1, 2015 at 3:39 PM, wimalopaan [via Asciidoctor ::
> Discussion] <[hidden email]
> </user/SendEmail.jtp?type=node&node=2944&i=0>> wrote:
>
> Is this available as asciidoctor extension too?
>
>
> Something similar for Ruby can be found here (perhaps more
> primitive) https://github.com/asciidoctor/asciidoctor-extensions-lab/tree/master/lib/tree-block-macro

Oh thank you, very cool!

>
> -Dan
>
>
> --
> Dan Allen | http://google.com/profiles/dan.j.allen
>
>
> ------------------------------------------------------------------------
> If you reply to this email, your message will be added to the discussion
> below:
> http://discuss.asciidoctor.org/MonoTree-extension-tp2903p2944.html
> To start a new topic under Asciidoctor :: Discussion, email
> [hidden email]
> To unsubscribe from Asciidoctor :: Discussion, click here
> <
> NAML
> <http://discuss.asciidoctor.org/template/NamlServlet.jtp?macro=macro_viewer&id=instant_html%21nabble%3Aemail.naml&base=nabble.naml.namespaces.BasicNamespace-nabble.view.web.template.NabbleNamespace-nabble.view.web.template.NodeNamespace&breadcrumbs=notify_subscribers%21nabble%3Aemail.naml-instant_emails%21nabble%3Aemail.naml-send_instant_email%21nabble%3Aemail.naml>
>

... [show rest of quote]

--
Wilhelm

vdmitriev

Apr 09, 2015; 11:06pm

Re: "MonoTree" extension

7 posts

In reply to this post by mojavelinux

mojavelinux wrote

You should consider promoting it by adding a link to asciidoctor.org/docs.
(for now put it at the bottom of "Integration and Plugins"). Send a pull
request and we'll merge it in.

Pull request: https://github.com/asciidoctor/asciidoctor.org/pull/372

mojavelinux wrote

Ideally the AsciiDoc source could be handled by different interpreters. One could be to feed it through Asciidoctor Diagram / salt (after some text conversion). Another is to output it as text.

What's important is that we try to find the best way to represent the source document. I like the simplicity of the nested arrows. However, we could also consider supporting nested asterisks. That way, it would render in plain AsciiDoc output (up to the max depth of an AsciiDoc list).

That was something that I had thought of myself! See question 4 here (I used ordered list in the example there by mistake). Maybe you could share some insight on questions 3 and 4 while we are at it?

mojavelinux wrote

Others might like the idea of being about to feed output from the tree command directly into the block.

Could you please elaborate on that? Short example will be most welcome.

~ Regards, Vadim

mojavelinux

May 04, 2015; 5:26am

Re: "MonoTree" extension

Administrator

2681 posts

On Thu, Apr 9, 2015 at 5:06 PM, vdmitriev [via Asciidoctor :: Discussion] <[hidden email]> wrote:

mojavelinux wrote

You should consider promoting it by adding a link to asciidoctor.org/docs.
(for now put it at the bottom of "Integration and Plugins"). Send a pull
request and we'll merge it in.

Pull request: https://github.com/asciidoctor/asciidoctor.org/pull/372

Excellent!

mojavelinux wrote

Ideally the AsciiDoc source could be handled by different interpreters. One could be to feed it through Asciidoctor Diagram / salt (after some text conversion). Another is to output it as text.

What's important is that we try to find the best way to represent the source document. I like the simplicity of the nested arrows. However, we could also consider supporting nested asterisks. That way, it would render in plain AsciiDoc output (up to the max depth of an AsciiDoc list).

That was something that I had thought of myself! See question 4 here (I used ordered list in the example there by mistake). Maybe you could share some insight on questions 3 and 4 while we are at it?

Currently, extensions cannot tie into lists. This is something on the roadmap. But you can wrap the list in an open block and register the block processor on the open block. That way, you can control the parsing (for instance, parse_content_as :raw) and get the raw text in the extension. But it will still look like a regular list when the extension isn't loaded. Sneaky!

[tree]

. parent

.. child

mojavelinux wrote

Others might like the idea of being about to feed output from the tree command directly into the block.

Could you please elaborate on that? Short example will be most welcome.

Something like the tree extension from the extensions lab. See https://github.com/asciidoctor/asciidoctor-extensions-lab/blob/master/lib/tree-block-macro/extension.rb

Cheers,

-Dan

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