emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Kaushal Modi <kaushal.modi@gmail.com>
To: emacs-org list <emacs-orgmode@gnu.org>
Subject: Re: RFC: Proposal for an Org Special Block for ox-html
Date: Thu, 24 May 2018 14:08:49 -0400	[thread overview]
Message-ID: <CAFyQvY2j1=qh37wad3V-u0XUziih2-tuNjFUrUjiru23q0riJg@mail.gmail.com> (raw)
In-Reply-To: <87o9h56jdl.fsf@gmail.com>

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

Hi Aaron,

Thanks for the feedback.

On Thu, May 24, 2018 at 1:42 PM Aaron Ecay <aaronecay@gmail.com> wrote:

> Hi Kaushal,
>
> It seems like a good idea.  My two comments are:
>
> - Remember that ox-html can export to HTML4, so the code would need to
>   detect that case and have a sensible fallback
>

Yes, I think that would need to be handle just as ox-html does now.. use
div tags instead of details and summary tags.


> - The approach of looking for “magic” strings in the contents seems
>   hackish.  What if the summary was treated as a caption?
>

I also feel like that's a hack, but seems quite robust and functional at
least in my tests. The main reason to make summary part of details was to
no impose a one-paragraph limit on summaries.

Here's my pathological test for this feature:
https://ox-hugo.scripter.co/test/posts/details-and-summary/

#+caption: Open for details
> #+begin_details
> Many details here.
> #+end_details
>
> (Admittedly, the mismatch between “caption” and “summary” is not ideal,
> but caption is the only suitable keyword that the syntax gives us...).
>

I agree. caption doesn't go well with details.. looks like making a stew
out of whatever's in the fridge. Hope that bad metaphor makes sense :)

Another idea would be:
>
> #+begin_details
> #+summary: Open for details.
> Many details here.
> #+end_details
>

HTML allows multi-paragraph summaries.. (see my test link above). Expanding
on your idea.. what if we had another Special block with name summary?

#+begin_details
#+begin_summary
Open for details

More summary.
#+end_summary
Many details here.
#+end_details

It doesn't look as pretty as using the magic string "---", but it should
work.  But still not sure..




> Just food for thought...
>

I appreciate that.
-- 

Kaushal Modi

[-- Attachment #2: Type: text/html, Size: 3174 bytes --]

  reply	other threads:[~2018-05-24 18:09 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-05-24 13:40 RFC: Proposal for an Org Special Block for ox-html Kaushal Modi
2018-05-24 17:41 ` Aaron Ecay
2018-05-24 18:08   ` Kaushal Modi [this message]
2018-05-24 18:28     ` Kaushal Modi
2018-05-24 18:36     ` Aaron Ecay
2018-05-24 18:47       ` Kaushal Modi
2018-05-24 19:08         ` Aaron Ecay
2018-05-24 19:25           ` Kaushal Modi
2018-05-25 14:19             ` Aaron Ecay
2018-05-25 15:09               ` Kaushal Modi
2018-05-25 16:38                 ` Kaushal Modi
2018-05-27 16:21                 ` Aaron Ecay

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='CAFyQvY2j1=qh37wad3V-u0XUziih2-tuNjFUrUjiru23q0riJg@mail.gmail.com' \
    --to=kaushal.modi@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).