emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* [new exporter][texinfo] Macro definition section
@ 2012-11-11 20:22 Thomas S. Dye
  2012-11-12 14:57 ` Jonathan Leech-Pepin
  2012-11-12 14:58 ` Jonathan Leech-Pepin
  0 siblings, 2 replies; 6+ messages in thread
From: Thomas S. Dye @ 2012-11-11 20:22 UTC (permalink / raw)
  To: Org-mode

Aloha all,

The texinfo source for the Org manual has a number of macro definitions
for commands and keys between the end of the header (@finalout) and the
beginning of the Copying section.

The texinfo back-end for the new exporter doesn't have a slot here and
I'm wondering if it needs one?  

All the best,
Tom
-- 
T.S. Dye & Colleagues, Archaeologists
735 Bishop St, Suite 315, Honolulu, HI 96813
Tel: 808-529-0866, Fax: 808-529-0884
http://www.tsdye.com

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [new exporter][texinfo] Macro definition section
  2012-11-11 20:22 [new exporter][texinfo] Macro definition section Thomas S. Dye
@ 2012-11-12 14:57 ` Jonathan Leech-Pepin
  2012-11-12 14:58 ` Jonathan Leech-Pepin
  1 sibling, 0 replies; 6+ messages in thread
From: Jonathan Leech-Pepin @ 2012-11-12 14:57 UTC (permalink / raw)
  To: Thomas S. Dye; +Cc: Org-mode

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

Hello,

On 11 November 2012 15:22, Thomas S. Dye <tsd@tsdye.com> wrote:

> Aloha all,
>
> The texinfo source for the Org manual has a number of macro definitions
> for commands and keys between the end of the header (@finalout) and the
> beginning of the Copying section.
>
> The texinfo back-end for the new exporter doesn't have a slot here and
> I'm wondering if it needs one?
>
>



> All the best,
> Tom
> --
> T.S. Dye & Colleagues, Archaeologists
> 735 Bishop St, Suite 315, Honolulu, HI 96813
> Tel: 808-529-0866, Fax: 808-529-0884
> http://www.tsdye.com
>
>

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

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [new exporter][texinfo] Macro definition section
  2012-11-11 20:22 [new exporter][texinfo] Macro definition section Thomas S. Dye
  2012-11-12 14:57 ` Jonathan Leech-Pepin
@ 2012-11-12 14:58 ` Jonathan Leech-Pepin
  2012-11-12 18:03   ` Thomas S. Dye
  1 sibling, 1 reply; 6+ messages in thread
From: Jonathan Leech-Pepin @ 2012-11-12 14:58 UTC (permalink / raw)
  To: Thomas S. Dye; +Cc: Org-mode

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

Hello,  (helps if I hit paste before hitting send)

On 11 November 2012 15:22, Thomas S. Dye <tsd@tsdye.com> wrote:

> Aloha all,
>
> The texinfo source for the Org manual has a number of macro definitions
> for commands and keys between the end of the header (@finalout) and the
> beginning of the Copying section.
>
> The texinfo back-end for the new exporter doesn't have a slot here and
> I'm wondering if it needs one?
>
>
I believe I accounted for most of the special strings that are
directly transcoded in texinfo.  There may be some that are missing,
however they can be added directly in the document using the
=@@info:<texinfo command>@@= syntax (inline export snippets).

Are there any particular pieces of synxtax that you believe would be
useful to have added to org-entities that would also be useful in
other backends?


> All the best,
> Tom
> --
> T.S. Dye & Colleagues, Archaeologists
> 735 Bishop St, Suite 315, Honolulu, HI 96813
> Tel: 808-529-0866, Fax: 808-529-0884
> http://www.tsdye.com
>
>
Regards,

--
Jon

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

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [new exporter][texinfo] Macro definition section
  2012-11-12 14:58 ` Jonathan Leech-Pepin
