From: Eric Schulte <schulte.eric@gmail.com>
To: Ilya Shlyakhter <ilya_shl@alum.mit.edu>
Cc: emacs-orgmode <emacs-orgmode@gnu.org>
Subject: Re: inline source code blocks
Date: Thu, 06 Mar 2014 15:04:05 -0700 [thread overview]
Message-ID: <874n3bug4r.fsf@gmail.com> (raw)
In-Reply-To: CACfYvRYLhLLTnFjGM0ytwaENRRZjtci5ouJq1xgOm1ohqFnWgQ@mail.gmail.com
Ilya Shlyakhter <ilya_shl@alum.mit.edu> writes:
> Some questions about inline source code blocks:
>
> - They're not fontified even when org-src-fontify-natively is true
> -- correct?
Correct.
>
> - They're not included in tangled code; is that intended behavior?
> The manual does not seem to say they're different from normal code
> blocks, except for syntax.
They were originally added for the sole purpose of including results
inline in textual elements. They are not meant to export code. There
is currently no support (to my knowledge) for inline fontified code.
> There are also mailing list messages that suggest they're not meant
> to be exported. What is the correct understanding? I can submit a
> patch to the manual once I understand this myself.
>
That would be much appreciated.
>
> - For very short code snippets (1-2 lines), it would be good to
> allow specifying (via properties) a default language for code blocks
> (say C) and a prefix character (say '>'), after which one could write
>
> > int i;
>
I think code blocks work well for non-inline code. Although I think
that an inline fontification solution may be nice. I use the following
to make code block syntax less intrusive...
Pretty code blocks
#+begin_src emacs-lisp
(defun prettier-org-code-blocks ()
(interactive)
(font-lock-add-keywords nil
'(("\\(\+begin_src\\)"
(0 (progn (compose-region (match-beginning 1) (match-end 1) ?¦)
nil)))
("\\(\+end_src\\)"
(0 (progn (compose-region (match-beginning 1) (match-end 1) ?¦)
nil))))))
(add-hook 'org-mode-hook 'prettier-org-code-blocks)
#+end_src
and code blocks may easily by typed with "< s TAB". Beyond that you
could add personal customization to further reduce either the visual or
typing burden.
>
> and have this be the equivalent of
>
> +BEGIN_SRC c
> int i;
> +END_SRC
>
> by analogy with short literal examples
> : such as this
>
> Would this break any Org invariants?
>
> (Context: trying to use Org for literate programming in C++;
> interested in others' experience in this area).
>
Hope these suggestions help,
>
> Thanks,
>
> Ilya
>
--
Eric Schulte
https://cs.unm.edu/~eschulte
PGP: 0x614CA05D
next prev parent reply other threads:[~2014-03-06 22:19 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-03-05 21:28 inline source code blocks Ilya Shlyakhter
2014-03-06 22:04 ` Eric Schulte [this message]
2014-03-06 23:35 ` Ilya Shlyakhter
2014-03-07 2:22 ` Eric Schulte
2014-03-07 2:52 ` Ilya Shlyakhter
2014-03-07 0:02 ` Ilya Shlyakhter
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=874n3bug4r.fsf@gmail.com \
--to=schulte.eric@gmail.com \
--cc=emacs-orgmode@gnu.org \
--cc=ilya_shl@alum.mit.edu \
/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).