From: Eric Abrahamsen <eric@ericabrahamsen.net>
To: emacs-orgmode@gnu.org
Subject: Re: setting local variables
Date: Thu, 03 Aug 2017 17:42:10 -0700 [thread overview]
Message-ID: <87y3r0go4d.fsf@ericabrahamsen.net> (raw)
In-Reply-To: 87wp6kxo50.fsf@ericabrahamsen.net
Eric Abrahamsen <eric@ericabrahamsen.net> writes:
> Nicolas Goaziou <mail@nicolasgoaziou.fr> writes:
>
>> Eric Abrahamsen <eric@ericabrahamsen.net> writes:
>>
>>> Oh I don't think it's about shortcomings, just about having a version
>>> that's tweaked specifically for writing Emacs manuals. I _really_ want
>>> my packages to have info manuals, and I _really_ don't want to learn how
>>> to write texinfo. I saw Rasmus' Org manual in org, and it looked like a
>>> lot of work. Then I noticed that the Magit manuals used this
>>> texinfo-plus thing, and it seemed good enough.
>>
>> I think "ox-texinfo" is (almost) able to write Emacs manuals.
>>
>> IMO, you are comparing oranges and apples. Org's manual is historically
>> written as a (very convoluted) pure Texinfo document, with many macros
>> and different authors. Trying to convert it to Org for an Org to Texinfo
>> process is bound to be painful. OTOH, Magit's manual is probably more
>> straightforward, i.e., written as an Org document from the beginning,
>> with simpler requirements.
>>
>> In both cases, you cannot eschew learning a bit of Texinfo, if only for
>> the various indices commands and the installation part in the Info
>> directory.
>
> Well, I'll admit laziness has been my major motivation throughout the
> whole process.
>
>>> I think what might be nice would be to have another exporter, derived
>>> from ox-texinfo, specifically for writing Emacs manuals, that helps
>>> authors conform to the Emacs manual conventions. The way texinfo-plus
>>> handles lists of keybindings/user options/etc is nice, and it appears to
>>> set up the indexes for you, you only have to add concept index entries
>>> manually.
>>
>> AFAIU, the way texinfo-plus handles lists of ... is certainly nice, but
>> it's unrelated to Emacs manual conventions. It helps authors conform
>> Magit's author conventions. Those are fine, but I'm pretty sure not all
>> Emacs manuals follow them (Org doesn't, obviously).
>
> The main thing I was after was semi-automated indexing (obviously some
> of it you have to do yourself). I just looked more closely at the texi
> output that texinfo-plus produced, and it seems to only be doing concept
> and key indexing, not function or variable indexing. So that's not as
> helpful as I thought.
And regarding the lists of commands and keys, what would be the
recommended way of making a list of @deffns and corresponding index
entries? Perhaps it would be enough to expand the example document in
the texinfo section of the Org manual.
Eric
next prev parent reply other threads:[~2017-08-04 0:43 UTC|newest]
Thread overview: 37+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-08-02 21:53 setting local variables Eric Abrahamsen
2017-08-02 22:10 ` Kaushal Modi
2017-08-02 22:15 ` Eric Abrahamsen
2017-08-03 10:52 ` Nicolas Goaziou
2017-08-03 16:11 ` Eric Abrahamsen
2017-08-03 22:02 ` Nicolas Goaziou
2017-08-03 22:49 ` Eric Abrahamsen
2017-08-04 0:42 ` Eric Abrahamsen [this message]
2017-08-04 15:37 ` Nicolas Goaziou
2017-08-05 1:06 ` Eric Abrahamsen
2017-08-05 8:50 ` Nicolas Goaziou
2017-08-05 19:14 ` Eric Abrahamsen
2017-09-05 11:48 ` Rasmus
2017-09-05 16:57 ` Eric Abrahamsen
2017-09-06 8:56 ` Rasmus
2017-09-06 10:38 ` Nicolas Goaziou
2017-09-06 12:42 ` Rasmus
2017-09-06 13:08 ` Nicolas Goaziou
2017-09-06 16:33 ` Eric Abrahamsen
2017-09-06 16:57 ` Nicolas Goaziou
2017-09-06 17:44 ` Eric Abrahamsen
2017-09-07 8:56 ` Rasmus
2017-09-07 12:48 ` Nicolas Goaziou
2017-09-07 15:01 ` Eric Abrahamsen
2017-09-10 13:55 ` Nicolas Goaziou
2017-09-20 16:17 ` Carsten Dominik
2017-09-20 18:42 ` Scott Randby
2017-09-20 23:16 ` Kaushal Modi
2017-09-21 8:38 ` Carsten Dominik
2017-09-21 9:39 ` Rasmus
2017-09-21 9:58 ` Carsten Dominik
2017-09-21 19:21 ` Nicolas Goaziou
2017-09-21 21:25 ` Kaushal Modi
2017-09-22 7:22 ` Carsten Dominik
2017-09-22 9:09 ` Rasmus
2017-09-21 13:00 ` Scott Randby
2017-09-21 7:45 ` Eric S Fraga
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:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87y3r0go4d.fsf@ericabrahamsen.net \
--to=eric@ericabrahamsen.net \
--cc=emacs-orgmode@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* 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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.