Custom backend - how easy ?

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
7 messages Options
Jmm
Reply | Threaded
Open this post in threaded view
|

Custom backend - how easy ?

Jmm
Just playing with an idea....

How easy/difficult would it be to create a custom backend for Asciidoctor to generate Wiki format output ?
Where should I start ? Is Ruby knowledge required ?

Would it make sense ? In my case, yes, several documentations are stored on wiki servers (Pmwiki or Xwiki).

Jmm
Reply | Threaded
Open this post in threaded view
|

Re: Custom backend - how easy ?

LightGuardjp
Administrator
Comments inline. 

On Thu, Nov 28, 2013 at 2:54, Jmm [via Asciidoctor :: Discussion] <[hidden email]="mailto:[hidden email]">> wrote:

Just playing with an idea....

How easy/difficult would it be to create a custom backend for Asciidoctor to generate Wiki format output ? 

​Wouldn't be that difficult at all. 


Where should I start ? Is Ruby knowledge required ? 

​Not necessarily, but you do need some knowledge about a temp laying language (erb, haml, slim, etc). Take a look at the asciidoctor-backends project. You need a file for each element in the abstract syntax tree (ast). 


Would it make sense ? In my case, yes, several documentations are stored on wiki servers (Pmwiki or Xwiki). 

​In my mind, yes it would make perfect sense. We also need to be able to go the other way too so conversion of your documents is easy. 


Jmm


If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Custom-backend-how-easy-tp1151.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML
Jmm
Reply | Threaded
Open this post in threaded view
|

Re: Custom backend - how easy ?

Jmm

Ok. Now you made me curious. I'll put that on my exploration list. You'll probably hear it when I'll start that journey.

Jmm

Not sent from my PC

Le 28 nov. 2013 16:47, "LightGuardjp [via Asciidoctor :: Discussion]" <[hidden email]> a écrit :
Comments inline. 

On Thu, Nov 28, 2013 at 2:54, Jmm [via Asciidoctor :: Discussion] <[hidden email]="mailto:[hidden email]">> wrote:

Just playing with an idea....

How easy/difficult would it be to create a custom backend for Asciidoctor to generate Wiki format output ? 

Wouldn't be that difficult at all. 


Where should I start ? Is Ruby knowledge required ? 

Not necessarily, but you do need some knowledge about a temp laying language (erb, haml, slim, etc). Take a look at the asciidoctor-backends project. You need a file for each element in the abstract syntax tree (ast). 


Would it make sense ? In my case, yes, several documentations are stored on wiki servers (Pmwiki or Xwiki). 

In my mind, yes it would make perfect sense. We also need to be able to go the other way too so conversion of your documents is easy. 


Jmm


If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Custom-backend-how-easy-tp1151.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Custom-backend-how-easy-tp1151p1152.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML
Reply | Threaded
Open this post in threaded view
|

Re: Custom backend - how easy ?

vmassol
In reply to this post by Jmm
Hi Jmm,

I'm Vincent from the XWiki project. I'm also interested in including Asciidoc as a supported syntax for XWiki Rendering (http://rendering.xwiki.org).

So far asciidoctor didn't provide an event mechanism that would allow use to convert its event to the XWiki event system.

However I got this tweet from Dan Allen a while back:
https://twitter.com/mojavelinux/status/376809428650971136

And now that 0.1.4 is out maybe it's doable.

If you're interested in helping out, please join us on the xwiki devs mailing list/forum where we could discuss this further:
http://dev.xwiki.org/xwiki/bin/view/Community/MailingLists

Thanks!
-Vincent
Jmm
Reply | Threaded
Open this post in threaded view
|

Re: Custom backend - how easy ?

Jmm
Hello Vincent,

I understand what you want to do and it would be very interesting indeed.

What I had in mind (especially as we have several wiki flavor around here) was to generate the different outputs (PDF, html, *wiki from a single Asciidoc source in a Maven build pipeline. The user could then select the Wiki output and paste it in the edit window of the wiki. Uploading from Maven would be even better.

But if I understand it well, both approaches need a *wiki back-end.

If I can help (others program better and faster then me) I'd be very happy. I plan to look into this during my Christmas holidays.

Jean-Marc (Jmm)
Reply | Threaded
Open this post in threaded view
|

Re: Custom backend - how easy ?

vmassol
Hi Jmm,

XWiki Rendering can be used without any wiki backend! See http://rendering.xwiki.org

It'd be cool if we could work together on this. The best would be if you could join the XWiki dev mailing list/forum (see http://dev.xwiki.org/xwiki/bin/view/Community/MailingLists).

I'm planning to commit this week end some skeleton classes to get the work started. However I've just hit the issue described at http://discuss.asciidoctor.org/Events-in-the-Java-integration-tc1190.html

Thanks
-Vincent
Reply | Threaded
Open this post in threaded view
|

Re: Custom backend - how easy ?

vmassol