emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Dan Davison <dandavison7@gmail.com>
To: Jeff Horn <jrhorn424@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: Re: Worg needs some reorganizing
Date: Thu, 20 Jan 2011 17:41:20 +0000	[thread overview]
Message-ID: <AANLkTikS-7cto_jdz-tuC2p9DP5ygDsby+XoFMRxanYA@mail.gmail.com> (raw)
In-Reply-To: <AANLkTik+twehQS3dYU8navJMQKh9iQR9obOB+5JvJqOP@mail.gmail.com>

On Thu, Jan 20, 2011 at 5:02 PM, Jeff Horn <jrhorn424@gmail.com> wrote:
>
> On Thu, Jan 20, 2011 at 6:22 AM, Dan Davison <dandavison7@gmail.com> wrote:
> > I strongly second this. In fact I'll stick my neck out more: Worg is
> > great, but for tutorials on org-mode, HTML export is often the wrong
> > format for obvious reasons (i.e. unless you go to some trouble, it
> > conceals a lot of the org syntax). I'm tempted to suggest that htmlized
> > output should be the default format for many org tutorials on Worg.
>
> I respectfully disagree with your assertion. When someone writes a
> document "properly", i.e. in a literate fashion, i.e. using org source
> blocks, the right syntax is shown at the right time.

So I think we both have babel documents in mind -- i.e. ones with
active code blocks. The trouble with using org source blocks to render
the org syntax in HTML is that the content must be duplicated. I know
from experience that it is easy to let the pedagogical org block get
out of sync with its functional counterpart. I did try to choose my
words carefully -- I said "tutorials", by which I meant the sort of
documents demonstrating Org syntax that can be played with in the org
source version. Not talking about the whole of Worg.

>
> Please see the
> manual as an example.

Hmm? The manual is written in texinfo.

>
> Now, I'm no fan of nerfing choices in order to force anyone to do
> things "The Right Way (tm)", but it bears mentioning.
>
> I see no harm in publishing using org-publish-org-to-org with htmlize.
> We could even add a link in the footer or header of each page that
> links to the htmlized source. I do *not* agree in making it the
> "default format" for any page.

To see examples of a document that would work better in htmlized
format, look no further than

http://orgmode.org/worg/org-contrib/babel/intro.html

Scroll down to the ditaa section and infelicities start to appear.
Someone (Eric or Tom) has done a good job of trying to make sure that
an org src counterpart exists for each source block, but that is (a)
hard work, (b) error prone and (c) cumbersome (what's the point of the
non org src version?).

And in the places which they missed, the document doesn't work well.
E.g. look at the "Capturing the Results of Code Evaluation" section.
Those two blocks are formatted in HTML only and its all a bit baffling
as they appear the same (can't see the header args, which are the
whole point of the example).

All of which could be solved with some effort. My point is: what does
the HTML export of this document really offer over the verbatim
htmlized one?

Dan

>
> --
> Jeffrey Horn
> http://www.failuretorefrain.com/jeff/

  parent reply	other threads:[~2011-01-20 17:41 UTC|newest]

