| blob | 88fcc6e96d1bb6b0aa335d7e30cb16467e37bac7 |
1 ;;; org-list.el --- Plain lists for Org -*- lexical-binding: t; -*-
2 ;;
3 ;; Copyright (C) 2004-2019 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:
111 (declare-function org-element-map "org-element" (data types fun &optional info first-match no-recursion with-affiliated))
149 \f
150 ;;; Configuration variables
153 "Options concerning plain lists in Org mode."
158 "When t, make TAB cycle visibility on plain list items.
159 Cycling plain lists works only when the cursor is on a plain list
160 item. When the cursor is on an outline heading, plain lists are
161 treated as text. This is the most stable way of handling this,
162 which is why it is the default.
164 When this is the symbol `integrate', then integrate plain list
165 items when cycling, as if they were children of outline headings.
167 This setting can lead to strange effects when switching visibility
170 plain list item with an implied large level number, all true
171 children and grand children of the outline heading will be
172 exposed in a children' view."
181 "Default bullet type installed when demoting an item.
182 This is an association list, for each bullet type, this alist will point
183 to the bullet that should be used when this item is demoted.
184 For example,
186 (setq org-list-demote-modify-bullet
189 will make
191 + Movies
192 + Silence of the Lambs
193 + My Cousin Vinny
194 + Books
195 + The Hunt for Red October
196 + The Road to Omaha
198 into
200 + Movies
201 - Silence of the Lambs
202 - My Cousin Vinny
203 + Books
204 - The Hunt for Red October
205 - The Road to Omaha"
223 "The character that makes a line with leading number an ordered list item.
224 Valid values are ?. and ?\). To get both terminators, use t.
226 This variable needs to be set before org.el is loaded. If you
227 need to make a change while Emacs is running, use the customize
228 interface or run the following code after updating it:
239 "Non-nil means single character alphabetical bullets are allowed.
241 Both uppercase and lowercase are handled. Lists with more than
242 26 items will fallback to standard numbering. Alphabetical
245 This variable needs to be set before org.el is loaded. If you
246 need to make a change while Emacs is running, use the customize
247 interface or run the following code after updating it:
257 "A regular expression matching bullets that should have 2 spaces after them.
258 When nil, no bullet will have two spaces after them. When
259 a string, it will be used as a regular expression. When the
260 bullet type of a list is changed, the new bullet type will be
261 matched against this regexp. If it matches, there will be two
262 spaces instead of one after the bullet in each item of the list."
270 "Non-nil means apply set of rules when acting on lists.
272 By default, automatic actions are taken when using
282 You can disable individually these rules by setting them to nil.
283 Valid rules are:
285 checkbox when non-nil, checkbox statistics is updated each time
286 you either insert a new checkbox or toggle a checkbox.
287 indent when non-nil, indenting or outdenting list top-item
288 with its subtree will move the whole list and
289 outdenting a list whose bullet is * to column 0 will
294 :key-type
298 :value-type
302 "Non-nil means commands implying motion in lists should be cyclic.
304 In that case, the item following the last item is the first one,
305 and the item preceding the first item is the last one.
307 This affects the behavior of
317 "Hook that is run whenever Org thinks checkbox statistics should be updated.
318 This hook runs even if checkbox rule in
319 `org-list-automatic-rules' does not apply, so it can be used to
320 implement alternative ways of collecting statistics
324 "Non-nil means checkbox statistics counts only the state of direct children.
325 When nil, all boxes below the cookie are counted.
326 This can be set to nil on a per-node basis using a COOKIE_DATA property
332 "Additional indentation for sub-items in a list.
333 By setting this to a small number, usually 1 or 2, one can more
334 clearly distinguish sub-items in a list."
340 "Names of blocks where lists are not allowed.
343 \f
344 ;;; Predicates and regexps
354 "Matches a list item and puts everything into groups:
355 group 1: bullet
356 group 2: counter
357 group 3: checkbox
361 "Return the correct regular expression for plain lists."
372 "Regexp matching the beginning of a plain list item."
376 "Is point at a list item with REGEXP after bullet?"
385 ;; Ignore counter if any
390 "Is point in a context where lists are allowed?"
394 "Return item beginning position when in a plain list, nil otherwise."
403 ;; Indentation isn't meaningful when point starts at an empty
404 ;; line or an inline task.
407 10000
413 ;; Detect if cursor in amidst `org-list-end-re'. First, count
414 ;; number HL of hard lines it takes, then call `org-in-regexp'
415 ;; to compute its boundaries END-BOUNDS. When point is
416 ;; in-between, move cursor before regexp beginning.
427 ;; Look for an item, less indented that reference line.
432 ;; This is exactly what we want.
435 ;; At upper bound of search or looking at the end of a
436 ;; previous list: search is over.
439 ;; Skip blocks, drawers, inline-tasks, blank lines
449 ;; Text at column 0 cannot belong to a list: stop.
451 ;; Normal text less indented than reference line, take
452 ;; it as new reference.
459 "Is point in a line starting a hand-formatted item?"
465 "Is point at the bullet of a plain list item?"
471 "Is point at a line starting a plain list item with a timer?"
476 "Is point at a description list item?"
480 "Is point at a line starting a plain-list item with a checklet?"
484 "Is point at a line starting a plain-list item with a counter?"
490 \f
491 ;;; Structures and helper functions
494 "Determine context, and its boundaries, around point.
496 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
497 are boundaries and CONTEXT is a symbol among `drawer', `block',
498 `invalid', `inlinetask' and nil.
500 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
506 ;; Get positions of surrounding headings. This is the
507 ;; default context.
512 ;; Is point inside a drawer?
522 lim-down))
525 ;; Is point strictly in a block, and of which type?
536 lim-down))
542 ;; Is point in an inlinetask?
555 ;; Return context boundaries and type.
559 "Return structure of list at point.
561 A list structure is an alist where key is point at item, and
562 values are:
563 1. indentation,
564 2. bullet with trailing whitespace,
565 3. bullet counter, if any,
566 4. checkbox, if any,
567 5. description tag, if any,
568 6. position at item end.
570 Thus the following list, where numbers in parens are
571 point-at-bol:
573 - [X] first item (1)
574 1. sub-item 1 (18)
575 5. [@5] sub-item 2 (34)
576 some other text belonging to first item (55)
577 - last item (97)
578 + tag :: description (109)
579 (131)
581 will get the following structure:
589 Assume point is at an item."
601 itm-lst itm-lst-2 end-lst end-lst-2 struct
604 ;; Return association at point.
609 ind
610 bullet
613 ;; Description tag.
618 ;; Ensure list ends at the first blank line.
622 ;; 1. Read list from starting item to its beginning, and save
623 ;; top item position and indentation in BEG-CELL. Also store
624 ;; ending position of items in END-LST.
631 ;; At upward limit: if we ended at an item, store it,
632 ;; else dismiss useless data recorded above BEG-CELL.
633 ;; Jump to part 2.
640 ;; Looking at a list ending regexp. Dismiss useless
641 ;; data recorded above BEG-CELL. Jump to part 2.
646 ;; Point is at an item. Add data to ITM-LST. It may
647 ;; also end a previous item: save it in END-LST. If
648 ;; ind is less or equal than BEG-CELL and there is no
649 ;; end at this ind or lesser, this item becomes the new
650 ;; BEG-CELL.
656 ;; Skip blocks, drawers, inline tasks, blank lines.
667 ;; From there, point is not at an item. Interpret
668 ;; line's indentation:
669 ;; - text at column 0 is necessarily out of any list.
670 ;; Dismiss data recorded above BEG-CELL. Jump to
671 ;; part 2.
672 ;; - any other case may be an ending position for an
673 ;; hypothetical item above. Store it and proceed.
682 ;; 2. Read list from starting point to its end, that is until we
683 ;; get out of context, or that a non-item line is less or
684 ;; equally indented than BEG-CELL's cdr. Also, store ending
685 ;; position of items in END-LST-2.
691 ;; At downward limit: this is de facto the end of the
692 ;; list. Save point as an ending position, and jump to
693 ;; part 3.
696 ;; Looking at a list ending regexp. Save point as an
697 ;; ending position and jump to part 3.
701 ;; Point is at an item. Add data to ITM-LST-2. It may
702 ;; also end a previous item, so save it in END-LST-2.
706 ;; Skip inline tasks and blank lines along the way
711 ;; Ind is lesser or equal than BEG-CELL's. The list is
712 ;; over: store point as an ending position and jump to
713 ;; part 3.
717 ;; Else, if ind is lesser or equal than previous item's,
718 ;; this is an ending position: store it. In any case,
719 ;; skip block or drawer at point, and move to next line.
731 ;; 3. Associate each item to its end position.
733 ;; 4. Return STRUCT
734 struct)))
737 "Associate proper ending point to items in STRUCT.
739 END-LIST is a pseudo-alist where car is indentation and cdr is
740 ending position.
742 This function modifies STRUCT."
748 ;; Remove end candidates behind current item.
751 ;; Add end position to item assoc.
757 struct)))
760 "Return alist between item and previous item in STRUCT."
762 struct)))
766 struct)))
769 "Return alist between item and parent in STRUCT."
781 ;; A sub-list is over. Find the associated
782 ;; origin in IND-TO-ORI. If it cannot be
783 ;; found (ill-formed list), set its parent as
784 ;; the first item less indented. If there is
785 ;; none, make it a top-level item.
793 ind-to-ori)
796 ;; A sub-list starts. Every item at IND will
797 ;; have previous item as its parent.
802 ;; Another item in the same sub-list: it shares
803 ;; the same parent as the previous item.
808 "Delete metadata from the heading at point.
809 Metadata are tags, planning information and properties drawers."
819 \f
820 ;;; Accessors
823 "Return the Nth value of KEY in STRUCT."
827 "Set the Nth value of KEY in STRUCT to NEW.
832 "Return indentation of ITEM in STRUCT."
836 "Set indentation of ITEM in STRUCT to IND.
841 "Return bullet of ITEM in STRUCT."
845 "Set bullet of ITEM in STRUCT to BULLET.
850 "Return counter of ITEM in STRUCT."
854 "Return checkbox of ITEM in STRUCT or nil."
858 "Set checkbox of ITEM in STRUCT to CHECKBOX.
863 "Return end position of ITEM in STRUCT."
867 "Return end position of ITEM in STRUCT."
871 "Return point at end of ITEM in STRUCT, before any blank line.
872 Point returned is at end of line."
879 "Return parent of ITEM or nil.
880 STRUCT is the list structure. PARENTS is the alist of parents,
881 as returned by `org-list-parents-alist'."
886 "Non-nil if ITEM has a child.
888 STRUCT is the list structure.
890 Value returned is the position of the first child of ITEM."
895 child-maybe)))
898 "Return next item in same sub-list as ITEM, or nil.
899 STRUCT is the list structure. PREVS is the alist of previous
900 items, as returned by `org-list-prevs-alist'."
904 "Return previous item in same sub-list as ITEM, or nil.
905 STRUCT is the list structure. PREVS is the alist of previous
906 items, as returned by `org-list-prevs-alist'."
910 "List all items having ITEM as a common ancestor, or nil.
911 STRUCT is the list structure."
914 subtree)
919 sub-struct))
923 "List all items in the same sub-list as ITEM.
924 STRUCT is the list structure. PREVS is the alist of previous
925 items, as returned by `org-list-prevs-alist'."
928 before-item after-item)
936 "List all children of ITEM, or nil.
937 STRUCT is the list structure. PARENTS is the alist of parents,
938 as returned by `org-list-parents-alist'."
946 "Return point at beginning of list.
947 STRUCT is the list structure."
951 "Return point at bottom of list.
952 STRUCT is the list structure."
957 "Return point at beginning of sub-list ITEM belongs.
958 STRUCT is the list structure. PREVS is the alist of previous
959 items, as returned by `org-list-prevs-alist'."
963 first-item))
968 "Return point at last item of sub-list ITEM belongs.
969 STRUCT is the list structure. PREVS is the alist of previous
970 items, as returned by `org-list-prevs-alist'."
974 last-item))
977 "Return point at end of sub-list ITEM belongs.
978 STRUCT is the list structure. PREVS is the alist of previous
979 items, as returned by `org-list-prevs-alist'."
983 "Return the type of the list containing ITEM, as a symbol.
985 STRUCT is the list structure. PREVS is the alist of previous
986 items, as returned by `org-list-prevs-alist'.
988 Possible types are `descriptive', `ordered' and `unordered'. The
989 type is determined by the first item of the list."
997 "Return ITEM's sequence number.
999 STRUCT is the list structure. PREVS is the alist of previous
1000 items, as returned by `org-list-prevs-alist'. PARENTS is the
1001 alist of ancestors, as returned by `org-list-parents-alist'.
1003 Return value is a list of integers. Counters have an impact on
1004 that value."
1008 ;; Return relative sequence number of ITEM in the sub-list
1009 ;; it belongs. STRUCT is the list structure. PREVS is
1010 ;; the alist of previous items.
1019 seq))
1023 ;; Cons each parent relative number into return value (OUT).
1028 ;; Return value.
1029 out)))
1032 \f
1033 ;;; Searching
1036 "Search a string in valid contexts for lists.
1037 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1038 in `re-search-forward'."
1042 ;; 1. No match: return to origin or bound, depending on NOERR.
1045 nil)))
1046 ;; 2. Match in valid context: return point. Else, continue
1047 ;; searching.
1051 "Like `re-search-backward' but stop only where lists are recognized.
1052 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1053 `re-search-backward'."
1058 "Like `re-search-forward' but stop only where lists are recognized.
1059 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1060 `re-search-forward'."
1065 \f
1066 ;;; Methods on structures
1069 "Return BULLET with the correct number of whitespaces.
1070 It determines the number of whitespaces to append by looking at
1071 `org-list-two-spaces-after-bullet-regexp'."
1075 org-list-two-spaces-after-bullet-regexp bullet))
1076 " "
1080 bullet))))
1083 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1085 Blank lines at the end of items are left in place. Item
1086 visibility is preserved. Return the new structure after the
1087 changes.
1089 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1090 to the same sub-list.
1092 This function modifies STRUCT."
1105 ;; Store overlays responsible for visibility status. We
1106 ;; also need to store their boundaries as they will be
1107 ;; removed from buffer.
1122 ;; 1. Move effectively items in buffer.
1126 ;; 2. Now modify struct. No need to re-read the list, the
1127 ;; transformation is just a shift of positions. Some special
1128 ;; attention is required for items ending at END-A and END-B
1129 ;; as empty spaces are not moved there. In others words,
1130 ;; item BEG-A will end with whitespaces that were at the end
1131 ;; of BEG-B and the same applies to BEG-B.
1154 ;; Restore visibility status, by moving overlays to their new
1155 ;; position.
1165 ;; Return structure.
1166 struct)))
1169 "Return number of blank lines that should separate items in list.
1171 POS is the position of point where `org-list-insert-item' was called.
1173 STRUCT is the list structure. PREVS is the alist of previous
1174 items, as returned by `org-list-prevs-alist'.
1176 Assume point is at item's beginning. If the item is alone, apply
1177 some heuristics to guess the result."
1182 usr-blank
1186 ;; Count blank lines above beginning of line.
1193 ;; Trivial cases where there should be none.
1195 ;; When `org-blank-before-new-entry' says so, it is 1.
1197 ;; `plain-list-item' is 'auto. Count blank lines separating
1198 ;; neighbors' items in list.
1201 ;; Is there a next item?
1204 ;; Is there a previous item?
1207 ;; User inserted blank lines, trust him.
1212 usr-blank)
1213 ;; Are there blank lines inside the list so far?
1216 ;; Do not use `org-list-search-forward' so blank lines
1217 ;; in blocks can be counted in.
1221 ;; Default choice: no blank line.
1225 "Insert a new list item at POS and return the new structure.
1226 If POS is before first character after bullet of the item, the
1227 new item will be created before the current one.
1229 STRUCT is the list structure. PREVS is the alist of previous
1230 items, as returned by `org-list-prevs-alist'.
1232 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1233 after the bullet. Cursor will be after this text once the
1234 function ends.
1236 This function modifies STRUCT."
1238 ;; 1. Get information about list: ITEM containing POS, position of
1239 ;; point with regards to item start (BEFOREP), blank lines
1240 ;; number separating items (BLANK-NB), if we're allowed to
1241 ;; (SPLIT-LINE-P).
1249 inner-item))))
1255 (<= pos
1258 ;; Ignore tag in a non-descriptive list.
1267 pos struct prevs))
1268 ;; 2. Build the new item to be created. Concatenate same
1269 ;; bullet as item, checkbox, text AFTER-BULLET if
1270 ;; provided, and text cut from point to end of item
1271 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1272 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1273 ;; between what was cut and what was inserted in buffer
1274 ;; is stored in SIZE-OFFSET.
1278 ind))
1285 ;; If POS is greater than ITEM-END, then point is
1286 ;; in some white lines after the end of the list.
1287 ;; Those must be removed, or they will be left,
1288 ;; stacking up after the list.
1298 text-cut))))
1302 ;; 4. Insert effectively item into buffer.
1306 ;; 5. Add new item to STRUCT.
1310 ;; Before inserted item, positions don't change but
1311 ;; an item ending after insertion has its end shifted
1312 ;; by SIZE-OFFSET.
1315 ;; Trivial cases where current item isn't split in
1316 ;; two. Just shift every item after new one by
1317 ;; ITEM-SIZE.
1321 ;; Item is split in two: elements before POS are just
1322 ;; shifted by ITEM-SIZE. In the case item would end
1323 ;; after split POS, ending is only shifted by
1324 ;; SIZE-OFFSET.
1330 ;; Elements after POS are moved into new item.
1331 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1332 ;; doesn't appear in buffer yet.
1338 (+ end size-offset
1340 ;; Elements at ITEM-END or after are only shifted by
1341 ;; SIZE-OFFSET.
1344 struct)
1347 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1348 ;; exchange ITEM with the next item in list. Position cursor
1349 ;; after bullet, counter, checkbox, and label.
1355 struct)))
1358 "Remove ITEM from the list and return the new structure.
1360 STRUCT is the list structure."
1363 ;; If ITEM ends with the list, delete blank lines
1364 ;; before it.
1369 item)))
1370 ;; Remove item from buffer.
1372 ;; Remove item from structure and shift others items accordingly.
1373 ;; Don't forget to shift also ending position when appropriate.
1391 struct)))))
1394 "Send ITEM to destination DEST.
1396 STRUCT is the list structure.
1398 DEST can have various values.
1400 If DEST is a buffer position, the function will assume it points
1401 to another item in the same list as ITEM, and will move the
1402 latter just before the former.
1404 If DEST is `begin' (respectively `end'), ITEM will be moved at
1405 the beginning (respectively end) of the list it belongs to.
1408 be moved at the Nth position in the list.
1410 If DEST is `kill', ITEM will be deleted and its body will be
1411 added to the kill-ring.
1413 If DEST is `delete', ITEM will be deleted.
1415 Visibility of item is preserved.
1417 This function returns, destructively, the new list structure."
1420 ;; Grab full item body minus its bullet.
1429 item-end)))
1430 ;; Change DEST into a buffer position. A trick is needed
1431 ;; when ITEM is meant to be sent at the end of the list.
1432 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1433 ;; nil and insertion point (INS-POINT) to the first line's
1434 ;; end of the last item, we ensure the new item will be
1435 ;; inserted after the last item, and not after any of its
1436 ;; hypothetical sub-items.
1452 ;; Send ITEM at the end of the list.
1460 ;; Store inner overlays (to preserve visibility).
1472 ;; 1. Structure returned by `org-list-insert-item' may not be
1473 ;; accurate, as it cannot see sub-items included in BODY.
1474 ;; Thus, first compute the real structure so far.
1482 ;; 1.1. Remove the item just created in structure.
1484 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1487 struct
1495 new-end
1497 moved-items))
1499 ;; 2. Restore inner overlays.
1504 ;; 3. Eventually delete extra copy of the item and clean marker.
1510 "Outdent items between positions START and END.
1512 STRUCT is the list structure. PARENTS is the alist of items'
1513 parents, as returned by `org-list-parents-alist'.
1515 START is included, END excluded."
1521 ;; Item not yet in zone: keep association.
1523 ;; Item out of zone: follow associations in ACC.
1527 ;; Item has no parent: error
1530 ;; Parent is outdented: keep association.
1534 ;; Parent isn't outdented: reparent to grand-parent.
1536 parent struct parents)))
1542 "Indent items between positions START and END.
1544 STRUCT is the list structure. PARENTS is the alist of parents
1545 and PREVS is the alist of previous items, returned by,
1546 respectively, `org-list-parents-alist' and
1547 `org-list-prevs-alist'.
1549 START is included and END excluded.
1551 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1552 bullets between START and END."
1560 ;; Normalize ordered bullets.
1570 org-list-demote-modify-bullet))))
1577 ;; Item not yet in zone: keep association.
1580 ;; Item out of zone: follow associations in ACC.
1584 ;; Item is in zone...
1586 ;; Check if bullet needs to be changed.
1589 ;; First item indented but not parent: error
1592 ;; First item and parent indented: keep same
1593 ;; parent.
1595 ;; Previous item not indented: reparent to it.
1597 ;; Previous item indented: reparent like it.
1604 \f
1605 ;;; Repairing structures
1608 "Non-nil if list starting at FIRST can have alphabetical bullets.
1610 STRUCT is list structure. PREVS is the alist of previous items,
1611 as returned by `org-list-prevs-alist'."
1615 ;; Pretend that bullets are uppercase and check if alphabet
1616 ;; is sufficient, taking counters into account.
1619 ;; Virtually determine current bullet
1621 ;; Counters are not case-sensitive.
1624 ;; Test if bullet would be over z or Z.
1628 ;; All items checked. All good.
1629 t))))
1632 "Increment BULLET if applicable."
1635 ;; Num bullet: increment it.
1639 nil nil bullet))
1640 ;; Alpha bullet: increment it.
1644 nil nil bullet))
1645 ;; Unordered bullet: leave it.
1649 "Verify and correct bullets in STRUCT.
1650 PREVS is the alist of previous items, as returned by
1651 `org-list-prevs-alist'.
1653 This function modifies STRUCT."
1657 ;; Set bullet of ITEM in STRUCT, depending on the type of
1658 ;; first item of the list, the previous bullet and counter
1659 ;; if any.
1668 item struct
1671 ;; Alpha counter in alpha list: use counter.
1675 ;; Use cond to be sure `string-match' is used in
1676 ;; both cases.
1682 ;; Num counter in a num list: use counter.
1687 ;; No counter: increase, if needed, previous bullet.
1690 ;; Alpha counter at first item: use counter.
1699 ;; Num counter at first item: use counter.
1704 ;; First bullet is alpha uppercase: use "A".
1707 ;; First bullet is alpha lowercase: use "a".
1710 ;; First bullet is num: use "1".
1713 ;; Not an ordered list: keep bullet.
1718 "Verify and correct indentation in STRUCT.
1720 PARENTS is the alist of parents, as returned by
1721 `org-list-parents-alist'.
1723 If numeric optional argument BULLET-SIZE is set, assume all
1724 bullets in list have this length to determine new indentation.
1726 This function modifies STRUCT."
1733 ;; Indent like parent + length of parent's bullet +
1734 ;; sub-list offset.
1740 org-list-indent-offset))
1741 ;; If no parent, indent like top-point.
1746 "Verify and correct checkboxes in STRUCT.
1748 PARENTS is the alist of parents and PREVS is the alist of
1749 previous items, as returned by, respectively,
1750 `org-list-parents-alist' and `org-list-prevs-alist'.
1752 If ORDERED is non-nil, a checkbox can only be checked when every
1753 checkbox before it is checked too. If there was an attempt to
1754 break this rule, the function will return the blocking item. In
1755 all others cases, the return value will be nil.
1757 This function modifies STRUCT."
1767 item struct
1773 ;; Parent has no boxed child: leave box as-is.
1775 parent-list)
1776 ;; 1. List all parents with a checkbox.
1783 all-items)
1784 ;; 2. Sort those parents by decreasing indentation.
1789 ;; 3. For each parent, get all children's checkboxes to determine
1790 ;; and set its checkbox accordingly.
1792 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1797 ;; There are boxes checked after an unchecked one: fix that.
1804 ;; Verify once again the structure, without ORDERED.
1806 ;; Return blocking item.
1810 "Verify and correct each item end position in STRUCT.
1812 This function modifies STRUCT."
1819 ;; To determine real ind of an ending position that is
1820 ;; not at an item, we have to find the item it belongs
1821 ;; to: it is the last item (ITEM-UP), whose ending is
1822 ;; further than the position we're interested in.
1825 ;; Else part is for the bottom point.
1827 end-pos)
1828 end-list)))
1831 struct)
1836 "Apply set difference between STRUCT and OLD-STRUCT to the buffer.
1838 OLD-STRUCT is the structure before any modifications, and STRUCT
1839 the structure to be applied. The function will only modify parts
1840 of the list which have changed.
1842 Initial position of cursor is restored after the changes."
1849 ;; Shift the indentation between END and BEG by DELTA.
1850 ;; Start from the line before END.
1859 ;; Skip inline tasks.
1862 ;; Shift only non-empty lines.
1868 ;; Replace ITEM first line elements with new elements from
1869 ;; STRUCT, if appropriate.
1879 ;; a. Replace bullet
1882 ;; b. Replace checkbox.
1893 ;; c. Indent item to appropriate column.
1898 ;; 1. First get list of items and position endings. We maintain
1899 ;; two alists: ITM-SHIFT, determining indentation shift needed
1900 ;; at item, and END-LIST, a pseudo-alist where key is ending
1901 ;; position and value point.
1914 ;; To determine real ind of an ending position that
1915 ;; is not at an item, we have to find the item it
1916 ;; belongs to: it is the last item (ITEM-UP), whose
1917 ;; ending is further than the position we're
1918 ;; interested in.
1922 ;; 2. Slice the items into parts that should be shifted by the
1923 ;; same amount of indentation. Each slice follow the pattern
1924 ;; (END BEG DELTA). Slices are returned in reverse order.
1927 #'<)
1935 ;; If we're not at an item, there's a child of the
1936 ;; item point belongs to above. Make sure the less
1937 ;; indented line in this slice has the same column
1938 ;; as that child.
1945 ;; Ignore empty lines. Also ignore blocks and
1946 ;; drawers contents.
1954 down t)))
1957 down t)))))
1961 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1962 ;; end to beginning. Take a special action when beginning is
1963 ;; at item bullet.
1970 ;; 4. Go back to initial position and clean marker.
1975 "Correct bullets, checkboxes and indentation in list at point.
1977 STRUCT is the list structure. PARENTS is the alist of parents,
1978 as returned by `org-list-parents-alist'.
1980 When non-nil, optional argument OLD-STRUCT is the reference
1981 structure of the list. It should be provided whenever STRUCT
1982 doesn't correspond anymore to the real list in buffer."
1983 ;; Order of functions matters here: checkboxes and endings need
1984 ;; correct indentation to be set, and indentation needs correct
1985 ;; bullets.
1986 ;;
1987 ;; 0. Save a copy of structure before modifications
1989 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1990 ;; order to get items endings and bullets properly
1992 ;; 2. Fix each item end to get correct prevs alist.
1994 ;; 3. Get bullets right.
1997 ;; 4. Now get real indentation.
1999 ;; 5. Eventually fix checkboxes.
2001 ;; 6. Apply structure modifications to buffer.
2003 ;; 7. Return the updated structure
2004 struct)
2007 \f
2008 ;;; Misc Tools
2011 "Call FUNCTION on each item of the list at point.
2012 FUNCTION must be called with at least one argument: INIT-VALUE,
2013 that will contain the value returned by the function at the
2014 previous item, plus ARGS extra arguments.
2016 FUNCTION is applied on items in reverse order.
2018 As an example, \(org-apply-on-list \(lambda \(result) \(1+ result)) 0)
2019 will return the number of items in the current list.
2021 Sublists of the list are skipped. Cursor is always at the
2022 beginning of the item."
2034 value))
2037 "Set visibility of ITEM in STRUCT to VIEW.
2039 Possible values are: `folded', `children' or `subtree'. See
2040 `org-cycle' for more information."
2044 ;; Hide from eol
2048 ;; First show everything.
2050 ;; Then fold every child.
2055 children)))
2057 ;; Show everything
2062 "Return column at which body of ITEM should start."
2070 2
2074 \f
2075 ;;; Interactive functions
2080 "Go to the beginning of the current item.
2081 Throw an error when not in a list."
2087 "Go to the beginning item of the current list or sublist.
2088 Throw an error when not in a list."
2099 "Go to the end of the current list or sublist.
2100 Throw an error when not in a list."
2111 "Go to the end of the current item.
2112 Throw an error when not in a list."
2122 "Move to the beginning of the previous item.
2123 Throw an error when not in a list. Also throw an error when at
2124 first item, unless `org-list-use-circular-motion' is non-nil."
2140 "Move to the beginning of the next item.
2141 Throw an error when not in a list. Also throw an error when at
2142 last item, unless `org-list-use-circular-motion' is non-nil."
2158 "Move the item at point down, i.e. swap with following item.
2159 Sub-items (items with larger indentation) are considered part of
2160 the item, so this really moves item trees."
2179 "Move the item at point up, i.e. swap with previous item.
2180 Sub-items (items with larger indentation) are considered part of
2181 the item, so this really moves item trees."
2198 "Insert a new item at the current level.
2199 If cursor is before first character after bullet of the item, the
2200 new item will be created before the current one.
2202 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2204 Return t when things worked, nil when we are not in an item, or
2205 item is invisible."
2209 ;; If cursor isn't is a list or if list is invisible, return nil.
2217 ;; Timer list: delegate to `org-timer-item'.
2222 ;; If we're in a description list, ask for the new term.
2236 t)))))
2239 "Fix indentation, bullets and checkboxes in the list at point."
2247 "Cycle through the different itemize/enumerate bullets.
2248 This cycle the entire list level through the sequence:
2250 `-' -> `+' -> `*' -> `1.' -> `1)'
2252 If WHICH is a valid string, use that as the new bullet. If WHICH
2253 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2254 `previous', cycle backwards."
2274 ;; Compute list of possible bullets, depending on context.
2277 ;; *-bullets are not allowed at column 0.
2279 ;; Description items cannot be numbered.
2302 ;; Use a short variation of `org-list-write-struct' as there's
2303 ;; no need to go through all the steps.
2311 "Toggle the checkbox in the current line.
2313 With prefix argument TOGGLE-PRESENCE, add or remove checkboxes.
2316 When there is an active region, toggle status or presence of the
2317 first checkbox there, and make every item inside have the same
2318 status or presence, respectively.
2320 If point is on a headline, apply this to all checkbox items in
2321 the text below the heading, taking as reference the first item in
2322 subtree, ignoring planning line and any drawer following it."
2326 block-item
2327 lim-up
2328 lim-down
2331 ;; In a region, start at first item in region.
2341 ;; On a heading, start at first item after drawers and
2342 ;; time-stamps (scheduled, etc.).
2349 ;; Just one item: set SINGLEP flag.
2355 ;; Determine the checkbox going to be applied to all items
2356 ;; within bounds.
2367 ;; When an item is found within bounds, grab the full list at
2368 ;; point structure, then: (1) set check-box of all its items
2369 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2370 ;; whole list, (3) move point after the list.
2384 e struct
2385 ;; If there is no box at item, leave as-is
2386 ;; unless function was called with C-u prefix.
2389 ref-checkbox
2390 cur-box))))
2391 items-to-toggle)
2393 struct parents prevs orderedp))
2394 ;; Report some problems due to ORDERED status of subtree.
2395 ;; If only one box was being checked, throw an error, else,
2396 ;; only signal problems.
2400 "Checkbox blocked because of unchecked box at line %d"
2404 "Checkboxes were removed due to unchecked box at line %d"
2413 "Reset all checkboxes in an entry subtree."
2430 "Update the checkbox statistics in the current section.
2432 This will find all statistic cookies like [57%] and [6/12] and
2433 update them with the current numbers.
2435 With optional prefix argument ALL, do this for the whole buffer."
2456 ;; Return number of checked boxes and boxes of all types
2457 ;; in all structures in STRUCTS. If RECURSIVEP is
2458 ;; non-nil, also count boxes in sub-lists. If ITEM is
2459 ;; nil, count across the whole structure, else count only
2460 ;; across subtree whose ancestor is ITEM.
2475 items))))
2478 cookies-list cache)
2479 ;; Move to start.
2483 ;; Build an alist for each cookie found. The key is the position
2484 ;; at beginning of cookie and values ending position, format of
2485 ;; cookie, number of checked boxes to report and total number of
2486 ;; boxes.
2496 context
2498 quote-block special-block verse-block)))
2514 structs)
2519 structs)
2520 ;; Skip whole list since we have its
2521 ;; structure anyway.
2526 end))))))
2527 ;; Cache count for cookies applying to the same
2528 ;; area. Then return it.
2535 structs
2536 recursivep)))
2538 count))))))
2539 cookies-list))))
2540 ;; Apply alist to buffer.
2556 "Select the face for checkbox statistics.
2557 The face will be `org-done' when all relevant boxes are checked.
2558 Otherwise it will be `org-todo'."
2561 'org-checkbox-statistics-done
2565 'org-checkbox-statistics-done
2569 "Update checkbox statistics unless turned off by user.
2570 With an optional argument ALL, update them in the whole buffer."
2578 "Indent a local list item including its children.
2579 When number ARG is a negative, item will be outdented, otherwise
2580 it will be indented.
2582 If a region is active, all items inside will be moved.
2584 If NO-SUBTREE is non-nil, only indent the item itself, not its
2585 children.
2587 STRUCT is the list structure.
2589 Return t if successful."
2597 ;; Are we going to move the whole list?
2605 t))))
2606 ;; Determine begin and end points of zone to indent. If moving
2607 ;; more than one item, save them for subsequent moves.
2623 ;; Special case: moving top-item with indent rule.
2631 ;; Change bullet if necessary.
2637 ;; Shift every item by OFFSET and fix bullets. Then
2638 ;; apply changes to buffer.
2642 struct)
2645 ;; Forbidden move:
2647 ;; If only one item is moved, it mustn't have a child.
2651 ;; If a subtree or region is moved, the last item
2652 ;; of the subtree mustn't have a child.
2657 struct)))))
2660 ;; Normal shifting
2668 t)
2671 "Outdent a local list item, but not its children.
2672 If a region is active, all items inside will be moved."
2688 "Indent a local list item, but not its children.
2689 If a region is active, all items inside will be moved."
2705 "Outdent a local list item including its children.
2706 If a region is active, all items inside will be moved."
2722 "Indent a local list item including its children.
2723 If a region is active, all items inside will be moved."
2741 "Cycle levels of indentation of an empty item.
2742 The first run indents the item, if applicable. Subsequent runs
2743 outdent it at meaningful levels in the list. When done, item is
2744 put back at its original position with its original bullet.
2746 Return t at each successful move."
2752 ;; Accept empty items or if cycle has already started.
2763 ;; When in the middle of the cycle, try to outdent first. If
2764 ;; it fails, and point is still at initial position, indent.
2765 ;; Else, re-create it at its original position.
2774 ;; Break cycle
2776 ;; If a cycle is starting, remember indentation and bullet,
2777 ;; then try to indent. If it fails, try to outdent.
2783 t))))
2787 "Sort list items.
2788 The cursor may be at any item of the list that should be sorted.
2789 Sublists are not sorted. Checkboxes, if any, are ignored.
2791 Sorting can be alphabetically, numerically, by date/time as given
2792 by a time stamp, by a property or by priority.
2794 Comparing entries ignores case by default. However, with an
2795 optional argument WITH-CASE, the sorting considers case as well,
2796 if the current locale allows for it.
2798 The command prompts for the sorting type unless it has been given
2799 to the function through the SORTING-TYPE argument, which needs to
2800 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F ?x ?X). Here is the
2801 detailed meaning of each character:
2803 n Numerically, by converting the beginning of the item to a number.
2804 a Alphabetically. Only the first line of item is checked.
2805 t By date/time, either the first active time stamp in the entry, if
2806 any, or by the first inactive one. In a timer list, sort the timers.
2809 Capital letters will reverse the sort order.
2811 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2812 a function to be called with point at the beginning of the
2813 record. It must return a value that is compatible with COMPARE-FUNC,
2814 the function used to compare entries.
2816 Sorting is done against the visible part of the headlines, it
2817 ignores hidden links.
2819 A non-nil value for INTERACTIVE? is used to signal that this
2820 function is being called interactively."
2879 ;; If it is a timer list, convert timer to seconds
2896 value))
2900 next-record
2901 end-record
2902 value-to-sort
2903 nil
2904 sort-func)
2905 ;; Read and fix list again, as `sort-subr' probably destroyed
2906 ;; its structure.
2912 "Convert headings or normal lines to items, items to normal lines.
2913 If there is no active region, only the current line is considered.
2915 If the first non blank line in the region is a headline, convert
2916 all headlines to items, shifting text accordingly.
2918 If it is an item, convert all items to normal lines.
2920 If it is normal text, change region into a list of items.
2921 With a prefix argument ARG, change the region in a single item."
2925 ;; Shift text in current section to IND, from point to END.
2926 ;; The function leaves point to END line.
2928 ;; First determine the minimum indentation (MIN-I) of
2929 ;; the text.
2935 ;; Skip blank lines and inline tasks.
2938 ;; We can't find less than 0 indentation.
2942 ;; Then indent each line so that a line indented to
2943 ;; MIN-I becomes indented to IND. Ignore blank lines
2944 ;; and inline tasks in the process.
2953 ;; Return beginning of first non-blank line, starting from
2954 ;; line at POS.
2959 beg end)
2960 ;; Determine boundaries of changes.
2966 ;; Depending on the starting line, choose an action on the text
2967 ;; between BEG and END.
2972 ;; Case 1. Start at an item: de-itemize. Note that it only
2973 ;; happens when a region is active: `org-ctrl-c-minus'
2974 ;; would call `org-cycle-list-bullet' otherwise.
2981 ;; Case 2. Start at an heading: convert to items.
2983 ;; Remove metadata
2988 ;; Indentation of the first heading. It should be
2989 ;; relative to the indentation of its parent, if any.
2995 ;; Level of first heading. Further headings will be
2996 ;; compared to it to determine hierarchy in the list.
3002 ;; If current headline is less indented than the first
3003 ;; one, set it as reference, in order to preserve
3004 ;; subtrees.
3006 ;; Remove metadata
3009 ;; Remove stars and TODO keyword.
3015 ;; Turn TODO keyword into a check box.
3021 struct
3023 "[X]"
3027 old)))
3028 ;; Ensure all text down to END (or SECTION-END) belongs
3029 ;; to the newly created item.
3036 ;; Case 3. Normal line with ARG: make the first line of region
3037 ;; an item, and shift indentation of others lines to
3038 ;; set them as item's body.
3046 ;; Ensure that lines less indented than first one
3047 ;; still get included in item body.
3053 ;; Case 4. Normal line without ARG: turn each non-item line
3054 ;; into an item.
3063 \f
3064 ;;; Send and receive lists
3067 "Parse the list at point and maybe DELETE it.
3069 Return a list whose car is a symbol of list type, among
3070 `ordered', `unordered' and `descriptive'. Then, each item is
3071 a list of strings and other sub-lists.
3073 For example, the following list:
3075 1. first item
3076 + sub-item one
3077 + [X] sub-item two
3078 more text in first item
3079 2. [@3] last item
3081 is parsed as
3083 (ordered
3085 (unordered
3091 Point is left at list's end."
3099 ;; Remove indentation and final newline from TEXT.
3103 text))))
3106 ;; Return a list whose car is list type and cdr a list
3107 ;; of items' body.
3112 ;; Return a list containing counter of item, if any,
3113 ;; text and any sublist inside it.
3122 trim
3132 ;; Remove whole sub-list from children.
3134 ;; There is a chunk of text belonging to the item
3135 ;; if last child doesn't end where next child
3136 ;; starts or where item ends.
3141 trim
3143 body)))))
3145 ;; Store output, take care of cursor position and deletion of
3146 ;; list, then return output.
3155 "Convert the plain list at point into a subtree."
3163 "Convert a LIST parsed through `org-list-to-lisp' to a custom format.
3165 LIST is a list as returned by `org-list-to-lisp', which see.
3166 PARAMS is a property list of parameters used to tweak the output
3167 format.
3169 Valid parameters are:
3171 :backend, :raw
3173 Export back-end used as a basis to transcode elements of the
3174 list, when no specific parameter applies to it. It is also
3175 used to translate its contents. You can prevent this by
3176 setting :raw property to a non-nil value.
3178 :splice
3180 When non-nil, only export the contents of the top most plain
3181 list, effectively ignoring its opening and closing lines.
3183 :ustart, :uend
3185 Strings to start and end an unordered list. They can also be
3186 set to a function returning a string or nil, which will be
3187 called with the depth of the list, counting from 1.
3189 :ostart, :oend
3191 Strings to start and end an ordered list. They can also be set
3192 to a function returning a string or nil, which will be called
3193 with the depth of the list, counting from 1.
3195 :dstart, :dend
3197 Strings to start and end a descriptive list. They can also be
3198 set to a function returning a string or nil, which will be
3199 called with the depth of the list, counting from 1.
3201 :dtstart, :dtend, :ddstart, :ddend
3203 Strings to start and end a descriptive term.
3205 :istart, :iend
3207 Strings to start or end a list item, and to start a list item
3208 with a counter. They can also be set to a function returning
3209 a string or nil, which will be called with two arguments: the
3210 type of list and the depth of the item, counting from 1.
3212 :icount
3214 Strings to start a list item with a counter. It can also be
3215 set to a function returning a string or nil, which will be
3216 called with three arguments: the type of list, the depth of the
3217 item, counting from 1, and the counter. Its value, when
3218 non-nil, has precedence over `:istart'.
3220 :isep
3222 String used to separate items. It can also be set to
3223 a function returning a string or nil, which will be called with
3224 two arguments: the type of list and the depth of the item,
3225 counting from 1. It always start on a new line.
3227 :ifmt
3229 Function to be applied to the contents of every item. It is
3230 called with two arguments: the type of list and the contents.
3232 :cbon, :cboff, :cbtrans
3234 String to insert, respectively, an un-checked check-box,
3235 a checked check-box and a check-box in transitional state."
3241 :transcoders
3245 data info)
3246 ;; Write LIST back into Org syntax and parse it.
3276 ;; When`:raw' property has a non-nil value, turn all objects back
3277 ;; into Org syntax.
3283 ;; We use a low-level mechanism to export DATA so as to skip all
3284 ;; usual pre-processing and post-processing, i.e., hooks, filters,
3285 ;; Babel code evaluation, include keywords and macro expansion,
3286 ;; and filters.
3288 ;; Remove final newline.
3292 "Return the level of ELEMENT within current plain list.
3293 ELEMENT is either an item or a plain list."
3298 "Return the number of trailing newlines in STRING."
3305 "Evaluate VALUE according to its type.
3306 VALUE is either nil, a string or a function. In the latter case,
3307 it is called with arguments ARGS."
3314 "Return a transcoder for `plain-list' elements.
3315 PARAMS is a plist used to tweak the behavior of the transcoder."
3333 depth)))
3340 depth))))
3341 ;; Make sure trailing newlines in END appear in the output by
3342 ;; setting `:post-blank' property to their number.
3346 ;; Build output.
3349 contents
3351 end)))))
3354 "Return a transcoder for `item' elements.
3355 PARAMS is a plist used to tweak the behavior of the transcoder."
3381 ;; When a closing line or a separator is provided, make sure
3382 ;; its trailing newlines are taken into account when building
3383 ;; output. This is done by setting `:post-blank' property to
3384 ;; the number of such lines in the last line to be added.
3388 item
3389 :post-blank
3391 ;; Build output.
3409 tag backend info)
3411 dtend))
3417 contents))
3420 ;; Remove final newline.
3423 closing
3424 separator)))))
3427 "Convert LIST into a LaTeX list.
3428 LIST is a parsed plain list, as returned by `org-list-to-lisp'.
3429 PARAMS is a property list with overruling parameters for
3430 `org-list-to-generic'. Return converted list as a string."
3435 "Convert LIST into a HTML list.
3436 LIST is a parsed plain list, as returned by `org-list-to-lisp'.
3437 PARAMS is a property list with overruling parameters for
3438 `org-list-to-generic'. Return converted list as a string."
3443 "Convert LIST into a Texinfo list.
3444 LIST is a parsed plain list, as returned by `org-list-to-lisp'.
3445 PARAMS is a property list with overruling parameters for
3446 `org-list-to-generic'. Return converted list as a string."
3451 "Convert LIST into an Org plain list.
3452 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3453 with overruling parameters for `org-list-to-generic'."
3460 :icount make-item
3470 "Convert LIST into an Org subtree.
3471 LIST is as returned by `org-list-to-lisp'. PARAMS is a property
3472 list with overruling parameters for `org-list-to-generic'."
3481 ;; Return the string for the heading, depending on DEPTH
3482 ;; of current sub-list.
3486 oddeven-level)
3487 ?*)
3490 list
3493 :istart make-stars
3494 :icount make-stars
3498 params))))
3502 ;;; org-list.el ends here