@ 2012-11-12 18:03   ` Thomas S. Dye
  2012-11-12 18:39     ` Jonathan Leech-Pepin
  2012-11-12 22:52     ` François Pinard
  0 siblings, 2 replies; 6+ messages in thread
From: Thomas S. Dye @ 2012-11-12 18:03 UTC (permalink / raw)
  To: Jonathan Leech-Pepin; +Cc: Org-mode

Aloha Jon,

I'm working on an Org version of the Org manual that (hopefully) can be
used to generate the required texinfo version.

My goal at this point is to export a document that matches org.texi.

My problem is not with the macro definitions, which can be wrapped as
you point out.  It is with their placement in org.texi between @finalout
and @copying.  IIUC, this should happen around line 670 of
org-e-texinfo.el, but the code seems to expect that there are two blank
lines between these commands and no macro definitions or other material.

In view of my goal, it would be nice to have something like
#+TEXINFO_POST_HEADER that would pass the macro definitions through to
this location in the texinfo document.

All the best,
Tom


Jonathan Leech-Pepin <jonathan.leechpepin@gmail.com> writes:

> Hello,  (helps if I hit paste before hitting send)
>
> On 11 November 2012 15:22, Thomas S. Dye <tsd@tsdye.com> wrote:
>
>> Aloha all,
>>
>> The texinfo source for the Org manual has a number of macro definitions
>> for commands and keys between the end of the header (@finalout) and the
>> beginning of the Copying section.
>>
>> The texinfo back-end for the new exporter doesn't have a slot here and
>> I'm wondering if it needs one?
>>
>>
> I believe I accounted for most of the special strings that are
> directly transcoded in texinfo.  There may be some that are missing,
> however they can be added directly in the document using the
> =@@info:<texinfo command>@@= syntax (inline export snippets).
>
> Are there any particular pieces of synxtax that you believe would be
> useful to have added to org-entities that would also be useful in
> other backends?
>
>
>> All the best,
>> Tom
>> --
>> T.S. Dye & Colleagues, Archaeologists
>> 735 Bishop St, Suite 315, Honolulu, HI 96813
>> Tel: 808-529-0866, Fax: 808-529-0884
>> http://www.tsdye.com
>>
>>
> Regards,
>
> --
> Jon
> Hello,  (helps if I hit paste before hitting send)
>
> On 11 November 2012 15:22, Thomas S. Dye <tsd@tsdye.com> wrote:
>
>     Aloha all,
>     
>     The texinfo source for the Org manual has a number of macro
>     definitions
>     for commands and keys between the end of the header (@finalout)
>     and the
>     beginning of the Copying section.
>     
>     The texinfo back-end for the new exporter doesn't have a slot here
>     and
>     I'm wondering if it needs one?
>     
>     
>
> I believe I accounted for most of the special strings that are
> directly transcoded in texinfo.  There may be some that are missing,
> however they can be added directly in the document using the
> =@@info:<texinfo command>@@= syntax (inline export snippets).
>
> Are there any particular pieces of synxtax that you believe would be
> useful to have added to org-entities that would also be useful in
> other backends?
>  
>
>     All the best,
>     Tom
>     --
>     T.S. Dye & Colleagues, Archaeologists
>     735 Bishop St, Suite 315, Honolulu, HI 96813
>     Tel: 808-529-0866, Fax: 808-529-0884
>     http://www.tsdye.com
>     
>     
>
> Regards,
>
> --
> Jon

-- 
Thomas S. Dye
http://www.tsdye.com

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [new exporter][texinfo] Macro definition section
  2012-11-12 18:03   ` Thomas S. Dye
@ 2012-11-12 18:39     ` Jonathan Leech-Pepin
  2012-11-12 22:52     ` François Pinard
  1 sibling, 0 replies; 6+ messages in thread
From: Jonathan Leech-Pepin @ 2012-11-12 18:39 UTC (permalink / raw)
  To: Thomas S. Dye; +Cc: Org-mode

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

Hello Tom

On 12 November 2012 13:03, Thomas S. Dye <tsd@tsdye.com> wrote:

> Aloha Jon,
>
> I'm working on an Org version of the Org manual that (hopefully) can be
> used to generate the required texinfo version.
>
> My goal at this point is to export a document that matches org.texi.
>

Do you want it to match org.texi exactly?  Or that the generated info
document end up matching?


> My problem is not with the macro definitions, which can be wrapped as
> you point out.  It is with their placement in org.texi between @finalout
> and @copying.  IIUC, this should happen around line 670 of
> org-e-texinfo.el, but the code seems to expect that there are two blank
> lines between these commands and no macro definitions or other material.
>

I didn't mean wrapping the macro definitions themselves.  I meant
replacing the macro definitions with equivalent Org macros.

For example the =orgcmd{key,command}= macro could be replaced with
something like (ommiting the ifset and iftex logic):

#+MACRO: tkbd @@info:@kbd{@@$1@@info:}@@
#+MACRO: tcode @@info:@code{@@$1@@info:}@@
#+MACRO: tkindex @@info:@kindex $1@@
#+MACRO: tfindex @@info:@findex $1@@

