emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Oleh Krehel <oleh@oremacs.com>
To: Oleh Krehel <ohwoeowho@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: Is it possible to keep /all/ the heading properties in one place?
Date: Sun, 28 Feb 2016 13:17:15 +0100	[thread overview]
Message-ID: <87vb59ni5w.fsf@oremacs.com> (raw)
In-Reply-To: <87ziulb48b.fsf@nicolasgoaziou.fr> (Nicolas Goaziou's message of "Sun, 28 Feb 2016 09:59:00 +0100")

Nicolas Goaziou <mail@nicolasgoaziou.fr> writes:

> Some users complained, and told me that "Org is not a programming
> language". Fair enough. Org has, indeed, to strike a balance between
> structure, required for efficiency and maintainability, and sloppiness,
> needed when you want to quickly jot down notes in a document, or simply
> let your ideas flow as you type, without hindrance.

Simply the headline structure is enough for all of this. The rest, like
properties, tags and logging can be made more rigorous.  For instance,
the current tags implementation implies the illusion that they can be
manipulated by hand. However, in practice it's frustrating to align
them.

>> Suggestion, and I've said it before, Org needs a standard simple inline
>> kbd markup. Just like Markdown's <kbd></kbd> and Texinfo's @kbd{}.
>> Since Org is tied into Emacs having an easy (and unambiguous) way to
>> denote keyboard shortcuts would be very convenient.
>
> This is export back-end specific. Org has no use for a "kbd" markup.

I really disagree here. The very first thing I did used Org for was
jotting down the Emacs key bindings that I wanted to remember.  Not
being able to distinguish the key bindings from symbols removes from the
markup's expressiveness.

For example, some people write like this:

    ~M-x forward-char~ or ~C-f~

while I write like this:

    ~M-x~ =forward-char= or ~C-f~

As long as only I read my own documents, my notation isn't a
problem. But if I share it with someone else, they will have to get used
to my non-standard notation.


>> Adding that would also progress the direction of having Org be the
>> language for Emacs manuals. Right now, Org's own manual is in Texinfo,
>> which is a shame since no one likes Texinfo and few people understand
>> enough of it to get by.

> Org can export to Texinfo. It can be helpful for those not understanding
> well enough the latter.

Org can export to Texinfo. But not well enough to be able to write Org
manual in Org.

That was my point. To be able to write a manual as rich as any existing
one, with only Org's built-in markup, i.e. without a tonne of export
specific #+TEXINFO or #+HTML includes.

I made some progress towards this goal with some custom code for
ivy.org -> ivy.html + ivy.texi export:
https://github.com/abo-abo/swiper/blob/master/doc/ivy-ox.el.

I made use of my own kbd markup that I wrote once in Org, but exported
the same both to Texinfo and HTML (see e.g. http://oremacs.com/swiper/#key-bindings).

regards,
Oleh

  reply	other threads:[~2016-02-28 12:17 UTC|newest]

Thread overview: 29+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-02-25 10:59 Is it possible to keep /all/ the heading properties in one place? Oleh Krehel
2016-02-25 13:37 ` Nicolas Goaziou
2016-02-25 13:46   ` Oleh Krehel
2016-02-25 14:03     ` Nicolas Goaziou
2016-02-25 14:26       ` Oleh Krehel
2016-02-25 16:52         ` Nicolas Goaziou
2016-02-25 18:21           ` Eric S Fraga
2016-02-26 16:35             ` Rasmus
2016-02-28  9:35               ` Eric S Fraga
2016-02-28 11:32                 ` Rasmus
2016-02-28 12:44                   ` Eric S Fraga
2016-02-28 16:46                     ` Rasmus
2016-02-28 17:05                       ` Eric S Fraga
2016-02-25 19:17           ` Oleh Krehel
2016-02-25 20:16             ` Nicolas Goaziou
2016-02-26  8:18               ` Oleh Krehel
2016-02-28  8:59                 ` Nicolas Goaziou
2016-02-28 12:17                   ` Oleh Krehel [this message]
2016-02-28 16:34                     ` Thomas S. Dye
2016-02-29 10:05                       ` Nicolas Goaziou
2016-02-29 13:42                         ` Thomas S. Dye
2016-02-29 15:00                           ` Nicolas Goaziou
2016-02-29 13:53                         ` Marcin Borkowski
2016-02-29 15:05                           ` Nicolas Goaziou
2016-02-29 17:57                         ` Revisiting moving manual to Org (was: Is it possible to keep /all/ the heading properties in one place?) Kyle Meyer
2016-02-29 17:17                       ` Is it possible to keep /all/ the heading properties in one place? Achim Gratz
2016-02-29 18:01                         ` Thomas S. Dye
2016-02-29 18:47                           ` Nicolas Goaziou
2016-02-25 17:47 ` Michael Brand

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=87vb59ni5w.fsf@oremacs.com \
    --to=oleh@oremacs.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=ohwoeowho@gmail.com \
    /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).