Thread overview: 140+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-10-07  8:15 Themes Compatible with color-theme.el Ian Barton
2010-10-07  8:56 ` Sébastien Vauban
2010-10-07  9:04   ` Ian Barton
2010-10-09 15:54 ` Yavuz
2010-10-09 18:42   ` David O'Toole
2010-10-10  7:54     ` Ian Barton
2010-10-11  3:29       ` David O'Toole
2010-10-11 19:01         ` Jason McBrayer
2010-10-10  7:52   ` Ian Barton
2010-10-09 21:45 ` Memnon Anon
2010-10-10  7:55   ` Ian Barton
2010-10-10 19:24 ` Scott Jaderholm
2010-10-10 20:55   ` Ian Barton
2010-10-13  3:46     ` Eric Schulte
2010-10-13 10:08       ` Ian Barton
2010-10-13 12:40         ` Carsten Dominik
2010-10-13 14:51           ` Worg needs some reorganizing Dan Davison
2010-10-13 15:41             ` Eric Schulte
2010-10-14  9:44               ` Ian Barton
2011-01-15 16:08                 ` Samuel Wales
2010-10-13 16:02             ` John Hendy
2010-10-14  7:44               ` Sébastien Vauban
2010-10-14 13:09               ` Eric Schulte
2010-10-14 14:07                 ` John Hendy
2010-10-14 15:51                   ` Jeff Horn
2011-01-15 12:01             ` Bastien
2011-01-15 15:19               ` Matt Lundin
2011-01-15 18:50                 ` Bastien
2011-01-16  0:00                   ` Alan E. Davis
2011-01-16 15:37                     ` Eric Schulte
2011-01-16 18:02                       ` Jason Dunsmore
2011-01-16 20:04                         ` Eric Schulte
2011-01-16 20:31                           ` Jason Dunsmore
2011-01-16 20:41                             ` Eric Schulte
2011-01-16 20:50                               ` Jason Dunsmore
2011-01-16 22:37                                 ` Eric Schulte
2011-01-17 14:56                                   ` Jason Dunsmore
2011-01-17 17:41                                     ` Bastien
2011-01-17 18:01                                       ` Jason Dunsmore
2011-01-17 18:57                                         ` Eric Schulte
2011-01-18 16:13                                           ` Eric Schulte
2011-01-18 16:53                                             ` Jeff Horn
2011-01-18 16:55                                             ` Jason Dunsmore
2011-01-18 19:15                                               ` Jason Dunsmore
2011-01-18 19:52                                                 ` Bastien
2011-01-18 21:54                                                   ` Jason Dunsmore
2011-01-18 22:23                                                     ` Nick Dokos
2011-01-18 22:42                                                   ` Eric Schulte
2011-01-19  1:35                                                     ` Jeff Horn
2011-01-19 16:52                                                   ` Achim Gratz
2011-01-19  1:02                                                 ` Matt Lundin
2011-01-19 17:05                                                   ` Achim Gratz
2011-01-19 17:24                                                     ` Eric Schulte
2011-01-19 17:34                                                   ` Jason Dunsmore
2011-01-19 17:56                                                     ` Eric Schulte
2011-01-19 18:13                                                       ` Achim Gratz
2011-01-19 18:20                                                         ` Eric Schulte
2011-01-19 18:46                                                           ` Jason Dunsmore
2011-01-19 18:52                                                             ` Achim Gratz
2011-01-19 19:18                                                               ` Jason Dunsmore
2011-01-19 21:12                                                                 ` Jeff Horn
2011-01-20  2:24                                                                 ` Matt Lundin
2011-01-20  4:30                                                                   ` Jeff Horn
2011-01-20 15:15                                                                     ` Jason Dunsmore
2011-01-20  2:29                                                       ` Matt Lundin
2011-01-20  3:10                                                         ` Nick Dokos
2011-01-20 15:41                                                           ` Matt Lundin
2011-01-20 16:16                                                             ` Nick Dokos
2011-01-20 18:09                                                               ` Jeff Horn
2011-01-20 18:46                                                                 ` Eric Schulte
2011-01-20 19:22                                                                   ` Jeff Horn
2011-01-20 16:17                                                             ` Eric Schulte
2011-01-19 18:07                                                     ` Jeff Horn
2011-01-19 18:32                                                       ` Jason Dunsmore
2011-01-19 21:06                                                         ` Jeff Horn
2011-01-17 19:05                                       ` Achim Gratz
2011-01-17 20:15                                         ` Bastien
2011-01-17 20:52                                         ` Jason Dunsmore
2011-01-17 21:14                                           ` Eric Schulte
2011-01-18 16:01                                             ` Jason Dunsmore
2011-01-18 16:05                                             ` Eric Schulte
2011-01-18 19:18                                               ` Jason Dunsmore
2011-01-18 19:40                                                 ` Bastien
2011-01-17 22:16                                           ` Achim Gratz
2011-01-17 22:47                                             ` Jason Dunsmore
2011-01-17 23:01                                               ` Achim Gratz
2011-01-17 23:29                                                 ` Eric Schulte
2011-01-18  1:34                                       ` Matt Lundin
2011-01-18  1:53                                         ` Eric Schulte
2011-01-18  2:17                                         ` Jeff Horn
2011-01-18  8:39                                           ` Bastien
2011-01-18 15:05                                             ` Matt Lundin
2011-01-18 15:36                                               ` Jason Dunsmore
2011-01-18 15:45                                                 ` Nick Dokos
2011-01-18 15:52                                                   ` Jason Dunsmore
2011-01-18 16:04                                                     ` Nick Dokos
2011-01-18 16:26                                               ` Eric Schulte
2011-01-18 18:50                                                 ` Jason Dunsmore
2011-01-18 19:20                                                   ` Jeff Horn
2011-01-18 19:48                                                   ` Bastien
2011-01-18 23:17                                                     ` Bernt Hansen
2011-01-19  0:57                                                       ` Bastien
2011-01-19  1:03                                                     ` Matt Lundin
2011-01-20 11:22                                                   ` Dan Davison
2011-01-20 17:02                                                     ` Jeff Horn
2011-01-20 17:21                                                       ` Erik Iverson
2011-01-20 17:38                                                         ` Jason Dunsmore
2011-01-20 18:44                                                           ` Eric Schulte
2011-01-20 17:41                                                       ` Dan Davison [this message]
2011-01-20 17:48                                                         ` Dan Davison
2011-01-20 17:50                                                           ` Jeff Horn
2011-01-20 17:49                                                         ` Jeff Horn
2011-01-20 22:23                                                         ` Sébastien Vauban
2011-01-21  8:48                                                           ` Eric S Fraga
2011-01-21  8:58                                                           ` Giovanni Ridolfi
2011-01-20 17:42                                                       ` Jason Dunsmore
2011-01-18 23:13                                               ` Jason Dunsmore
2011-01-19  0:15                                                 ` Eric Schulte
2011-01-19  0:40                                                 ` Bastien
2011-01-19  0:46                                                   ` Eric Schulte
2011-01-19  1:13                                                   ` Matt Lundin
2011-01-19 18:04                                                   ` Achim Gratz
2011-01-18 15:22                                             ` Jason Dunsmore
2011-01-19  1:21                                               ` Bastien
2011-01-19  1:41                                                 ` Jeff Horn
2011-01-20 16:44                                                 ` Eric Schulte
2011-01-20 16:52                                                   ` Jeff Horn
2011-01-19 18:36                                               ` Achim Gratz
2011-01-18 16:46                                             ` Jeff Horn
2011-01-18 16:57                                               ` Brian T. Wightman
2011-01-18  9:23                                         ` Bastien
2011-01-18 15:41                                           ` Jason Dunsmore
2011-01-18 19:38                                         ` Jason Dunsmore
2011-01-17 18:33                         ` Samuel Wales
2011-01-17 18:43                           ` Samuel Wales
2011-01-17 21:39                         ` Matt Lundin
2010-10-14  9:16           ` Themes Compatible with color-theme.el Ian Barton
2010-10-13 15:30         ` Eric Schulte
2010-10-14  9:17           ` Ian Barton
2010-10-10 23:53 ` suvayu ali

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=AANLkTikS-7cto_jdz-tuC2p9DP5ygDsby+XoFMRxanYA@mail.gmail.com \
    --to=dandavison7@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=jrhorn424@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).