| blob | 1f51809f1cef87fc01aa0ccba5772a6b20e7e3f6 |
1 ;;; org-list.el --- Plain lists for Org -*- lexical-binding: t; -*-
2 ;;
3 ;; Copyright (C) 2004-2018 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Bastien Guerry <bzg@gnu.org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: https://orgmode.org
9 ;;
10 ;; This file is part of GNU Emacs.
11 ;;
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
24 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
25 ;;
26 ;;; Commentary:
28 ;; This file contains the code dealing with plain lists in Org mode.
30 ;; The core concept behind lists is their structure. A structure is
31 ;; a snapshot of the list, in the shape of a data tree (see
32 ;; `org-list-struct').
34 ;; Once the list structure is stored, it is possible to make changes
35 ;; on it that will be mirrored to the real list or to get information
36 ;; about the list, using accessors and methods provided in the
37 ;; library. Most of them require the use of one or two helper
38 ;; functions, namely `org-list-parents-alist' and
39 ;; `org-list-prevs-alist'.
41 ;; Structure is eventually applied to the buffer with
42 ;; `org-list-write-struct'. This function repairs (bullets,
43 ;; indentation, checkboxes) the list in the process. It should be
44 ;; called near the end of any function working on structures.
46 ;; Thus, a function applying to lists should usually follow this
47 ;; template:
49 ;; 1. Verify point is in a list and grab item beginning (with the same
50 ;; function `org-in-item-p'). If the function requires the cursor
51 ;; to be at item's bullet, `org-at-item-p' is more selective. It
52 ;; is also possible to move point to the closest item with
53 ;; `org-list-search-backward', or `org-list-search-forward',
54 ;; applied to the function `org-item-beginning-re'.
56 ;; 2. Get list structure with `org-list-struct'.
58 ;; 3. Compute one, or both, helper functions,
59 ;; (`org-list-parents-alist', `org-list-prevs-alist') depending on
60 ;; needed accessors.
62 ;; 4. Proceed with the modifications, using methods and accessors.
64 ;; 5. Verify and apply structure to buffer, using
65 ;; `org-list-write-struct'.
67 ;; 6. If changes made to the list might have modified check-boxes,
68 ;; call `org-update-checkbox-count-maybe'.
70 ;; Computing a structure can be a costly operation on huge lists (a
71 ;; few thousand lines long). Thus, code should follow the rule:
72 ;; "collect once, use many". As a corollary, it is usually a bad idea
73 ;; to use directly an interactive function inside the code, as those,
74 ;; being independent entities, read the whole list structure another
75 ;; time.
77 ;;; Code:
113 org-element-map "org-element"
164 \f
165 ;;; Configuration variables
168 "Options concerning plain lists in Org mode."
173 "When t, make TAB cycle visibility on plain list items.
174 Cycling plain lists works only when the cursor is on a plain list
175 item. When the cursor is on an outline heading, plain lists are
176 treated as text. This is the most stable way of handling this,
177 which is why it is the default.
179 When this is the symbol `integrate', then integrate plain list
180 items when cycling, as if they were children of outline headings.
182 This setting can lead to strange effects when switching visibility
185 plain list item with an implied large level number, all true
186 children and grand children of the outline heading will be
187 exposed in a children' view."
196 "Default bullet type installed when demoting an item.
197 This is an association list, for each bullet type, this alist will point
198 to the bullet that should be used when this item is demoted.
199 For example,
201 (setq org-list-demote-modify-bullet
204 will make
206 + Movies
207 + Silence of the Lambs
208 + My Cousin Vinny
209 + Books
210 + The Hunt for Red October
211 + The Road to Omaha
213 into
215 + Movies
216 - Silence of the Lambs
217 - My Cousin Vinny
218 + Books
219 - The Hunt for Red October
220 - The Road to Omaha"
238 "The character that makes a line with leading number an ordered list item.
239 Valid values are ?. and ?\). To get both terminators, use t.
241 This variable needs to be set before org.el is loaded. If you
242 need to make a change while Emacs is running, use the customize
243 interface or run the following code after updating it:
254 "Non-nil means single character alphabetical bullets are allowed.
256 Both uppercase and lowercase are handled. Lists with more than
257 26 items will fallback to standard numbering. Alphabetical
260 This variable needs to be set before org.el is loaded. If you
261 need to make a change while Emacs is running, use the customize
262 interface or run the following code after updating it:
272 "A regular expression matching bullets that should have 2 spaces after them.
273 When nil, no bullet will have two spaces after them. When
274 a string, it will be used as a regular expression. When the
275 bullet type of a list is changed, the new bullet type will be
276 matched against this regexp. If it matches, there will be two
277 spaces instead of one after the bullet in each item of the list."
285 "Non-nil means apply set of rules when acting on lists.
287 By default, automatic actions are taken when using
297 You can disable individually these rules by setting them to nil.
298 Valid rules are:
300 checkbox when non-nil, checkbox statistics is updated each time
301 you either insert a new checkbox or toggle a checkbox.
302 indent when non-nil, indenting or outdenting list top-item
303 with its subtree will move the whole list and
304 outdenting a list whose bullet is * to column 0 will
309 :key-type
313 :value-type
317 "Non-nil means commands implying motion in lists should be cyclic.
319 In that case, the item following the last item is the first one,
320 and the item preceding the first item is the last one.
322 This affects the behavior of
332 "Hook that is run whenever Org thinks checkbox statistics should be updated.
333 This hook runs even if checkbox rule in
334 `org-list-automatic-rules' does not apply, so it can be used to
335 implement alternative ways of collecting statistics
339 "Non-nil means checkbox statistics counts only the state of direct children.
340 When nil, all boxes below the cookie are counted.
341 This can be set to nil on a per-node basis using a COOKIE_DATA property
347 "Maximum indentation for the second line of a description list.
348 When the indentation would be larger than this, it will become
349 5 characters instead."
354 "Additional indentation for sub-items in a list.
355 By setting this to a small number, usually 1 or 2, one can more
356 clearly distinguish sub-items in a list."
363 % END RECEIVE ORGLST %n
365 #+ORGLST: SEND %n org-list-to-latex
366 -
369 @c END RECEIVE ORGLST %n
370 @ignore
371 #+ORGLST: SEND %n org-list-to-texinfo
372 -
375 <!-- END RECEIVE ORGLST %n -->
376 <!--
377 #+ORGLST: SEND %n org-list-to-html
378 -
380 "Templates for radio lists in different major modes.
381 All occurrences of %n in a template will be replaced with the name of the
382 list, obtained by prompting the user."
389 "Names of blocks where lists are not allowed.
393 "Context types where lists will be interpreted during export.
395 Valid types are `drawer', `inlinetask' and `block'. More
396 specifically, type `block' is determined by the variable
400 \f
401 ;;; Predicates and regexps
411 "Matches a list item and puts everything into groups:
412 group 1: bullet
413 group 2: counter
414 group 3: checkbox
418 "Return the correct regular expression for plain lists."
429 "Regexp matching the beginning of a plain list item."
433 "Is point at a list item with REGEXP after bullet?"
442 ;; Ignore counter if any
447 "Is point in a context where lists are allowed?"
451 "Return item beginning position when in a plain list, nil otherwise."
460 ;; Indentation isn't meaningful when point starts at an empty
461 ;; line or an inline task.
464 10000
470 ;; Detect if cursor in amidst `org-list-end-re'. First, count
471 ;; number HL of hard lines it takes, then call `org-in-regexp'
472 ;; to compute its boundaries END-BOUNDS. When point is
473 ;; in-between, move cursor before regexp beginning.
484 ;; Look for an item, less indented that reference line.
489 ;; This is exactly what we want.
492 ;; At upper bound of search or looking at the end of a
493 ;; previous list: search is over.
496 ;; Skip blocks, drawers, inline-tasks, blank lines
506 ;; Text at column 0 cannot belong to a list: stop.
508 ;; Normal text less indented than reference line, take
509 ;; it as new reference.
516 "Is point in a line starting a hand-formatted item?"
522 "Is point at the bullet of a plain list item?"
528 "Is point at a line starting a plain list item with a timer?"
533 "Is point at a description list item?"
537 "Is point at a line starting a plain-list item with a checklet?"
541 "Is point at a line starting a plain-list item with a counter?"
547 \f
548 ;;; Structures and helper functions
551 "Determine context, and its boundaries, around point.
553 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
554 are boundaries and CONTEXT is a symbol among `drawer', `block',
555 `invalid', `inlinetask' and nil.
557 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
563 ;; Get positions of surrounding headings. This is the
564 ;; default context.
569 ;; Is point inside a drawer?
579 lim-down))
582 ;; Is point strictly in a block, and of which type?
593 lim-down))
599 ;; Is point in an inlinetask?
612 ;; Return context boundaries and type.
616 "Return structure of list at point.
618 A list structure is an alist where key is point at item, and
619 values are:
620 1. indentation,
621 2. bullet with trailing whitespace,
622 3. bullet counter, if any,
623 4. checkbox, if any,
624 5. description tag, if any,
625 6. position at item end.
627 Thus the following list, where numbers in parens are
628 point-at-bol:
630 - [X] first item (1)
631 1. sub-item 1 (18)
632 5. [@5] sub-item 2 (34)
633 some other text belonging to first item (55)
634 - last item (97)
635 + tag :: description (109)
636 (131)
638 will get the following structure:
646 Assume point is at an item."
658 itm-lst itm-lst-2 end-lst end-lst-2 struct
661 ;; Return association at point.
666 ind
667 bullet
670 ;; Description tag.
675 ;; Ensure list ends at the first blank line.
679 ;; 1. Read list from starting item to its beginning, and save
680 ;; top item position and indentation in BEG-CELL. Also store
681 ;; ending position of items in END-LST.
688 ;; At upward limit: if we ended at an item, store it,
689 ;; else dismiss useless data recorded above BEG-CELL.
690 ;; Jump to part 2.
697 ;; Looking at a list ending regexp. Dismiss useless
698 ;; data recorded above BEG-CELL. Jump to part 2.
703 ;; Point is at an item. Add data to ITM-LST. It may
704 ;; also end a previous item: save it in END-LST. If
705 ;; ind is less or equal than BEG-CELL and there is no
706 ;; end at this ind or lesser, this item becomes the new
707 ;; BEG-CELL.
713 ;; Skip blocks, drawers, inline tasks, blank lines.
724 ;; From there, point is not at an item. Interpret
725 ;; line's indentation:
726 ;; - text at column 0 is necessarily out of any list.
727 ;; Dismiss data recorded above BEG-CELL. Jump to
728 ;; part 2.
729 ;; - any other case may be an ending position for an
730 ;; hypothetical item above. Store it and proceed.
739 ;; 2. Read list from starting point to its end, that is until we
740 ;; get out of context, or that a non-item line is less or
741 ;; equally indented than BEG-CELL's cdr. Also, store ending
742 ;; position of items in END-LST-2.
748 ;; At downward limit: this is de facto the end of the
749 ;; list. Save point as an ending position, and jump to
750 ;; part 3.
753 ;; Looking at a list ending regexp. Save point as an
754 ;; ending position and jump to part 3.
758 ;; Point is at an item. Add data to ITM-LST-2. It may
759 ;; also end a previous item, so save it in END-LST-2.
763 ;; Skip inline tasks and blank lines along the way
768 ;; Ind is lesser or equal than BEG-CELL's. The list is
769 ;; over: store point as an ending position and jump to
770 ;; part 3.
774 ;; Else, if ind is lesser or equal than previous item's,
775 ;; this is an ending position: store it. In any case,
776 ;; skip block or drawer at point, and move to next line.
788 ;; 3. Associate each item to its end position.
790 ;; 4. Return STRUCT
791 struct)))
794 "Associate proper ending point to items in STRUCT.
796 END-LIST is a pseudo-alist where car is indentation and cdr is
797 ending position.
799 This function modifies STRUCT."
805 ;; Remove end candidates behind current item.
808 ;; Add end position to item assoc.
814 struct)))
817 "Return alist between item and previous item in STRUCT."
819 struct)))
823 struct)))
826 "Return alist between item and parent in STRUCT."
838 ;; A sub-list is over. Find the associated
839 ;; origin in IND-TO-ORI. If it cannot be
840 ;; found (ill-formed list), set its parent as
841 ;; the first item less indented. If there is
842 ;; none, make it a top-level item.
850 ind-to-ori)
853 ;; A sub-list starts. Every item at IND will
854 ;; have previous item as its parent.
859 ;; Another item in the same sub-list: it shares
860 ;; the same parent as the previous item.
865 \f
866 ;;; Accessors
869 "Return the Nth value of KEY in STRUCT."
873 "Set the Nth value of KEY in STRUCT to NEW.
878 "Return indentation of ITEM in STRUCT."
882 "Set indentation of ITEM in STRUCT to IND.
887 "Return bullet of ITEM in STRUCT."
891 "Set bullet of ITEM in STRUCT to BULLET.
896 "Return counter of ITEM in STRUCT."
900 "Return checkbox of ITEM in STRUCT or nil."
904 "Set checkbox of ITEM in STRUCT to CHECKBOX.
909 "Return end position of ITEM in STRUCT."
913 "Return end position of ITEM in STRUCT."
917 "Return point at end of ITEM in STRUCT, before any blank line.
918 Point returned is at end of line."
925 "Return parent of ITEM or nil.
926 STRUCT is the list structure. PARENTS is the alist of parents,
927 as returned by `org-list-parents-alist'."
932 "Non-nil if ITEM has a child.
934 STRUCT is the list structure.
936 Value returned is the position of the first child of ITEM."
941 child-maybe)))
944 "Return next item in same sub-list as ITEM, or nil.
945 STRUCT is the list structure. PREVS is the alist of previous
946 items, as returned by `org-list-prevs-alist'."
950 "Return previous item in same sub-list as ITEM, or nil.
951 STRUCT is the list structure. PREVS is the alist of previous
952 items, as returned by `org-list-prevs-alist'."
956 "List all items having ITEM as a common ancestor, or nil.
957 STRUCT is the list structure."
960 subtree)
965 sub-struct))
969 "List all items in the same sub-list as ITEM.
970 STRUCT is the list structure. PREVS is the alist of previous
971 items, as returned by `org-list-prevs-alist'."
974 before-item after-item)
982 "List all children of ITEM, or nil.
983 STRUCT is the list structure. PARENTS is the alist of parents,
984 as returned by `org-list-parents-alist'."
992 "Return point at beginning of list.
993 STRUCT is the list structure."
997 "Return point at bottom of list.
998 STRUCT is the list structure."
1003 "Return point at beginning of sub-list ITEM belongs.
1004 STRUCT is the list structure. PREVS is the alist of previous
1005 items, as returned by `org-list-prevs-alist'."
1009 first-item))
1014 "Return point at last item of sub-list ITEM belongs.
1015 STRUCT is the list structure. PREVS is the alist of previous
1016 items, as returned by `org-list-prevs-alist'."
1020 last-item))
1023 "Return point at end of sub-list ITEM belongs.
1024 STRUCT is the list structure. PREVS is the alist of previous
1025 items, as returned by `org-list-prevs-alist'."
1029 "Return the type of the list containing ITEM, as a symbol.
1031 STRUCT is the list structure. PREVS is the alist of previous
1032 items, as returned by `org-list-prevs-alist'.
1034 Possible types are `descriptive', `ordered' and `unordered'. The
1035 type is determined by the first item of the list."
1043 "Return ITEM's sequence number.
1045 STRUCT is the list structure. PREVS is the alist of previous
1046 items, as returned by `org-list-prevs-alist'. PARENTS is the
1047 alist of ancestors, as returned by `org-list-parents-alist'.
1049 Return value is a list of integers. Counters have an impact on
1050 that value."
1054 ;; Return relative sequence number of ITEM in the sub-list
1055 ;; it belongs. STRUCT is the list structure. PREVS is
1056 ;; the alist of previous items.
1065 seq))
1069 ;; Cons each parent relative number into return value (OUT).
1074 ;; Return value.
1075 out)))
1078 \f
1079 ;;; Searching
1082 "Search a string in valid contexts for lists.
1083 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1084 in `re-search-forward'."
1088 ;; 1. No match: return to origin or bound, depending on NOERR.
1091 nil)))
1092 ;; 2. Match in valid context: return point. Else, continue
1093 ;; searching.
1097 "Like `re-search-backward' but stop only where lists are recognized.
1098 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1099 `re-search-backward'."
1104 "Like `re-search-forward' but stop only where lists are recognized.
1105 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1106 `re-search-forward'."
1111 \f
1112 ;;; Methods on structures
1115 "Return BULLET with the correct number of whitespaces.
1116 It determines the number of whitespaces to append by looking at
1117 `org-list-two-spaces-after-bullet-regexp'."
1121 org-list-two-spaces-after-bullet-regexp bullet))
1122 " "
1126 bullet))))
1129 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1131 Blank lines at the end of items are left in place. Item
1132 visibility is preserved. Return the new structure after the
1133 changes.
1135 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1136 to the same sub-list.
1138 This function modifies STRUCT."
1151 ;; Store overlays responsible for visibility status. We
1152 ;; also need to store their boundaries as they will be
1153 ;; removed from buffer.
1168 ;; 1. Move effectively items in buffer.
1172 ;; 2. Now modify struct. No need to re-read the list, the
1173 ;; transformation is just a shift of positions. Some special
1174 ;; attention is required for items ending at END-A and END-B
1175 ;; as empty spaces are not moved there. In others words,
1176 ;; item BEG-A will end with whitespaces that were at the end
1177 ;; of BEG-B and the same applies to BEG-B.
1200 ;; Restore visibility status, by moving overlays to their new
1201 ;; position.
1211 ;; Return structure.
1212 struct)))
1215 "Return number of blank lines that should separate items in list.
1217 POS is the position of point where `org-list-insert-item' was called.
1219 STRUCT is the list structure. PREVS is the alist of previous
1220 items, as returned by `org-list-prevs-alist'.
1222 Assume point is at item's beginning. If the item is alone, apply
1223 some heuristics to guess the result."
1228 usr-blank
1232 ;; Count blank lines above beginning of line.
1239 ;; Trivial cases where there should be none.
1241 ;; When `org-blank-before-new-entry' says so, it is 1.
1243 ;; `plain-list-item' is 'auto. Count blank lines separating
1244 ;; neighbors' items in list.
1247 ;; Is there a next item?
1250 ;; Is there a previous item?
1253 ;; User inserted blank lines, trust him.
1258 usr-blank)
1259 ;; Are there blank lines inside the list so far?
1262 ;; Do not use `org-list-search-forward' so blank lines
1263 ;; in blocks can be counted in.
1267 ;; Default choice: no blank line.
1271 "Insert a new list item at POS and return the new structure.
1272 If POS is before first character after bullet of the item, the
1273 new item will be created before the current one.
1275 STRUCT is the list structure. PREVS is the alist of previous
1276 items, as returned by `org-list-prevs-alist'.
1278 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1279 after the bullet. Cursor will be after this text once the
1280 function ends.
1282 This function modifies STRUCT."
1284 ;; 1. Get information about list: position of point with regards
1285 ;; to item start (BEFOREP), blank lines number separating items
1286 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1293 (<= pos
1296 ;; Ignore tag in a non-descriptive list.
1305 pos struct prevs))
1306 ;; 2. Build the new item to be created. Concatenate same
1307 ;; bullet as item, checkbox, text AFTER-BULLET if
1308 ;; provided, and text cut from point to end of item
1309 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1310 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1311 ;; between what was cut and what was inserted in buffer
1312 ;; is stored in SIZE-OFFSET.
1316 ind))
1323 ;; If POS is greater than ITEM-END, then point is
1324 ;; in some white lines after the end of the list.
1325 ;; Those must be removed, or they will be left,
1326 ;; stacking up after the list.
1336 text-cut))))
1340 ;; 4. Insert effectively item into buffer.
1344 ;; 5. Add new item to STRUCT.
1348 ;; Before inserted item, positions don't change but
1349 ;; an item ending after insertion has its end shifted
1350 ;; by SIZE-OFFSET.
1353 ;; Trivial cases where current item isn't split in
1354 ;; two. Just shift every item after new one by
1355 ;; ITEM-SIZE.
1359 ;; Item is split in two: elements before POS are just
1360 ;; shifted by ITEM-SIZE. In the case item would end
1361 ;; after split POS, ending is only shifted by
1362 ;; SIZE-OFFSET.
1368 ;; Elements after POS are moved into new item.
1369 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1370 ;; doesn't appear in buffer yet.
1376 (+ end size-offset
1378 ;; Elements at ITEM-END or after are only shifted by
1379 ;; SIZE-OFFSET.
1382 struct)
1385 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1386 ;; exchange ITEM with the next item in list. Position cursor
1387 ;; after bullet, counter, checkbox, and label.
1393 struct)))
1396 "Remove ITEM from the list and return the new structure.
1398 STRUCT is the list structure."
1401 ;; If ITEM ends with the list, delete blank lines
1402 ;; before it.
1407 item)))
1408 ;; Remove item from buffer.
1410 ;; Remove item from structure and shift others items accordingly.
1411 ;; Don't forget to shift also ending position when appropriate.
1429 struct)))))
1432 "Send ITEM to destination DEST.
1434 STRUCT is the list structure.
1436 DEST can have various values.
1438 If DEST is a buffer position, the function will assume it points
1439 to another item in the same list as ITEM, and will move the
1440 latter just before the former.
1442 If DEST is `begin' (respectively `end'), ITEM will be moved at
1443 the beginning (respectively end) of the list it belongs to.
1446 be moved at the Nth position in the list.
1448 If DEST is `kill', ITEM will be deleted and its body will be
1449 added to the kill-ring.
1451 If DEST is `delete', ITEM will be deleted.
1453 Visibility of item is preserved.
1455 This function returns, destructively, the new list structure."
1458 ;; Grab full item body minus its bullet.
1467 item-end)))
1468 ;; Change DEST into a buffer position. A trick is needed
1469 ;; when ITEM is meant to be sent at the end of the list.
1470 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1471 ;; nil and insertion point (INS-POINT) to the first line's
1472 ;; end of the last item, we ensure the new item will be
1473 ;; inserted after the last item, and not after any of its
1474 ;; hypothetical sub-items.
1490 ;; Send ITEM at the end of the list.
1498 ;; Store inner overlays (to preserve visibility).
1510 ;; 1. Structure returned by `org-list-insert-item' may not be
1511 ;; accurate, as it cannot see sub-items included in BODY.
1512 ;; Thus, first compute the real structure so far.
1520 ;; 1.1. Remove the item just created in structure.
1522 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1525 struct
1533 new-end
1535 moved-items))
1537 ;; 2. Restore inner overlays.
1542 ;; 3. Eventually delete extra copy of the item and clean marker.
1548 "Outdent items between positions START and END.
1550 STRUCT is the list structure. PARENTS is the alist of items'
1551 parents, as returned by `org-list-parents-alist'.
1553 START is included, END excluded."
1559 ;; Item not yet in zone: keep association.
1561 ;; Item out of zone: follow associations in ACC.
1565 ;; Item has no parent: error
1568 ;; Parent is outdented: keep association.
1572 ;; Parent isn't outdented: reparent to grand-parent.
1574 parent struct parents)))
1580 "Indent items between positions START and END.
1582 STRUCT is the list structure. PARENTS is the alist of parents
1583 and PREVS is the alist of previous items, returned by,
1584 respectively, `org-list-parents-alist' and
1585 `org-list-prevs-alist'.
1587 START is included and END excluded.
1589 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1590 bullets between START and END."
1598 ;; Normalize ordered bullets.
1608 org-list-demote-modify-bullet))))
1615 ;; Item not yet in zone: keep association.
1618 ;; Item out of zone: follow associations in ACC.
1622 ;; Item is in zone...
1624 ;; Check if bullet needs to be changed.
1627 ;; First item indented but not parent: error
1630 ;; First item and parent indented: keep same
1631 ;; parent.
1633 ;; Previous item not indented: reparent to it.
1635 ;; Previous item indented: reparent like it.
1642 \f
1643 ;;; Repairing structures
1646 "Non-nil if list starting at FIRST can have alphabetical bullets.
1648 STRUCT is list structure. PREVS is the alist of previous items,
1649 as returned by `org-list-prevs-alist'."
1653 ;; Pretend that bullets are uppercase and check if alphabet
1654 ;; is sufficient, taking counters into account.
1657 ;; Virtually determine current bullet
1659 ;; Counters are not case-sensitive.
1662 ;; Test if bullet would be over z or Z.
1666 ;; All items checked. All good.
1667 t))))
1670 "Increment BULLET if applicable."
1673 ;; Num bullet: increment it.
1677 nil nil bullet))
1678 ;; Alpha bullet: increment it.
1682 nil nil bullet))
1683 ;; Unordered bullet: leave it.
1687 "Verify and correct bullets in STRUCT.
1688 PREVS is the alist of previous items, as returned by
1689 `org-list-prevs-alist'.
1691 This function modifies STRUCT."
1695 ;; Set bullet of ITEM in STRUCT, depending on the type of
1696 ;; first item of the list, the previous bullet and counter
1697 ;; if any.
1706 item struct
1709 ;; Alpha counter in alpha list: use counter.
1713 ;; Use cond to be sure `string-match' is used in
1714 ;; both cases.
1720 ;; Num counter in a num list: use counter.
1725 ;; No counter: increase, if needed, previous bullet.
1728 ;; Alpha counter at first item: use counter.
1737 ;; Num counter at first item: use counter.
1742 ;; First bullet is alpha uppercase: use "A".
1745 ;; First bullet is alpha lowercase: use "a".
1748 ;; First bullet is num: use "1".
1751 ;; Not an ordered list: keep bullet.
1756 "Verify and correct indentation in STRUCT.
1758 PARENTS is the alist of parents, as returned by
1759 `org-list-parents-alist'.
1761 If numeric optional argument BULLET-SIZE is set, assume all
1762 bullets in list have this length to determine new indentation.
1764 This function modifies STRUCT."
1771 ;; Indent like parent + length of parent's bullet +
1772 ;; sub-list offset.
1778 org-list-indent-offset))
1779 ;; If no parent, indent like top-point.
1784 "Verify and correct checkboxes in STRUCT.
1786 PARENTS is the alist of parents and PREVS is the alist of
1787 previous items, as returned by, respectively,
1788 `org-list-parents-alist' and `org-list-prevs-alist'.
1790 If ORDERED is non-nil, a checkbox can only be checked when every
1791 checkbox before it is checked too. If there was an attempt to
1792 break this rule, the function will return the blocking item. In
1793 all others cases, the return value will be nil.
1795 This function modifies STRUCT."
1805 item struct
1811 ;; Parent has no boxed child: leave box as-is.
1813 parent-list)
1814 ;; 1. List all parents with a checkbox.
1821 all-items)
1822 ;; 2. Sort those parents by decreasing indentation.
1827 ;; 3. For each parent, get all children's checkboxes to determine
1828 ;; and set its checkbox accordingly.
1830 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1835 ;; There are boxes checked after an unchecked one: fix that.
1842 ;; Verify once again the structure, without ORDERED.
1844 ;; Return blocking item.
1848 "Verify and correct each item end position in STRUCT.
1850 This function modifies STRUCT."
1857 ;; To determine real ind of an ending position that is
1858 ;; not at an item, we have to find the item it belongs
1859 ;; to: it is the last item (ITEM-UP), whose ending is
1860 ;; further than the position we're interested in.
1863 ;; Else part is for the bottom point.
1865 end-pos)
1866 end-list)))
1869 struct)
1874 "Apply set difference between STRUCT and OLD-STRUCT to the buffer.
1876 OLD-STRUCT is the structure before any modifications, and STRUCT
1877 the structure to be applied. The function will only modify parts
1878 of the list which have changed.
1880 Initial position of cursor is restored after the changes."
1887 ;; Shift the indentation between END and BEG by DELTA.
1888 ;; Start from the line before END.
1897 ;; Skip inline tasks.
1900 ;; Shift only non-empty lines.
1906 ;; Replace ITEM first line elements with new elements from
1907 ;; STRUCT, if appropriate.
1917 ;; a. Replace bullet
1920 ;; b. Replace checkbox.
1931 ;; c. Indent item to appropriate column.
1936 ;; 1. First get list of items and position endings. We maintain
1937 ;; two alists: ITM-SHIFT, determining indentation shift needed
1938 ;; at item, and END-LIST, a pseudo-alist where key is ending
1939 ;; position and value point.
1952 ;; To determine real ind of an ending position that
1953 ;; is not at an item, we have to find the item it
1954 ;; belongs to: it is the last item (ITEM-UP), whose
1955 ;; ending is further than the position we're
1956 ;; interested in.
1960 ;; 2. Slice the items into parts that should be shifted by the
1961 ;; same amount of indentation. Each slice follow the pattern
1962 ;; (END BEG DELTA). Slices are returned in reverse order.
1965 #'<)
1973 ;; If we're not at an item, there's a child of the
1974 ;; item point belongs to above. Make sure the less
1975 ;; indented line in this slice has the same column
1976 ;; as that child.
1983 ;; Ignore empty lines. Also ignore blocks and
1984 ;; drawers contents.
1992 down t)))
1995 down t)))))
1999 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
2000 ;; end to beginning. Take a special action when beginning is
2001 ;; at item bullet.
2008 ;; 4. Go back to initial position and clean marker.
2013 "Correct bullets, checkboxes and indentation in list at point.
2015 STRUCT is the list structure. PARENTS is the alist of parents,
2016 as returned by `org-list-parents-alist'.
2018 When non-nil, optional argument OLD-STRUCT is the reference
2019 structure of the list. It should be provided whenever STRUCT
2020 doesn't correspond anymore to the real list in buffer."
2021 ;; Order of functions matters here: checkboxes and endings need
2022 ;; correct indentation to be set, and indentation needs correct
2023 ;; bullets.
2024 ;;
2025 ;; 0. Save a copy of structure before modifications
2027 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
2028 ;; order to get items endings and bullets properly
2030 ;; 2. Fix each item end to get correct prevs alist.
2032 ;; 3. Get bullets right.
2035 ;; 4. Now get real indentation.
2037 ;; 5. Eventually fix checkboxes.
2039 ;; 6. Apply structure modifications to buffer.
2043 \f
2044 ;;; Misc Tools
2047 "Call FUNCTION on each item of the list at point.
2048 FUNCTION must be called with at least one argument: INIT-VALUE,
2049 that will contain the value returned by the function at the
2050 previous item, plus ARGS extra arguments.
2052 FUNCTION is applied on items in reverse order.
2054 As an example, \(org-apply-on-list \(lambda \(result) \(1+ result)) 0)
2055 will return the number of items in the current list.
2057 Sublists of the list are skipped. Cursor is always at the
2058 beginning of the item."
2070 value))
2073 "Set visibility of ITEM in STRUCT to VIEW.
2075 Possible values are: `folded', `children' or `subtree'. See
2076 `org-cycle' for more information."
2080 ;; Hide from eol
2082 item-end t)))
2084 ;; First show everything.
2086 ;; Then fold every child.
2091 children)))
2093 ;; Show everything
2098 "Return column at which body of ITEM should start."
2105 ;; Descriptive list item. Body starts after item's tag, if
2106 ;; possible.
2111 start))
2112 ;; Regular item. Body starts after bullet.
2118 2
2122 \f
2123 ;;; Interactive functions
2128 "Go to the beginning of the current item.
2129 Throw an error when not in a list."
2135 "Go to the beginning item of the current list or sublist.
2136 Throw an error when not in a list."
2147 "Go to the end of the current list or sublist.
2148 Throw an error when not in a list."
2159 "Go to the end of the current item.
2160 Throw an error when not in a list."
2170 "Move to the beginning of the previous item.
2171 Throw an error when not in a list. Also throw an error when at
2172 first item, unless `org-list-use-circular-motion' is non-nil."
2188 "Move to the beginning of the next item.
2189 Throw an error when not in a list. Also throw an error when at
2190 last item, unless `org-list-use-circular-motion' is non-nil."
2206 "Move the item at point down, i.e. swap with following item.
2207 Sub-items (items with larger indentation) are considered part of
2208 the item, so this really moves item trees."
2227 "Move the item at point up, i.e. swap with previous item.
2228 Sub-items (items with larger indentation) are considered part of
2229 the item, so this really moves item trees."
2246 "Insert a new item at the current level.
2247 If cursor is before first character after bullet of the item, the
2248 new item will be created before the current one.
2250 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2252 Return t when things worked, nil when we are not in an item, or
2253 item is invisible."
2257 ;; If cursor isn't is a list or if list is invisible, return nil.
2265 ;; Timer list: delegate to `org-timer-item'.
2270 ;; If we're in a description list, ask for the new term.
2284 t)))))
2287 "Fix indentation, bullets and checkboxes in the list at point."
2295 "Cycle through the different itemize/enumerate bullets.
2296 This cycle the entire list level through the sequence:
2298 `-' -> `+' -> `*' -> `1.' -> `1)'
2300 If WHICH is a valid string, use that as the new bullet. If WHICH
2301 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2302 `previous', cycle backwards."
2322 ;; Compute list of possible bullets, depending on context.
2325 ;; *-bullets are not allowed at column 0.
2327 ;; Description items cannot be numbered.
2350 ;; Use a short variation of `org-list-write-struct' as there's
2351 ;; no need to go through all the steps.
2359 "Toggle the checkbox in the current line.
2361 With prefix argument TOGGLE-PRESENCE, add or remove checkboxes.
2364 When there is an active region, toggle status or presence of the
2365 first checkbox there, and make every item inside have the same
2366 status or presence, respectively.
2368 If point is on a headline, apply this to all checkbox items in
2369 the text below the heading, taking as reference the first item in
2370 subtree, ignoring planning line and any drawer following it."
2374 block-item
2375 lim-up
2376 lim-down
2379 ;; In a region, start at first item in region.
2389 ;; On a heading, start at first item after drawers and
2390 ;; time-stamps (scheduled, etc.).
2397 ;; Just one item: set SINGLEP flag.
2403 ;; Determine the checkbox going to be applied to all items
2404 ;; within bounds.
2415 ;; When an item is found within bounds, grab the full list at
2416 ;; point structure, then: (1) set check-box of all its items
2417 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2418 ;; whole list, (3) move point after the list.
2432 e struct
2433 ;; If there is no box at item, leave as-is
2434 ;; unless function was called with C-u prefix.
2437 ref-checkbox
2438 cur-box))))
2439 items-to-toggle)
2441 struct parents prevs orderedp))
2442 ;; Report some problems due to ORDERED status of subtree.
2443 ;; If only one box was being checked, throw an error, else,
2444 ;; only signal problems.
2448 "Checkbox blocked because of unchecked box at line %d"
2452 "Checkboxes were removed due to unchecked box at line %d"
2461 "Reset all checkboxes in an entry subtree."
2478 "Update the checkbox statistics in the current section.
2480 This will find all statistic cookies like [57%] and [6/12] and
2481 update them with the current numbers.
2483 With optional prefix argument ALL, do this for the whole buffer."
2504 ;; Return number of checked boxes and boxes of all types
2505 ;; in all structures in STRUCTS. If RECURSIVEP is
2506 ;; non-nil, also count boxes in sub-lists. If ITEM is
2507 ;; nil, count across the whole structure, else count only
2508 ;; across subtree whose ancestor is ITEM.
2523 items))))
2526 cookies-list cache)
2527 ;; Move to start.
2531 ;; Build an alist for each cookie found. The key is the position
2532 ;; at beginning of cookie and values ending position, format of
2533 ;; cookie, number of checked boxes to report and total number of
2534 ;; boxes.
2544 context
2546 quote-block special-block verse-block)))
2562 structs)
2567 structs)
2568 ;; Skip whole list since we have its
2569 ;; structure anyway.
2574 end))))))
2575 ;; Cache count for cookies applying to the same
2576 ;; area. Then return it.
2583 structs
2584 recursivep)))
2586 count))))))
2587 cookies-list))))
2588 ;; Apply alist to buffer.
2604 "Select the face for checkbox statistics.
2605 The face will be `org-done' when all relevant boxes are checked.
2606 Otherwise it will be `org-todo'."
2609 'org-checkbox-statistics-done
2613 'org-checkbox-statistics-done
2617 "Update checkbox statistics unless turned off by user.
2618 With an optional argument ALL, update them in the whole buffer."
2626 "Indent a local list item including its children.
2627 When number ARG is a negative, item will be outdented, otherwise
2628 it will be indented.
2630 If a region is active, all items inside will be moved.
2632 If NO-SUBTREE is non-nil, only indent the item itself, not its
2633 children.
2635 STRUCT is the list structure.
2637 Return t if successful."
2645 ;; Are we going to move the whole list?
2653 t))))
2654 ;; Determine begin and end points of zone to indent. If moving
2655 ;; more than one item, save them for subsequent moves.
2671 ;; Special case: moving top-item with indent rule.
2679 ;; Change bullet if necessary.
2685 ;; Shift every item by OFFSET and fix bullets. Then
2686 ;; apply changes to buffer.
2690 struct)
2693 ;; Forbidden move:
2695 ;; If only one item is moved, it mustn't have a child.
2699 ;; If a subtree or region is moved, the last item
2700 ;; of the subtree mustn't have a child.
2705 struct)))))
2708 ;; Normal shifting
2716 t)
2719 "Outdent a local list item, but not its children.
2720 If a region is active, all items inside will be moved."
2736 "Indent a local list item, but not its children.
2737 If a region is active, all items inside will be moved."
2753 "Outdent a local list item including its children.
2754 If a region is active, all items inside will be moved."
2770 "Indent a local list item including its children.
2771 If a region is active, all items inside will be moved."
2789 "Cycle levels of indentation of an empty item.
2790 The first run indents the item, if applicable. Subsequent runs
2791 outdent it at meaningful levels in the list. When done, item is
2792 put back at its original position with its original bullet.
2794 Return t at each successful move."
2800 ;; Accept empty items or if cycle has already started.
2811 ;; When in the middle of the cycle, try to outdent first. If
2812 ;; it fails, and point is still at initial position, indent.
2813 ;; Else, re-create it at its original position.
2822 ;; Break cycle
2824 ;; If a cycle is starting, remember indentation and bullet,
2825 ;; then try to indent. If it fails, try to outdent.
2831 t))))
2835 "Sort list items.
2836 The cursor may be at any item of the list that should be sorted.
2837 Sublists are not sorted. Checkboxes, if any, are ignored.
2839 Sorting can be alphabetically, numerically, by date/time as given
2840 by a time stamp, by a property or by priority.
2842 Comparing entries ignores case by default. However, with an
2843 optional argument WITH-CASE, the sorting considers case as well.
2845 The command prompts for the sorting type unless it has been given
2846 to the function through the SORTING-TYPE argument, which needs to
2847 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F ?x ?X). Here is the
2848 detailed meaning of each character:
2850 n Numerically, by converting the beginning of the item to a number.
2851 a Alphabetically. Only the first line of item is checked.
2852 t By date/time, either the first active time stamp in the entry, if
2853 any, or by the first inactive one. In a timer list, sort the timers.
2856 Capital letters will reverse the sort order.
2858 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2859 a function to be called with point at the beginning of the
2860 record. It must return a value that is compatible with COMPARE-FUNC,
2861 the function used to compare entries.
2863 Sorting is done against the visible part of the headlines, it
2864 ignores hidden links.
2866 A non-nil value for INTERACTIVE? is used to signal that this
2867 function is being called interactively."
2926 ;; If it is a timer list, convert timer to seconds
2943 value))
2947 next-record
2948 end-record
2949 value-to-sort
2950 nil
2951 sort-func)
2952 ;; Read and fix list again, as `sort-subr' probably destroyed
2953 ;; its structure.
2959 "Convert headings or normal lines to items, items to normal lines.
2960 If there is no active region, only the current line is considered.
2962 If the first non blank line in the region is a headline, convert
2963 all headlines to items, shifting text accordingly.
2965 If it is an item, convert all items to normal lines.
2967 If it is normal text, change region into a list of items.
2968 With a prefix argument ARG, change the region in a single item."
2972 ;; Shift text in current section to IND, from point to END.
2973 ;; The function leaves point to END line.
2975 ;; First determine the minimum indentation (MIN-I) of
2976 ;; the text.
2982 ;; Skip blank lines and inline tasks.
2985 ;; We can't find less than 0 indentation.
2989 ;; Then indent each line so that a line indented to
2990 ;; MIN-I becomes indented to IND. Ignore blank lines
2991 ;; and inline tasks in the process.
3000 ;; Return beginning of first non-blank line, starting from
3001 ;; line at POS.
3006 beg end)
3007 ;; Determine boundaries of changes.
3013 ;; Depending on the starting line, choose an action on the text
3014 ;; between BEG and END.
3019 ;; Case 1. Start at an item: de-itemize. Note that it only
3020 ;; happens when a region is active: `org-ctrl-c-minus'
3021 ;; would call `org-cycle-list-bullet' otherwise.
3028 ;; Case 2. Start at an heading: convert to items.
3032 ;; Indentation of the first heading. It should be
3033 ;; relative to the indentation of its parent, if any.
3039 ;; Level of first heading. Further headings will be
3040 ;; compared to it to determine hierarchy in the list.
3046 ;; If current headline is less indented than the first
3047 ;; one, set it as reference, in order to preserve
3048 ;; subtrees.
3050 ;; Remove stars and TODO keyword.
3056 ;; Turn TODO keyword into a check box.
3062 struct
3064 "[X]"
3068 old)))
3069 ;; Ensure all text down to END (or SECTION-END) belongs
3070 ;; to the newly created item.
3077 ;; Case 3. Normal line with ARG: make the first line of region
3078 ;; an item, and shift indentation of others lines to
3079 ;; set them as item's body.
3087 ;; Ensure that lines less indented than first one
3088 ;; still get included in item body.
3094 ;; Case 4. Normal line without ARG: turn each non-item line
3095 ;; into an item.
3104 \f
3105 ;;; Send and receive lists
3108 "Parse the list at point and maybe DELETE it.
3110 Return a list whose car is a symbol of list type, among
3111 `ordered', `unordered' and `descriptive'. Then, each item is
3112 a list of strings and other sub-lists.
3114 For example, the following list:
3116 1. first item
3117 + sub-item one
3118 + [X] sub-item two
3119 more text in first item
3120 2. [@3] last item
3122 is parsed as
3124 (ordered
3126 (unordered
3132 Point is left at list's end."
3140 ;; Remove indentation and final newline from TEXT.
3144 text))))
3147 ;; Return a list whose car is list type and cdr a list
3148 ;; of items' body.
3153 ;; Return a list containing counter of item, if any,
3154 ;; text and any sublist inside it.
3163 trim
3173 ;; Remove whole sub-list from children.
3175 ;; There is a chunk of text belonging to the item
3176 ;; if last child doesn't end where next child
3177 ;; starts or where item ends.
3182 trim
3184 body)))))
3186 ;; Store output, take care of cursor position and deletion of
3187 ;; list, then return output.
3196 "Convert the plain list at point into a subtree."
3204 "Insert a radio list template appropriate for this major mode."
3208 name pos)
3219 "Send a transformed version of this list to the receiver position.
3220 With argument MAYBE, fail quietly if no transformation is defined
3221 for this list."
3250 ;; Find the insertion(s) place(s).
3255 name))
3257 name)))
3274 "Convert a LIST parsed through `org-list-to-lisp' to a custom format.
3276 LIST is a list as returned by `org-list-to-lisp', which see.
3277 PARAMS is a property list of parameters used to tweak the output
3278 format.
3280 Valid parameters are:
3282 :backend, :raw
3284 Export back-end used as a basis to transcode elements of the
3285 list, when no specific parameter applies to it. It is also
3286 used to translate its contents. You can prevent this by
3287 setting :raw property to a non-nil value.
3289 :splice
3291 When non-nil, only export the contents of the top most plain
3292 list, effectively ignoring its opening and closing lines.
3294 :ustart, :uend
3296 Strings to start and end an unordered list. They can also be
3297 set to a function returning a string or nil, which will be
3298 called with the depth of the list, counting from 1.
3300 :ostart, :oend
3302 Strings to start and end an ordered list. They can also be set
3303 to a function returning a string or nil, which will be called
3304 with the depth of the list, counting from 1.
3306 :dstart, :dend
3308 Strings to start and end a descriptive list. They can also be
3309 set to a function returning a string or nil, which will be
3310 called with the depth of the list, counting from 1.
3312 :dtstart, :dtend, :ddstart, :ddend
3314 Strings to start and end a descriptive term.
3316 :istart, :iend
3318 Strings to start or end a list item, and to start a list item
3319 with a counter. They can also be set to a function returning
3320 a string or nil, which will be called with two arguments: the
3321 type of list and the depth of the item, counting from 1.
3323 :icount
3325 Strings to start a list item with a counter. It can also be
3326 set to a function returning a string or nil, which will be
3327 called with three arguments: the type of list, the depth of the
3328 item, counting from 1, and the counter. Its value, when
3329 non-nil, has precedence over `:istart'.
3331 :isep
3333 String used to separate items. It can also be set to
3334 a function returning a string or nil, which will be called with
3335 two arguments: the type of list and the depth of the item,
3336 counting from 1. It always start on a new line.
3338 :ifmt
3340 Function to be applied to the contents of every item. It is
3341 called with two arguments: the type of list and the contents.
3343 :cbon, :cboff, :cbtrans
3345 String to insert, respectively, an un-checked check-box,
3346 a checked check-box and a check-box in transitional state."
3352 :transcoders
3356 data info)
3357 ;; Write LIST back into Org syntax and parse it.
3387 ;; When`:raw' property has a non-nil value, turn all objects back
3388 ;; into Org syntax.
3394 ;; We use a low-level mechanism to export DATA so as to skip all
3395 ;; usual pre-processing and post-processing, i.e., hooks, filters,
3396 ;; Babel code evaluation, include keywords and macro expansion,
3397 ;; and filters.
3399 ;; Remove final newline.
3403 "Return the level of ELEMENT within current plain list.
3404 ELEMENT is either an item or a plain list."
3409 "Return the number of trailing newlines in STRING."
3416 "Evaluate VALUE according to its type.
3417 VALUE is either nil, a string or a function. In the latter case,
3418 it is called with arguments ARGS."
3425 "Return a transcoder for `plain-list' elements.
3426 PARAMS is a plist used to tweak the behavior of the transcoder."
3444 depth)))
3451 depth))))
3452 ;; Make sure trailing newlines in END appear in the output by
3453 ;; setting `:post-blank' property to their number.
3457 ;; Build output.
3460 contents
3462 end)))))
3465 "Return a transcoder for `item' elements.
3466 PARAMS is a plist used to tweak the behavior of the transcoder."
3492 ;; When a closing line or a separator is provided, make sure
3493 ;; its trailing newlines are taken into account when building
3494 ;; output. This is done by setting `:post-blank' property to
3495 ;; the number of such lines in the last line to be added.
3499 item
3500 :post-blank
3502 ;; Build output.
3520 tag backend info)
3522 dtend))
3528 contents))
3531 ;; Remove final newline.
3534 closing
3535 separator)))))
3538 "Convert LIST into a LaTeX list.
3539 LIST is a parsed plain list, as returned by `org-list-to-lisp'.
3540 PARAMS is a property list with overruling parameters for
3541 `org-list-to-generic'. Return converted list as a string."
3546 "Convert LIST into a HTML list.
3547 LIST is a parsed plain list, as returned by `org-list-to-lisp'.
3548 PARAMS is a property list with overruling parameters for
3549 `org-list-to-generic'. Return converted list as a string."
3554 "Convert LIST into a Texinfo list.
3555 LIST is a parsed plain list, as returned by `org-list-to-lisp'.
3556 PARAMS is a property list with overruling parameters for
3557 `org-list-to-generic'. Return converted list as a string."
3562 "Convert LIST into an Org plain list.
3563 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3564 with overruling parameters for `org-list-to-generic'."
3571 :icount make-item
3581 "Convert LIST into an Org subtree.
3582 LIST is as returned by `org-list-to-lisp'. PARAMS is a property
3583 list with overruling parameters for `org-list-to-generic'."
3592 ;; Return the string for the heading, depending on DEPTH
3593 ;; of current sub-list.
3597 oddeven-level)
3598 ?*)
3601 list
3604 :istart make-stars
3605 :icount make-stars
3609 params))))
3613 ;;; org-list.el ends here