emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: John Hendy <jw.hendy@gmail.com>
To: emacs-orgmode <emacs-orgmode@gnu.org>
Subject: [PATCH] Update documentation for :exports (applicable to blocks only, not inline)
Date: Tue, 11 Mar 2014 20:38:14 -0500	[thread overview]
Message-ID: <CA+M2ft-o_TZi-gmU_Qqk-AtT_EtQDA3fZRoG1eA4d4Qkghaejg@mail.gmail.com> (raw)

[-- Attachment #1: Type: text/plain, Size: 412 bytes --]

Per Eric's comment to a previous thread, I took a stab at updating two
locations in the documentation that discuss using the :exports options
so that users (like myself!) don't try to use them on inline code
blocks.
- http://lists.gnu.org/archive/html/emacs-orgmode/2014-03/msg00285.html

Patch is attached.

Feel free to counter my changes with suggestions/improvements and I'll
re-submit.


Best regards,
John

[-- Attachment #2: 0001-updated-documentation-for-exports-argument-to-specif.patch --]
[-- Type: text/x-patch, Size: 1219 bytes --]

From 0b178a22c29c7abe02a30aece6731ce3f77ac12e Mon Sep 17 00:00:00 2001
From: John Henderson <jw.hendy@gmail.com>
Date: Tue, 11 Mar 2014 20:33:36 -0500
Subject: [PATCH] updated documentation for :exports argument to specify that
 it's only relevant for blocks, no inline code

---
 doc/org.texi | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/doc/org.texi b/doc/org.texi
index 7e66034..cd9aa35 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -13828,7 +13828,8 @@ results of code block evaluation.  For information on exporting code block
 bodies, see @ref{Literal examples}.
 
 The @code{:exports} header argument can be used to specify export
-behavior:
+behavior (note that these arguments are only relevant for code blocks, not
+inline code):
 
 @subsubheading Header arguments:
 
@@ -14828,7 +14829,8 @@ which the link does not point.
 @cindex @code{:exports}, src header argument
 
 The @code{:exports} header argument specifies what should be included in HTML
-or @LaTeX{} exports of the Org mode file.
+or @LaTeX{} exports of the Org mode file.  Note that the @code{:exports}
+option is only relevant for code blocks, not inline code.  
 
 @itemize @bullet
 @item @code{code}
-- 
1.9.0


             reply	other threads:[~2014-03-12  1:38 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-03-12  1:38 John Hendy [this message]
2014-03-12 15:23 ` [PATCH] Update documentation for :exports (applicable to blocks only, not inline) Bastien
2014-03-13  2:08   ` John Hendy
2014-03-13  8:17     ` Bastien
2014-03-14 15:44       ` John Hendy
2014-03-14 15:51         ` Bastien
2014-03-14 16:06           ` John Hendy
2014-03-14 16:17             ` Bastien
2014-03-14 16:25               ` John Hendy

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=CA+M2ft-o_TZi-gmU_Qqk-AtT_EtQDA3fZRoG1eA4d4Qkghaejg@mail.gmail.com \
    --to=jw.hendy@gmail.com \
    --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 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).