emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* "noweb-ref": Limiting scope of definitions?
@ 2012-01-30 16:31 Yu
  2012-02-01 14:16 ` Eric Schulte
  0 siblings, 1 reply; 2+ messages in thread
From: Yu @ 2012-01-30 16:31 UTC (permalink / raw)
  To: org-mode mailing list

Hello!

Scenario
-----------------

  * Maintain a potentially long org file as an appendix.
  * In this appendix, many independent scripting tasks will be documented.
  * Each such scripting task has similiar partial tasks, e.g. imports,
"settings", ...

In such a case, many independent scripts may contain a block
"<<imports>>" or something or something to the same effect, i.e. an
overlap of definitions could be avoided only by some sort of scoping:
  (a) manually, e.g. by prefixing the names with a script-specific
        string (e.g. <<task1-imports>>. While this is flexible (i.e.
        allows reuse of code from other script), it also reduces the
        readability of the NOWEB code).
  (b) providing some sort of scoping, e.g. declaring definitions section-local.


Implementation Idea
----------------------------------

A simple implementation, maintaining the flexibility of the manual
solution, would be to create a header argument like ":noweb-prefix",
that effectively just adds a prefix to the noweb reference names (both
in declaring the block (#+name, :noweb-ref) and in using it
(<<name>>)), unless such a prefix is explicitly specified. This could
then be set as needed, for specific blocks or subtrees (as property)
or any mixture of such.

A prefix would then be recognized by a delimiter string to be specified.

This solution would also be downward compatible with existing files,
as the syntax for recognizing a prefix would be relevant only when
deciding whether to apply an explicitly introduced ":noweb-prefix".

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2012-02-01 15:27 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2012-01-30 16:31 "noweb-ref": Limiting scope of definitions? Yu
2012-02-01 14:16 ` Eric Schulte

Code repositories for project(s) associated with this 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).