| blob | 77dc7cc29bb2e504aadae39766efe241a661ddb1 |
1 ;;; rst.el --- Mode for viewing and editing reStructuredText-documents.
3 ;; Copyright (C) 2003-2012 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 `.emacs' 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: Add proper ";;;###autoload" comments.
108 ;; FIXME: When 24.1 is common place remove use of `lexical-let' and put "-*-
109 ;; lexical-binding: t -*-" in the first line.
111 ;; Only use of macros is allowed - may be replaced by `cl-lib' some time.
115 ;; Redefine some functions from `cl.el' in a proper namespace until they may be
116 ;; used from there.
119 "Return 1 if X is positive, -1 if negative, 0 if zero."
126 "Return non-nil if any element of SEQ yields non-nil when PRED is applied.
127 Apply PRED to each element of list SEQ until the first non-nil
128 result is yielded and return this result. PRED defaults to
129 `identity'."
139 "Return position of first element satisfying PRED in list SEQ or nil."
148 "Return position of ELEM in list SEQ or nil.
149 Comparison done with `equal'."
150 ;; Create a closure containing `elem' so the `lambda' always sees our
151 ;; parameter instead of an `elem' which may be in dynamic scope at the time
152 ;; of execution of the `lambda'.
156 seq)))
158 ;; FIXME: Embed complicated `defconst's in `eval-when-compile'.
160 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
161 ;; Versions
164 "Extract the version from a variable according to the given regexes.
165 Return the version after regex DELIM-RE and HEAD-RE matching RE
166 and before TAIL-RE and DELIM-RE in VAR or DEFAULT for no match."
169 var)
171 default))
173 ;; Use CVSHeader to really get information from CVS and not other version
174 ;; control systems.
187 ;; Use LastChanged... to really get information from SVN.
191 "The SVN revision of this file.
198 ;; Maintained by the release process.
210 rst-official-version
212 rst-cvs-rev rst-cvs-timestamp))
213 "The version string.
214 Starts with the current official version. For developer versions
224 ))
228 rst-version))
233 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
234 ;; Initialize customization
236 \f
242 \f
243 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
244 ;; Facilities for regular expressions used everywhere
246 ;; The trailing numbers in the names give the number of referenceable regex
247 ;; groups contained in the regex.
249 ;; Used to be customizable but really is not customizable but fixed by the reST
250 ;; syntax.
252 ;; Sorted so they can form a character class when concatenated.
263 ;; Sorted so they can form a character class when concatenated.
267 ?-)
271 1000
275 ;; `*-beg' matches * at the beginning of a line.
276 ;; `*-end' matches * at the end of a line.
277 ;; `*-prt' matches a part of *.
278 ;; `*-tag' matches *.
279 ;; `*-sta' matches the start of * which may be followed by respective content.
280 ;; `*-pfx' matches the delimiter left of *.
281 ;; `*-sfx' matches the delimiter right of *.
282 ;; `*-hlp' helper for *.
283 ;;
284 ;; A trailing number says how many referenceable groups are contained.
285 `(
287 ;; Horizontal white space (`hws')
292 ;; Lines (`lin')
297 ;; Various tags and parts
308 ;; Block lead in (`bli')
310 ; immediate content.
312 ;; Various starts
315 ;; Explicit markup tag (`exm')
320 ;; Counters in enumerations (`cnt')
324 ;; Enumerator (`enm')
331 ; enumerator.
338 ; at the beginning of a line.
340 ;; Items may be enumerated or bulleted (`itm')
343 ; is the item tag.
345 ; beginning of a line, group is the
346 ; item tag.
348 ;; Inline markup (`ilm')
352 ;; Inline markup content (`ilc')
357 ; definition.
360 ; definition.
366 (:seq ilcsgl-tag
367 ilcast-prt ilcrep-hlp
370 (:seq ilcsgl-tag
371 ilcbkq-prt ilcrep-hlp
374 (:seq ilcsgl-tag
375 ilcbkqdef-prt ilcrep-hlp
378 (:seq ilcsgl-tag
379 ilcbar-prt ilcrep-hlp
382 (:seq ilcsgl-tag
383 ilcbardef-prt ilcrep-hlp
386 ;; Fields (`fld')
391 ;; Options (`opt')
398 ;; Footnotes and citations (`fnc')
404 ; tag. First group is the explicit markup
405 ; start, second group is the footnote /
406 ; citation tag.
408 ; definition. First group is the explicit
409 ; markup start, second group is the
410 ; footnote / citation tag.
412 ;; Substitutions (`sub')
415 ; tag.
417 ;; Symbol (`sym')
421 ;; URIs (`uri')
424 ;; Adornment (`ado')
427 ; otherwise explicit markup start would be
428 ; recognized.
430 ; characters is matched differently.
433 ; adornment character and MUST be the FIRST
434 ; group in the whole expression.
437 ; adornment character and MUST be the
438 ; SECOND group in the whole expression.
441 ; adornment and MUST be the FIRST group in the whole
442 ; expression; second group is the first adornment
443 ; character.
445 ;; Titles (`ttl')
449 ;; Directives and substitution definitions (`dir')
453 ; tag. First group is explicit markup
454 ; start, second group is a possibly
455 ; empty substitution tag, third group is
456 ; the directive tag including the double
457 ; colon.
459 ; definition. Groups are as in dir-tag-3.
461 ;; Literal block (`lit')
464 ; any text before the double colon tag which
465 ; may not exist, second group is the double
466 ; colon tag.
468 ;; Comments (`cmt')
472 ; start.
474 ;; Paragraphs (`par')
477 ; certain cases.
478 )
479 "Definition alist of relevant regexes.
480 Each entry consists of the symbol naming the regex and an
485 ;; FIXME: Use `sregex` or `rx` instead of re-inventing the wheel.
487 "Interpret ARGS as regular expressions and return a regex string.
488 Each element of ARGS may be one of the following:
490 A string which is inserted unchanged.
492 A character which is resolved to a quoted regex.
494 A symbol which is resolved to a string using `rst-re-alist-def'.
496 A list with a keyword in the car. Each element of the cdr of such
497 a list is recursively interpreted as ARGS. The results of this
498 interpretation are concatenated according to the keyword.
500 For the keyword `:seq' the results are simply concatenated.
502 For the keyword `:shy' the results are concatenated and
508 For the keyword `:grp' the results are concatenated and form a
511 After interpretation of ARGS the results are concatenated as for
512 `:seq'."
518 re)
541 args)))
543 ;; FIXME: Remove circular dependency between `rst-re' and `rst-re-alist'.
546 ;; Shadow global value we are just defining so we can construct it step by
547 ;; step.
555 \f
556 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
557 ;; Mode definition
560 "Bind like `define-key' but add deprecated key definitions.
561 KEYMAP, KEY, and DEF are as in `define-key'. DEPRECATED key
562 definitions should be in vector notation. These are defined as
563 well but give an additional message."
575 ;; Key bindings.
579 ;; \C-c is the general keymap.
582 ;;
583 ;; Section Adornments
584 ;;
585 ;; The adjustment function that adorns or rotates a section title.
588 ; on consoles.
590 ;; \C-c \C-a is the keymap for adornments.
592 ;; Another binding which works with all types of input.
594 ;; Display the hierarchy of adornments implied by the current document
595 ;; contents.
597 ;; Homogenize the adornments in the document.
601 ;;
602 ;; Section Movement and Selection
603 ;;
604 ;; Mark the subsection where the cursor is.
606 ;; Same as mark-defun sgml-mark-current-element.
608 ;; Move backward/forward between section titles.
609 ;; FIXME: Also bind similar to outline mode.
611 ;; Same as beginning-of-defun.
614 ;; Same as end-of-defun.
617 ;;
618 ;; Operating on regions
619 ;;
620 ;; \C-c \C-r is the keymap for regions.
622 ;; Makes region a line-block.
625 ;; Shift region left or right according to tabs.
629 ;;
630 ;; Operating on lists
631 ;;
632 ;; \C-c \C-l is the keymap for lists.
634 ;; Makes paragraphs in region as a bullet list.
637 ;; Makes paragraphs in region as a enumeration.
640 ;; Converts bullets to an enumeration.
643 ;; Make sure that all the bullets in the region are consistent.
646 ;; Insert a list item.
649 ;;
650 ;; Table-of-Contents Features
651 ;;
652 ;; \C-c \C-t is the keymap for table of contents.
654 ;; Enter a TOC buffer to view and move to a specific section.
656 ;; Insert a TOC here.
659 ;; Update the document's TOC (without changing the cursor position).
662 ;; Go to the section under the cursor (cursor must be in TOC).
666 ;;
667 ;; Converting Documents from Emacs
668 ;;
669 ;; \C-c \C-c is the keymap for compilation.
671 ;; Run one of two pre-configured toolset commands on the document.
676 ;; Convert the active region to pseudo-xml using the docutils tools.
679 ;; Convert the current document to PDF and launch a viewer on the results.
682 ;; Convert the current document to S5 slides and view in a web browser.
686 map)
687 "Keymap for reStructuredText mode commands.
691 ;; Abbrevs.
699 ;; FIXME: Add footnotes, links, and more.
700 ))
704 ;; Syntax table.
728 st)
733 "Hook run when `rst-mode' is turned on.
734 The hook for `text-mode' is run before this one."
738 ;; Pull in variable definitions silencing byte-compiler.
741 ;; Use rst-mode for *.rst and *.rest files. Many ReStructured-Text files
742 ;; use *.txt, but this is too generic to be set as a default.
743 ;;;###autoload (add-to-list 'auto-mode-alist (purecopy '("\\.re?st\\'" . rst-mode)))
744 ;;;###autoload
746 "Major mode for editing reStructuredText documents.
749 Turning on `rst-mode' calls the normal hooks `text-mode-hook'
750 and `rst-mode-hook'. This mode also supports font-lock
751 highlighting.
754 :abbrev-table rst-mode-abbrev-table
755 :syntax-table rst-mode-syntax-table
758 ;; Paragraph recognition.
762 lin-end)))
766 lin-end
769 ;; Indenting and filling.
777 ;; Comments.
784 ;; reStructuredText has not really a comment ender but nil is not really a
785 ;; permissible value.
789 ;; Commenting in reStructuredText is very special so use our own set of
790 ;; functions.
802 ;; Font lock.
805 t nil nil nil
810 ;; Text after a changed line may need new fontification.
813 ;;;###autoload
815 "Toggle ReST minor mode.
816 With a prefix argument ARG, enable ReST minor mode if ARG is
817 positive, and disable it otherwise. If called from Lisp, enable
818 the mode if ARG is omitted or nil.
820 When ReST minor mode is enabled, the ReST mode keybindings
821 are installed on top of the major mode bindings. Use this
822 for modes derived from Text mode, like Mail mode."
823 ;; The initial value.
824 nil
825 ;; The indicator for the mode line.
826 " ReST"
827 ;; The minor mode bindings.
828 rst-mode-map
831 ;; FIXME: can I somehow install these too?
832 ;; :abbrev-table rst-mode-abbrev-table
833 ;; :syntax-table rst-mode-syntax-table
835 \f
836 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
837 ;; Section Adornment Adjustment
838 ;; ============================
839 ;;
840 ;; The following functions implement a smart automatic title sectioning feature.
841 ;; The idea is that with the cursor sitting on a section title, we try to get as
842 ;; much information from context and try to do the best thing automatically.
843 ;; This function can be invoked many times and/or with prefix argument to rotate
844 ;; between the various sectioning adornments.
845 ;;
846 ;; Definitions: the two forms of sectioning define semantically separate section
847 ;; levels. A sectioning ADORNMENT consists in:
848 ;;
849 ;; - a CHARACTER
850 ;;
851 ;; - a STYLE which can be either of 'simple' or 'over-and-under'.
852 ;;
853 ;; - an INDENT (meaningful for the over-and-under style only) which determines
854 ;; how many characters and over-and-under style is hanging outside of the
855 ;; title at the beginning and ending.
856 ;;
857 ;; Here are two examples of adornments (| represents the window border, column
858 ;; 0):
859 ;;
860 ;; |
861 ;; 1. char: '-' e |Some Title
862 ;; style: simple |----------
863 ;; |
864 ;; 2. char: '=' |==============
865 ;; style: over-and-under | Some Title
866 ;; indent: 2 |==============
867 ;; |
868 ;;
869 ;; Some notes:
870 ;;
871 ;; - The underlining character that is used depends on context. The file is
872 ;; scanned to find other sections and an appropriate character is selected.
873 ;; If the function is invoked on a section that is complete, the character is
874 ;; rotated among the existing section adornments.
875 ;;
876 ;; Note that when rotating the characters, if we come to the end of the
877 ;; hierarchy of adornments, the variable rst-preferred-adornments is
878 ;; consulted to propose a new underline adornment, and if continued, we cycle
879 ;; the adornments all over again. Set this variable to nil if you want to
880 ;; limit the underlining character propositions to the existing adornments in
881 ;; the file.
882 ;;
883 ;; - An underline/overline that is not extended to the column at which it should
884 ;; be hanging is dubbed INCOMPLETE. For example::
885 ;;
886 ;; |Some Title
887 ;; |-------
888 ;;
889 ;; Examples of default invocation:
890 ;;
891 ;; |Some Title ---> |Some Title
892 ;; | |----------
893 ;;
894 ;; |Some Title ---> |Some Title
895 ;; |----- |----------
896 ;;
897 ;; | |------------
898 ;; | Some Title ---> | Some Title
899 ;; | |------------
900 ;;
901 ;; In over-and-under style, when alternating the style, a variable is
902 ;; available to select how much default indent to use (it can be zero). Note
903 ;; that if the current section adornment already has an indent, we don't
904 ;; adjust it to the default, we rather use the current indent that is already
905 ;; there for adjustment (unless we cycle, in which case we use the indent
906 ;; that has been found previously).
909 "Settings for adjustment and cycling of section title adornments."
923 "Preferred hierarchy of section title adornments.
925 A list consisting of lists of the form (CHARACTER STYLE INDENT).
926 CHARACTER is the character used. STYLE is one of the symbols
927 OVER-AND-UNDER or SIMPLE. INDENT is an integer giving the wanted
928 indentation for STYLE OVER-AND-UNDER. CHARACTER and STYLE are
929 always used when a section adornment is described. In other
930 places t instead of a list stands for a transition.
932 This sequence is consulted to offer a new adornment suggestion
933 when we rotate the underlines at the end of the existing
934 hierarchy of characters, or when there is no existing section
935 title in the file.
937 Set this to an empty list to use only the adornment found in the
938 file."
946 rst-adornment-chars))
954 "Number of characters to indent the section title.
956 This is used for when toggling adornment styles, when switching
957 from a simple adornment style to a over-and-under adornment
958 style."
964 "Compare adornments.
965 Return true if both ADO1 and ADO2 adornments are equal,
966 according to restructured text semantics (only the character and
967 the style are compared, the indentation does not matter)."
973 "Return the index (level) in hierarchy HIER of adornment ADO.
974 This basically just searches for the item using the appropriate
975 comparison and returns the index. Return nil if the item is
976 not found."
980 cur))
984 "Suggest a new, different adornment from all that have been seen.
986 ALLADOS is the set of all adornments, including the line numbers.
987 PREV is the optional previous adornment, in order to suggest a
988 better match."
990 ;; For all the preferred adornments...
992 ;; If 'prev' is given, reorder the list to start searching after the
993 ;; match.
997 ;; List of candidates to search.
1000 ;; For all the adornments...
1002 found)
1005 ;; Found it!
1008 found)
1015 "Delete the entire current line without using the `kill-ring'."
1020 "Unconditionally update the style of a section adornment.
1022 Do this using the given character CHAR, with STYLE 'simple
1023 or 'over-and-under, and with indent INDENT. If the STYLE
1024 is 'simple, whitespace before the title is removed (indent
1025 is always assumed to be 0).
1027 If there are existing overline and/or underline from the
1028 existing adornment, they are removed before adding the
1029 requested adornment."
1032 len)
1034 ;; Fixup whitespace at the beginning and end of the line.
1044 ;; Set the current column, we're at the end of the title line.
1047 ;; Remove previous line if it is an adornment.
1051 ;; Avoid removing the underline of a title right above us.
1056 ;; Remove following line if it is an adornment.
1061 ;; Add a newline if we're at the end of the buffer, for the subsequence
1062 ;; inserting of the underline.
1066 ;; Insert overline.
1073 ;; Insert underline.
1080 ))
1083 "Classify adornment for section titles and transitions.
1084 ADORNMENT is the complete adornment string as found in the buffer
1085 with optional trailing whitespace. END is the point after the
1086 last character of ADORNMENT.
1088 Return a list. The first entry is t for a transition or a
1089 cons (CHARACTER . STYLE). Check `rst-preferred-adornments' for
1090 the meaning of CHARACTER and STYLE.
1092 The remaining list forms four match groups as returned by
1093 `match-data'. Match group 0 matches the whole construct. Match
1094 group 1 matches the overline adornment if present. Match group 2
1095 matches the section title text or the transition. Match group 3
1096 matches the underline adornment.
1098 Return nil if no syntactically valid adornment is found."
1141 key beg-ovr end-ovr beg-txt end-txt beg-und end-und)
1144 ;; A transition.
1146 beg-txt beg-pnt
1147 end-txt end-pnt))
1149 ;; An overline with an underline.
1165 ;; An underline.
1167 beg-und beg-pnt
1168 end-und end-pnt)
1173 ;; Invalid adornment.
1179 beg-ovr end-ovr beg-txt end-txt beg-und end-und)))))))
1182 "Find a section title line around point and return its characteristics.
1183 If the point is on an adornment line find the respective title
1184 line. If the point is on an empty line check previous or next
1185 line whether it is a suitable title line and use it if so. If
1186 point is on a suitable title line use it.
1188 If no title line is found return nil.
1190 Otherwise return as `rst-classify-adornment' does. However, if
1191 the title line has no syntactically valid adornment STYLE is nil
1192 in the first element. If there is no adornment around the title
1193 CHARACTER is also nil and match groups for overline and underline
1194 are nil."
1206 ;; Invalid adornment - check whether this is an incomplete overline.
1213 ;; A section title - not a transition.
1214 r))))
1228 ;; Try to use the underline.
1234 r
1235 ;; No valid adornment found.
1239 ;; The following function and variables are used to maintain information about
1240 ;; current section adornment in a buffer local cache. Thus they can be used for
1241 ;; font-locking and manipulation commands.
1244 "All section adornments in the buffer as found by `rst-find-all-adornments'.
1248 ;; FIXME: If this variable is set to a different value font-locking of section
1249 ;; headers is wrong.
1251 "Section hierarchy in the buffer as determined by `rst-get-hierarchy'.
1252 t when no section adornments were found. Value depends on
1257 "Reset all section cache variables.
1258 Should be called by interactive functions which deal with sections."
1260 rst-section-hierarchy nil))
1263 "Return all the section adornments in the current buffer.
1264 Return a list of (LINE . ADORNMENT) with ascending LINE where
1265 LINE is the line containing the section title. ADORNMENT consists
1266 of a (CHARACTER STYLE INDENT) triple as described for
1267 `rst-preferred-adornments'.
1269 Uses and sets `rst-all-sections'."
1272 ;; Iterate over all the section titles/adornments in the file.
1286 positions)
1291 nil
1292 rst-all-sections))
1295 "Build a hierarchy of adornments using the list of given ADORNMENTS.
1297 ADORNMENTS is a list of (CHARACTER STYLE INDENT) adornment
1298 specifications, in order that they appear in a file, and will
1299 infer a hierarchy of section levels by removing adornments that
1300 have already been seen in a forward traversal of the adornments,
1301 comparing just CHARACTER and STYLE.
1303 Similarly returns a list of (CHARACTER STYLE INDENT), where each
1304 list element should be unique."
1314 "Return the hierarchy of section titles in the file.
1316 Return a list of adornments that represents the hierarchy of
1317 section titles in the file. Each element consists of (CHARACTER
1318 STYLE INDENT) as described for `rst-find-all-adornments'. If the
1319 line number in IGNORE is specified, a possibly adornment found on
1320 that line is not taken into account when building the hierarchy.
1322 Uses and sets `rst-section-hierarchy' unless IGNORE is given."
1325 nil
1326 rst-section-hierarchy)
1330 ignore
1334 ;; Clear cache reflecting that a possible update is not
1335 ;; reflected.
1336 nil
1338 r)))
1341 "Return the adornments around point.
1342 Return a list of the previous and next adornments."
1345 prev next
1348 ;; Search for the adornments around the current line.
1352 ;; 'cur' is the following adornment.
1358 ))
1362 "Return true if the adornment ADO around point is complete."
1363 ;; Note: we assume that the detection of the overline as being the underline
1364 ;; of a preceding title has already been detected, and has been eliminated
1365 ;; from the adornment that is given to us.
1367 ;; There is some sectioning already present, so check if the current
1368 ;; sectioning is complete and correct.
1373 )
1384 ))
1385 ))
1390 "Get the next adornment for CURADO, in given hierarchy HIER.
1391 If suggesting, suggest for new adornment SUGGESTION.
1392 REVERSE-DIRECTION is used to reverse the cycling order."
1398 ;; Build a new list of adornments for the rotation.
1401 ;; Suggest a new adornment.
1403 ;; If nothing to suggest, use first adornment.
1406 ;; Search for next adornment.
1414 cur))
1416 ;; If not found, take the first of all adornments.
1417 suggestion
1418 )))
1421 ;; FIXME: A line "``/`` full" is not accepted as a section title.
1423 "Auto-adjust the adornment around point.
1425 Adjust/rotate the section adornment for the section title around
1426 point or promote/demote the adornments inside the region,
1427 depending on if the region is active. This function is meant to
1428 be invoked possibly multiple times, and can vary its behavior
1429 with a positive PFXARG (toggle style), or with a negative
1430 PFXARG (alternate behavior).
1432 This function is a bit of a swiss knife. It is meant to adjust
1433 the adornments of a section title in reStructuredText. It tries
1434 to deal with all the possible cases gracefully and to do `the
1435 right thing' in all cases.
1437 See the documentations of `rst-adjust-adornment-work' and
1438 `rst-promote-region' for full details.
1440 Prefix Arguments
1441 ================
1443 The method can take either (but not both) of
1445 a. a (non-negative) prefix argument, which means to toggle the
1446 adornment style. Invoke with a prefix argument for example;
1448 b. a negative numerical argument, which generally inverts the
1449 direction of search in the file or hierarchy. Invoke with C--
1450 prefix for example."
1460 ;; Adjust adornments within region.
1462 ;; Adjust adornment around point.
1465 ;; Run the hooks to run after adjusting.
1468 ;; Make sure to reset the cursor position properly after we're done.
1471 ))
1474 "Hooks to be run after running `rst-adjust'."
1480 "Controls level of new adornment for section headers."
1488 "Call `rst-adjust-adornment-work' interactively.
1490 Keep this for compatibility for older bindings (are there any?).
1491 Argument PFXARG has the same meaning as for `rst-adjust'."
1499 "Adjust/rotate the section adornment for the section title around point.
1501 This function is meant to be invoked possibly multiple times, and
1502 can vary its behavior with a true TOGGLE-STYLE argument, or with
1503 a REVERSE-DIRECTION argument.
1505 General Behavior
1506 ================
1508 The next action it takes depends on context around the point, and
1509 it is meant to be invoked possibly more than once to rotate among
1510 the various possibilities. Basically, this function deals with:
1512 - adding a adornment if the title does not have one;
1514 - adjusting the length of the underline characters to fit a
1515 modified title;
1517 - rotating the adornment in the set of already existing
1518 sectioning adornments used in the file;
1520 - switching between simple and over-and-under styles.
1522 You should normally not have to read all the following, just
1523 invoke the method and it will do the most obvious thing that you
1524 would expect.
1527 Adornment Definitions
1528 =====================
1530 The adornments consist in
1532 1. a CHARACTER
1534 2. a STYLE which can be either of 'simple' or 'over-and-under'.
1536 3. an INDENT (meaningful for the over-and-under style only)
1537 which determines how many characters and over-and-under
1538 style is hanging outside of the title at the beginning and
1539 ending.
1541 See source code for mode details.
1544 Detailed Behavior Description
1545 =============================
1547 Here are the gory details of the algorithm (it seems quite
1548 complicated, but really, it does the most obvious thing in all
1549 the particular cases):
1551 Before applying the adornment change, the cursor is placed on
1552 the closest line that could contain a section title.
1554 Case 1: No Adornment
1555 --------------------
1557 If the current line has no adornment around it,
1559 - search backwards for the last previous adornment, and apply
1560 the adornment one level lower to the current line. If there
1561 is no defined level below this previous adornment, we suggest
1562 the most appropriate of the `rst-preferred-adornments'.
1564 If REVERSE-DIRECTION is true, we simply use the previous
1565 adornment found directly.
1567 - if there is no adornment found in the given direction, we use
1568 the first of `rst-preferred-adornments'.
1570 TOGGLE-STYLE forces a toggle of the prescribed adornment style.
1572 Case 2: Incomplete Adornment
1573 ----------------------------
1575 If the current line does have an existing adornment, but the
1576 adornment is incomplete, that is, the underline/overline does
1577 not extend to exactly the end of the title line (it is either too
1578 short or too long), we simply extend the length of the
1579 underlines/overlines to fit exactly the section title.
1581 If TOGGLE-STYLE we toggle the style of the adornment as well.
1583 REVERSE-DIRECTION has no effect in this case.
1585 Case 3: Complete Existing Adornment
1586 -----------------------------------
1588 If the adornment is complete (i.e. the underline (overline)
1589 length is already adjusted to the end of the title line), we
1590 search/parse the file to establish the hierarchy of all the
1591 adornments (making sure not to include the adornment around
1592 point), and we rotate the current title's adornment from within
1593 that list (by default, going *down* the hierarchy that is present
1594 in the file, i.e. to a lower section level). This is meant to be
1595 used potentially multiple times, until the desired adornment is
1596 found around the title.
1598 If we hit the boundary of the hierarchy, exactly one choice from
1599 the list of preferred adornments is suggested/chosen, the first
1600 of those adornment that has not been seen in the file yet (and
1601 not including the adornment around point), and the next
1602 invocation rolls over to the other end of the hierarchy (i.e. it
1603 cycles). This allows you to avoid having to set which character
1604 to use.
1606 If REVERSE-DIRECTION is true, the effect is to change the
1607 direction of rotation in the hierarchy of adornments, thus
1608 instead going *up* the hierarchy.
1610 However, if TOGGLE-STYLE, we do not rotate the adornment, but
1611 instead simply toggle the style of the current adornment (this
1612 should be the most common way to toggle the style of an existing
1613 complete adornment).
1616 Point Location
1617 ==============
1619 The invocation of this function can be carried out anywhere
1620 within the section title line, on an existing underline or
1621 overline, as well as on an empty line following a section title.
1622 This is meant to be as convenient as possible.
1625 Indented Sections
1626 =================
1628 Indented section titles such as ::
1630 My Title
1631 --------
1633 are invalid in reStructuredText and thus not recognized by the
1634 parser. This code will thus not work in a way that would support
1635 indented sections (it would be ambiguous anyway).
1638 Joint Sections
1639 ==============
1641 Section titles that are right next to each other may not be
1642 treated well. More work might be needed to support those, and
1643 special conditions on the completeness of existing adornments
1644 might be required to make it non-ambiguous.
1646 For now we assume that the adornments are disjoint, that is,
1647 there is at least a single line between the titles/adornment
1648 lines."
1660 char-new style-new indent-new)
1662 ;;-------------------------------------------------------------------
1663 ;; Case 1: No valid adornment
1666 cur
1668 ;; Advance one level down.
1674 prev
1678 ;; Invert the style if requested.
1685 ;;-------------------------------------------------------------------
1686 ;; Case 2: Incomplete Adornment
1688 ;; Invert the style if requested.
1692 style-new style
1693 indent-new indent))
1694 ;;-------------------------------------------------------------------
1695 ;; Case 3: Complete Existing Adornment
1698 ;; Simply switch the style of the current adornment.
1701 indent-new rst-default-indent)
1702 ;; Else, we rotate, ignoring the adornment around the current
1703 ;; line...
1705 ;; Suggestion, in case we need to come up with something new.
1707 hier
1710 curado hier suggestion reverse-direction)))
1711 ;; Indent, if present, always overrides the prescribed indent.
1715 ;; Override indent with present indent!
1719 ;; Correct the position of the cursor to more accurately reflect where
1720 ;; it was located when the function was invoked.
1725 ;; Maintain an alias for compatibility.
1730 "Promote the section titles within the region.
1732 With argument DEMOTE or a prefix argument, demote the section
1733 titles instead. The algorithm used at the boundaries of the
1734 hierarchy is similar to that used by `rst-adjust-adornment-work'."
1744 marker-list
1745 )
1747 ;; Skip the markers that come before the region beginning.
1751 ;; Create a list of markers for all the adornments which are found within
1752 ;; the region.
1761 ;; Apply modifications.
1763 ;; Go to the adornment to promote.
1766 ;; Update the adornment.
1768 ;; Rotate the next adornment.
1772 ;; Clear marker to avoid slowing down the editing after we're done.
1775 )))
1780 "Display the current file's section title adornments hierarchy.
1781 This function expects a list of (CHARACTER STYLE INDENT) triples
1782 in ADORNMENTS."
1796 ))
1797 )))
1800 "Redo all the adornments in the current buffer.
1801 This is done using our preferred set of adornments. This can be
1802 used, for example, when using somebody else's copy of a document,
1803 in order to adapt it to our preferred style."
1818 ;; Go to the appropriate position.
1821 ;; Apply the new style.
1824 ;; Reset the marker to avoid slowing down editing until it gets GC'ed.
1826 )
1827 )))
1830 \f
1831 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1832 ;; Insert list items
1833 ;; =================
1836 ;=================================================
1837 ; Borrowed from a2r.el (version 1.3), by Lawrence Mitchell <wence@gmx.li>.
1838 ; I needed to make some tiny changes to the functions, so I put it here.
1839 ; -- Wei-Wei Guo
1849 "Convert Arabic number NUM to its Roman numeral representation.
1851 Obviously, NUM must be greater than zero. Don't blame me, blame the
1853 apologies to Monty Python).
1854 If optional prefix ARG is non-nil, insert in current buffer."
1856 res)
1863 res))
1866 "Convert STRING of Roman numerals to an Arabic number.
1868 If STRING contains a letter which isn't a valid Roman numeral, the rest
1869 of the string from that point onwards is ignored.
1871 Hence:
1872 MMD == 2500
1873 and
1874 MMDFLXXVI == 2500.
1875 If optional ARG is non-nil, insert in current buffer."
1883 res))
1884 ;=================================================
1887 "Find all the positions of prefixes in region between BEG and END.
1888 This is used to find bullets and enumerated list items. PFX-RE is
1889 a regular expression for matching the lines after indentation
1890 with items. Returns a list of cons cells consisting of the point
1891 and the column of the point."
1908 pfx))
1913 "Arrange relative position of a newly inserted list item of style NEWITEM.
1915 Adding a new list might consider three situations:
1917 (a) Current line is a blank line.
1918 (b) Previous line is a blank line.
1919 (c) Following line is a blank line.
1921 When (a) and (b), just add the new list at current line.
1923 when (a) and not (b), a blank line is added before adding the new list.
1925 When not (a), first forward point to the end of the line, and add two
1926 blank lines, then add the new list.
1928 Other situations are just ignored and left to users themselves."
1940 ;; FIXME: Isn't this a `defconst'?
1949 ;; FIXME: Isn't this a `defconst'?
1955 "Insert a new list item.
1957 User is asked to select the item style first, for example (a), i), +. Use TAB
1958 for completion and choices.
1960 If user selects bullets or #, it's just added with position arranged by
1961 `rst-insert-list-pos'.
1963 If user selects enumerations, a further prompt is given. User need to input a
1964 starting item, for example 'e' for 'A)' style. The position is also arranged by
1965 `rst-insert-list-pos'."
1967 ;; FIXME: Make this comply to `interactive' standards.
1969 "Select preferred item style [#.]: "
1975 ;; FIXME: Make this comply to `interactive' standards.
2000 "List of favorite bullets."
2006 rst-bullets)))
2010 "Insert a list item with list start CURITEM including its indentation level.
2011 If PREFER-ROMAN roman numbering is preferred over using letters."
2018 curitem)
2022 nil nil curitem))
2027 ;; FIXME: Assumes one line list items without separating
2028 ;; empty lines.
2045 t nil curitem))
2049 nil nil curitem)))))
2053 "Insert a list item at the current point.
2055 The command can insert a new list or a continuing list. When it is called at a
2056 non-list line, it will promote to insert new list. When it is called at a list
2057 line, it will insert a list with the same list style.
2059 1. When inserting a new list:
2061 User is asked to select the item style first, for example (a), i), +. Use TAB
2062 for completion and choices.
2064 (a) If user selects bullets or #, it's just added.
2065 (b) If user selects enumerations, a further prompt is given. User needs to
2066 input a starting item, for example 'e' for 'A)' style.
2068 The position of the new list is arranged according to whether or not the
2069 current line and the previous line are blank lines.
2071 2. When continuing a list, one thing need to be noticed:
2073 List style alphabetical list, such as 'a.', and roman numerical list, such as
2074 'i.', have some overlapping items, for example 'v.' The function can deal with
2075 the problem elegantly in most situations. But when those overlapped list are
2076 preceded by a blank line, it is hard to determine which type to use
2077 automatically. The function uses alphabetical list by default. If you want
2078 roman numerical list, just use a prefix to set PREFER-ROMAN."
2086 "Make all the bulleted list items in the region consistent.
2087 The region is specified between BEG and END. You can use this
2088 after you have merged multiple bulleted lists to make them use
2089 the same/correct/consistent bullet characters.
2091 See variable `rst-preferred-bullets' for the list of bullets to
2092 adjust. If bullets are found on levels beyond the
2093 `rst-preferred-bullets' list, they are not modified."
2099 ;; Create a map of levels to list of positions.
2105 levtable)))
2107 ;; Sort this map and create a new map of prefix char and list of positions.
2114 ;; Apply the characters.
2121 \f
2122 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2123 ;; Table of contents
2124 ;; =================
2127 "Return the line at cursor, stripped from whitespace."
2133 "Get the hierarchical tree of section titles.
2135 Returns a hierarchical tree of the sections titles in the
2136 document. This can be used to generate a table of contents for
2137 the document. The top node will always be a nil node, with the
2138 top level titles as children (there may potentially be more than
2139 one).
2141 Each section title consists in a cons of the stripped title
2142 string and a marker to the section in the original text document.
2144 If there are missing section levels, the section titles are
2145 inserted automatically, and the title string is set to nil, and
2146 the marker set to the first non-nil child of itself.
2147 Conceptually, the nil nodes--i.e.\ those which have no title--are
2148 to be considered as being the same line as their first non-nil
2149 child. This has advantages later in processing the graph."
2153 lines)
2157 ;; Compare just the character and indent in the hash table.
2161 ;; Create a list of lines that contains (text, level, marker) for each
2162 ;; adornment.
2179 "Recursive guts of the section tree construction.
2180 ADOS is a cons cell whose cdr is the remaining list of
2181 adornments, and we change it as we consume them. LEV is
2182 the current level of that node. This function returns a
2183 pair of the subtree that was built. This treats the ADOS
2184 list destructively."
2187 node
2188 children)
2190 ;; If the next adornment matches our level.
2192 ;; Pop the next adornment and create the current node with it.
2195 ;; Else we let the node title/marker be unset.
2197 ;; Build the child nodes.
2201 children)))
2204 ;; If node is still unset, we use the marker of the first child.
2208 ;; Return this node with its children.
2210 ))
2214 "Find tree node at point.
2215 Given a computed and valid section tree in NODE and a point
2216 POINT (default being the current point in the current buffer),
2217 find and return the node within the section tree where the cursor
2218 lives.
2220 Return values: a pair of (parent path, container subtree).
2221 The parent path is simply a list of the nodes above the
2222 container subtree node that we're returning."
2228 ;; Check if we are before the current node.
2231 ;; Iterate all the children, looking for one that might contain the
2232 ;; current section.
2234 last)
2246 )))
2248 ))
2252 "Settings for reStructuredText table of contents."
2257 "Indentation for table-of-contents display.
2258 Also used for formatting insertion, when numbering is disabled."
2262 "Insertion style for table-of-contents.
2263 Set this to one of the following values to determine numbering and
2264 indentation style:
2265 - plain: no numbering (fixed indentation)
2266 - fixed: numbering, but fixed indentation
2267 - aligned: numbering, titles aligned under each other
2268 - listed: numbering, with dashes like list items (EXPERIMENTAL)"
2272 "Separator that goes between the TOC number and the title."
2275 ;; This is used to avoid having to change the user's mode.
2279 map)
2283 "If non-nil, maximum depth of the inserted TOC."
2288 "Insert a simple text rendering of the table of contents.
2289 By default the top level is ignored if there is only one, because
2290 we assume that the document will have a single title.
2292 If a numeric prefix argument PFXARG is given, insert the TOC up
2293 to the specified level.
2295 The TOC is inserted indented at the current column."
2303 ;; Get the section tree for the current cursor point.
2308 ;; Figure out initial indent.
2315 ;; Fixup for the first line.
2318 ;; Delete the last newline added.
2320 )))
2323 "Insert tree node NODE in table-of-contents.
2324 Recursive function that does printing of the inserted toc.
2325 LEVEL is the depth level of the sections in the tree.
2326 INDENT is the indentation string. PFX is the prefix numbering,
2327 that includes the alignment necessary for all the children of
2328 level to align."
2330 ;; Note: we do child numbering from the parent, so we start number the
2331 ;; children one level before we print them.
2340 ;; Add properties to the text, even though in normal text mode it
2341 ;; won't be doing anything for now. Not sure that I want to change
2342 ;; mode stuff. At least the highlighting gives the idea that this
2343 ;; is generated automatically.
2348 )
2351 ;; Prepare indent for children.
2366 ))
2367 )
2372 fmt)
2375 ;; Add a separating dot if there is already a prefix.
2380 ;; Calculate the amount of space that the prefix will require
2381 ;; for the numbers.
2386 ))
2391 indent
2396 )))
2400 "Automatically find the contents section of a document and update.
2401 Updates the inserted TOC if present. You can use this in your
2402 file-write hook to always make it up-to-date automatically."
2405 ;; Find and delete an existing comment after the first contents directive.
2406 ;; Delete that region.
2408 ;; We look for the following and the following only (in other words, if your
2409 ;; syntax differs, this won't work.).
2410 ;;
2411 ;; .. contents:: [...anything here...]
2412 ;; [:field: value]...
2413 ;; ..
2414 ;; XXXXXXXX
2415 ;; XXXXXXXX
2416 ;; [more lines]
2420 last-real)
2422 ;; Look for the first line that starts at the first column.
2439 ;; Note: always return nil, because this may be used as a hook.
2440 nil)
2442 ;; Note: we cannot bind the TOC update on file write because it messes with
2443 ;; undo. If we disable undo, since it adds and removes characters, the
2444 ;; positions in the undo list are not making sense anymore. Dunno what to do
2445 ;; with this, it would be nice to update when saving.
2446 ;;
2447 ;; (add-hook 'write-contents-hooks 'rst-toc-update-fun)
2448 ;; (defun rst-toc-update-fun ()
2449 ;; ;; Disable undo for the write file hook.
2450 ;; (let ((buffer-undo-list t)) (rst-toc-update) ))
2454 ;;------------------------------------------------------------------------------
2457 "Recursive function that does insert NODE at LEVEL in the table-of-contents."
2461 ;; Insert line text.
2465 ;; Highlight lines.
2468 ;; Add link on lines.
2472 ))
2478 "Count the number of lines from NODE to the TARGET-NODE node.
2479 This recursive function returns a cons of the number of
2480 additional lines that have been counted for its node and
2481 children, and t if the node has been found."
2484 found)
2503 "Display a table-of-contents.
2504 Finds all the section titles and their adornments in the
2505 file, and displays a hierarchically-organized list of the
2506 titles, which is essentially a table-of-contents of the
2507 document.
2509 The Emacs buffer can be navigated, and selecting a section
2510 brings the cursor in that section."
2517 line
2519 ;; Create a temporary buffer.
2521 )
2532 ;; Count the lines to our found node.
2535 ))
2539 ;; Save the buffer to return to.
2542 ;; Move the cursor near the right section in the TOC.
2545 ))
2549 "Get the section from text property at point."
2555 pos))
2557 ;; FIXME: Cursor before or behind the list must be handled properly; before the
2558 ;; list should jump to the top and behind the list to the last normal
2559 ;; paragraph.
2561 "Go to the section the current line describes.
2562 If KILL a toc buffer is destroyed."
2566 ;; FIXME: This should rather go to `rst-toc-mode-goto-section'.
2571 ;; FIXME: make the recentering conditional on scroll.
2575 "Go to the section the current line describes and kill the TOC buffer."
2580 "In `rst-toc' mode, go to the occurrence whose line you click on.
2581 EVENT is the input event."
2593 "Same as `rst-toc-mode-mouse-goto', but kill TOC buffer as well.
2594 EVENT is the input event."
2600 "Leave the current TOC buffer."
2614 map)
2619 ;; Could inherit from the new `special-mode'.
2624 ;; Note: use occur-mode (replace.el) as a good example to complete missing
2625 ;; features.
2627 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2628 ;; Section movement commands
2629 ;; =========================
2632 "Skip to the next reStructuredText section title.
2633 OFFSET specifies how many titles to skip. Use a negative OFFSET to move
2634 backwards in the file (default is to use 1)."
2640 ;; Get all the adornments in the file, with their line numbers.
2643 ;; Get the current line.
2648 )
2650 ;; Find the index of the "next" adornment w.r.t. to the current line.
2654 ;; 'cur' is the adornment on or following the current line.
2659 ;; Find the final index.
2663 ;; If the index is positive, goto the line, otherwise go to the buffer
2664 ;; boundaries.
2670 ))
2673 "Like `rst-forward-section', except move back one title."
2677 ;; FIXME: What is `allow-extend' for?
2679 "Select COUNT sections around point.
2680 Mark following sections for positive COUNT or preceding sections
2681 for negative COUNT."
2682 ;; Cloned from mark-paragraph.
2700 \f
2701 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2702 ;; Functions to work on item lists (e.g. indent/dedent, enumerate), which are
2703 ;; always 2 or 3 characters apart horizontally with rest.
2706 "Return the leftmost column in region BEG to END."
2717 mincol))
2719 ;; FIXME: This definition is old and deprecated. We need to move to the newer
2720 ;; version below.
2723 ;; FIXME: The following comment is pretty useless.
2724 "Call FUN at the beginning of each line, with an argument that
2725 specifies whether we are at the first line of a paragraph that
2726 starts at the leftmost column of the given region BEG and END.
2727 Set FIRST-ONLY to true if you want to callback on the first line
2728 of each paragraph only."
2746 )
2751 valid)
2752 ,body-consequent
2755 ))))
2757 ;; FIXME: This needs to be refactored. Probably this is simply a function
2758 ;; applying BODY rather than a macro.
2760 "Evaluate BODY for each line in region defined by BEG END.
2761 LEFTMOST is set to true if the line is one of the leftmost of the
2762 entire paragraph. PARABEGIN is set to true if the line is the
2763 first of a paragraph."
2789 )
2794 )))))
2796 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2797 ;; Indentation
2799 ;; FIXME: At the moment only block comments with leading empty comment line are
2800 ;; supported. Comment lines with leading comment markup should be also
2801 ;; supported. May be a customizable option could control which style to
2802 ;; prefer.
2806 In reStructuredText indentation points are usually determined by
2807 preceding lines. Sometimes the syntax allows arbitrary
2808 indentation points such as where to start the first line
2809 following a directive. These indentation widths can be customized
2810 here."
2817 "Indentation when there is no more indentation point given."
2822 "Indentation for first line after a field or 0 to always indent for content."
2827 "Default indentation for literal block after a markup on an own line."
2832 "Default indentation for literal block after a minimized markup."
2837 "Default indentation for first line of a comment."
2841 ;; FIXME: Must consider other tabs:
2842 ;; * Line blocks
2843 ;; * Definition lists
2844 ;; * Option lists
2846 "Return tabs of the current line or nil for no tab.
2847 The list is sorted so the tab where writing continues most likely
2848 is the first one. Each tab is of the form (COLUMN . INNER).
2849 COLUMN is the column of the tab. INNER is non-nil if this is an
2850 inner tab. I.e. a tab which does come from the basic indentation
2851 and not from inner alignment points."
2857 ;; Current indentation is always the least likely tab.
2859 ;; Push inner tabs more likely to continue writing.
2861 ;; Item.
2865 ;; Field.
2876 ;; Directive.
2883 ;; Footnote or citation definition.
2888 ;; Comment.
2891 ;; Start of literal block.
2897 rst-indent-literal-minimized
2898 rst-indent-literal-normal))
2903 tabs))))))
2906 "Build the list of possible tabs for all lines above.
2907 Search backwards from point PT to build the list of possible
2908 tabs. Return a list of tabs sorted by likeliness to continue
2909 writing like `rst-line-tabs'. Nearer lines have generally a
2910 higher likeliness than farther lines. Return nil if no tab is found
2911 in the text above."
2915 innermost ; Leftmost column for inner tab.
2916 tablist)
2923 ;; Consider only lines indented less or same if not INNERMOST.
2941 leftcol
2942 innermost))
2947 "Indent current line to next best reStructuredText tab.
2948 The next best tab is taken from the tab list returned by
2949 `rst-compute-tabs' which is used in a cyclic manner. If the
2950 current indentation does not end on a tab use the first one. If
2951 the current indentation is on a tab use the next tab. This allows
2953 possible tabs. If no indentation is possible return `noindent' or
2954 use DFLT. Return the indentation indented to. When point is in
2955 indentation it ends up at its end. Otherwise the point is kept
2956 relative to the content."
2962 ind)
2964 'noindent
2977 ind)))
2980 "Shift region BEG to END by CNT tabs.
2981 Shift by one tab to the right (CNT > 0) or left (CNT < 0) or
2982 remove all indentation (CNT = 0). A tab is taken from the text
2983 above. If no suitable tab is found `rst-indent-width' is used."
2988 ;; Apply the indent.
2990 beg end
2993 ;; Find the next tab after the leftmost column.
2999 ;; Get the position of the first tab beyond leftmostcol.
3004 tabs)))
3005 ;; Virtual position of tab.
3008 ;; Tab exists - use it.
3010 ;; Column needs to be computed.
3012 ;; Base on last known column.
3014 dir ; Direction to take.
3015 rst-indent-width))))
3019 ;; FIXME: A paragraph with an (incorrectly) indented second line is not filled
3020 ;; correctly::
3021 ;;
3022 ;; Some start
3023 ;; continued wrong
3025 "Return fill prefix found at point.
3026 Value for `adaptive-fill-function'."
3031 ;; An non-comment prefix is fine.
3032 fnd
3033 ;; Matches a comment - return whitespace instead.
3042 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3043 ;; Comments
3046 "Break line and indent, continuing reStructuredText comment if within one.
3047 Value for `comment-line-break-function'. If SOFT use soft
3048 newlines as mandated by `comment-line-break-function'."
3061 "Return indentation for current comment line."
3065 "Insert a comment in the current line."
3070 "Comment or uncomment the current region.
3071 Region is from from BEG to END. Uncomment if ARG."
3077 bol)
3087 "Uncomment the current region.
3088 Region is from BEG to END. ARG is ignored"
3099 ;;------------------------------------------------------------------------------
3101 ;; FIXME: These next functions should become part of a larger effort to redo
3102 ;; the bullets in bulleted lists. The enumerate would just be one of
3103 ;; the possible outputs.
3104 ;;
3105 ;; FIXME: We need to do the enumeration removal as well.
3108 "Add enumeration to all the leftmost paragraphs in the given region.
3109 The region is specified between BEG and END. With ALL,
3110 do all lines instead of just paragraphs."
3120 )))
3123 "Add bullets to all the leftmost paragraphs in the given region.
3124 The region is specified between BEG and END. With ALL,
3125 do all lines instead of just paragraphs."
3131 ))
3133 ;; FIXME: Does not deal with a varying number of digits appropriately.
3134 ;; FIXME: Does not deal with multiple levels independently.
3135 ;; FIXME: Does not indent a multiline item correctly.
3137 "Convert the bulleted and enumerated items in the region to enumerated lists.
3138 Renumber as necessary. Region is from BEG to END."
3147 )
3154 ))
3155 ))
3159 ;;------------------------------------------------------------------------------
3162 "Toggle line block prefixes for a region.
3163 Region is from RBEG to REND. With PFXARG set the empty lines too."
3178 \f
3179 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3180 ;; Font lock
3181 ;; =========
3185 ;; FIXME: The obsolete variables need to disappear.
3187 ;; The following versions have been done inside Emacs and should not be
3188 ;; replaced by `:package-version' attributes until a change.
3196 "Face used for all syntax marking up a special block."
3201 "All syntax marking up a special block."
3206 "customize the face `rst-block' instead."
3210 "Face used for field names and interpreted text."
3215 "Field names and interpreted text."
3220 "customize the face `rst-external' instead."
3224 "Face used for all other defining constructs."
3229 "All other defining constructs."
3234 "customize the face `rst-definition' instead."
3237 ;; XEmacs compatibility (?).
3241 "Face used for directives and roles."
3246 "Directives and roles."
3250 "customize the face `rst-directive' instead."
3254 "Face used for comments."
3259 "Comments."
3264 "customize the face `rst-comment' instead."
3268 "Face used for simple emphasis."
3273 "Simple emphasis."
3278 "customize the face `rst-emphasis1' instead."
3282 "Face used for double emphasis."
3287 "Double emphasis."
3291 "customize the face `rst-emphasis2' instead."
3295 "Face used for literal text."
3300 "Literal text."
3305 "customize the face `rst-literal' instead."
3309 "Face used for references to a definition."
3314 "References to a definition."
3319 "customize the face `rst-reference' instead."
3323 "Face used for a transition."
3328 "Face used for the adornment of a section header."
3332 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3334 ;; FIXME LEVEL-FACE: May be this complicated mechanism should be replaced
3335 ;; simply by a number of customizable faces `rst-header-%d'
3336 ;; which by default are set properly for dark and light
3337 ;; background. Initialization should come from the old
3338 ;; variables if they exist. A maximum level of 6 should
3339 ;; suffice - after that the last level should be repeated.
3340 ;; Only `rst-adornment-faces-alist' is needed outside this
3341 ;; block. Would also fix docutils-Bugs-3479594.
3344 "Values used to generate default faces for section titles on all levels.
3345 Tweak these if you are content with how section title faces are built in
3346 general but you do not like the details."
3351 "Set custom variable SYM affecting section title text face.
3352 Recompute the faces. VAL is the value to set."
3354 ;; Also defines the faces initially when all values are available.
3363 ;; Faces for displaying items on several levels. These definitions define
3364 ;; different shades of gray where the lightest one (i.e. least contrasting on a
3365 ;; light background) is used for level 1.
3367 "Maximum depth of levels for which section title faces are defined."
3371 ;; FIXME: It should be possible to give "#RRGGBB" type of color values.
3372 ;; Together with a `rst-level-face-end-light' this could be used for
3373 ;; computing steps.
3374 ;; FIXME: This variable should be combined with `rst-level-face-format-light'
3375 ;; to a single string.
3377 "Base name of the color for creating background colors in section title faces."
3381 ;; FIXME LEVEL-FACE: This needs to be done differently: The faces must specify
3382 ;; how they behave for dark and light background using the
3383 ;; relevant options explained in `defface'.
3386 15
3388 "The lightness factor for the base color. This value is used for level 1.
3389 The default depends on whether the value of `frame-background-mode' is
3390 `dark' or not."
3395 "The format for the lightness factor appended to the base name of the color.
3396 This value is expanded by `format' with an integer."
3400 ;; FIXME LEVEL-FACE: This needs to be done differently: The faces must specify
3401 ;; how they behave for dark and light background using the
3402 ;; relevant options explained in `defface'.
3403 ;; FIXME: Alternatively there could be a customizable variable
3404 ;; `rst-level-face-end-light' which defines the end value and steps are
3405 ;; computed
3408 7
3410 "The step width to use for the next color.
3411 The formula
3413 `rst-level-face-base-light'
3414 + (`rst-level-face-max' - 1) * `rst-level-face-step-light'
3416 must result in a color level which appended to `rst-level-face-base-color'
3417 using `rst-level-face-format-light' results in a valid color such as `grey50'.
3418 This color is used as background for section title text on level
3419 `rst-level-face-max'."
3425 ;; FIXME LEVEL-FACE: Must be redone if `rst-level-face-max' is changed
3430 ;; FIXME: why not `push'?
3433 alist)
3434 "Faces for the various adornment types.
3435 Key is a number (for the section title text of that level
3436 starting with 1), t (for transitions) or nil (for section title
3437 adornment). If you generally do not like how section title text
3438 faces are set up tweak here. If the general idea is ok for you
3439 but you do not like the details check the Rst Faces Defaults
3440 group."
3443 :key-type
3452 "Define the faces for the section title text faces from the values."
3453 ;; All variables used here must be checked in `rst-set-level-default'.
3458 This symbol is *not* meant for customization but modified if a
3459 variable of the `rst-faces-defaults' group is customized. Use
3462 rst-level-face-base-color
3464 rst-level-face-base-light))))
3471 ;; FIXME LEVEL-FACE: This is probably superfluous since it is done by the
3472 ;; customization / `rst-set-level-default'.
3475 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3478 ;; The reST-links in the comments below all relate to sections in
3479 ;; http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html.
3481 ;; start.
3483 ;; Simple `Body Elements`_
3484 ;; `Bullet Lists`_
3485 ;; FIXME: A bullet directly after a field name is not recognized.
3488 ;; `Enumerated Lists`_
3491 ;; `Definition Lists`_
3492 ;; FIXME: missing.
3493 ;; `Field Lists`_
3496 ;; `Option Lists`_
3500 ;; `Line Blocks`_
3501 ;; Only for lines containing no more bar - to distinguish from tables.
3505 ;; `Tables`_
3506 ;; FIXME: missing
3508 ;; All the `Explicit Markup Blocks`_
3509 ;; `Footnotes`_ / `Citations`_
3513 ;; `Directives`_ / `Substitution Definitions`_
3518 ;; `Hyperlink Targets`_
3528 ;; All `Inline Markup`_
3529 ;; Most of them may be multiline though this is uninteresting.
3531 ;; FIXME: Condition 5 preventing fontification of e.g. "*" not implemented
3532 ;; `Strong Emphasis`_.
3535 ;; `Emphasis`_
3538 ;; `Inline Literals`_
3541 ;; `Inline Internal Targets`_
3544 ;; `Hyperlink References`_
3545 ;; FIXME: `Embedded URIs`_ not considered.
3546 ;; FIXME: Directly adjacent marked up words are not fontified correctly
3547 ;; unless they are not separated by two spaces: foo_ bar_.
3552 ;; `Interpreted Text`_
3559 ;; `Footnote References`_ / `Citation References`_
3562 ;; `Substitution References`_
3563 ;; FIXME: References substitutions like |this|_ or |this|__ are not
3564 ;; fontified correctly.
3567 ;; `Standalone Hyperlinks`_
3568 ;; FIXME: This takes it easy by using a whitespace as delimiter.
3574 ;; Do all block fontification as late as possible so 'append works.
3576 ;; Sections_ / Transitions_
3577 ;; For sections this is multiline.
3582 nil
3588 ;; FIXME: FACESPEC could be used instead of ordinary faces to set
3589 ;; properties on comments and literal blocks so they are *not*
3590 ;; inline fontified. See (elisp)Search-based Fontification.
3592 ;; FIXME: And / or use `syntax-propertize` functions as in `octave-mod.el`
3593 ;; and other V24 modes. May make `font-lock-extend-region`
3594 ;; superfluous.
3596 ;; `Comments`_
3597 ;; This is multiline.
3602 nil
3609 nil
3612 ;; FIXME: This is not rendered as comment::
3613 ;; .. .. list-table::
3614 ;; :stub-columns: 1
3615 ;; :header-rows: 1
3617 ;; FIXME: This is rendered wrong::
3618 ;;
3619 ;; xxx yyy::
3620 ;;
3621 ;; ----|> KKKKK <|----
3622 ;; / \
3623 ;; -|> AAAAAAAAAAPPPPPP <|- -|> AAAAAAAAAABBBBBBB <|-
3624 ;; | | | |
3625 ;; | | | |
3626 ;; PPPPPP PPPPPPDDDDDDD BBBBBBB PPPPPPBBBBBBB
3627 ;;
3628 ;; Indentation needs to be taken from the line with the ``::`` and not from
3629 ;; the first content line.
3631 ;; `Indented Literal Blocks`_
3632 ;; This is multiline.
3637 nil
3640 ;; FIXME: `Quoted Literal Blocks`_ missing.
3641 ;; This is multiline.
3643 ;; `Doctest Blocks`_
3644 ;; FIXME: This is wrong according to the specification:
3645 ;;
3646 ;; Doctest blocks are text blocks which begin with ">>> ", the Python
3647 ;; interactive interpreter main prompt, and end with a blank line.
3648 ;; Doctest blocks are treated as a special case of literal blocks,
3649 ;; without requiring the literal block syntax. If both are present, the
3650 ;; literal block syntax takes priority over Doctest block syntax:
3651 ;;
3652 ;; This is an ordinary paragraph.
3653 ;;
3654 ;; >>> print 'this is a Doctest block'
3655 ;; this is a Doctest block
3656 ;;
3657 ;; The following is a literal block::
3658 ;;
3659 ;; >>> This is not recognized as a doctest block by
3660 ;; reStructuredText. It *will* be recognized by the doctest
3661 ;; module, though!
3662 ;;
3663 ;; Indentation is not required for doctest blocks.
3667 )
3674 "Extend the font-lock region if it might be in a multi-line construct.
3675 Return non-nil if so. Font-lock region is from `font-lock-beg'
3676 to `font-lock-end'."
3681 t)))
3684 "Check the region BEG / END for being in the middle of a multi-line construct.
3685 Return nil if not or a cons with new values for BEG / END"
3692 "Like `forward-line' but always end up in column 0 and return accordingly.
3693 Move N lines forward just as `forward-line'."
3696 moved
3700 ;; FIXME: If a single line is made a section header by `rst-adjust' the header
3701 ;; is not always fontified immediately.
3703 "Extend the region starting at point PT and extending in direction DIR.
3704 Return extended point or nil if not moved."
3705 ;; There are many potential multiline constructs but there are two groups
3706 ;; which are really relevant. The first group consists of
3707 ;;
3708 ;; * comment lines without leading explicit markup tag and
3709 ;;
3710 ;; * literal blocks following "::"
3711 ;;
3712 ;; which are both indented. Thus indentation is the first thing recognized
3713 ;; here. The second criteria is an explicit markup tag which may be a comment
3714 ;; or a double colon at the end of a line.
3715 ;;
3716 ;; The second group consists of the adornment cases.
3718 ;; Move only if we don't start inside a multiline construct already.
3721 ;; block tag.
3725 ;; The comments below are for dir == -1 / dir == 1.
3731 ; line if it exists.
3733 ; overline.
3736 ; underline / overline
3737 ; found.
3741 ; overline /
3742 ; underline.
3744 ; / adornment.
3751 ; underline.
3756 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3757 ;; Indented blocks
3760 "Move forward across one indented block.
3761 Find the next non-empty line which is not indented at least to COLUMN (defaults
3762 to the column of the point). Moves point to first character of this line or the
3763 first empty line immediately before it and returns that position. If there is
3764 no such line before LIMIT (defaults to the end of the buffer) returns nil and
3765 point is not moved."
3769 fnd beg cand)
3780 ;; FIXME: No indentation [(zerop clm)] must be handled in some
3781 ;; useful way - though it is not clear what this should mean
3782 ;; at all.
3789 fnd))
3795 "End of the match as determined by `rst-font-lock-find-unindented-line-limit'.
3796 Also used as a trigger for
3800 "Find the next unindented line relative to indentation at IND-PNT.
3801 Return this point, the end of the buffer or nil if nothing found.
3802 If IND-PNT is `next' take the indentation from the next line if
3803 this is not empty and indented more than the current one. If
3804 IND-PNT is non-nil but not a number take the indentation from the
3805 next non-empty line if this is indented more than the current
3806 one."
3811 ;; Find indentation point in next line if any.
3813 ;; FIXME: Should be refactored to two different functions
3814 ;; giving their result to this function, may be
3815 ;; integrated in caller.
3821 ;; Not at EOF.
3826 ;; Use end of indentation if non-empty line.
3829 ;; Skip until non-empty line or EOF.
3834 ;; Not at EOF.
3838 ;; Indentation bigger than line of departure.
3847 "Set the match found earlier if match were found.
3848 Match has been found by
3849 `rst-font-lock-find-unindented-line-limit' the first time called
3850 or no match is found. Return non-nil if match was found. LIMIT
3851 is not used but mandated by the caller."
3855 rst-font-lock-find-unindented-line-end))
3857 rst-font-lock-find-unindented-line-end
3859 ;; Make sure this is called only once.
3861 t))
3863 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3864 ;; Adornments
3867 "Storage for `rst-font-lock-handle-adornment-matcher'.
3871 "Return section level for adornment KEY.
3872 KEY is the first element of the return list of
3873 `rst-classify-adornment'. If KEY is not a cons return it. If KEY is found
3874 in the hierarchy return its level. Otherwise return a level one
3875 beyond the existing hierarchy."
3877 key
3890 "Storage for match for current adornment.
3891 Set by `rst-font-lock-handle-adornment-pre-match-form'. Also used
3895 "Determine limit for adornments.
3896 Determine all things necessary for font-locking section titles
3897 and transitions and put the result to
3898 `rst-font-lock-adornment-match' and
3899 `rst-font-lock-adornment-level'. ADO is the complete adornment
3900 matched. ADO-END is the point where ADO ends. Return the point
3901 where the whole adorned construct ends.
3903 Called as a PRE-MATCH-FORM in the sense of `font-lock-keywords'."
3907 rst-font-lock-adornment-match nil)
3915 "Set the match found earlier if match were found.
3916 Match has been found by
3917 `rst-font-lock-handle-adornment-pre-match-form' the first time
3918 called or no match is found. Return non-nil if match was found.
3920 Called as a MATCHER in the sense of `font-lock-keywords'.
3921 LIMIT is not used but mandated by the caller."
3923 ;; May run only once - enforce this.
3930 t)))
3932 \f
3933 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3934 ;; Compilation
3937 "Settings for support of conversion of reStructuredText
3959 "Table describing the command to use for each tool-set.
3960 An association list of the tool-set to a list of the (command to use,
3961 extension of produced filename, options to the tool (nil or a
3962 string)) to be used for converting the document."
3963 ;; FIXME: These are not options but symbols which may be referenced by
3964 ;; `rst-compile-*-toolset` below. The `:validate' keyword of
3965 ;; `defcustom' may help to define this properly in newer Emacs
3966 ;; versions (> 23.1).
3968 :key-type symbol
3978 ;; FIXME: Must be `defcustom`.
3982 ;; FIXME: Must be `defcustom`.
3987 "Look for the configuration file in the parents of the current path."
3991 ;; Move up in the dir hierarchy till we find a change log file.
3996 nil)
3998 ;; Move up to the parent dir and try again.
4003 )
4005 )))
4011 "Compile command to convert reST document into some output file.
4012 Attempts to find configuration file, if it can, overrides the
4013 options. There are two commands to choose from, with USE-ALT,
4014 select the alternative tool-set."
4016 ;; Note: maybe we want to check if there is a Makefile too and not do anything
4017 ;; if that is the case. I dunno.
4019 rst-compile-secondary-toolset
4020 rst-compile-primary-toolset)
4021 rst-compile-toolsets)))
4029 ;; Set compile-command before invocation of compile.
4041 ;; Invoke the compile command.
4045 ))
4048 "Compile command with the alternative tool-set."
4053 "Show pseudo-XML rendering.
4054 Rendering is done of the current active region, or of the entire
4055 buffer, if the region is not selected."
4056 ;; FIXME: The region should be given interactively.
4063 standard-output)))
4065 ;; FIXME: Should be `defcustom`.
4070 "Convert the document to a PDF file and launch a preview program."
4075 buffer-file-name tmp-filename
4076 rst-pdf-program tmp-filename tmp-filename)))
4078 ;; Note: you could also use (compile command) to view the compilation
4079 ;; output.
4080 ))
4082 ;; FIXME: Should be `defcustom` or use something like `browse-url`.
4087 "Convert the document to an S5 slide presentation and launch a preview program."
4092 buffer-file-name tmp-filename
4093 rst-slides-program tmp-filename tmp-filename)))
4095 ;; Note: you could also use (compile command) to view the compilation
4096 ;; output.
4097 ))
4099 \f
4100 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4101 ;; Generic text functions that are more convenient than the defaults.
4103 ;; FIXME: Unbound command - should be bound or removed.
4105 "Replace flush-left lines of FROMCHAR with equal-length lines of TOCHAR."
4107 cSearch for flush-left lines of char:
4120 ;; FIXME: Unbound command - should be bound or removed.
4122 "Join lines in current paragraph into one line, removing end-of-lines."
4127 ;; FIXME: Unbound command - should be bound or removed.
4129 "Fill paragraph at point, first joining the paragraph's lines into one.
4130 This is useful for filling list item paragraphs."
4136 ;; FIXME: Unbound command - should be bound or removed.
4137 ;; Generic character repeater function.
4138 ;; For sections, better to use the specialized function above, but this can
4139 ;; be useful for creating separators.
4141 "Fill the current line using the last character on the current line.
4142 Fill up to the length of the preceding line or up to
4143 `fill-column' if preceding line is empty.
4145 If USE-NEXT, use the next line rather than the preceding line.
4147 If the current line is longer than the desired length, shave the characters off
4148 the current line to fit the desired length.
4150 As an added convenience, if the command is repeated immediately, the alternative
4151 column is used (fill-column vs. end of previous/next line)."
4158 fill-column
4170 )) )
4173 ;; Shave characters off the end.
4177 ;; Fill with last characters.
4180 ))
4184 "Return non-nil if the mark is active.
4185 This is a portable function."
4191 \f
4193 ;; LocalWords: docutils http sourceforge rst html wp svn svnroot txt reST regex
4194 ;; LocalWords: regexes alist seq alt grp keymap abbrev overline overlines toc
4195 ;; LocalWords: XML PNT propertized
4197 ;; Local Variables:
4198 ;; sentence-end-double-space: t
4199 ;; End:
4203 ;;; rst.el ends here