emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Carsten Dominik <carsten.dominik@gmail.com>
To: Steven Haryanto <stevenharyanto@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: A simpler way to write literal examples?
Date: Wed, 1 Jun 2011 09:29:18 +0200	[thread overview]
Message-ID: <4B55F606-7151-4F20-A51E-DF6D5F6DEB0D@gmail.com> (raw)
In-Reply-To: <BANLkTim859RQmfEp74b47vQpc2MdLZ=Tgg@mail.gmail.com>

On 25.5.2011, at 11:43, Steven Haryanto wrote:

> I plan to document some parts of Perl source code (more specifically, description in subroutine Sub::Spec specification, http://search.cpan.org/dist/Sub-Spec) using Org format instead of the canonical POD, hoping to have better table support, more customizable links, and overall markups that are nicer to look at (IMO).
> However, one of the nice things of POD (and Wiki, Markdown, etc) for documenting source code is the relative simplicity of writing literal examples: an indented paragraph. In Org we either have to use the colon+space prefix syntax:
>  : this is an example
>  : another line
>  : another line
> or the example block:
>  this is an example
>  another line
>  another line
> Is there an alternative syntax? If there isn't, would people consider an alternative syntax (e.g. say a setting which toggles parsing an indented paragraph as a literal example)?

No, since indentation has other uses in org (for example for list structure).
I find it often helps to write #+begin_example instead of #+BEGIN_EXAMPLE.
I guess one could set up font-lock to hide the #+begin and #+end lines, but
how would you then change them.
The bug advantage in Org is that you can say
#+begin_src perl
to get correct indentation and syntax highlighting to the language of the snippet.....

- Carsten

      parent reply	other threads:[~2011-06-01  7:29 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-05-25  9:43 A simpler way to write literal examples? Steven Haryanto
2011-05-25 15:25 ` Nick Dokos
2011-05-25 16:01   ` Eric Schulte
2011-06-01  1:53   ` Steven Haryanto
2011-06-01  7:29 ` Carsten Dominik [this message]

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:

  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=4B55F606-7151-4F20-A51E-DF6D5F6DEB0D@gmail.com \
    --to=carsten.dominik@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=stevenharyanto@gmail.com \


* 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


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).