emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Chris Gray <chrismgray@gmail.com>
To: Myles English <mylesenglish@gmail.com>
Cc: emacs-orgmode Mode <emacs-orgmode@gnu.org>
Subject: [patch] Re:  meaning of body-only in org-export-as-html
Date: Sat, 31 Mar 2012 16:47:02 -0600	[thread overview]
Message-ID: <87obrcie1l.fsf@gmail.com> (raw)
In-Reply-To: <87haxgheoe.fsf@gmail.com>

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

Hi Myles,

Sorry I missed your email for so long.

On Thu, 22 Mar 2012 14:51:29 +0000, Myles English <mylesenglish@gmail.com> wrote:
> 
> Hi Chris,
> 
> >> On Fri, 16 Mar 2012 16:33:22 -0600, Chris Gray said:
> 
>   > Hello, I am using org-export-as-html with the body-only parameter
>   > set to t in the org plugin for ikiwiki that I'm working on.  It
>   > works almost perfectly, but I recently had a user point out that
>   > it's not possible to get a table of contents, even when one is
>   > explicitly asked for in the #+OPTIONS line of the org file.
> 
>   > Since the table of contents is part of the body (at least in the
>   > sense that it is between the <body> tags), I found this surprising.
>   > So would it cause problems to change the line
> 
>   > (if (and org-export-with-toc (not body-only)) ...)
> 
>   > to
> 
>   > (if org-export-with-toc ...)
> 
>   > in org-export-as-html?
> 
> I see one problem in that it would be then be inconsistent with
> org-export-as-ascii which considers the TOC to be part of the header.  I
> would like to be able to export just the TOC (as ascii, and I understand
> a new ascii exporter has been written lately).  The same thing for the
> html exporter would presumably solve your problem too because then you
> could export TOC+body (as html)?

The thing is, the docstring is not consistent with the code.  It would
make my life easier if the code was changed to match the docstring, but
I would also be okay if the opposite happened.

I am also looking forward to the new exporter being ready, but I guess
this small issue should be fixed in the current exporter until it is.

I have attached the patch that I suggested for the HTML exporter.

Cheers,
Chris


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Bring-the-meaning-of-body-only-in-org-export-as-html.patch --]
[-- Type: text/x-diff, Size: 1200 bytes --]

From 9f91361e8c8cd7047acf0260bff2ae81e72fcc93 Mon Sep 17 00:00:00 2001
From: Chris Gray <chrismgray@gmail.com>
Date: Sat, 31 Mar 2012 16:35:04 -0600
Subject: [PATCH] Bring the meaning of body-only in org-export-as-html closer
 to docs

The docstring for org-export-as-html says "When BODY-ONLY is set,
don't produce the file header and footer, simply return the content of
<body>...</body>, without even the body tags themselves."  However, it
currently also inhibits the generation of the table of contents,
regardless if one is asked for by the user in the #+OPTIONS line of
the file.  This patch fixes that (i.e. allows for toc generation if it
is requested).
---
 lisp/org-html.el |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/lisp/org-html.el b/lisp/org-html.el
index 2de2ea9..cb785f3 100644
--- a/lisp/org-html.el
+++ b/lisp/org-html.el
@@ -1402,7 +1402,7 @@ PUB-DIR is set, use this as the publishing directory."
 		"\n<h1 class=\"title\">" title "</h1>\n"))
 
       ;; insert body
-      (if (and org-export-with-toc (not body-only))
+      (if org-export-with-toc
 	  (progn
 	    (push (format "<h%d>%s</h%d>\n"
 			  org-export-html-toplevel-hlevel
-- 
1.7.9


  reply	other threads:[~2012-03-31 22:47 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-03-16 22:33 Chris Gray
2012-03-22 14:51 ` Myles English
2012-03-31 22:47   ` Chris Gray [this message]
2012-04-02  8:07     ` [patch] " Bastien
2012-04-03 16:40       ` Chris Gray
2012-04-03 18:12         ` Bastien
2012-04-04  7:06         ` Bastien
2012-04-04 18:24           ` Chris Gray

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=87obrcie1l.fsf@gmail.com \
    --to=chrismgray@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=mylesenglish@gmail.com \
    --subject='[patch] Re:  meaning of body-only in org-export-as-html' \
    /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

Code repositories for project(s) associated with this 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).