From: Thomas S. Dye <tsd@tsdye.com>
To: Joe Riel <joer@san.rr.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: obtain ob-template.el for Babel language extension
Date: Sat, 12 Sep 2015 07:15:37 -1000 [thread overview]
Message-ID: <m21te3r22u.fsf@tsdye.com> (raw)
In-Reply-To: <20150911211305.295d8ff4@gauss>
Aloha Joe,
Joe Riel <joer@san.rr.com> writes:
>
> No offense, but the help pages on the code blocks could really use
> improvement.
Glad to have your help. The documentation is a community effort.
> For example,
>
> Exporting code blocks
> ---------------------
> Nowhere does this section explain *how* you can export a code block,
> nor are there any links to pages that are helpful. As a minimum it
> should include the relevant commands and the key bindings for
> exporting code blocks. Where are they?
Typically, one doesn't export a code block by itself. Instead, one
exports a document that includes one or more code blocks. How to export
a document is covered in Chapter 12, Exporting.
> Evaluating code blocks
> ----------------------
> The second paragraph states that only 'emacs-lisp' is enabled by
> default. Suppose I want to use something other than 'emacs-lisp',
> *how* do I enable that? The parenthetical comment states that the
> Languages section lists the supoported languages but doesn't mention
> that the explanation of enabling other languages is there. Better
> to not leave the reader hanging. How about this:
>
> "By default, the evaluation facility is only enabled for Lisp code
> blocks specified as ‘emacs-lisp’. See _Languages_ for instructions on
> enabling other languages and for a list of supported languages. See
> _Structure of code blocks_ for information on the syntax used to
> define a code block."
I think this is an improvement. IMHO it is almost always a good thing
to get rid of parenthetical statements. Would you like to submit a
patch for org.texi? You'll find instructions here:
http://orgmode.org/worg/org-contribute.html#orgheadline1
Another problem is the outdated list of supported languages in Section
14.7, Languages. Perhaps this could be replaced by a pointer to the
more complete list maintained on Worg? Should this section distinguish
the various levels of "support", e.g. core, contrib, and packages?
All the best,
Tom
--
Thomas S. Dye
http://www.tsdye.com
next prev parent reply other threads:[~2015-09-12 17:15 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-09-11 5:23 obtain ob-template.el for Babel language extension Joe Riel
2015-09-11 6:38 ` Thomas S. Dye
2015-09-11 14:37 ` Joe Riel
2015-09-11 16:03 ` Thomas S. Dye
2015-09-11 19:30 ` Marco Maggesi
2015-09-13 17:45 ` Joe Riel
2015-09-15 2:37 ` Thomas S. Dye
2015-09-16 15:43 ` Joe Riel
2015-09-12 4:13 ` Joe Riel
2015-09-12 17:15 ` Thomas S. Dye [this message]
2015-09-12 17:39 ` Joe Riel
2015-09-12 18:50 ` [PATCH] small improvements to info page, Working with source code Joe Riel
2015-09-13 17:32 ` [PATCH] small improvements to info page, Working with source code; add TINYCHANG Joe Riel
2015-09-13 18:24 ` Rasmus
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=m21te3r22u.fsf@tsdye.com \
--to=tsd@tsdye.com \
--cc=emacs-orgmode@gnu.org \
--cc=joer@san.rr.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).