| blob | 2d75c825811e5df5ac56389965028a08d9010797 |
1 ;;; rst.el --- Mode for viewing and editing reStructuredText-documents.
3 ;; Copyright (C) 2003-2015 Free Software Foundation, Inc.
5 ;; Maintainer: Stefan Merten <smerten@oekonux.de>
6 ;; Author: Stefan Merten <smerten@oekonux.de>,
7 ;; Martin Blais <blais@furius.ca>,
8 ;; David Goodger <goodger@python.org>,
9 ;; Wei-Wei Guo <wwguocn@gmail.com>
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; This package provides major mode rst-mode, which supports documents marked
29 ;; up using the reStructuredText format. Support includes font locking as well
30 ;; as a lot of convenience functions for editing. It does this by defining a
31 ;; Emacs major mode: rst-mode (ReST). This mode is derived from text-mode.
32 ;; This package also contains:
33 ;;
34 ;; - Functions to automatically adjust and cycle the section underline
35 ;; adornments;
36 ;; - A mode that displays the table of contents and allows you to jump anywhere
37 ;; from it;
38 ;; - Functions to insert and automatically update a TOC in your source
39 ;; document;
40 ;; - Function to insert list, processing item bullets and enumerations
41 ;; automatically;
42 ;; - Font-lock highlighting of most reStructuredText structures;
43 ;; - Indentation and filling according to reStructuredText syntax;
44 ;; - Cursor movement according to reStructuredText syntax;
45 ;; - Some other convenience functions.
46 ;;
47 ;; See the accompanying document in the docutils documentation about
48 ;; the contents of this package and how to use it.
49 ;;
50 ;; For more information about reStructuredText, see
51 ;; http://docutils.sourceforge.net/rst.html
52 ;;
53 ;; For full details on how to use the contents of this file, see
54 ;; http://docutils.sourceforge.net/docs/user/emacs.html
55 ;;
56 ;;
57 ;; There are a number of convenient key bindings provided by rst-mode.
58 ;; For more on bindings, see rst-mode-map below. There are also many variables
59 ;; that can be customized, look for defcustom in this file.
60 ;;
61 ;; If you use the table-of-contents feature, you may want to add a hook to
62 ;; update the TOC automatically every time you adjust a section title::
63 ;;
64 ;; (add-hook 'rst-adjust-hook 'rst-toc-update)
65 ;;
66 ;; Syntax highlighting: font-lock is enabled by default. If you want to turn
67 ;; off syntax highlighting to rst-mode, you can use the following::
68 ;;
69 ;; (setq font-lock-global-modes '(not rst-mode ...))
70 ;;
71 ;;
72 ;;
73 ;; Customization is done by customizable variables contained in customization
74 ;; group "rst" and subgroups. Group "rst" is contained in the "wp" group.
75 ;;
77 ;;; DOWNLOAD
79 ;; The latest release of this file lies in the docutils source code repository:
80 ;; http://docutils.svn.sourceforge.net/svnroot/docutils/trunk/docutils/tools/editors/emacs/rst.el
82 ;;; INSTALLATION
84 ;; Add the following lines to your init file:
85 ;;
86 ;; (require 'rst)
87 ;;
88 ;; If you are using `.txt' as a standard extension for reST files as
89 ;; http://docutils.sourceforge.net/FAQ.html#what-s-the-standard-filename-extension-for-a-restructuredtext-file
90 ;; suggests you may use one of the `Local Variables in Files' mechanism Emacs
91 ;; provides to set the major mode automatically. For instance you may use::
92 ;;
93 ;; .. -*- mode: rst -*-
94 ;;
95 ;; in the very first line of your file. The following code is useful if you
96 ;; want automatically enter rst-mode from any file with compatible extensions:
97 ;;
98 ;; (setq auto-mode-alist
99 ;; (append '(("\\.txt\\'" . rst-mode)
100 ;; ("\\.rst\\'" . rst-mode)
101 ;; ("\\.rest\\'" . rst-mode)) auto-mode-alist))
102 ;;
104 ;;; Code:
106 ;; FIXME: Check through major mode conventions again.
108 ;; FIXME: Add proper ";;;###autoload" comments.
110 ;; FIXME: When 24.1 is common place remove use of `lexical-let' and put "-*-
111 ;; lexical-binding: t -*-" in the first line.
113 ;; FIXME: Use `testcover'.
115 ;; FIXME: The adornment classification often called `ado' should be a
116 ;; `defstruct'.
118 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
119 ;; Support for `testcover'
123 ;; Below `lambda' is used in a loop with varying parameters and is thus not
124 ;; 1valued.
130 "Remove all customized variables from `testcover-module-constants'.
131 This seems to be a bug in `testcover': `defcustom' variables are
132 considered constants. Revert it with this function after each `defcustom'."
139 sym))
140 testcover-module-constants)))))
143 "Add FUN to `testcover-compose-functions'."
148 "Add FUN to `testcover-1value-functions'."
152 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
153 ;; Common Lisp stuff
155 ;; Only use of macros is allowed - may be replaced by `cl-lib' some time.
159 ;; Redefine some functions from `cl.el' in a proper namespace until they may be
160 ;; used from there.
163 "Return 1 if X is positive, -1 if negative, 0 if zero."
170 "Return non-nil if any element of SEQ yields non-nil when PRED is applied.
171 Apply PRED to each element of list SEQ until the first non-nil
172 result is yielded and return this result. PRED defaults to
173 `identity'."
183 "Return position of first element satisfying PRED in list SEQ or nil."
192 "Return position of ELEM in list SEQ or nil.
193 Comparison done with `equal'."
194 ;; Create a closure containing `elem' so the `lambda' always sees our
195 ;; parameter instead of an `elem' which may be in dynamic scope at the time
196 ;; of execution of the `lambda'.
200 seq)))
202 ;; FIXME: Embed complicated `defconst's in `eval-when-compile'.
204 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
205 ;; Versions
207 ;; testcover: ok.
209 "Extract the version from a variable according to the given regexes.
210 Return the version after regex DELIM-RE and HEAD-RE matching RE
211 and before TAIL-RE and DELIM-RE in VAR or DEFAULT for no match."
214 var)
216 default))
218 ;; Use CVSHeader to really get information from CVS and not other version
219 ;; control systems.
232 ;; Use LastChanged... to really get information from SVN.
236 "The SVN revision of this file.
243 ;; Maintained by the release process.
255 rst-official-version
257 rst-cvs-rev rst-cvs-timestamp))
258 "The version string.
259 Starts with the current official version. For developer versions
271 ))
275 rst-version))
280 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
281 ;; Initialize customization
283 \f
289 \f
290 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
291 ;; Facilities for regular expressions used everywhere
293 ;; The trailing numbers in the names give the number of referenceable regex
294 ;; groups contained in the regex.
296 ;; Used to be customizable but really is not customizable but fixed by the reST
297 ;; syntax.
299 ;; Sorted so they can form a character class when concatenated.
310 ;; Sorted so they can form a character class when concatenated.
314 ?-)
318 1000
322 ;; `*-beg' matches * at the beginning of a line.
323 ;; `*-end' matches * at the end of a line.
324 ;; `*-prt' matches a part of *.
325 ;; `*-tag' matches *.
326 ;; `*-sta' matches the start of * which may be followed by respective content.
327 ;; `*-pfx' matches the delimiter left of *.
328 ;; `*-sfx' matches the delimiter right of *.
329 ;; `*-hlp' helper for *.
330 ;;
331 ;; A trailing number says how many referenceable groups are contained.
332 `(
334 ;; Horizontal white space (`hws')
339 ;; Lines (`lin')
344 ;; Various tags and parts
355 ;; Block lead in (`bli')
357 ; immediate content.
359 ;; Various starts
362 ;; Explicit markup tag (`exm')
367 ;; Counters in enumerations (`cnt')
371 ;; Enumerator (`enm')
378 ; enumerator.
385 ; at the beginning of a line.
387 ;; Items may be enumerated or bulleted (`itm')
390 ; is the item tag.
392 ; beginning of a line, group is the
393 ; item tag.
395 ;; Inline markup (`ilm')
399 ;; Inline markup content (`ilc')
404 ; definition.
407 ; definition.
413 (:seq ilcsgl-tag
414 ilcast-prt ilcrep-hlp
417 (:seq ilcsgl-tag
418 ilcbkq-prt ilcrep-hlp
421 (:seq ilcsgl-tag
422 ilcbkqdef-prt ilcrep-hlp
425 (:seq ilcsgl-tag
426 ilcbar-prt ilcrep-hlp
429 (:seq ilcsgl-tag
430 ilcbardef-prt ilcrep-hlp
433 ;; Fields (`fld')
438 ;; Options (`opt')
445 ;; Footnotes and citations (`fnc')
451 ; tag. First group is the explicit markup
452 ; start, second group is the footnote /
453 ; citation tag.
455 ; definition. First group is the explicit
456 ; markup start, second group is the
457 ; footnote / citation tag.
459 ;; Substitutions (`sub')
462 ; tag.
464 ;; Symbol (`sym')
468 ;; URIs (`uri')
471 ;; Adornment (`ado')
474 ; otherwise explicit markup start would be
475 ; recognized.
477 ; characters is matched differently.
480 ; adornment character and MUST be the FIRST
481 ; group in the whole expression.
484 ; adornment character and MUST be the
485 ; SECOND group in the whole expression.
488 ; adornment and MUST be the FIRST group in the whole
489 ; expression; second group is the first adornment
490 ; character.
492 ;; Titles (`ttl')
496 ;; Directives and substitution definitions (`dir')
500 ; tag. First group is explicit markup
501 ; start, second group is a possibly
502 ; empty substitution tag, third group is
503 ; the directive tag including the double
504 ; colon.
506 ; definition. Groups are as in dir-tag-3.
508 ;; Literal block (`lit')
511 ; any text before the double colon tag which
512 ; may not exist, second group is the double
513 ; colon tag.
515 ;; Comments (`cmt')
519 ; start.
521 ;; Paragraphs (`par')
524 ; certain cases.
525 )
526 "Definition alist of relevant regexes.
527 Each entry consists of the symbol naming the regex and an
532 ;; FIXME: Use `sregex' or `rx' instead of re-inventing the wheel.
534 ;; testcover: ok.
536 "Interpret ARGS as regular expressions and return a regex string.
537 Each element of ARGS may be one of the following:
539 A string which is inserted unchanged.
541 A character which is resolved to a quoted regex.
543 A symbol which is resolved to a string using `rst-re-alist-def'.
545 A list with a keyword in the car. Each element of the cdr of such
546 a list is recursively interpreted as ARGS. The results of this
547 interpretation are concatenated according to the keyword.
549 For the keyword `:seq' the results are simply concatenated.
551 For the keyword `:shy' the results are concatenated and
557 For the keyword `:grp' the results are concatenated and form a
560 After interpretation of ARGS the results are concatenated as for
561 `:seq'."
567 re)
590 args)))
592 ;; FIXME: Remove circular dependency between `rst-re' and `rst-re-alist'.
595 ;; Shadow global value we are just defining so we can construct it step by
596 ;; step.
604 \f
605 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
606 ;; Mode definition
608 ;; testcover: ok.
610 "Bind like `define-key' but add deprecated key definitions.
611 KEYMAP, KEY, and DEF are as in `define-key'. DEPRECATED key
612 definitions should be in vector notation. These are defined
613 as well but give an additional message."
633 def def)))
636 ;; Key bindings.
640 ;; \C-c is the general keymap.
643 ;;
644 ;; Section Adornments
645 ;;
646 ;; The adjustment function that adorns or rotates a section title.
649 ; on consoles.
651 ;; \C-c \C-a is the keymap for adornments.
653 ;; Another binding which works with all types of input.
655 ;; Display the hierarchy of adornments implied by the current document
656 ;; contents.
658 ;; Homogenize the adornments in the document.
662 ;;
663 ;; Section Movement and Selection
664 ;;
665 ;; Mark the subsection where the cursor is.
667 ;; Same as mark-defun sgml-mark-current-element.
669 ;; Move backward/forward between section titles.
670 ;; FIXME: Also bind similar to outline mode.
672 ;; Same as beginning-of-defun.
675 ;; Same as end-of-defun.
678 ;;
679 ;; Operating on regions
680 ;;
681 ;; \C-c \C-r is the keymap for regions.
683 ;; Makes region a line-block.
686 ;; Shift region left or right according to tabs.
690 ;;
691 ;; Operating on lists
692 ;;
693 ;; \C-c \C-l is the keymap for lists.
695 ;; Makes paragraphs in region as a bullet list.
698 ;; Makes paragraphs in region as a enumeration.
701 ;; Converts bullets to an enumeration.
704 ;; Make sure that all the bullets in the region are consistent.
707 ;; Insert a list item.
710 ;;
711 ;; Table-of-Contents Features
712 ;;
713 ;; \C-c \C-t is the keymap for table of contents.
715 ;; Enter a TOC buffer to view and move to a specific section.
717 ;; Insert a TOC here.
720 ;; Update the document's TOC (without changing the cursor position).
723 ;; Go to the section under the cursor (cursor must be in TOC).
727 ;;
728 ;; Converting Documents from Emacs
729 ;;
730 ;; \C-c \C-c is the keymap for compilation.
732 ;; Run one of two pre-configured toolset commands on the document.
737 ;; Convert the active region to pseudo-xml using the docutils tools.
740 ;; Convert the current document to PDF and launch a viewer on the results.
743 ;; Convert the current document to S5 slides and view in a web browser.
747 map)
748 "Keymap for reStructuredText mode commands.
752 ;; Abbrevs.
760 ;; FIXME: Add footnotes, links, and more.
761 ))
765 ;; Syntax table.
788 st)
792 "Hook run when `rst-mode' is turned on.
793 The hook for `text-mode' is run before this one."
798 ;; Pull in variable definitions silencing byte-compiler.
803 ;; Use rst-mode for *.rst and *.rest files. Many ReStructured-Text files
804 ;; use *.txt, but this is too generic to be set as a default.
805 ;;;###autoload (add-to-list 'auto-mode-alist (purecopy '("\\.re?st\\'" . rst-mode)))
806 ;;;###autoload
808 "Major mode for editing reStructuredText documents.
811 Turning on `rst-mode' calls the normal hooks `text-mode-hook'
812 and `rst-mode-hook'. This mode also supports font-lock
813 highlighting.
816 :abbrev-table rst-mode-abbrev-table
817 :syntax-table rst-mode-syntax-table
820 ;; Paragraph recognition.
824 lin-end)))
828 lin-end
831 ;; Indenting and filling.
839 ;; Comments.
846 ;; reStructuredText has not really a comment ender but nil is not really a
847 ;; permissible value.
851 ;; Commenting in reStructuredText is very special so use our own set of
852 ;; functions.
867 ;; Imenu and which function.
868 ;; FIXME: Check documentation of `which-function' for alternative ways to
869 ;; determine the current function name.
873 ;; Font lock.
876 t nil nil nil
881 ;; Text after a changed line may need new fontification.
884 ;; Indentation is not deterministic.
887 ;;;###autoload
889 "Toggle ReST minor mode.
890 With a prefix argument ARG, enable ReST minor mode if ARG is
891 positive, and disable it otherwise. If called from Lisp, enable
892 the mode if ARG is omitted or nil.
894 When ReST minor mode is enabled, the ReST mode keybindings
895 are installed on top of the major mode bindings. Use this
896 for modes derived from Text mode, like Mail mode."
897 ;; The initial value.
898 nil
899 ;; The indicator for the mode line.
900 " ReST"
901 ;; The minor mode bindings.
902 rst-mode-map
905 ;; FIXME: can I somehow install these too?
906 ;; :abbrev-table rst-mode-abbrev-table
907 ;; :syntax-table rst-mode-syntax-table
909 \f
910 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
911 ;; Section Adornment Adjustment
912 ;; ============================
913 ;;
914 ;; The following functions implement a smart automatic title sectioning feature.
915 ;; The idea is that with the cursor sitting on a section title, we try to get as
916 ;; much information from context and try to do the best thing automatically.
917 ;; This function can be invoked many times and/or with prefix argument to rotate
918 ;; between the various sectioning adornments.
919 ;;
920 ;; Definitions: the two forms of sectioning define semantically separate section
921 ;; levels. A sectioning ADORNMENT consists in:
922 ;;
923 ;; - a CHARACTER
924 ;;
925 ;; - a STYLE which can be either of 'simple' or 'over-and-under'.
926 ;;
927 ;; - an INDENT (meaningful for the over-and-under style only) which determines
928 ;; how many characters and over-and-under style is hanging outside of the
929 ;; title at the beginning and ending.
930 ;;
931 ;; Here are two examples of adornments (| represents the window border, column
932 ;; 0):
933 ;;
934 ;; |
935 ;; 1. char: '-' e |Some Title
936 ;; style: simple |----------
937 ;; |
938 ;; 2. char: '=' |==============
939 ;; style: over-and-under | Some Title
940 ;; indent: 2 |==============
941 ;; |
942 ;;
943 ;; Some notes:
944 ;;
945 ;; - The underlining character that is used depends on context. The file is
946 ;; scanned to find other sections and an appropriate character is selected.
947 ;; If the function is invoked on a section that is complete, the character is
948 ;; rotated among the existing section adornments.
949 ;;
950 ;; Note that when rotating the characters, if we come to the end of the
951 ;; hierarchy of adornments, the variable rst-preferred-adornments is
952 ;; consulted to propose a new underline adornment, and if continued, we cycle
953 ;; the adornments all over again. Set this variable to nil if you want to
954 ;; limit the underlining character propositions to the existing adornments in
955 ;; the file.
956 ;;
957 ;; - An underline/overline that is not extended to the column at which it should
958 ;; be hanging is dubbed INCOMPLETE. For example::
959 ;;
960 ;; |Some Title
961 ;; |-------
962 ;;
963 ;; Examples of default invocation:
964 ;;
965 ;; |Some Title ---> |Some Title
966 ;; | |----------
967 ;;
968 ;; |Some Title ---> |Some Title
969 ;; |----- |----------
970 ;;
971 ;; | |------------
972 ;; | Some Title ---> | Some Title
973 ;; | |------------
974 ;;
975 ;; In over-and-under style, when alternating the style, a variable is
976 ;; available to select how much default indent to use (it can be zero). Note
977 ;; that if the current section adornment already has an indent, we don't
978 ;; adjust it to the default, we rather use the current indent that is already
979 ;; there for adjustment (unless we cycle, in which case we use the indent
980 ;; that has been found previously).
983 "Settings for adjustment and cycling of section title adornments."
997 "Preferred hierarchy of section title adornments.
999 A list consisting of lists of the form (CHARACTER STYLE INDENT).
1000 CHARACTER is the character used. STYLE is one of the symbols
1001 `over-and-under' or `simple'. INDENT is an integer giving the
1002 wanted indentation for STYLE `over-and-under'. CHARACTER and
1003 STYLE are always used when a section adornment is described.
1004 In other places, t instead of a list stands for a transition.
1006 This sequence is consulted to offer a new adornment suggestion
1007 when we rotate the underlines at the end of the existing
1008 hierarchy of characters, or when there is no existing section
1009 title in the file.
1011 Set this to an empty list to use only the adornment found in the
1012 file."
1020 rst-adornment-chars))
1029 "Number of characters to indent the section title.
1031 This is used for when toggling adornment styles, when switching
1032 from a simple adornment style to a over-and-under adornment
1033 style."
1039 "Compare adornments.
1040 Return true if both ADO1 and ADO2 adornments are equal,
1041 according to restructured text semantics (only the character
1042 and the style are compared, the indentation does not matter)."
1048 "Return the index (level) in hierarchy HIER of adornment ADO.
1049 This basically just searches for the item using the appropriate
1050 comparison and returns the index. Return nil if the item is
1051 not found."
1055 cur))
1057 ;; testcover: FIXME: Test with `rst-preferred-adornments' == nil. Add test
1058 ;; `rst-adjust-no-preference'.
1060 "Suggest a new, different adornment from all that have been seen.
1062 ALLADOS is the set of all adornments, including the line numbers.
1063 PREV is the optional previous adornment, in order to suggest a
1064 better match."
1066 ;; For all the preferred adornments...
1068 ;; If 'prev' is given, reorder the list to start searching after the
1069 ;; match.
1073 ;; List of candidates to search.
1076 ;; For all the adornments...
1078 found)
1081 ;; Found it!
1084 found)
1091 "Delete the entire current line without using the `kill-ring'."
1096 "Unconditionally update the style of a section adornment.
1098 Do this using the given character CHAR, with STYLE `simple'
1099 or `over-and-under', and with indent INDENT. If the STYLE
1100 is `simple', whitespace before the title is removed (indent
1101 is always assumed to be 0).
1103 If there are existing overline and/or underline from the
1104 existing adornment, they are removed before adding the
1105 requested adornment."
1108 len)
1110 ;; Fixup whitespace at the beginning and end of the line.
1120 ;; Set the current column, we're at the end of the title line.
1123 ;; Remove previous line if it is an adornment.
1126 ;; of buffer.
1128 ;; Avoid removing the underline of a title right above us.
1133 ;; Remove following line if it is an adornment.
1136 ;; of buffer.
1139 ;; Add a newline if we're at the end of the buffer, for the subsequence
1140 ;; inserting of the underline.
1144 ;; Insert overline.
1151 ;; Insert underline.
1162 "Classify adornment for section titles and transitions.
1163 ADORNMENT is the complete adornment string as found in the buffer
1164 with optional trailing whitespace. END is the point after the
1165 last character of ADORNMENT.
1167 Return a list. The first entry is t for a transition or a
1168 cons (CHARACTER . STYLE). Check `rst-preferred-adornments' for
1169 the meaning of CHARACTER and STYLE.
1171 The remaining list forms four match groups as returned by
1172 `match-data'. Match group 0 matches the whole construct. Match
1173 group 1 matches the overline adornment if present. Match group 2
1174 matches the section title text or the transition. Match group 3
1175 matches the underline adornment.
1177 Return nil if no syntactically valid adornment is found."
1192 ;; testcover: FIXME: Add test classifying at the end of
1193 ;; buffer.
1203 ;; classifying at the end of
1204 ;; buffer.
1217 ;; classifying at the end of
1218 ;; buffer.
1227 key beg-ovr end-ovr beg-txt end-txt beg-und end-und)
1230 ;; A transition.
1232 beg-txt beg-pnt
1233 end-txt end-pnt))
1235 ;; An overline with an underline.
1251 ;; An underline.
1253 beg-und beg-pnt
1254 end-und end-pnt)
1259 ;; Invalid adornment.
1265 beg-ovr end-ovr beg-txt end-txt beg-und end-und)))))))
1268 "Find a section title line around point and return its characteristics.
1269 If the point is on an adornment line find the respective title
1270 line. If the point is on an empty line check previous or next
1271 line whether it is a suitable title line and use it if so. If
1272 point is on a suitable title line use it.
1274 If no title line is found return nil.
1276 Otherwise return as `rst-classify-adornment' does. However, if
1277 the title line has no syntactically valid adornment, STYLE is nil
1278 in the first element. If there is no adornment around the title,
1279 CHARACTER is also nil and match groups for overline and underline
1280 are nil."
1293 ;; Invalid adornment - check whether this is an incomplete overline.
1300 ;; A section title - not a transition.
1301 r))))
1315 ;; Try to use the underline.
1321 r
1322 ;; No valid adornment found.
1326 ;; The following function and variables are used to maintain information about
1327 ;; current section adornment in a buffer local cache. Thus they can be used for
1328 ;; font-locking and manipulation commands.
1331 "All section adornments in the buffer as found by `rst-find-all-adornments'.
1335 ;; FIXME: If this variable is set to a different value font-locking of section
1336 ;; headers is wrong.
1338 "Section hierarchy in the buffer as determined by `rst-get-hierarchy'.
1339 Set to t when no section adornments were found.
1345 "Reset all section cache variables.
1346 Should be called by interactive functions which deal with sections."
1348 rst-section-hierarchy nil))
1351 "Return all the section adornments in the current buffer.
1352 Return a list of (LINE . ADORNMENT) with ascending LINE where
1353 LINE is the line containing the section title. ADORNMENT consists
1354 of a (CHARACTER STYLE INDENT) triple as described for
1355 `rst-preferred-adornments'.
1357 Uses and sets `rst-all-sections'."
1360 ;; Iterate over all the section titles/adornments in the file.
1374 positions)
1379 nil
1380 rst-all-sections))
1383 "Build a hierarchy of adornments using the list of given ADORNMENTS.
1385 ADORNMENTS is a list of (CHARACTER STYLE INDENT) adornment
1386 specifications, in order that they appear in a file, and will
1387 infer a hierarchy of section levels by removing adornments that
1388 have already been seen in a forward traversal of the adornments,
1389 comparing just CHARACTER and STYLE.
1391 Similarly returns a list of (CHARACTER STYLE INDENT), where each
1392 list element should be unique."
1402 "Return the hierarchy of section titles in the file.
1404 Return a list of adornments that represents the hierarchy of
1405 section titles in the file. Each element consists of (CHARACTER
1406 STYLE INDENT) as described for `rst-find-all-adornments'. If the
1407 line number in IGNORE is specified, a possibly adornment found on
1408 that line is not taken into account when building the hierarchy.
1410 Uses and sets `rst-section-hierarchy' unless IGNORE is given."
1413 nil
1414 rst-section-hierarchy)
1418 ignore
1422 ;; Clear cache reflecting that a possible update is not
1423 ;; reflected.
1424 nil
1426 r)))
1429 "Return the adornments around point.
1430 Return a list of the previous and next adornments."
1433 prev next
1436 ;; Search for the adornments around the current line.
1440 ;; 'cur' is the following adornment.
1448 "Return true if the adornment ADO around point is complete."
1449 ;; Note: we assume that the detection of the overline as being the underline
1450 ;; of a preceding title has already been detected, and has been eliminated
1451 ;; from the adornment that is given to us.
1453 ;; There is some sectioning already present, so check if the current
1454 ;; sectioning is complete and correct.
1473 "Get the next adornment for CURADO, in given hierarchy HIER.
1474 If suggesting, suggest for new adornment SUGGESTION.
1475 REVERSE-DIRECTION is used to reverse the cycling order."
1481 ;; Build a new list of adornments for the rotation.
1484 ;; Suggest a new adornment.
1486 ;; If nothing to suggest, use first adornment.
1489 ;; Search for next adornment.
1497 cur))
1499 ;; If not found, take the first of all adornments.
1500 suggestion)))
1503 ;; FIXME: A line "``/`` full" is not accepted as a section title.
1505 "Auto-adjust the adornment around point.
1507 Adjust/rotate the section adornment for the section title around
1508 point or promote/demote the adornments inside the region,
1509 depending on whether the region is active. This function is meant
1510 to be invoked possibly multiple times, and can vary its behavior
1511 with a positive PFXARG (toggle style), or with a negative
1512 PFXARG (alternate behavior).
1514 This function is a bit of a swiss knife. It is meant to adjust
1515 the adornments of a section title in reStructuredText. It tries
1519 See the documentations of `rst-adjust-adornment-work' and
1520 `rst-promote-region' for full details.
1522 Prefix Arguments
1523 ================
1525 The method can take either (but not both) of
1527 a. a (non-negative) prefix argument, which means to toggle the
1528 adornment style. Invoke with a prefix argument for example;
1530 b. a negative numerical argument, which generally inverts the
1531 direction of search in the file or hierarchy. Invoke with C--
1532 prefix for example."
1542 ;; Adjust adornments within region.
1544 ;; Adjust adornment around point.
1547 ;; Run the hooks to run after adjusting.
1550 ;; Make sure to reset the cursor position properly after we're done.
1554 "Hooks to be run after running `rst-adjust'."
1561 "Controls level of new adornment for section headers."
1570 "Call `rst-adjust-adornment-work' interactively.
1572 Keep this for compatibility for older bindings (are there any?).
1573 Argument PFXARG has the same meaning as for `rst-adjust'."
1581 "Adjust/rotate the section adornment for the section title around point.
1583 This function is meant to be invoked possibly multiple times, and
1584 can vary its behavior with a true TOGGLE-STYLE argument, or with
1585 a REVERSE-DIRECTION argument.
1587 General Behavior
1588 ================
1590 The next action it takes depends on context around the point, and
1591 it is meant to be invoked possibly more than once to rotate among
1592 the various possibilities. Basically, this function deals with:
1594 - adding a adornment if the title does not have one;
1596 - adjusting the length of the underline characters to fit a
1597 modified title;
1599 - rotating the adornment in the set of already existing
1600 sectioning adornments used in the file;
1602 - switching between simple and over-and-under styles.
1604 You should normally not have to read all the following, just
1605 invoke the method and it will do the most obvious thing that you
1606 would expect.
1609 Adornment Definitions
1610 =====================
1612 The adornments consist in
1614 1. a CHARACTER
1616 2. a STYLE which can be either `simple' or `over-and-under'.
1618 3. an INDENT (meaningful for the over-and-under style only)
1619 which determines how many characters and over-and-under
1620 style is hanging outside of the title at the beginning and
1621 ending.
1623 See source code for mode details.
1626 Detailed Behavior Description
1627 =============================
1629 Here are the gory details of the algorithm (it seems quite
1630 complicated, but really, it does the most obvious thing in all
1631 the particular cases):
1633 Before applying the adornment change, the cursor is placed on
1634 the closest line that could contain a section title.
1636 Case 1: No Adornment
1637 --------------------
1639 If the current line has no adornment around it,
1641 - search backwards for the last previous adornment, and apply
1642 the adornment one level lower to the current line. If there
1643 is no defined level below this previous adornment, we suggest
1644 the most appropriate of the `rst-preferred-adornments'.
1646 If REVERSE-DIRECTION is true, we simply use the previous
1647 adornment found directly.
1649 - if there is no adornment found in the given direction, we use
1650 the first of `rst-preferred-adornments'.
1652 TOGGLE-STYLE forces a toggle of the prescribed adornment style.
1654 Case 2: Incomplete Adornment
1655 ----------------------------
1657 If the current line does have an existing adornment, but the
1658 adornment is incomplete, that is, the underline/overline does
1659 not extend to exactly the end of the title line (it is either
1660 too short or too long), we simply extend the length of the
1661 underlines/overlines to fit exactly the section title.
1663 If TOGGLE-STYLE we toggle the style of the adornment as well.
1665 REVERSE-DIRECTION has no effect in this case.
1667 Case 3: Complete Existing Adornment
1668 -----------------------------------
1670 If the adornment is complete (i.e. the underline (overline)
1671 length is already adjusted to the end of the title line), we
1672 search/parse the file to establish the hierarchy of all the
1673 adornments (making sure not to include the adornment around
1674 point), and we rotate the current title's adornment from within
1675 that list (by default, going *down* the hierarchy that is present
1676 in the file, i.e. to a lower section level). This is meant to be
1677 used potentially multiple times, until the desired adornment is
1678 found around the title.
1680 If we hit the boundary of the hierarchy, exactly one choice from
1681 the list of preferred adornments is suggested/chosen, the first
1682 of those adornment that has not been seen in the file yet (and
1683 not including the adornment around point), and the next
1684 invocation rolls over to the other end of the hierarchy (i.e. it
1685 cycles). This allows you to avoid having to set which character
1686 to use.
1688 If REVERSE-DIRECTION is true, the effect is to change the
1689 direction of rotation in the hierarchy of adornments, thus
1690 instead going *up* the hierarchy.
1692 However, if TOGGLE-STYLE, we do not rotate the adornment, but
1693 instead simply toggle the style of the current adornment (this
1694 should be the most common way to toggle the style of an existing
1695 complete adornment).
1698 Point Location
1699 ==============
1701 The invocation of this function can be carried out anywhere
1702 within the section title line, on an existing underline or
1703 overline, as well as on an empty line following a section title.
1704 This is meant to be as convenient as possible.
1707 Indented Sections
1708 =================
1710 Indented section titles such as ::
1712 My Title
1713 --------
1715 are invalid in reStructuredText and thus not recognized by the
1716 parser. This code will thus not work in a way that would support
1717 indented sections (it would be ambiguous anyway).
1720 Joint Sections
1721 ==============
1723 Section titles that are right next to each other may not be
1724 treated well. More work might be needed to support those, and
1725 special conditions on the completeness of existing adornments
1726 might be required to make it non-ambiguous.
1728 For now we assume that the adornments are disjoint, that is,
1729 there is at least a single line between the titles/adornment
1730 lines."
1742 char-new style-new indent-new)
1744 ;;-------------------------------------------------------------------
1745 ;; Case 1: No valid adornment
1748 cur
1750 ;; Advance one level down.
1756 prev
1760 ;; Invert the style if requested.
1767 ;;-------------------------------------------------------------------
1768 ;; Case 2: Incomplete Adornment
1770 ;; Invert the style if requested.
1774 style-new style
1775 indent-new indent))
1776 ;;-------------------------------------------------------------------
1777 ;; Case 3: Complete Existing Adornment
1780 ;; Simply switch the style of the current adornment.
1783 indent-new rst-default-indent)
1784 ;; Else, we rotate, ignoring the adornment around the current
1785 ;; line...
1787 ;; Suggestion, in case we need to come up with something new.
1789 hier
1792 curado hier suggestion reverse-direction)))
1793 ;; Indent, if present, always overrides the prescribed indent.
1797 ;; Override indent with present indent!
1801 ;; Correct the position of the cursor to more accurately reflect where
1802 ;; it was located when the function was invoked.
1807 ;; Maintain an alias for compatibility.
1812 "Promote the section titles within the region.
1814 With argument DEMOTE or a prefix argument, demote the section
1815 titles instead. The algorithm used at the boundaries of the
1816 hierarchy is similar to that used by `rst-adjust-adornment-work'."
1826 marker-list)
1828 ;; Skip the markers that come before the region beginning.
1832 ;; Create a list of markers for all the adornments which are found within
1833 ;; the region.
1842 ;; Apply modifications.
1844 ;; Go to the adornment to promote.
1847 ;; Update the adornment.
1849 ;; Rotate the next adornment.
1853 ;; Clear marker to avoid slowing down the editing after we're done.
1860 "Display the current file's section title adornments hierarchy.
1861 This function expects a list of (CHARACTER STYLE INDENT) triples
1862 in ADORNMENTS."
1878 "Redo all the adornments in the current buffer.
1879 This is done using our preferred set of adornments. This can be
1880 used, for example, when using somebody else's copy of a document,
1881 in order to adapt it to our preferred style."
1896 ;; Go to the appropriate position.
1899 ;; Apply the new style.
1902 ;; Reset the marker to avoid slowing down editing until it gets GC'ed.
1905 \f
1906 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1907 ;; Insert list items
1908 ;; =================
1911 ;=================================================
1912 ; Borrowed from a2r.el (version 1.3), by Lawrence Mitchell <wence@gmx.li>.
1913 ; I needed to make some tiny changes to the functions, so I put it here.
1914 ; -- Wei-Wei Guo
1924 "Convert Arabic number NUM to its Roman numeral representation.
1926 Obviously, NUM must be greater than zero. Don't blame me, blame the
1928 apologies to Monty Python).
1929 If optional ARG is non-nil, insert in current buffer."
1931 res)
1941 "Convert STRING of Roman numerals to an Arabic number.
1943 If STRING contains a letter which isn't a valid Roman numeral,
1944 the rest of the string from that point onwards is ignored.
1946 Hence:
1947 MMD == 2500
1948 and
1949 MMDFLXXVI == 2500.
1950 If optional ARG is non-nil, insert in current buffer."
1959 ;=================================================
1962 "Find all the positions of prefixes in region between BEG and END.
1963 This is used to find bullets and enumerated list items. PFX-RE is
1964 a regular expression for matching the lines after indentation
1965 with items. Returns a list of cons cells consisting of the point
1966 and the column of the point."
1983 pfx))
1988 "Arrange relative position of a newly inserted list item of style NEWITEM.
1990 Adding a new list might consider three situations:
1992 (a) Current line is a blank line.
1993 (b) Previous line is a blank line.
1994 (c) Following line is a blank line.
1996 When (a) and (b), just add the new list at current line.
1998 when (a) and not (b), a blank line is added before adding the new list.
2000 When not (a), first forward point to the end of the line, and add two
2001 blank lines, then add the new list.
2003 Other situations are just ignored and left to users themselves."
2015 ;; FIXME: Isn't this a `defconst'?
2024 ;; FIXME: Isn't this a `defconst'?
2030 "Insert a new list item.
2032 User is asked to select the item style first, for example (a), i), +.
2033 Use TAB for completion and choices.
2035 If user selects bullets or #, it's just added with position arranged by
2036 `rst-insert-list-pos'.
2038 If user selects enumerations, a further prompt is given. User need to
2039 input a starting item, for example 'e' for 'A)' style. The position is
2040 also arranged by `rst-insert-list-pos'."
2042 ;; FIXME: Make this comply to `interactive' standards.
2044 "Select preferred item style [#.]: "
2050 ;; FIXME: Make this comply to `interactive' standards.
2075 "List of favorite bullets."
2081 rst-bullets)))
2086 "Insert a list item with list start CURITEM including its indentation level.
2087 If PREFER-ROMAN roman numbering is preferred over using letters."
2094 curitem)
2098 nil nil curitem))
2103 ;; FIXME: Assumes one line list items without separating
2104 ;; empty lines.
2121 t nil curitem))
2125 nil nil curitem)))))
2129 "Insert a list item at the current point.
2131 The command can insert a new list or a continuing list. When it is called at a
2132 non-list line, it will promote to insert new list. When it is called at a list
2133 line, it will insert a list with the same list style.
2135 1. When inserting a new list:
2137 User is asked to select the item style first, for example (a), i), +. Use TAB
2138 for completion and choices.
2140 (a) If user selects bullets or #, it's just added.
2141 (b) If user selects enumerations, a further prompt is given. User needs to
2142 input a starting item, for example `e' for `A)' style.
2144 The position of the new list is arranged according to whether or not the
2145 current line and the previous line are blank lines.
2147 2. When continuing a list, one thing needs to be noticed:
2149 List style alphabetical list, such as `a.', and roman numerical list, such as
2150 `i.', have some overlapping items, for example `v.' The function can deal with
2151 the problem elegantly in most situations. But when those overlapped list are
2152 preceded by a blank line, it is hard to determine which type to use
2153 automatically. The function uses alphabetical list by default. If you want
2154 roman numerical list, just use a prefix to set PREFER-ROMAN."
2162 "Make all the bulleted list items in the region consistent.
2163 The region is specified between BEG and END. You can use this
2164 after you have merged multiple bulleted lists to make them use
2165 the same/correct/consistent bullet characters.
2167 See variable `rst-preferred-bullets' for the list of bullets to
2168 adjust. If bullets are found on levels beyond the
2169 `rst-preferred-bullets' list, they are not modified."
2175 ;; Create a map of levels to list of positions.
2181 levtable)))
2183 ;; Sort this map and create a new map of prefix char and list of positions.
2190 ;; Apply the characters.
2197 \f
2198 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2199 ;; Table of contents
2200 ;; =================
2202 ;; FIXME: Return value should be a `defstruct'.
2204 "Return the hierarchical tree of section titles.
2205 A tree entry looks like ((TITLE MARKER) CHILD...). TITLE is the
2206 stripped text of the section title. MARKER is a marker for the
2207 beginning of the title text. For the top node or a missing
2208 section level node TITLE is nil and MARKER points to the title
2209 text of the first child. Each CHILD is another tree entry. The
2210 CHILD list may be empty."
2213 lev-ttl-mrk-l)
2217 ;; Compare just the character and indent in the hash table.
2221 ;; Create a list that contains (LEVEL TITLE MARKER) for each adornment.
2229 ;; Get title.
2240 ;; FIXME: Return value should be a `defstruct'.
2242 "Process the first entry of REMAINING expected to be on level LEV.
2243 REMAINING is the remaining list of adornments consisting
2244 of (LEVEL TITLE MARKER) entries.
2246 Return (UNPROCESSED (TITLE MARKER) CHILD...) for the first entry
2247 of REMAINING where TITLE is nil if the expected level is not
2248 matched. UNPROCESSED is the list of still unprocessed entries.
2249 Each CHILD is a child of this entry in the same format but
2250 without UNPROCESSED."
2253 ttl-mrk children)
2254 ;; If the current adornment matches expected level.
2256 ;; Consume the current entry and create the current node with it.
2260 ;; Build the child nodes as long as they have deeper level.
2269 ;; Node on this level missing - use nil as text and the
2270 ;; marker of the first child.
2272 children))))
2275 "Return section containing POINT by returning the closest node in TREE.
2276 TREE is a section tree as returned by `rst-section-tree'
2277 consisting of (NODE CHILD...) entries. POINT defaults to the
2278 current point. A NODE must have the structure (IGNORED MARKER...).
2280 Return (PATH NODE CHILD...). NODE is the node where POINT is in
2281 if any. PATH is a list of nodes from the top of the tree down to
2282 and including NODE. List of CHILD are the children of NODE if any."
2286 ;; Point behind current node?
2288 ;; Iterate all the children, looking for one that might contain the
2289 ;; current section.
2295 ;; Found section containing point in children.
2297 ;; Extend path with current node and return NODE CHILD... from
2298 ;; sub.
2300 ;; Point in this section: Start a new path with current node and
2301 ;; return current NODE CHILD...
2303 ;; Current node behind point: start a new path with current node and
2304 ;; no NODE CHILD...
2308 "Settings for reStructuredText table of contents."
2313 "Indentation for table-of-contents display.
2314 Also used for formatting insertion, when numbering is disabled."
2320 "Insertion style for table-of-contents.
2321 Set this to one of the following values to determine numbering and
2322 indentation style:
2323 - `plain': no numbering (fixed indentation)
2324 - `fixed': numbering, but fixed indentation
2325 - `aligned': numbering, titles aligned under each other
2326 - `listed': numbering, with dashes like list items (EXPERIMENTAL)"
2335 "Separator that goes between the TOC number and the title."
2340 ;; This is used to avoid having to change the user's mode.
2344 map)
2348 "If non-nil, maximum depth of the inserted TOC."
2354 "Insert a simple text rendering of the table of contents.
2355 By default the top level is ignored if there is only one, because
2356 we assume that the document will have a single title.
2358 If a numeric prefix argument PFXARG is given, insert the TOC up
2359 to the specified level.
2361 The TOC is inserted indented at the current column."
2369 ;; Get the section tree for the current cursor point.
2374 ;; Figure out initial indent.
2381 ;; Fixup for the first line.
2384 ;; Delete the last newline added.
2388 "Insert tree node NODE in table-of-contents.
2389 Recursive function that does printing of the inserted TOC.
2390 LEVEL is the depth level of the sections in the tree.
2391 INDENT is the indentation string. PFX is the prefix numbering,
2392 that includes the alignment necessary for all the children of
2393 level to align."
2395 ;; Note: we do child numbering from the parent, so we start number the
2396 ;; children one level before we print them.
2405 ;; Add properties to the text, even though in normal text mode it
2406 ;; won't be doing anything for now. Not sure that I want to change
2407 ;; mode stuff. At least the highlighting gives the idea that this
2408 ;; is generated automatically.
2414 ;; Prepare indent for children.
2433 fmt)
2436 ;; Add a separating dot if there is already a prefix.
2441 ;; Calculate the amount of space that the prefix will require
2442 ;; for the numbers.
2451 indent
2458 "Automatically find the contents section of a document and update.
2459 Updates the inserted TOC if present. You can use this in your
2460 file-write hook to always make it up-to-date automatically."
2463 ;; Find and delete an existing comment after the first contents directive.
2464 ;; Delete that region.
2466 ;; We look for the following and the following only (in other words, if your
2467 ;; syntax differs, this won't work.).
2468 ;;
2469 ;; .. contents:: [...anything here...]
2470 ;; [:field: value]...
2471 ;; ..
2472 ;; XXXXXXXX
2473 ;; XXXXXXXX
2474 ;; [more lines]
2478 last-real)
2480 ;; Look for the first line that starts at the first column.
2497 ;; Note: always return nil, because this may be used as a hook.
2498 nil)
2500 ;; Note: we cannot bind the TOC update on file write because it messes with
2501 ;; undo. If we disable undo, since it adds and removes characters, the
2502 ;; positions in the undo list are not making sense anymore. Dunno what to do
2503 ;; with this, it would be nice to update when saving.
2504 ;;
2505 ;; (add-hook 'write-contents-hooks 'rst-toc-update-fun)
2506 ;; (defun rst-toc-update-fun ()
2507 ;; ;; Disable undo for the write file hook.
2508 ;; (let ((buffer-undo-list t)) (rst-toc-update) ))
2512 ;;------------------------------------------------------------------------------
2515 "Recursive function that does insert NODE at LEVEL in the table-of-contents."
2519 ;; Insert line text.
2523 ;; Highlight lines.
2526 ;; Add link on lines.
2535 "Count the number of lines from NODE to the TARGET-NODE node.
2536 This recursive function returns a cons of the number of
2537 additional lines that have been counted for its node and
2538 children, and t if the node has been found."
2541 found)
2560 "Display a table-of-contents.
2561 Finds all the section titles and their adornments in the
2562 file, and displays a hierarchically-organized list of the
2563 titles, which is essentially a table-of-contents of the
2564 document.
2566 The Emacs buffer can be navigated, and selecting a section
2567 brings the cursor in that section."
2574 line
2576 ;; Create a temporary buffer.
2588 ;; Count the lines to our found node.
2594 ;; Save the buffer to return to.
2597 ;; Move the cursor near the right section in the TOC.
2603 "Get the section from text property at point."
2609 pos))
2611 ;; FIXME: Cursor before or behind the list must be handled properly; before the
2612 ;; list should jump to the top and behind the list to the last normal
2613 ;; paragraph.
2615 "Go to the section the current line describes.
2616 If KILL a TOC buffer is destroyed."
2620 ;; FIXME: This should rather go to `rst-toc-mode-goto-section'.
2625 ;; FIXME: make the recentering conditional on scroll.
2629 "Go to the section the current line describes and kill the TOC buffer."
2634 "In `rst-toc' mode, go to the occurrence whose line you click on.
2635 EVENT is the input event."
2647 "Same as `rst-toc-mode-mouse-goto', but kill TOC buffer as well.
2648 EVENT is the input event."
2654 "Leave the current TOC buffer."
2668 map)
2673 ;; Could inherit from the new `special-mode'.
2678 ;; Note: use occur-mode (replace.el) as a good example to complete missing
2679 ;; features.
2681 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2682 ;; Section movement commands
2683 ;; =========================
2686 "Skip to the next reStructuredText section title.
2687 OFFSET specifies how many titles to skip. Use a negative OFFSET
2688 to move backwards in the file (default is to use 1)."
2694 ;; Get all the adornments in the file, with their line numbers.
2697 ;; Get the current line.
2703 ;; Find the index of the "next" adornment w.r.t. to the current line.
2707 ;; 'cur' is the adornment on or following the current line.
2712 ;; Find the final index.
2716 ;; If the index is positive, goto the line, otherwise go to the buffer
2717 ;; boundaries.
2725 "Like `rst-forward-section', except move back one title."
2729 ;; FIXME: What is `allow-extend' for?
2731 "Select COUNT sections around point.
2732 Mark following sections for positive COUNT or preceding sections
2733 for negative COUNT."
2734 ;; Cloned from mark-paragraph.
2752 \f
2753 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2754 ;; Functions to work on item lists (e.g. indent/dedent, enumerate), which are
2755 ;; always 2 or 3 characters apart horizontally with rest.
2758 "Return the leftmost column in region BEG to END."
2769 mincol))
2771 ;; FIXME: This definition is old and deprecated. We need to move to the newer
2772 ;; version below.
2775 ;; FIXME: The following comment is pretty useless.
2776 "Call FUN at the beginning of each line, with an argument that
2777 specifies whether we are at the first line of a paragraph that
2778 starts at the leftmost column of the given region BEG and END.
2779 Set FIRST-ONLY to true if you want to callback on the first line
2780 of each paragraph only."
2802 valid)
2803 ,body-consequent
2806 ;; FIXME: This needs to be refactored. Probably this is simply a function
2807 ;; applying BODY rather than a macro.
2809 "Evaluate BODY for each line in region defined by BEG END.
2810 LEFTMOST is set to true if the line is one of the leftmost of the
2811 entire paragraph. PARABEGIN is set to true if the line is the
2812 first of a paragraph."
2842 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2843 ;; Indentation
2845 ;; FIXME: At the moment only block comments with leading empty comment line are
2846 ;; supported. Comment lines with leading comment markup should be also
2847 ;; supported. May be a customizable option could control which style to
2848 ;; prefer.
2852 In reStructuredText indentation points are usually determined by
2853 preceding lines. Sometimes the syntax allows arbitrary indentation
2854 points such as where to start the first line following a directive.
2855 These indentation widths can be customized here."
2862 "Indentation when there is no more indentation point given."
2868 "Indentation for first line after a field or 0 to always indent for content."
2875 "Default indentation for literal block after a markup on an own line."
2882 "Default indentation for literal block after a minimized markup."
2889 "Default indentation for first line of a comment."
2895 ;; FIXME: Must consider other tabs:
2896 ;; * Line blocks
2897 ;; * Definition lists
2898 ;; * Option lists
2900 "Return tabs of the current line or nil for no tab.
2901 The list is sorted so the tab where writing continues most likely
2902 is the first one. Each tab is of the form (COLUMN . INNER).
2903 COLUMN is the column of the tab. INNER is non-nil if this is an
2904 inner tab. I.e. a tab which does come from the basic indentation
2905 and not from inner alignment points."
2911 ;; Current indentation is always the least likely tab.
2913 ;; Push inner tabs more likely to continue writing.
2915 ;; Item.
2919 ;; Field.
2930 ;; Directive.
2937 ;; Footnote or citation definition.
2942 ;; Comment.
2945 ;; Start of literal block.
2951 rst-indent-literal-minimized
2952 rst-indent-literal-normal))
2957 tabs))))))
2960 "Build the list of possible tabs for all lines above.
2961 Search backwards from point PT to build the list of possible tabs.
2962 Return a list of tabs sorted by likeliness to continue writing
2963 like `rst-line-tabs'. Nearer lines have generally a higher
2964 likeliness than farther lines. Return nil if no tab is found in
2965 the text above."
2969 innermost ; Leftmost column for inner tab.
2970 tablist)
2977 ;; Consider only lines indented less or same if not INNERMOST.
2995 leftcol
2996 innermost))
3001 "Indent current line to next best reStructuredText tab.
3002 The next best tab is taken from the tab list returned by
3003 `rst-compute-tabs' which is used in a cyclic manner. If the
3004 current indentation does not end on a tab use the first one. If
3005 the current indentation is on a tab use the next tab. This allows
3007 possible tabs. If no indentation is possible return `noindent' or
3008 use DFLT. Return the indentation indented to. When point is in
3009 indentation it ends up at its end. Otherwise the point is kept
3010 relative to the content."
3016 ind)
3018 'noindent
3031 ind)))
3034 "Shift region BEG to END by CNT tabs.
3035 Shift by one tab to the right (CNT > 0) or left (CNT < 0) or
3036 remove all indentation (CNT = 0). A tab is taken from the text
3037 above. If no suitable tab is found `rst-indent-width' is used."
3042 ;; Apply the indent.
3044 beg end
3047 ;; Find the next tab after the leftmost column.
3053 ;; Get the position of the first tab beyond leftmostcol.
3058 tabs)))
3059 ;; Virtual position of tab.
3062 ;; Tab exists - use it.
3064 ;; Column needs to be computed.
3066 ;; Base on last known column.
3068 dir ; Direction to take.
3069 rst-indent-width))))
3073 ;; FIXME: A paragraph with an (incorrectly) indented second line is not filled
3074 ;; correctly::
3075 ;;
3076 ;; Some start
3077 ;; continued wrong
3079 "Return fill prefix found at point.
3080 Value for `adaptive-fill-function'."
3085 ;; An non-comment prefix is fine.
3086 fnd
3087 ;; Matches a comment - return whitespace instead.
3096 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3097 ;; Comments
3100 "Break line and indent, continuing reStructuredText comment if within one.
3101 Value for `comment-line-break-function'. If SOFT use soft
3102 newlines as mandated by `comment-line-break-function'."
3115 "Return indentation for current comment line."
3119 "Insert a comment in the current line."
3124 "Comment or uncomment the current region.
3125 Region is from BEG to END. Uncomment if ARG."
3131 bol)
3141 "Uncomment the current region.
3142 Region is from BEG to END. ARG is ignored"
3153 ;;------------------------------------------------------------------------------
3155 ;; FIXME: These next functions should become part of a larger effort to redo
3156 ;; the bullets in bulleted lists. The enumerate would just be one of
3157 ;; the possible outputs.
3158 ;;
3159 ;; FIXME: We need to do the enumeration removal as well.
3162 "Add enumeration to all the leftmost paragraphs in the given region.
3163 The region is specified between BEG and END. With ALL,
3164 do all lines instead of just paragraphs."
3176 "Add bullets to all the leftmost paragraphs in the given region.
3177 The region is specified between BEG and END. With ALL,
3178 do all lines instead of just paragraphs."
3185 ;; FIXME: Does not deal with a varying number of digits appropriately.
3186 ;; FIXME: Does not deal with multiple levels independently.
3187 ;; FIXME: Does not indent a multiline item correctly.
3189 "Convert the bulleted and enumerated items in the region to enumerated lists.
3190 Renumber as necessary. Region is from BEG to END."
3206 ;;------------------------------------------------------------------------------
3209 "Toggle line block prefixes for a region.
3210 Region is from RBEG to REND. With PFXARG set the empty lines too."
3225 \f
3226 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3227 ;; Font lock
3228 ;; =========
3232 ;; FIXME: The obsolete variables need to disappear.
3234 ;; The following versions have been done inside Emacs and should not be
3235 ;; replaced by `:package-version' attributes until a change.
3243 "Face used for all syntax marking up a special block."
3248 "All syntax marking up a special block."
3254 "customize the face `rst-block' instead."
3258 "Face used for field names and interpreted text."
3263 "Field names and interpreted text."
3269 "customize the face `rst-external' instead."
3273 "Face used for all other defining constructs."
3278 "All other defining constructs."
3284 "customize the face `rst-definition' instead."
3287 ;; XEmacs compatibility (?).
3291 "Face used for directives and roles."
3296 "Directives and roles."
3301 "customize the face `rst-directive' instead."
3305 "Face used for comments."
3310 "Comments."
3316 "customize the face `rst-comment' instead."
3320 "Face used for simple emphasis."
3325 "Simple emphasis."
3331 "customize the face `rst-emphasis1' instead."
3335 "Face used for double emphasis."
3340 "Double emphasis."
3345 "customize the face `rst-emphasis2' instead."
3349 "Face used for literal text."
3354 "Literal text."
3360 "customize the face `rst-literal' instead."
3364 "Face used for references to a definition."
3369 "References to a definition."
3375 "customize the face `rst-reference' instead."
3379 "Face used for a transition."
3384 "Face used for the adornment of a section header."
3388 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3391 rst-level-face-base-light
3392 rst-level-face-format-light
3393 rst-level-face-step-light
3394 rst-level-1-face
3395 rst-level-2-face
3396 rst-level-3-face
3397 rst-level-4-face
3398 rst-level-5-face
3399 rst-level-6-face))
3403 ;; Define faces for the first 6 levels. More levels are possible, however.
3406 "Default face for section title text at level 1."
3411 "Default face for section title text at level 2."
3416 "Default face for section title text at level 3."
3421 "Default face for section title text at level 4."
3426 "Default face for section title text at level 5."
3431 "Default face for section title text at level 6."
3443 "Faces for the various adornment types.
3444 Key is a number (for the section title text of that level
3445 starting with 1), t (for transitions) or nil (for section title
3446 adornment). If you need levels beyond 6 you have to define faces
3447 of your own."
3450 :key-type
3458 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3461 ;; The reST-links in the comments below all relate to sections in
3462 ;; http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html.
3464 ;; start.
3466 ;; Simple `Body Elements`_
3467 ;; `Bullet Lists`_
3468 ;; FIXME: A bullet directly after a field name is not recognized.
3471 ;; `Enumerated Lists`_
3474 ;; `Definition Lists`_
3475 ;; FIXME: missing.
3476 ;; `Field Lists`_
3479 ;; `Option Lists`_
3483 ;; `Line Blocks`_
3484 ;; Only for lines containing no more bar - to distinguish from tables.
3488 ;; `Tables`_
3489 ;; FIXME: missing
3491 ;; All the `Explicit Markup Blocks`_
3492 ;; `Footnotes`_ / `Citations`_
3496 ;; `Directives`_ / `Substitution Definitions`_
3501 ;; `Hyperlink Targets`_
3511 ;; All `Inline Markup`_
3512 ;; Most of them may be multiline though this is uninteresting.
3514 ;; FIXME: Condition 5 preventing fontification of e.g. "*" not implemented
3515 ;; `Strong Emphasis`_.
3518 ;; `Emphasis`_
3521 ;; `Inline Literals`_
3524 ;; `Inline Internal Targets`_
3527 ;; `Hyperlink References`_
3528 ;; FIXME: `Embedded URIs`_ not considered.
3529 ;; FIXME: Directly adjacent marked up words are not fontified correctly
3530 ;; unless they are not separated by two spaces: foo_ bar_.
3535 ;; `Interpreted Text`_
3542 ;; `Footnote References`_ / `Citation References`_
3545 ;; `Substitution References`_
3546 ;; FIXME: References substitutions like |this|_ or |this|__ are not
3547 ;; fontified correctly.
3550 ;; `Standalone Hyperlinks`_
3551 ;; FIXME: This takes it easy by using a whitespace as delimiter.
3557 ;; Do all block fontification as late as possible so 'append works.
3559 ;; Sections_ / Transitions_
3560 ;; For sections this is multiline.
3565 nil
3571 ;; FIXME: FACESPEC could be used instead of ordinary faces to set
3572 ;; properties on comments and literal blocks so they are *not*
3573 ;; inline fontified. See (elisp)Search-based Fontification.
3575 ;; FIXME: And / or use `syntax-propertize' functions as in `octave-mod.el'
3576 ;; and other V24 modes. May make `font-lock-extend-region'
3577 ;; superfluous.
3579 ;; `Comments`_
3580 ;; This is multiline.
3585 nil
3592 nil
3595 ;; FIXME: This is not rendered as comment::
3596 ;; .. .. list-table::
3597 ;; :stub-columns: 1
3598 ;; :header-rows: 1
3600 ;; FIXME: This is rendered wrong::
3601 ;;
3602 ;; xxx yyy::
3603 ;;
3604 ;; ----|> KKKKK <|----
3605 ;; / \
3606 ;; -|> AAAAAAAAAAPPPPPP <|- -|> AAAAAAAAAABBBBBBB <|-
3607 ;; | | | |
3608 ;; | | | |
3609 ;; PPPPPP PPPPPPDDDDDDD BBBBBBB PPPPPPBBBBBBB
3610 ;;
3611 ;; Indentation needs to be taken from the line with the ``::`` and not from
3612 ;; the first content line.
3614 ;; `Indented Literal Blocks`_
3615 ;; This is multiline.
3620 nil
3623 ;; FIXME: `Quoted Literal Blocks`_ missing.
3624 ;; This is multiline.
3626 ;; `Doctest Blocks`_
3627 ;; FIXME: This is wrong according to the specification:
3628 ;;
3629 ;; Doctest blocks are text blocks which begin with ">>> ", the Python
3630 ;; interactive interpreter main prompt, and end with a blank line.
3631 ;; Doctest blocks are treated as a special case of literal blocks,
3632 ;; without requiring the literal block syntax. If both are present, the
3633 ;; literal block syntax takes priority over Doctest block syntax:
3634 ;;
3635 ;; This is an ordinary paragraph.
3636 ;;
3637 ;; >>> print 'this is a Doctest block'
3638 ;; this is a Doctest block
3639 ;;
3640 ;; The following is a literal block::
3641 ;;
3642 ;; >>> This is not recognized as a doctest block by
3643 ;; reStructuredText. It *will* be recognized by the doctest
3644 ;; module, though!
3645 ;;
3646 ;; Indentation is not required for doctest blocks.
3656 "Extend the font-lock region if it might be in a multi-line construct.
3657 Return non-nil if so. Font-lock region is from `font-lock-beg'
3658 to `font-lock-end'."
3663 t)))
3666 "Check the region BEG / END for being in the middle of a multi-line construct.
3667 Return nil if not or a cons with new values for BEG / END"
3674 "Like `forward-line' but always end up in column 0 and return accordingly.
3675 Move N lines forward just as `forward-line'."
3678 moved
3682 ;; FIXME: If a single line is made a section header by `rst-adjust' the header
3683 ;; is not always fontified immediately.
3685 "Extend the region starting at point PT and extending in direction DIR.
3686 Return extended point or nil if not moved."
3687 ;; There are many potential multiline constructs but there are two groups
3688 ;; which are really relevant. The first group consists of
3689 ;;
3690 ;; * comment lines without leading explicit markup tag and
3691 ;;
3692 ;; * literal blocks following "::"
3693 ;;
3694 ;; which are both indented. Thus indentation is the first thing recognized
3695 ;; here. The second criteria is an explicit markup tag which may be a comment
3696 ;; or a double colon at the end of a line.
3697 ;;
3698 ;; The second group consists of the adornment cases.
3700 ;; Move only if we don't start inside a multiline construct already.
3703 ;; block tag.
3707 ;; The comments below are for dir == -1 / dir == 1.
3713 ; line if it exists.
3715 ; overline.
3718 ; underline / overline
3719 ; found.
3723 ; overline /
3724 ; underline.
3726 ; / adornment.
3733 ; underline.
3738 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3739 ;; Indented blocks
3742 "Move forward across one indented block.
3743 Find the next non-empty line which is not indented at least to COLUMN (defaults
3744 to the column of the point). Moves point to first character of this line or the
3745 first empty line immediately before it and returns that position. If there is
3746 no such line before LIMIT (defaults to the end of the buffer) returns nil and
3747 point is not moved."
3751 fnd beg cand)
3762 ;; FIXME: No indentation [(zerop clm)] must be handled in some
3763 ;; useful way - though it is not clear what this should mean
3764 ;; at all.
3771 fnd))
3777 "End of the match as determined by `rst-font-lock-find-unindented-line-limit'.
3781 "Find the next unindented line relative to indentation at IND-PNT.
3782 Return this point, the end of the buffer or nil if nothing found.
3783 If IND-PNT is `next' take the indentation from the next line if
3784 this is not empty and indented more than the current one. If
3785 IND-PNT is non-nil but not a number take the indentation from the
3786 next non-empty line if this is indented more than the current one."
3791 ;; Find indentation point in next line if any.
3793 ;; FIXME: Should be refactored to two different functions
3794 ;; giving their result to this function, may be
3795 ;; integrated in caller.
3801 ;; Not at EOF.
3806 ;; Use end of indentation if non-empty line.
3809 ;; Skip until non-empty line or EOF.
3814 ;; Not at EOF.
3818 ;; Indentation bigger than line of departure.
3827 "Set the match found earlier if match were found.
3828 Match has been found by `rst-font-lock-find-unindented-line-limit'
3829 the first time called or no match is found. Return non-nil if
3830 match was found. LIMIT is not used but mandated by the caller."
3834 rst-font-lock-find-unindented-line-end))
3836 rst-font-lock-find-unindented-line-end
3838 ;; Make sure this is called only once.
3840 t))
3842 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3843 ;; Adornments
3846 "Storage for `rst-font-lock-handle-adornment-matcher'.
3850 "Return section level for adornment KEY.
3851 KEY is the first element of the return list of `rst-classify-adornment'.
3852 If KEY is not a cons return it. If KEY is found in the hierarchy return
3853 its level. Otherwise return a level one beyond the existing hierarchy."
3855 key
3868 "Storage for match for current adornment.
3869 Set by `rst-font-lock-handle-adornment-pre-match-form'. Also used
3873 "Determine limit for adornments.
3874 Determine all things necessary for font-locking section titles
3875 and transitions and put the result to `rst-font-lock-adornment-match'
3876 and `rst-font-lock-adornment-level'. ADO is the complete adornment
3877 matched. ADO-END is the point where ADO ends. Return the point
3878 where the whole adorned construct ends.
3880 Called as a PRE-MATCH-FORM in the sense of `font-lock-keywords'."
3884 rst-font-lock-adornment-match nil)
3892 "Set the match found earlier if match were found.
3893 Match has been found by
3894 `rst-font-lock-handle-adornment-pre-match-form' the first time
3895 called or no match is found. Return non-nil if match was found.
3897 Called as a MATCHER in the sense of `font-lock-keywords'.
3898 LIMIT is not used but mandated by the caller."
3900 ;; May run only once - enforce this.
3907 t)))
3909 \f
3910 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3911 ;; Compilation
3914 "Settings for support of conversion of reStructuredText
3936 "Table describing the command to use for each tool-set.
3937 An association list of the tool-set to a list of the (command to use,
3938 extension of produced filename, options to the tool (nil or a
3939 string)) to be used for converting the document."
3940 ;; FIXME: These are not options but symbols which may be referenced by
3941 ;; `rst-compile-*-toolset` below. The `:validate' keyword of
3942 ;; `defcustom' may help to define this properly in newer Emacs
3943 ;; versions (> 23.1).
3945 :key-type symbol
3956 ;; FIXME: Must be defcustom.
3960 ;; FIXME: Must be defcustom.
3965 "Look for the configuration file in the parents of the current path."
3969 ;; Move up in the dir hierarchy till we find a change log file.
3974 nil)
3976 ;; Move up to the parent dir and try again.
3986 "Compile command to convert reST document into some output file.
3987 Attempts to find configuration file, if it can, overrides the
3988 options. There are two commands to choose from; with USE-ALT,
3989 select the alternative tool-set."
3991 ;; Note: maybe we want to check if there is a Makefile too and not do anything
3992 ;; if that is the case. I dunno.
3994 rst-compile-secondary-toolset
3995 rst-compile-primary-toolset)
3996 rst-compile-toolsets)))
4004 ;; Set compile-command before invocation of compile.
4016 ;; Invoke the compile command.
4022 "Compile command with the alternative tool-set."
4027 "Show pseudo-XML rendering.
4028 Rendering is done of the current active region, or of the entire
4029 buffer, if the region is not selected."
4030 ;; FIXME: The region should be given interactively.
4037 standard-output)))
4039 ;; FIXME: Should be defcustom.
4044 "Convert the document to a PDF file and launch a preview program."
4049 buffer-file-name tmp-filename
4050 rst-pdf-program tmp-filename tmp-filename)))
4052 ;; Note: you could also use (compile command) to view the compilation
4053 ;; output.
4054 ))
4056 ;; FIXME: Should be defcustom or use something like `browse-url'.
4061 "Convert the document to an S5 slide presentation and launch a preview program."
4066 buffer-file-name tmp-filename
4067 rst-slides-program tmp-filename tmp-filename)))
4069 ;; Note: you could also use (compile command) to view the compilation
4070 ;; output.
4071 ))
4073 \f
4074 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4075 ;; Imenu support.
4077 ;; FIXME: Integrate this properly. Consider a key binding.
4079 ;; Based on code from Masatake YAMATO <yamato@redhat.com>.
4082 "Find adornments cell in ADORNMENTS for position POS."
4088 adornments nil)
4090 a))
4093 "Convert a cell ELT in a tree returned from `rst-section-tree' to Imenu index.
4094 ADORNMENTS is used as hint information for conversion."
4104 ;; FIXME: Overline adornment characters need to be in front so
4105 ;; they become visible even for long title lines. May be
4106 ;; an additional level number is also useful.
4109 title
4111 ""
4115 p
4117 ;; A bit ugly but this make which-func happy.
4121 kdr)))))
4122 nil)))
4124 ;; FIXME: Document title and subtitle need to be handled properly. They should
4125 ;; get an own "Document" top level entry.
4127 "Create index for Imenu.
4128 Return as described for `imenu--index-alist'."
4131 ;; Translate line notation to point notation.
4137 ;; FIXME: Need to consider
4138 ;; `imenu-use-markers' here?
4144 tree))))
4146 \f
4147 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4148 ;; Generic text functions that are more convenient than the defaults.
4150 ;; FIXME: Unbound command - should be bound or removed.
4152 "Replace flush-left lines of FROMCHAR with equal-length lines of TOCHAR."
4154 cSearch for flush-left lines of char:
4167 ;; FIXME: Unbound command - should be bound or removed.
4169 "Join lines in current paragraph into one line, removing end-of-lines."
4174 ;; FIXME: Unbound command - should be bound or removed.
4176 "Fill paragraph at point, first joining the paragraph's lines into one.
4177 This is useful for filling list item paragraphs."
4183 ;; FIXME: Unbound command - should be bound or removed.
4184 ;; Generic character repeater function.
4185 ;; For sections, better to use the specialized function above, but this can
4186 ;; be useful for creating separators.
4188 "Fill the current line using the last character on the current line.
4189 Fill up to the length of the preceding line or up to `fill-column' if preceding
4190 line is empty.
4192 If USE-NEXT, use the next line rather than the preceding line.
4194 If the current line is longer than the desired length, shave the characters off
4195 the current line to fit the desired length.
4197 As an added convenience, if the command is repeated immediately, the alternative
4198 column is used (fill-column vs. end of previous/next line)."
4205 fill-column
4219 ;; Shave characters off the end.
4223 ;; Fill with last characters.
4227 \f
4229 ;; LocalWords: docutils http sourceforge rst html wp svn svnroot txt reST regex
4230 ;; LocalWords: regexes alist seq alt grp keymap abbrev overline overlines toc
4231 ;; LocalWords: XML PNT propertized
4233 ;; Local Variables:
4234 ;; sentence-end-double-space: t
4235 ;; End:
4239 ;; Local Variables:
4240 ;; coding: utf-8
4241 ;; End:
4243 ;;; rst.el ends here