Re: Step by step tutorial on Worg on how to create a new export backend
Bastien writes: > Then, after you commit an edited version of these instructions, maybe > Robert and Marcin can help reviewing and enhancing it to ensure it is > self-sufficient and explicit enough? I have pushed a (ever so) slightly edited version as new file in a branch to worg here: https://code.orgmode.org/bzg/worg/src/org-export-backend-tutorial/org-tutorials/org-export-backend.org Would Robert/Marcin like to take it from here? Stig
Re: Step by step tutorial on Worg on how to create a new export backend
Hi Stig, Marcin, Jean-Christophe and Robert, Stig Brautaset writes: > The primary source of `ox-jira.el' was once[1] an Org tutorial (to > myself) for creating an Org export backend. If this is broadly what you > had in mind, I can dig that out of Git history and put it on Worg. Yes, I think that would be a good start: > https://github.com/stig/ox-jira.el/blob/c4b8fd30c3bc48621759c9d128644d2d386e591e/ox-jira.org Then, after you commit an edited version of these instructions, maybe Robert and Marcin can help reviewing and enhancing it to ensure it is self-sufficient and explicit enough? Let me know if you don't already have push access to worg.git. Thanks! -- Bastien
Re: Step by step tutorial on Worg on how to create a new export backend
Bastien writes: > We have a good reference documentation for creating export backends: > https://orgmode.org/worg/dev/org-export-reference.html > > But we *badly* need a step by step tutorial on Worg. > > Anyone would like to volunteer for writing such a tutorial? The primary source of `ox-jira.el' was once[1] an Org tutorial (to myself) for creating an Org export backend. If this is broadly what you had in mind, I can dig that out of Git history and put it on Worg. I won't be able to do substantial edits or updates, as I made it 4 years ago and it is still my only attempt at creating a backend. (So I have forgotten most of it.) I still use it and it does pretty much what I need it to, however. https://github.com/stig/ox-jira.el/blob/c4b8fd30c3bc48621759c9d128644d2d386e591e/ox-jira.org Stig [1] Contributors got confused about the tangle step, probably because melpa required me to commit the tangled .el as well as the .org source file, so to make it simpler for them I since changed to shipping only the tangled file.
Re: Step by step tutorial on Worg on how to create a new export backend
> On Feb 16, 2020, at 17:05, Marcin Borkowski wrote: > > > On 2020-02-16, at 01:46, Jean-Christophe Helary > wrote: > >>> On Feb 16, 2020, at 2:55, Marcin Borkowski wrote: >>> >>> >>> On 2020-02-14, at 21:48, Bastien wrote: >>> We have a good reference documentation for creating export backends: https://orgmode.org/worg/dev/org-export-reference.html But we *badly* need a step by step tutorial on Worg. Anyone would like to volunteer for writing such a tutorial? >>> >>> I might try to at least start it, though I'll need some time. When is >>> that needed? (I assume that the sooner, the better, so if there is >>> anyone who would beat me to it, go on. I might do some proofreading >>> then.) >> >> Marcin, >> >> Aren't you supposed to write a book about Emacs already ? ;) > > Yep, point taken. I'm really not picking on you or anything :) I just realized that I would have written *exactly* the same thing in other contexts knowing that my plate is already over-full. > But the tutorial is a much smaller thing, and > I already did a similar thing (the Emacs Conf 2015 talk on creating > derived exporters), so much of the work is already done. And I'd love to read that. Jean-Christophe Helary --- http://mac4translators.blogspot.com @brandelune
Re: Step by step tutorial on Worg on how to create a new export backend
On 2020-02-16, at 01:46, Jean-Christophe Helary wrote: >> On Feb 16, 2020, at 2:55, Marcin Borkowski wrote: >> >> >> On 2020-02-14, at 21:48, Bastien wrote: >> >>> We have a good reference documentation for creating export backends: >>> https://orgmode.org/worg/dev/org-export-reference.html >>> >>> But we *badly* need a step by step tutorial on Worg. >>> >>> Anyone would like to volunteer for writing such a tutorial? >> >> I might try to at least start it, though I'll need some time. When is >> that needed? (I assume that the sooner, the better, so if there is >> anyone who would beat me to it, go on. I might do some proofreading >> then.) > > Marcin, > > Aren't you supposed to write a book about Emacs already ? ;) Yep, point taken. But the tutorial is a much smaller thing, and I already did a similar thing (the Emacs Conf 2015 talk on creating derived exporters), so much of the work is already done. Best, -- Marcin Borkowski http://mbork.pl
Re: Step by step tutorial on Worg on how to create a new export backend
> On Feb 16, 2020, at 2:55, Marcin Borkowski wrote: > > > On 2020-02-14, at 21:48, Bastien wrote: > >> We have a good reference documentation for creating export backends: >> https://orgmode.org/worg/dev/org-export-reference.html >> >> But we *badly* need a step by step tutorial on Worg. >> >> Anyone would like to volunteer for writing such a tutorial? > > I might try to at least start it, though I'll need some time. When is > that needed? (I assume that the sooner, the better, so if there is > anyone who would beat me to it, go on. I might do some proofreading > then.) Marcin, Aren't you supposed to write a book about Emacs already ? ;) Jean-Christophe Helary --- http://mac4translators.blogspot.com @brandelune
Re: Step by step tutorial on Worg on how to create a new export backend
On Fri, 14 Feb 2020 21:48:02 +0100 Bastien wrote: > We have a good reference documentation for creating export backends: > https://orgmode.org/worg/dev/org-export-reference.html > > But we *badly* need a step by step tutorial on Worg. > > Anyone would like to volunteer for writing such a tutorial? > I actually began writing something about “deriving a export backend” back in 2013. Deriving a backend might be an ideal starting point of creating an export backend; IIRC the main difference is, for a new backend you'll have to provide /all/ the options whereas in a derived exporter you could simply provide e.g. another src-block interpretation as alternative to the html exporter. Back then for some reason I didn't like punchagan's “org2blog” (which is not an exporter) and wrote my own ox-blog (derived from ox-html) for exporting into wordpress (i don't use wordpress anymore, so it's rotting away on github...). Best regards Robert
Re: Step by step tutorial on Worg on how to create a new export backend
On 2020-02-14, at 21:48, Bastien wrote: > We have a good reference documentation for creating export backends: > https://orgmode.org/worg/dev/org-export-reference.html > > But we *badly* need a step by step tutorial on Worg. > > Anyone would like to volunteer for writing such a tutorial? I might try to at least start it, though I'll need some time. When is that needed? (I assume that the sooner, the better, so if there is anyone who would beat me to it, go on. I might do some proofreading then.) Best, -- Marcin Borkowski http://mbork.pl
