emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Tassilo Horn <tassilo@member.fsf.org>
To: help-gnu-emacs@gnu.org
Cc: emacs-orgmode@gnu.org
Subject: Re: desirability of boxquote-style snippets for helping new users
Date: Fri, 16 Jan 2009 10:56:29 +0100	[thread overview]
Message-ID: <878wpb8tgy.fsf@thinkpad.tsdh.de> (raw)
In-Reply-To: 20524da70901151741n2ee14a3fta28b32b32d45b132@mail.gmail.com

"Samuel Wales" <samologist@gmail.com> writes:

Hi Samuel,

> While an experienced user can figure out rectangle commands or write a
> command to unpack the quote, new users and users who can't type much
> might skip using the code to avoid having to do that.  And a very new
> user could actually stick the whole thing in .emacs and wonder why it
> doesn't work.  It adds to the burden of fixing a problem or meeting a
> need in emacs without providing much benefit.  Even a few keystrokes
> can do that.
>
> Perhaps quotes of code, in all packages like boxquote, could by
> default get fancy only on the lines precediing and following.
>
> What do you think?

I think the best you can do is: Use boxquote for citations of
key/function/variable/info docs, but for code use

--8<---------------cut here---------------start------------->8---
(defun foo (a b)
  (if (> a b)
      (* a b)
    (foo (foo (- b a) a) (- a b))))
--8<---------------cut here---------------end--------------->8---

which is

,----[ C-h k C-c M-m ]
| C-c M-m runs the command message-mark-inserted-region, which is an interactive
| compiled Lisp function in `message.el'.
| 
| It is bound to C-c M-m, <menu-bar> <Message> <Insert Region Marked>.
| 
| (message-mark-inserted-region beg end &optional verbatim)
| 
| Mark some region in the current article with enclosing tags.
| See `message-mark-insert-begin' and `message-mark-insert-end'.
| If verbatim, use slrn style verbatim marks ("#v+" and "#v-").
`----

That's highlighted by gnus (and some other readers), too, and you can
simply copy & paste it somewhere.  It even tells you where to cut! ;-)

Bye,
Tassilo
-- 
In an average living room there are 1,242 objects RMS could use to write
an OS, including the room itself.

      parent reply	other threads:[~2009-01-16  9:56 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-01-16  1:41 desirability of boxquote-style snippets for helping new users Samuel Wales
2009-01-16  2:13 ` Matthew Lundin
2009-01-16  2:32 ` Austin Frank
2009-01-16  3:34   ` Matthew Lundin
2009-01-16  4:41 ` Kevin Rodgers
2023-08-18 20:46   ` Samuel Wales
2009-01-16  9:56 ` Tassilo Horn [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:
  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=878wpb8tgy.fsf@thinkpad.tsdh.de \
    --to=tassilo@member.fsf.org \
    --cc=emacs-orgmode@gnu.org \
    --cc=help-gnu-emacs@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).