emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Jonathan Leech-Pepin <jonathan.leechpepin@gmail.com>
To: Rasmus <rasmus@gmx.us>, emacs-orgmode@gnu.org
Subject: Re: template for writing Emacs manuals in Org
Date: Wed, 18 May 2016 10:56:02 -0400	[thread overview]
Message-ID: <4BDEAAA9-55A2-4886-80E1-ECF273D4C7E1@gmail.com> (raw)
In-Reply-To: <87oa83afi5.fsf@gmx.us>

Hi,

On May 18, 2016 5:21:06 AM EDT, Rasmus <rasmus@gmx.us> wrote:
>Hi,
>
>Nick Dokos <ndokos@gmail.com> writes:
>
>> I believe the main obstacle is that the emacs policy requires a
>texinfo
>> manual for all its component parts.
>
>What is the "component parts"?  I couldn't find the definition.
>
>>  If that can be generated automatically from the org document, then
>any
>> objections probably disappear. Of course, Bastien might object to the
>> extra effort required to do the conversion, but if the conversion is
>> indeed completely automatic (or, perhaps more likely, a volunteer can
>be
>> found to take care of the conversion and any problems that might
>arise),
>> then he might be amenable to it. But it would be an extra step
>required
>> at release time and would require some coordination.
>
>My issue is all the damn macros.  While it displays the flexibility of
>Org, it also makes Org-for-texinfo-manuals less appealing.  I don’t
>want
>to learn new mini documentation language for each manual I might send
>patches to.
>
>Maybe a "Library-of-Macros" would go some of the way of at least making
>it
>feel less ad-hoc?
>
>Another annoyance.  When I see something like the an index right after
>a
>headline, I really would like to put the index into the properties
>drawer:
>
>     ** Installation
>        :PROPERTIES:
>        :DESCRIPTION: How to install a downloaded version of Org-mode
>        :END:
>
>     {{{cindex(installation)}}}
>

I’m trying to remember why I didn’t implement indexes as properties (it may well have been because I simply didn’t consider it).  Assuming there’s nothing in the exporter to prevent converting properties to text after headlines it could work. Treat comma separated values as separate entries.

Then using the macro would only be needed if indexing at content rather than at a headline (use lower level headlines that do not become nodes and it could still work).

>Aside: I’ve been wanting a drawer property for inserting text just
>before
>headings (and maybe just after headings) for a while, e.g.
>
>         EXPORT_BACKEND_{BEFORE, AFTER}, or
>         INSERT_{BEFORE, AFTER}
>
>It would also be useful for latex, e.g.
>
>    * Proofs
>      :PROPERTIES:
>      :EXPORT_LATEX_BEFORE: \appendix
>      :INSERT_BEFORE: @@latex:\appendix@@
>      :END:
>
>Rasmus

--
Jon

  reply	other threads:[~2016-05-18 14:56 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-05-14  7:21 template for writing Emacs manuals in Org Eric Abrahamsen
2016-05-16 17:37 ` Kaushal Modi
2016-05-16 17:55 ` John Hendy
2016-05-16 18:08 ` Rasmus
2016-05-16 18:40   ` Thomas S. Dye
2016-05-16 20:02     ` Nicolas Goaziou
2016-05-16 21:33       ` Thomas S. Dye
2016-05-17  5:52         ` Nicolas Goaziou
2016-05-17 14:44           ` Thomas S. Dye
2016-05-17 15:37             ` Nicolas Goaziou
2016-05-17 18:36               ` Thomas S. Dye
2016-05-17 18:56                 ` Charles C. Berry
2016-05-17 18:56                 ` Nick Dokos
2016-05-18  9:21                   ` Rasmus
2016-05-18 14:56                     ` Jonathan Leech-Pepin [this message]
2016-05-18 16:20                       ` Nicolas Goaziou
2016-05-18 16:43                         ` Rasmus
2016-05-17  0:23     ` Eric Abrahamsen
2016-05-17  3:32       ` Thomas S. Dye
2016-05-17  4:16         ` Eric Abrahamsen
2016-05-17  7:35           ` Rasmus
2016-05-17  8:34             ` Eric Abrahamsen
2016-05-17 13:24           ` Phillip Lord
2016-05-18 23:59             ` Ciaran Mulloy

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

  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=4BDEAAA9-55A2-4886-80E1-ECF273D4C7E1@gmail.com \
    --to=jonathan.leechpepin@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=rasmus@gmx.us \
    /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 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).