| blob | 62fca9e5c2531ca44b5bccc011e4a3294013be9d |
1 ;;; org-mtags.el --- Muse-like tags in Org-mode
2 ;; Copyright (C) 2008 Free Software Foundation, Inc.
3 ;;
4 ;; Author: Carsten Dominik <carsten at orgmode dot org>
5 ;; Keywords: outlines, hypermedia, calendar, wp
6 ;; Homepage: http://orgmode.org
7 ;; Version: 0.01
8 ;;
9 ;; This file is not yet part of GNU Emacs.
10 ;;
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 3, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
28 ;;
29 ;; This modules implements some of the formatting tags available in
30 ;; Emacs Muse. This is not a way if adding new functionality, but just
31 ;; a different way to write some formatting directives. The advantage is
32 ;; that files written in this way can be read by Muse reasonably well,
33 ;; and that this provides an alternative way of writing formatting
34 ;; directives in Org, a way that some might find more pleasant to type
35 ;; and look at that the Org's #+BEGIN..#+END notation.
37 ;; The goal of this development is to make it easier for people to
38 ;; move between both worlds as they see fit for different tasks.
40 ;; The following muse tags will be translated during export into their
41 ;; native Org equivalents:
42 ;;
43 ;; <br>
44 ;; Needs to be at the end of a line. Will be translated to "\\".
45 ;;
46 ;; <example switches="-n -r">
47 ;; Needs to be on a line by itself, similarly the </example> tag.
48 ;; Will be translated into Org's #+BEGIN_EXAMPLE construct.
49 ;;
50 ;; <quote>
51 ;; Needs to be on a line by itself, similarly the </quote> tag.
52 ;; Will be translated into Org's #+BEGIN_QUOTE construct.
53 ;;
54 ;; <comment>
55 ;; Needs to be on a line by itself, similarly the </comment> tag.
56 ;; Will be translated into Org's #+BEGIN_COMMENT construct.
57 ;;
58 ;; <verse>
59 ;; Needs to be on a line by itself, similarly the </verse> tag.
60 ;; Will be translated into Org's #+BEGIN_VERSE construct.
61 ;;
62 ;; <contents>
63 ;; This gets translated into "[TABLE-OF-CONTENTS]". It will not
64 ;; trigger the production of a table of contents - that is done
65 ;; in Org with the "#+OPTIONS: toc:t" setting. But it will define
66 ;; the location where the TOC will be placed.
67 ;;
68 ;; <literal style="STYLE"> ;; only latex and html supported in Org
69 ;; Needs to be on a line by itself, similarly the </literal> tag.
70 ;;
71 ;; <src lang="LANG" switches="-n -r">
72 ;; Needs to be on a line by itself, similarly the </src> tag.
73 ;; Will be translated into Org's BEGIN_SRC construct.
74 ;;
75 ;; <include file="FILE" markup="MARKUP" lang="LANG" prefix="str" prefix1="str">
76 ;; Needs to be on a line by itself.
77 ;; Will be translated into Org's #+INCLUDE construct.
78 ;;
79 ;; The lisp/perl/ruby/python tags can be implemented using the
80 ;; `org-eval.el' module, which see.
84 ;;; Customization
87 "Options concerning Muse tags in Org mode."
101 "Face for Muse-like tags in Org."
106 "Non-nil means, prefere Muse tags for structure elements.
107 This is relevane when expanding the templates defined in the variable
108 `org-structure-templates'."
114 "The tags that are supported by org-mtags.el for conversion.
125 "Replace Muse-like tags with the appropriate Org constructs.
126 The is done in the entire buffer."
131 info tag rpl style markup lang file prefix prefix1 switches)
132 ;; First, do the <br> tag
136 ;; Now, all the other tags
147 ;; FIXME: also trigger TOC in options-plist?????
148 )
206 "Parse a Muse-like tag at point ant rturn the information about it.
207 The return value is a property list which contains all the attributes
208 with string values. In addition, it reutnrs the following properties:
210 :tag The tag as a string.
216 tag rest prop attributes endp val)
227 rest start)
234 attributes)))
237 "Fontify the muse-like tags."
241 font-lock-fontified t))))
248 ;;; org-mtags.el ends here