From mboxrd@z Thu Jan  1 00:00:00 1970
From: Nick Dokos <nicholas.dokos@hp.com>
Subject: Re: A simpler way to write literal examples?
Date: Wed, 25 May 2011 11:25:08 -0400
Message-ID: <13042.1306337108@alphaville.dokosmarshall.org>
References: <BANLkTim859RQmfEp74b47vQpc2MdLZ=Tgg@mail.gmail.com>
Reply-To: nicholas.dokos@hp.com
Mime-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
Return-path: <emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org>
Received: from eggs.gnu.org ([140.186.70.92]:52180)
	by lists.gnu.org with esmtp (Exim 4.71)
	(envelope-from <nick@dokosmarshall.org>) id 1QPFxn-0003jW-S5
	for emacs-orgmode@gnu.org; Wed, 25 May 2011 11:25:37 -0400
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
	(envelope-from <nick@dokosmarshall.org>) id 1QPFxl-0006ev-Sz
	for emacs-orgmode@gnu.org; Wed, 25 May 2011 11:25:35 -0400
Received: from vms173001pub.verizon.net ([206.46.173.1]:64720)
	by eggs.gnu.org with esmtp (Exim 4.71)
	(envelope-from <nick@dokosmarshall.org>) id 1QPFxl-0006bx-Nx
	for emacs-orgmode@gnu.org; Wed, 25 May 2011 11:25:33 -0400
Received: from alphaville.dokosmarshall.org ([unknown] [173.76.32.106])
	by vms173001.mailsrvcs.net
	(Sun Java(tm) System Messaging Server 7u2-7.02 32bit (built Apr 16
	2009)) with ESMTPA id <0LLR002URC5W1R30@vms173001.mailsrvcs.net> for
	emacs-orgmode@gnu.org; Wed, 25 May 2011 10:25:14 -0500 (CDT)
In-reply-to: Message from Steven Haryanto <stevenharyanto@gmail.com> of
	"Wed\, 25 May 2011 16\:43\:30 +0700."
	<BANLkTim859RQmfEp74b47vQpc2MdLZ=Tgg@mail.gmail.com>
List-Id: "General discussions about Org-mode." <emacs-orgmode.gnu.org>
List-Unsubscribe: <https://lists.gnu.org/mailman/options/emacs-orgmode>,
	<mailto:emacs-orgmode-request@gnu.org?subject=unsubscribe>
List-Archive: </archive/html/emacs-orgmode>
List-Post: <mailto:emacs-orgmode@gnu.org>
List-Help: <mailto:emacs-orgmode-request@gnu.org?subject=help>
List-Subscribe: <https://lists.gnu.org/mailman/listinfo/emacs-orgmode>,
	<mailto:emacs-orgmode-request@gnu.org?subject=subscribe>
Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org
Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org
To: Steven Haryanto <stevenharyanto@gmail.com>
Cc: nicholas.dokos@hp.com, emacs-orgmode@gnu.org

Steven Haryanto <stevenharyanto@gmail.com> wrote:

> I plan to document some parts of Perl source code (more specifically, des=
cription in subroutine
> Sub::Spec specification,=C2=A0http://search.cpan.org/dist/Sub-Spec) using=
 Org format instead of the
> canonical POD, hoping to have better table support, more customizable lin=
ks, and overall markups
> that are nicer to look at (IMO).
>=20
> However, one of the nice things of POD (and Wiki, Markdown, etc) for docu=
menting source code is the
> relative simplicity of writing literal examples: an indented paragraph. I=
n Org we either have to use
> the colon+space prefix syntax:
>=20
> =C2=A0: this is an example
> =C2=A0: another line
> =C2=A0: another line
>=20
> or the example block:
>=20
> =C2=A0#+BEGIN_EXAMPLE
> =C2=A0this is an example
> =C2=A0another line
> =C2=A0another line
> =C2=A0#+END_EXAMPLE
>=20
> 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 ex=
ample)?
>=20

What is the problem with #+BEGIN_EXAMPLE/#+END_EXAMPLE? IOW, why do you need
an alternative syntax? If your answer is "too much typing", check out
section 15.2, "Easy templates", in the Org manual.

Nick