emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* Hopes of making orgmanual.org the official manual?
@ 2017-01-12 18:58 Kaushal Modi
  2017-01-12 19:51 ` Nicolas Goaziou
  2017-01-12 20:15 ` Eric Abrahamsen
  0 siblings, 2 replies; 6+ messages in thread
From: Kaushal Modi @ 2017-01-12 18:58 UTC (permalink / raw)
  To: emacs-org list, Bastien Guerry

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

Hello all,

Are there plans to have the orgmanual.org (
http://orgmode.org/cgit.cgi/org-mode.git/tree/contrib/orgmanual.org)
completely replace the texinfo version at some point?

I believe that orgmanual.org was synchronized with the texinfo version when
it was checked in. But I fear that if this switching to org manual step is
delayed, there might not be enough motivation to keep orgmanual.org
maintained.

-- 

Kaushal Modi

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

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

* Re: Hopes of making orgmanual.org the official manual?
  2017-01-12 18:58 Hopes of making orgmanual.org the official manual? Kaushal Modi
@ 2017-01-12 19:51 ` Nicolas Goaziou
  2017-01-12 20:39   ` Nicolas Goaziou
  2017-01-12 20:15 ` Eric Abrahamsen
  1 sibling, 1 reply; 6+ messages in thread
From: Nicolas Goaziou @ 2017-01-12 19:51 UTC (permalink / raw)
  To: Kaushal Modi; +Cc: Bastien Guerry, emacs-org list

Hello,

Kaushal Modi <kaushal.modi@gmail.com> writes:

> Are there plans to have the orgmanual.org (
> http://orgmode.org/cgit.cgi/org-mode.git/tree/contrib/orgmanual.org)
> completely replace the texinfo version at some point?

The first step is to have orgmanual.org generate org.texi. We're not
there yet because there is no 1:1 correspondence between constructs used
in org.texi and Org syntax.

> I believe that orgmanual.org was synchronized with the texinfo version
> when it was checked in.

No, it wasn't even compiling when it landed in contrib/. Now, it exports
correctly. The process is slow, though, due to the sheer number of
macros (900+) and some code blocks at the end that can be removed.

> But I fear that if this switching to org manual step is
> delayed, there might not be enough motivation to keep orgmanual.org
> maintained.

Note that orgmanual.org is not maintained so far. A starting point would
be to try to update a small part of the manual and report what is
missing in "ox-texinfo.el".

As a side note, I think we could use some free (i.e., noop in
"ox-texinfo.el") emphasis markers, e.g. "+...+", for additional syntax,
e.g., @key{...}, or @kbd{...}.

Regards,

-- 
Nicolas Goaziou

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

* Re: Hopes of making orgmanual.org the official manual?
  2017-01-12 18:58 Hopes of making orgmanual.org the official manual? Kaushal Modi
  2017-01-12 19:51 ` Nicolas Goaziou
@ 2017-01-12 20:15 ` Eric Abrahamsen
  2017-01-12 20:21   ` Nicolas Goaziou
  1 sibling, 1 reply; 6+ messages in thread
From: Eric Abrahamsen @ 2017-01-12 20:15 UTC (permalink / raw)
  To: emacs-orgmode

Kaushal Modi <kaushal.modi@gmail.com> writes:

> Hello all,
>
> Are there plans to have the orgmanual.org
> (http://orgmode.org/cgit.cgi/org-mode.git/tree/contrib/orgmanual.org)
> completely replace the texinfo version at some point?
>
> I believe that orgmanual.org was synchronized with the texinfo version
> when it was checked in. But I fear that if this switching to org
> manual step is delayed, there might not be enough motivation to keep
> orgmanual.org maintained.

I must be missing something -- is there a SETUPFILE that's necessary to
make this work? Where are all the macros defined?

Thanks,
Eric

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

* Re: Hopes of making orgmanual.org the official manual?
  2017-01-12 20:15 ` Eric Abrahamsen
@ 2017-01-12 20:21   ` Nicolas Goaziou
  2017-01-12 20:25     ` Eric Abrahamsen
  0 siblings, 1 reply; 6+ messages in thread
From: Nicolas Goaziou @ 2017-01-12 20:21 UTC (permalink / raw)
  To: Eric Abrahamsen; +Cc: emacs-orgmode

Hello,

Eric Abrahamsen <eric@ericabrahamsen.net> writes:

> Kaushal Modi <kaushal.modi@gmail.com> writes:
>
>> Hello all,
>>
>> Are there plans to have the orgmanual.org
>> (http://orgmode.org/cgit.cgi/org-mode.git/tree/contrib/orgmanual.org)
>> completely replace the texinfo version at some point?
>>
>> I believe that orgmanual.org was synchronized with the texinfo version
>> when it was checked in. But I fear that if this switching to org
>> manual step is delayed, there might not be enough motivation to keep
>> orgmanual.org maintained.
>
> I must be missing something -- is there a SETUPFILE that's necessary to
> make this work? Where are all the macros defined?

Everything is in the headlines tagged with :noexport: at the end of the document.

Regards,

-- 
Nicolas Goaziou

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

* Re: Hopes of making orgmanual.org the official manual?
  2017-01-12 20:21   ` Nicolas Goaziou
@ 2017-01-12 20:25     ` Eric Abrahamsen
  0 siblings, 0 replies; 6+ messages in thread
From: Eric Abrahamsen @ 2017-01-12 20:25 UTC (permalink / raw)
  To: Nicolas Goaziou; +Cc: emacs-orgmode


On 01/12/17 21:21 PM, Nicolas Goaziou wrote:
> Hello,
>
> Eric Abrahamsen <eric@ericabrahamsen.net> writes:
>
>> Kaushal Modi <kaushal.modi@gmail.com> writes:
>>
>>> Hello all,
>>>
>>> Are there plans to have the orgmanual.org
>>> (http://orgmode.org/cgit.cgi/org-mode.git/tree/contrib/orgmanual.org)
>>> completely replace the texinfo version at some point?
>>>
>>> I believe that orgmanual.org was synchronized with the texinfo version
>>> when it was checked in. But I fear that if this switching to org
>>> manual step is delayed, there might not be enough motivation to keep
>>> orgmanual.org maintained.
>>
>> I must be missing something -- is there a SETUPFILE that's necessary to
>> make this work? Where are all the macros defined?
>
> Everything is in the headlines tagged with :noexport: at the end of the document.

Right you are! Sorry about that.

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

* Re: Hopes of making orgmanual.org the official manual?
  2017-01-12 19:51 ` Nicolas Goaziou
@ 2017-01-12 20:39   ` Nicolas Goaziou
  0 siblings, 0 replies; 6+ messages in thread
From: Nicolas Goaziou @ 2017-01-12 20:39 UTC (permalink / raw)
  To: Kaushal Modi; +Cc: Bastien Guerry, emacs-org list

Correcting myself,

Nicolas Goaziou <mail@nicolasgoaziou.fr> writes:

> The process is slow, though, due to the sheer number of macros (900+)

There are exactly 2050 macros at the moment. I was wide of the mark.

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

end of thread, other threads:[~2017-01-12 20:39 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-01-12 18:58 Hopes of making orgmanual.org the official manual? Kaushal Modi
2017-01-12 19:51 ` Nicolas Goaziou
2017-01-12 20:39   ` Nicolas Goaziou
2017-01-12 20:15 ` Eric Abrahamsen
2017-01-12 20:21   ` Nicolas Goaziou
2017-01-12 20:25     ` Eric Abrahamsen

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).