emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Ihor Radchenko <yantar92@gmail.com>
To: rms@gnu.org
Cc: eliz@gnu.org,  theophilusx@gmail.com,  monnier@iro.umontreal.ca,
	acm@muc.de,  emacs-devel@gnu.org, emacs-orgmode@gnu.org
Subject: Re: Org mode and Emacs (was: Convert README.org to plain text README while installing package)
Date: Tue, 14 Jun 2022 08:43:18 +0800	[thread overview]
Message-ID: <87czfcm5w9.fsf@localhost> (raw)
In-Reply-To: <E1o0sgC-0000jg-U3@fencepost.gnu.org>

I am CCing Org ML from now signifying that this branch of the thread is
directly relevent to Org mode and might be of interest for other Org

Richard Stallman <rms@gnu.org> writes:

>   > So, now we have our manual written in Org mode and we never had reasons
>   > to come back to texi.
> I suspect that it doesn't fully follow the markup conventions
> for GNU manuals.  That's because we designed Texinfo to have markup commands
> to make all the proper semantic distinctions.  If the manual source
> is written in a language which doesn't have the full gamut of markup
> distinctions, there is no way to do the markup correctly.
> It would be useful for someone who understands these conventions
> to check the Org manual and see.

Yes, it would certainly help!
The work on manual has been done a long time ago and we also extended
our texinfo exported to suit the manual at that time. Assumingly, just
enough to handle the Org manual use-cases.

Note that we have doc/Documentation_Standards.org explaining some of the

Here is a possibly relevant note inside it:

 - Only two of the standard Texinfo indexes are used; those for
   concepts and keys.  This has some implications:

   + The preference is to document commands by key rather than by name

   + Texinfo commands such as @var and @defoption are not used.  The
     preference for this type of thing is that the user browses the
     customize groups.  If you want or need to refer to, say, a
     variable then document it as "the variable
   + Entries in the concept index are normally all lower case unless
     some other rule dictates otherwise.

Without knowing texinfo, the above paragraphs do not make a whole lot of
sense for me. So, if someone points out any omissions, it would be
helpful for future Org contributors.

> I don't think the slowness of processing nowadays is the crucial issue
> here.  Computers are much faster now than in the 1990s.  It used
> to take a long time for TeX to process the Emacs Lisp Reference Manual.
> Now it is perhaps 10 times as fast.

Generally, there is no way Org export to .info gets any faster than
texinfo. Org is only able to export to other text formats: org->texi;
org->tex; org->html; etc. Convertion to more low-level formats is left
to the external tools like texinfo and pdflatex.

As for reports on the slow performance, they are still useful as long as
they reveal some bottlenecks in Org exporter. Org is being used to
export large documents and whole websites. Hence, improving performance
in this area is generally helpful, even if it is not strictly a critical
blocking issue.

What I want to say is: do not expect Org export to be faster than native
binary tools, but do not hesitate to report performance issues either.


       reply	other threads:[~2022-06-14  0:45 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <YpuV9DKe9kzNt5np@ACM>
     [not found] ` <871qw31ois.fsf@yahoo.com>
     [not found]   ` <8735gj4ceo.fsf@gnu.org>
     [not found]     ` <87ee038ipt.fsf@gmx.de>
     [not found]       ` <87o7z61v59.fsf@gmail.com>
     [not found]         ` <Yp3l+rjJ0mAIcVZJ@ACM>
     [not found]           ` <87bkv527p5.fsf@gmail.com>
     [not found]             ` <835yld93w7.fsf@gnu.org>
     [not found]               ` <877d5t0yrn.fsf@gmail.com>
     [not found]                 ` <Yp92eI2pEuc/gQu4@ACM>
     [not found]                   ` <jwvtu8wbbjb.fsf-monnier+emacs@gnu.org>
     [not found]                     ` <87r140yuof.fsf@gmail.com>
     [not found]                       ` <E1nzQh5-0001OB-22@fencepost.gnu.org>
     [not found]                         ` <875yl9e7zm.fsf@gmail.com>
     [not found]                           ` <83czfh12kp.fsf@gnu.org>
     [not found]                             ` <87pmjhghu2.fsf@localhost>
     [not found]                               ` <835yl910gp.fsf@gnu.org>
     [not found]                                 ` <87wndndbhq.fsf@gmail.com>
     [not found]                                   ` <83bkuzznws.fsf@gnu.org>
     [not found]                                     ` <877d5mqmkh.fsf@localhost>
     [not found]                                       ` <E1o0sgC-0000jg-U3@fencepost.gnu.org>
2022-06-14  0:43                                         ` Ihor Radchenko [this message]
2022-06-15  5:58                                           ` Org mode and Emacs (was: Convert README.org to plain text README while installing package) Ihor Radchenko
2022-06-16 10:05                                             ` Tom Gillespie
2022-06-18 10:56                                               ` Simplified Org mode for newcomer Emacs veterans (was: Org mode and Emacs (was: Convert README.org to plain text README while installing package)) Ihor Radchenko
2022-06-18 22:04                                                 ` Tim Cross
2022-06-19  8:49                                                   ` Ihor Radchenko
2022-06-17  6:42                                             ` Org syntax compatibility with texinfo syntax " Ihor Radchenko
     [not found]                                   ` <E1o0Bgv-0008SK-Gs@fencepost.gnu.org>
     [not found]                                     ` <874k0qbrhe.fsf@localhost>
     [not found]                                       ` <E1o0WEH-0004wk-Hw@fencepost.gnu.org>
     [not found]                                         ` <87v8t3wfgd.fsf@localhost>
     [not found]                                           ` <87zgifxt48.fsf@gmail.com>
2022-06-15  6:13                                             ` Cusom special block export, similar org org-link :export parameter (was: Org mode and Emacs) Ihor Radchenko

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87czfcm5w9.fsf@localhost \
    --to=yantar92@gmail.com \
    --cc=acm@muc.de \
    --cc=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=emacs-orgmode@gnu.org \
    --cc=monnier@iro.umontreal.ca \
    --cc=rms@gnu.org \
    --cc=theophilusx@gmail.com \


* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox


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