How to easily create a new export engine...

How to easily create a new export engine...

[flammable project]

[-- Attachment #1: Type: text/plain, Size: 497 bytes --]

Hi all,

I'm looking for informations on how to create a new exporter based on the
new export engine.

I want to convert org files into HTML files in which some "functions" from
Twitter Bootstrap framework will be instantiated via Emacs and Org-Mode.

I'm quite fustrated because the org-export_generic.el file is obsolete and
I tried to use ox.el ox-ascii.el files but I was discouraged by their heavy
contents.

Could you please tell how to easily find a good starting "point" ?

Thanks

Basile

[-- Attachment #2: Type: text/html, Size: 725 bytes --]

Re: How to easily create a new export engine...

[Suvayu Ali]

On Tue, Sep 03, 2013 at 03:37:05PM +0200, flammable project wrote:
> Hi all,
> 
> I'm looking for informations on how to create a new exporter based on the
> new export engine.
> 
> I want to convert org files into HTML files in which some "functions" from
> Twitter Bootstrap framework will be instantiated via Emacs and Org-Mode.
> 
> I'm quite fustrated because the org-export_generic.el file is obsolete and
> I tried to use ox.el ox-ascii.el files but I was discouraged by their heavy
> contents.
> 
> Could you please tell how to easily find a good starting "point" ?

You could take a look at ox-md.el; it derives from ox-html.el.  Since
you want to add to ox-html.el, that might be a nice starting point.

Needless to say, you should probably wait for Nicolas's comment.  He is
the expert, I'm just a user who looks at the source from time to time
;).

GL

-- 
Suvayu

Open source is the future. It sets us free.

Re: How to easily create a new export engine...

[Nicolas Goaziou]

Hello,

Suvayu Ali <fatkasuvayu+linux@gmail.com> writes:

> On Tue, Sep 03, 2013 at 03:37:05PM +0200, flammable project wrote:
>> Hi all,
>> 
>> I'm looking for informations on how to create a new exporter based on the
>> new export engine.
>> 
>> I want to convert org files into HTML files in which some "functions" from
>> Twitter Bootstrap framework will be instantiated via Emacs and Org-Mode.
>> 
>> I'm quite fustrated because the org-export_generic.el file is obsolete and
>> I tried to use ox.el ox-ascii.el files but I was discouraged by their heavy
>> contents.
>> 
>> Could you please tell how to easily find a good starting "point" ?
>
> You could take a look at ox-md.el; it derives from ox-html.el.  Since
> you want to add to ox-html.el, that might be a nice starting point.
>
> Needless to say, you should probably wait for Nicolas's comment.  He is
> the expert, I'm just a user who looks at the source from time to time
> ;).

The OP could also look at "12.13 Advanced configuration" from Org
manual. There's an example on how to extend an existing back-end.

There's also `org-export-define-derived-backend' docstring.

If the new exporter is not meant for public consumption and would always
be used instead of regular html back-end, defadvices are also fine.


Regards,

-- 
Nicolas Goaziou

Re: How to easily create a new export engine...

[flammable project]

[-- Attachment #1: Type: text/plain, Size: 1984 bytes --]

Thanks Nocolas and Suvayu,


I will spend some time on ox-md.el and the section listed by Nicolas.

One last question:
If I choose to extend the existing back-end, would I be able to put all the
code into a external file and allow the user to load it through it emacs
config file?
I mean, I would like to add a support of Twitter Bootstrap trough the
ox-html.el export engine. If the user add "(require 'ox-html-bootstrap)"
into its ".emacs" file, it will allow the user to extend the ox-html export
engine.
Does it seems possible?

Thanks






2013/9/3 Nicolas Goaziou <n.goaziou@gmail.com>

> Hello,
>
> Suvayu Ali <fatkasuvayu+linux@gmail.com> writes:
>
> > On Tue, Sep 03, 2013 at 03:37:05PM +0200, flammable project wrote:
> >> Hi all,
> >>
> >> I'm looking for informations on how to create a new exporter based on
> the
> >> new export engine.
> >>
> >> I want to convert org files into HTML files in which some "functions"
> from
> >> Twitter Bootstrap framework will be instantiated via Emacs and Org-Mode.
> >>
> >> I'm quite fustrated because the org-export_generic.el file is obsolete
> and
> >> I tried to use ox.el ox-ascii.el files but I was discouraged by their
> heavy
> >> contents.
> >>
> >> Could you please tell how to easily find a good starting "point" ?
> >
> > You could take a look at ox-md.el; it derives from ox-html.el.  Since
> > you want to add to ox-html.el, that might be a nice starting point.
> >
> > Needless to say, you should probably wait for Nicolas's comment.  He is
> > the expert, I'm just a user who looks at the source from time to time
> > ;).
>
> The OP could also look at "12.13 Advanced configuration" from Org
> manual. There's an example on how to extend an existing back-end.
>
> There's also `org-export-define-derived-backend' docstring.
>
> If the new exporter is not meant for public consumption and would always
> be used instead of regular html back-end, defadvices are also fine.
>
>
> Regards,
>
> --
> Nicolas Goaziou
>
>

[-- Attachment #2: Type: text/html, Size: 4000 bytes --]

Re: How to easily create a new export engine...

[Rasmus]

Hi,

flammable project <flammable.project@gmail.com> writes:

> I will spend some time on ox-md.el and the section listed by Nicolas.
>
> One last question:
> If I choose to extend the existing back-end, would I be able to put all the
> code into a external file and allow the user to load it through it emacs
> config file?

Yes.  Just make NAME.el and end the file by providing NAME (provide
'NAME).

> I mean, I would like to add a support of Twitter Bootstrap trough the
> ox-html.el export engine. If the user add "(require 'ox-html-bootstrap)"
> into its ".emacs" file, it will allow the user to extend the ox-html export
> engine.
> Does it seems possible?

Yeah, that's possible with the derived backend.  Indeed, that would
seem like on of the main usages.  In the simplest case you'd just add
an option to export dispatcher and people would have to select it when
they want to use twitter bootstrap (whatever that is. . .).

–Rasmus

-- 
In theory, practice and theory are the same. In practice they are not

Re: How to easily create a new export engine...

[Eric Abrahamsen]

flammable project <flammable.project@gmail.com> writes:

> Thanks Nocolas and Suvayu,
>
>
> I will spend some time on ox-md.el and the section listed by Nicolas.
>
> One last question:
> If I choose to extend the existing back-end, would I be able to put
> all the code into a external file and allow the user to load it
> through it emacs config file? 
> I mean, I would like to add a support of Twitter Bootstrap trough the
> ox-html.el export engine. If the user add "(require
> 'ox-html-bootstrap)" into its ".emacs" file, it will allow the user
> to extend the ox-html export engine.
> Does it seems possible?

The trick here is that your file calls (require 'ox-html) at the top
(maybe requiring org itself is a good idea), and (provide 'ox-bootstrap)
at the bottom.

When writing your mode, you've required ox-html at the top, so in the
rest of the file you can override or build on the ox-html functions, and
at the bottom you provide users with everything you've done. When users
require your module, they will then require everything you've required,
thus loading the whole chain of dependencies that are necessary for your
module. They can go from zero to having all of org mode loaded, simply
by requiring your file. Provided you've required all the necessary
modules, of course!

E