# - instead of @item since items are list elements
#+MACRO: orgcmd {{{tkindex($1)}}}\\{{{tfindex($2)}}}\\- {{{tkbd($1)}}}
{{{tcode($2)}}}

And you could them use {{{orgcmd(C-c C-r,org-reveal)}}} (org.texi line
1316).  It would also then be backend agnostic, since non-texinfo
exporters would be read the line as:

- $1      $2

Would that work for your needs?  Or would you rather still be able to
generate the macros themselves for use on export?


> In view of my goal, it would be nice to have something like
> #+TEXINFO_POST_HEADER that would pass the macro definitions through to
> this location in the texinfo document.
>
> All the best,
> Tom
>
>
Regards,

--
Jon

>
> Jonathan Leech-Pepin <jonathan.leechpepin@gmail.com> writes:
>
> > Hello,  (helps if I hit paste before hitting send)
> >
> > On 11 November 2012 15:22, Thomas S. Dye <tsd@tsdye.com> wrote:
> >
> >> Aloha all,
> >>
> >> The texinfo source for the Org manual has a number of macro definitions
> >> for commands and keys between the end of the header (@finalout) and the
> >> beginning of the Copying section.
> >>
> >> The texinfo back-end for the new exporter doesn't have a slot here and
> >> I'm wondering if it needs one?
> >>
> >>
> > I believe I accounted for most of the special strings that are
> > directly transcoded in texinfo.  There may be some that are missing,
> > however they can be added directly in the document using the
> > =@@info:<texinfo command>@@= syntax (inline export snippets).
> >
> > Are there any particular pieces of synxtax that you believe would be
> > useful to have added to org-entities that would also be useful in
> > other backends?
> >
> >
> >> All the best,
> >> Tom
> >> --
> >> T.S. Dye & Colleagues, Archaeologists
> >> 735 Bishop St, Suite 315, Honolulu, HI 96813
> >> Tel: 808-529-0866, Fax: 808-529-0884
> >> http://www.tsdye.com
> >>
> >>
> > Regards,
> >
> > --
> > Jon
> > Hello,  (helps if I hit paste before hitting send)
> >
> > On 11 November 2012 15:22, Thomas S. Dye <tsd@tsdye.com> wrote:
> >
> >     Aloha all,
> >
> >     The texinfo source for the Org manual has a number of macro
> >     definitions
> >     for commands and keys between the end of the header (@finalout)
> >     and the
> >     beginning of the Copying section.
> >
> >     The texinfo back-end for the new exporter doesn't have a slot here
> >     and
> >     I'm wondering if it needs one?
> >
> >
> >
> > I believe I accounted for most of the special strings that are
> > directly transcoded in texinfo.  There may be some that are missing,
> > however they can be added directly in the document using the
> > =@@info:<texinfo command>@@= syntax (inline export snippets).
> >
> > Are there any particular pieces of synxtax that you believe would be
> > useful to have added to org-entities that would also be useful in
> > other backends?
> >
> >
> >     All the best,
> >     Tom
> >     --
> >     T.S. Dye & Colleagues, Archaeologists
> >     735 Bishop St, Suite 315, Honolulu, HI 96813
> >     Tel: 808-529-0866, Fax: 808-529-0884
> >     http://www.tsdye.com
> >
> >
> >
> > Regards,
> >
> > --
> > Jon
>
> --
> Thomas S. Dye
> http://www.tsdye.com
>

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

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [new exporter][texinfo] Macro definition section
  2012-11-12 18:03   ` Thomas S. Dye
  2012-11-12 18:39     ` Jonathan Leech-Pepin
@ 2012-11-12 22:52     ` François Pinard
  1 sibling, 0 replies; 6+ messages in thread
From: François Pinard @ 2012-11-12 22:52 UTC (permalink / raw)
  To: emacs-orgmode

tsd@tsdye.com (Thomas S. Dye) writes:

> My goal at this point is to export a document that matches org.texi.

So nice! :-)

I guess I would be much happy myself if I could use Org rather than
Texinfo for some of my own documents.  Thanks to all involved! :-)

François

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2012-11-12 22:52 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2012-11-11 20:22 [new exporter][texinfo] Macro definition section Thomas S. Dye
2012-11-12 14:57 ` Jonathan Leech-Pepin
2012-11-12 14:58 ` Jonathan Leech-Pepin
2012-11-12 18:03   ` Thomas S. Dye
2012-11-12 18:39     ` Jonathan Leech-Pepin
2012-11-12 22:52     ` François Pinard

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).