emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: Kaushal Modi <kaushal.modi@gmail.com>
Cc: Bastien Guerry <bzg@gnu.org>, Achim Gratz <Stromeko@nexgo.de>,
	Org Mode List <emacs-orgmode@gnu.org>
Subject: Re: [RFC] Moving "manual.org" into core
Date: Mon, 22 Jan 2018 18:20:22 +0100	[thread overview]
Message-ID: <87d1216ca1.fsf@nicolasgoaziou.fr> (raw)
In-Reply-To: <CAFyQvY2NBtFFtKBBTJptPAeM_HhMGqGoYAGraL0mc4D2qJuzmA@mail.gmail.com> (Kaushal Modi's message of "Mon, 22 Jan 2018 17:00:45 +0000")

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

> I am hoping that using "begin_src org" preserves the meta data that a code
> block is an Org snippet when the Org manual HTML pages are published on
> orgmode.org.

Again, Org manual, as published in "orgmode.org", is generated through
Texinfo, which treats "begin_src org" exactly as "begin_example". So,
switching to "begin_src org" will not give us Org fontification in HTML
output.

> Moreover, the advantage of using "begin_example" instead is:
>> 1. we can use fixed-width for one-liners,
>>
>
> I personally don't see that as a big advantage. Whether the snippet is a
> single line or more, one can just select those and use the Org structural
> template insertion to wrap that with "#+begin_src org" .. "#+end_src".

This is not about typing. When the markup is more visible than the
contents, it is visual clutter.

>> 2. Org fontification for source blocks can be sometimes misleading,
>>    as you sometimes cannot what is an example and what is not.

> I didn't understand that limitation. I use Org src blocks quite liberally
> in this Org document[1], some even with nested non-Org src blocks.
>
> #+BEGIN_SRC org :noweb-ref src-block-n-default-continue
> ,#+BEGIN_SRC emacs-lisp +n
> ;; This will be listed as line 22
> (message "This is line 23")
> ,#+END_SRC
> #+END_SRC
>
> I haven't found any issue.

It is a matter of taste. I tested both when updating the manual, and
eventually settled for example blocks.

In any case, I have no strong opinion about it. I just lean towards
simplicity.

> While pasting that example, I realized, that you don't even need to
> specially made an Org snippet an src block just because you want to use it
> as a noweb ref in the manual. Making Org snippets, src blocks, always, just
> feels like the right thing.

I didn't understand this part.

  reply	other threads:[~2018-01-22 17:20 UTC|newest]

Thread overview: 77+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-01-20 14:43 [RFC] Moving "manual.org" into core Nicolas Goaziou
2018-01-20 17:41 ` Achim Gratz
2018-01-20 18:15   ` Nicolas Goaziou
2018-01-20 18:36     ` Achim Gratz
2018-01-20 18:51       ` Nicolas Goaziou
2018-01-20 17:41 ` Thomas S. Dye
2018-01-22 10:51 ` Bastien Guerry
2018-01-22 13:48   ` Nicolas Goaziou
2018-01-22 15:30     ` Kaushal Modi
2018-01-22 16:02       ` Nicolas Goaziou
2018-01-22 17:00         ` Kaushal Modi
2018-01-22 17:20           ` Nicolas Goaziou [this message]
2018-01-22 17:31             ` Kaushal Modi
2018-01-22 19:52               ` Nicolas Goaziou
2018-01-23 15:19                 ` Kaushal Modi
2018-01-23 16:30                   ` Julius Dittmar
2018-01-23 16:33                   ` Nicolas Goaziou
2018-01-23 16:37                     ` Kaushal Modi
2018-01-22 16:35       ` Bastien Guerry
2018-01-22 16:53         ` Kaushal Modi
2018-01-22 16:35       ` Bastien Guerry
2018-01-22 16:31     ` Bastien Guerry
2018-01-22 17:03       ` Nicolas Goaziou
2018-01-23  8:07         ` org-adapt-indentation 'content (was Re: [RFC] Moving "manual.org" into core) Christian Moe
2018-03-06 19:01           ` Bastien Guerry
2018-01-22 19:04       ` [RFC] Moving "manual.org" into core Achim Gratz
2018-03-03  9:17       ` Nicolas Goaziou
2018-03-03 10:18         ` Bastien Guerry
2018-03-03 11:29           ` Nicolas Goaziou
2018-03-03 15:57             ` Bastien Guerry
2018-03-03 16:15               ` Joseph Vidal-Rosset
2018-03-03 19:48               ` Glenn Morris
2018-03-04  9:30                 ` Bastien Guerry
2018-01-23 20:06     ` Thomas S. Dye
2018-01-22 13:54   ` Rasmus
2018-01-22 15:23     ` Kaushal Modi
2018-01-24  8:39     ` Yasushi SHOJI
2018-01-24 11:28       ` Nicolas Goaziou
2018-01-26  8:52         ` Yasushi SHOJI
2018-01-26 10:32           ` Nicolas Goaziou
2018-01-27  8:40             ` Yasushi SHOJI
2018-01-28 15:17               ` Nicolas Goaziou
2018-01-29  2:40                 ` Yasushi SHOJI
2018-01-29 14:41                   ` Nicolas Goaziou
2018-02-01 11:43                     ` Yasushi SHOJI
2018-02-01 12:11                       ` Yasushi SHOJI
2018-02-04  9:05                         ` Nicolas Goaziou
2018-02-01 14:55                       ` Nicolas Goaziou
2018-02-02  2:07                         ` Yasushi SHOJI
2018-02-04  9:40                           ` Nicolas Goaziou
2018-02-06 14:11                             ` Yasushi SHOJI
2018-01-22 16:41   ` Thomas S. Dye
2018-01-23  8:08   ` Christian Moe
2018-01-23 21:00   ` Samuel Wales
2018-03-04  9:32 ` Bastien Guerry
2018-03-04 10:06   ` Nicolas Goaziou
2018-03-04 10:29     ` Bastien
2018-03-05 14:20       ` Nicolas Goaziou
2018-03-05 16:23         ` Kaushal Modi
2018-03-06 17:41           ` Bastien Guerry
2018-03-06 21:39             ` Achim Gratz
2018-03-05 18:08         ` Thomas S. Dye
2018-03-06  1:08           ` Bastien Guerry
2018-03-06  9:57             ` Thomas S. Dye
2018-03-06 11:55               ` Eric S Fraga
2018-03-06 17:39               ` Bastien
2018-03-06 18:45                 ` Thomas S. Dye
2018-03-06 19:19                   ` Bastien
2018-03-07  2:53                     ` Thomas S. Dye
2018-03-05 19:01         ` Achim Gratz
2018-03-06 19:02           ` Bastien
2018-03-06 18:59         ` Bastien Guerry
     [not found]       ` <WM!6f8274ba0065f984ff76586f7cf117703ccda15adbb5042672b0d2695ee5ac6b367ee58f70aacbbc9c2b10eecb9672ea!@mailhub-mx3.ncl.ac.uk>
2018-03-05 16:22         ` Phillip Lord
2018-03-06 17:47           ` Bastien Guerry
2018-03-04 10:54     ` Bastien Guerry
2018-03-05 14:26       ` Nicolas Goaziou
2018-03-06 17:43         ` Bastien Guerry

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=87d1216ca1.fsf@nicolasgoaziou.fr \
    --to=mail@nicolasgoaziou.fr \
    --cc=Stromeko@nexgo.de \
    --cc=bzg@gnu.org \
    --cc=emacs-orgmode@gnu.org \
    --cc=kaushal.modi@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).