| blob | c61634cf7853fd55cb03bcb7fb63f2df82bc9292 |
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:
111 (declare-function org-element-map "org-element" (data types fun &optional info first-match no-recursion with-affiliated))
154 \f
155 ;;; Configuration variables
158 "Options concerning plain lists in Org mode."
163 "When t, make TAB cycle visibility on plain list items.
164 Cycling plain lists works only when the cursor is on a plain list
165 item. When the cursor is on an outline heading, plain lists are
166 treated as text. This is the most stable way of handling this,
167 which is why it is the default.
169 When this is the symbol `integrate', then integrate plain list
170 items when cycling, as if they were children of outline headings.
172 This setting can lead to strange effects when switching visibility
175 plain list item with an implied large level number, all true
176 children and grand children of the outline heading will be
177 exposed in a children' view."
186 "Default bullet type installed when demoting an item.
187 This is an association list, for each bullet type, this alist will point
188 to the bullet that should be used when this item is demoted.
189 For example,
191 (setq org-list-demote-modify-bullet
194 will make
196 + Movies
197 + Silence of the Lambs
198 + My Cousin Vinny
199 + Books
200 + The Hunt for Red October
201 + The Road to Omaha
203 into
205 + Movies
206 - Silence of the Lambs
207 - My Cousin Vinny
208 + Books
209 - The Hunt for Red October
210 - The Road to Omaha"
228 "The character that makes a line with leading number an ordered list item.
229 Valid values are ?. and ?\). To get both terminators, use t.
231 This variable needs to be set before org.el is loaded. If you
232 need to make a change while Emacs is running, use the customize
233 interface or run the following code after updating it:
244 "Non-nil means single character alphabetical bullets are allowed.
246 Both uppercase and lowercase are handled. Lists with more than
247 26 items will fallback to standard numbering. Alphabetical
250 This variable needs to be set before org.el is loaded. If you
251 need to make a change while Emacs is running, use the customize
252 interface or run the following code after updating it:
262 "A regular expression matching bullets that should have 2 spaces after them.
263 When nil, no bullet will have two spaces after them. When
264 a string, it will be used as a regular expression. When the
265 bullet type of a list is changed, the new bullet type will be
266 matched against this regexp. If it matches, there will be two
267 spaces instead of one after the bullet in each item of the list."
275 "Non-nil means apply set of rules when acting on lists.
277 By default, automatic actions are taken when using
287 You can disable individually these rules by setting them to nil.
288 Valid rules are:
290 checkbox when non-nil, checkbox statistics is updated each time
291 you either insert a new checkbox or toggle a checkbox.
292 indent when non-nil, indenting or outdenting list top-item
293 with its subtree will move the whole list and
294 outdenting a list whose bullet is * to column 0 will
299 :key-type
303 :value-type
307 "Non-nil means commands implying motion in lists should be cyclic.
309 In that case, the item following the last item is the first one,
310 and the item preceding the first item is the last one.
312 This affects the behavior of
322 "Hook that is run whenever Org thinks checkbox statistics should be updated.
323 This hook runs even if checkbox rule in
324 `org-list-automatic-rules' does not apply, so it can be used to
325 implement alternative ways of collecting statistics
329 "Non-nil means checkbox statistics counts only the state of direct children.
330 When nil, all boxes below the cookie are counted.
331 This can be set to nil on a per-node basis using a COOKIE_DATA property
337 "Maximum indentation for the second line of a description list.
338 When the indentation would be larger than this, it will become
339 5 characters instead."
345 "Additional indentation for sub-items in a list.
346 By setting this to a small number, usually 1 or 2, one can more
347 clearly distinguish sub-items in a list."
353 "Names of blocks where lists are not allowed.
357 "Context types where lists will be interpreted during export.
359 Valid types are `drawer', `inlinetask' and `block'. More
360 specifically, type `block' is determined by the variable
364 \f
365 ;;; Predicates and regexps
375 "Matches a list item and puts everything into groups:
376 group 1: bullet
377 group 2: counter
378 group 3: checkbox
382 "Return the correct regular expression for plain lists."
393 "Regexp matching the beginning of a plain list item."
397 "Is point at a list item with REGEXP after bullet?"
406 ;; Ignore counter if any
411 "Is point in a context where lists are allowed?"
415 "Return item beginning position when in a plain list, nil otherwise."
424 ;; Indentation isn't meaningful when point starts at an empty
425 ;; line or an inline task.
428 10000
434 ;; Detect if cursor in amidst `org-list-end-re'. First, count
435 ;; number HL of hard lines it takes, then call `org-in-regexp'
436 ;; to compute its boundaries END-BOUNDS. When point is
437 ;; in-between, move cursor before regexp beginning.
448 ;; Look for an item, less indented that reference line.
453 ;; This is exactly what we want.
456 ;; At upper bound of search or looking at the end of a
457 ;; previous list: search is over.
460 ;; Skip blocks, drawers, inline-tasks, blank lines
470 ;; Text at column 0 cannot belong to a list: stop.
472 ;; Normal text less indented than reference line, take
473 ;; it as new reference.
480 "Is point in a line starting a hand-formatted item?"
486 "Is point at the bullet of a plain list item?"
492 "Is point at a line starting a plain list item with a timer?"
497 "Is point at a description list item?"
501 "Is point at a line starting a plain-list item with a checklet?"
505 "Is point at a line starting a plain-list item with a counter?"
511 \f
512 ;;; Structures and helper functions
515 "Determine context, and its boundaries, around point.
517 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
518 are boundaries and CONTEXT is a symbol among `drawer', `block',
519 `invalid', `inlinetask' and nil.
521 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
527 ;; Get positions of surrounding headings. This is the
528 ;; default context.
533 ;; Is point inside a drawer?
543 lim-down))
546 ;; Is point strictly in a block, and of which type?
557 lim-down))
563 ;; Is point in an inlinetask?
576 ;; Return context boundaries and type.
580 "Return structure of list at point.
582 A list structure is an alist where key is point at item, and
583 values are:
584 1. indentation,
585 2. bullet with trailing whitespace,
586 3. bullet counter, if any,
587 4. checkbox, if any,
588 5. description tag, if any,
589 6. position at item end.
591 Thus the following list, where numbers in parens are
592 point-at-bol:
594 - [X] first item (1)
595 1. sub-item 1 (18)
596 5. [@5] sub-item 2 (34)
597 some other text belonging to first item (55)
598 - last item (97)
599 + tag :: description (109)
600 (131)
602 will get the following structure:
610 Assume point is at an item."
622 itm-lst itm-lst-2 end-lst end-lst-2 struct
625 ;; Return association at point.
630 ind
631 bullet
634 ;; Description tag.
639 ;; Ensure list ends at the first blank line.
643 ;; 1. Read list from starting item to its beginning, and save
644 ;; top item position and indentation in BEG-CELL. Also store
645 ;; ending position of items in END-LST.
652 ;; At upward limit: if we ended at an item, store it,
653 ;; else dismiss useless data recorded above BEG-CELL.
654 ;; Jump to part 2.
661 ;; Looking at a list ending regexp. Dismiss useless
662 ;; data recorded above BEG-CELL. Jump to part 2.
667 ;; Point is at an item. Add data to ITM-LST. It may
668 ;; also end a previous item: save it in END-LST. If
669 ;; ind is less or equal than BEG-CELL and there is no
670 ;; end at this ind or lesser, this item becomes the new
671 ;; BEG-CELL.
677 ;; Skip blocks, drawers, inline tasks, blank lines.
688 ;; From there, point is not at an item. Interpret
689 ;; line's indentation:
690 ;; - text at column 0 is necessarily out of any list.
691 ;; Dismiss data recorded above BEG-CELL. Jump to
692 ;; part 2.
693 ;; - any other case may be an ending position for an
694 ;; hypothetical item above. Store it and proceed.
703 ;; 2. Read list from starting point to its end, that is until we
704 ;; get out of context, or that a non-item line is less or
705 ;; equally indented than BEG-CELL's cdr. Also, store ending
706 ;; position of items in END-LST-2.
712 ;; At downward limit: this is de facto the end of the
713 ;; list. Save point as an ending position, and jump to
714 ;; part 3.
717 ;; Looking at a list ending regexp. Save point as an
718 ;; ending position and jump to part 3.
722 ;; Point is at an item. Add data to ITM-LST-2. It may
723 ;; also end a previous item, so save it in END-LST-2.
727 ;; Skip inline tasks and blank lines along the way
732 ;; Ind is lesser or equal than BEG-CELL's. The list is
733 ;; over: store point as an ending position and jump to
734 ;; part 3.
738 ;; Else, if ind is lesser or equal than previous item's,
739 ;; this is an ending position: store it. In any case,
740 ;; skip block or drawer at point, and move to next line.
752 ;; 3. Associate each item to its end position.
754 ;; 4. Return STRUCT
755 struct)))
758 "Associate proper ending point to items in STRUCT.
760 END-LIST is a pseudo-alist where car is indentation and cdr is
761 ending position.
763 This function modifies STRUCT."
769 ;; Remove end candidates behind current item.
772 ;; Add end position to item assoc.
778 struct)))
781 "Return alist between item and previous item in STRUCT."
783 struct)))
787 struct)))
790 "Return alist between item and parent in STRUCT."
802 ;; A sub-list is over. Find the associated
803 ;; origin in IND-TO-ORI. If it cannot be
804 ;; found (ill-formed list), set its parent as
805 ;; the first item less indented. If there is
806 ;; none, make it a top-level item.
814 ind-to-ori)
817 ;; A sub-list starts. Every item at IND will
818 ;; have previous item as its parent.
823 ;; Another item in the same sub-list: it shares
824 ;; the same parent as the previous item.
829 \f
830 ;;; Accessors
833 "Return the Nth value of KEY in STRUCT."
837 "Set the Nth value of KEY in STRUCT to NEW.
842 "Return indentation of ITEM in STRUCT."
846 "Set indentation of ITEM in STRUCT to IND.
851 "Return bullet of ITEM in STRUCT."
855 "Set bullet of ITEM in STRUCT to BULLET.
860 "Return counter of ITEM in STRUCT."
864 "Return checkbox of ITEM in STRUCT or nil."
868 "Set checkbox of ITEM in STRUCT to CHECKBOX.
873 "Return end position of ITEM in STRUCT."
877 "Return end position of ITEM in STRUCT."
881 "Return point at end of ITEM in STRUCT, before any blank line.
882 Point returned is at end of line."
889 "Return parent of ITEM or nil.
890 STRUCT is the list structure. PARENTS is the alist of parents,
891 as returned by `org-list-parents-alist'."
896 "Non-nil if ITEM has a child.
898 STRUCT is the list structure.
900 Value returned is the position of the first child of ITEM."
905 child-maybe)))
908 "Return next item in same sub-list as ITEM, or nil.
909 STRUCT is the list structure. PREVS is the alist of previous
910 items, as returned by `org-list-prevs-alist'."
914 "Return previous item in same sub-list as ITEM, or nil.
915 STRUCT is the list structure. PREVS is the alist of previous
916 items, as returned by `org-list-prevs-alist'."
920 "List all items having ITEM as a common ancestor, or nil.
921 STRUCT is the list structure."
924 subtree)
929 sub-struct))
933 "List all items in the same sub-list as ITEM.
934 STRUCT is the list structure. PREVS is the alist of previous
935 items, as returned by `org-list-prevs-alist'."
938 before-item after-item)
946 "List all children of ITEM, or nil.
947 STRUCT is the list structure. PARENTS is the alist of parents,
948 as returned by `org-list-parents-alist'."
956 "Return point at beginning of list.
957 STRUCT is the list structure."
961 "Return point at bottom of list.
962 STRUCT is the list structure."
967 "Return point at beginning of sub-list ITEM belongs.
968 STRUCT is the list structure. PREVS is the alist of previous
969 items, as returned by `org-list-prevs-alist'."
973 first-item))
978 "Return point at last item of sub-list ITEM belongs.
979 STRUCT is the list structure. PREVS is the alist of previous
980 items, as returned by `org-list-prevs-alist'."
984 last-item))
987 "Return point at end of sub-list ITEM belongs.
988 STRUCT is the list structure. PREVS is the alist of previous
989 items, as returned by `org-list-prevs-alist'."
993 "Return the type of the list containing ITEM, as a symbol.
995 STRUCT is the list structure. PREVS is the alist of previous
996 items, as returned by `org-list-prevs-alist'.
998 Possible types are `descriptive', `ordered' and `unordered'. The
999 type is determined by the first item of the list."
1007 "Return ITEM's sequence number.
1009 STRUCT is the list structure. PREVS is the alist of previous
1010 items, as returned by `org-list-prevs-alist'. PARENTS is the
1011 alist of ancestors, as returned by `org-list-parents-alist'.
1013 Return value is a list of integers. Counters have an impact on
1014 that value."
1018 ;; Return relative sequence number of ITEM in the sub-list
1019 ;; it belongs. STRUCT is the list structure. PREVS is
1020 ;; the alist of previous items.
1029 seq))
1033 ;; Cons each parent relative number into return value (OUT).
1038 ;; Return value.
1039 out)))
1042 \f
1043 ;;; Searching
1046 "Search a string in valid contexts for lists.
1047 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1048 in `re-search-forward'."
1052 ;; 1. No match: return to origin or bound, depending on NOERR.
1055 nil)))
1056 ;; 2. Match in valid context: return point. Else, continue
1057 ;; searching.
1061 "Like `re-search-backward' but stop only where lists are recognized.
1062 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1063 `re-search-backward'."
1068 "Like `re-search-forward' but stop only where lists are recognized.
1069 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1070 `re-search-forward'."
1075 \f
1076 ;;; Methods on structures
1079 "Return BULLET with the correct number of whitespaces.
1080 It determines the number of whitespaces to append by looking at
1081 `org-list-two-spaces-after-bullet-regexp'."
1085 org-list-two-spaces-after-bullet-regexp bullet))
1086 " "
1090 bullet))))
1093 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1095 Blank lines at the end of items are left in place. Item
1096 visibility is preserved. Return the new structure after the
1097 changes.
1099 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1100 to the same sub-list.
1102 This function modifies STRUCT."
1115 ;; Store overlays responsible for visibility status. We
1116 ;; also need to store their boundaries as they will be
1117 ;; removed from buffer.
1132 ;; 1. Move effectively items in buffer.
1136 ;; 2. Now modify struct. No need to re-read the list, the
1137 ;; transformation is just a shift of positions. Some special
1138 ;; attention is required for items ending at END-A and END-B
1139 ;; as empty spaces are not moved there. In others words,
1140 ;; item BEG-A will end with whitespaces that were at the end
1141 ;; of BEG-B and the same applies to BEG-B.
1164 ;; Restore visibility status, by moving overlays to their new
1165 ;; position.
1175 ;; Return structure.
1176 struct)))
1179 "Return number of blank lines that should separate items in list.
1181 POS is the position of point where `org-list-insert-item' was called.
1183 STRUCT is the list structure. PREVS is the alist of previous
1184 items, as returned by `org-list-prevs-alist'.
1186 Assume point is at item's beginning. If the item is alone, apply
1187 some heuristics to guess the result."
1192 usr-blank
1196 ;; Count blank lines above beginning of line.
1203 ;; Trivial cases where there should be none.
1205 ;; When `org-blank-before-new-entry' says so, it is 1.
1207 ;; `plain-list-item' is 'auto. Count blank lines separating
1208 ;; neighbors' items in list.
1211 ;; Is there a next item?
1214 ;; Is there a previous item?
1217 ;; User inserted blank lines, trust him.
1222 usr-blank)
1223 ;; Are there blank lines inside the list so far?
1226 ;; Do not use `org-list-search-forward' so blank lines
1227 ;; in blocks can be counted in.
1231 ;; Default choice: no blank line.
1235 "Insert a new list item at POS and return the new structure.
1236 If POS is before first character after bullet of the item, the
1237 new item will be created before the current one.
1239 STRUCT is the list structure. PREVS is the alist of previous
1240 items, as returned by `org-list-prevs-alist'.
1242 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1243 after the bullet. Cursor will be after this text once the
1244 function ends.
1246 This function modifies STRUCT."
1248 ;; 1. Get information about list: position of point with regards
1249 ;; to item start (BEFOREP), blank lines number separating items
1250 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1257 (<= pos
1260 ;; Ignore tag in a non-descriptive list.
1269 pos struct prevs))
1270 ;; 2. Build the new item to be created. Concatenate same
1271 ;; bullet as item, checkbox, text AFTER-BULLET if
1272 ;; provided, and text cut from point to end of item
1273 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1274 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1275 ;; between what was cut and what was inserted in buffer
1276 ;; is stored in SIZE-OFFSET.
1280 ind))
1287 ;; If POS is greater than ITEM-END, then point is
1288 ;; in some white lines after the end of the list.
1289 ;; Those must be removed, or they will be left,
1290 ;; stacking up after the list.
1300 text-cut))))
1304 ;; 4. Insert effectively item into buffer.
1308 ;; 5. Add new item to STRUCT.
1312 ;; Before inserted item, positions don't change but
1313 ;; an item ending after insertion has its end shifted
1314 ;; by SIZE-OFFSET.
1317 ;; Trivial cases where current item isn't split in
1318 ;; two. Just shift every item after new one by
1319 ;; ITEM-SIZE.
1323 ;; Item is split in two: elements before POS are just
1324 ;; shifted by ITEM-SIZE. In the case item would end
1325 ;; after split POS, ending is only shifted by
1326 ;; SIZE-OFFSET.
1332 ;; Elements after POS are moved into new item.
1333 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1334 ;; doesn't appear in buffer yet.
1340 (+ end size-offset
1342 ;; Elements at ITEM-END or after are only shifted by
1343 ;; SIZE-OFFSET.
1346 struct)
1349 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1350 ;; exchange ITEM with the next item in list. Position cursor
1351 ;; after bullet, counter, checkbox, and label.
1357 struct)))
1360 "Remove ITEM from the list and return the new structure.
1362 STRUCT is the list structure."
1365 ;; If ITEM ends with the list, delete blank lines
1366 ;; before it.
1371 item)))
1372 ;; Remove item from buffer.
1374 ;; Remove item from structure and shift others items accordingly.
1375 ;; Don't forget to shift also ending position when appropriate.
1393 struct)))))
1396 "Send ITEM to destination DEST.
1398 STRUCT is the list structure.
1400 DEST can have various values.
1402 If DEST is a buffer position, the function will assume it points
1403 to another item in the same list as ITEM, and will move the
1404 latter just before the former.
1406 If DEST is `begin' (respectively `end'), ITEM will be moved at
1407 the beginning (respectively end) of the list it belongs to.
1410 be moved at the Nth position in the list.
1412 If DEST is `kill', ITEM will be deleted and its body will be
1413 added to the kill-ring.
1415 If DEST is `delete', ITEM will be deleted.
1417 Visibility of item is preserved.
1419 This function returns, destructively, the new list structure."
1422 ;; Grab full item body minus its bullet.
1431 item-end)))
1432 ;; Change DEST into a buffer position. A trick is needed
1433 ;; when ITEM is meant to be sent at the end of the list.
1434 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1435 ;; nil and insertion point (INS-POINT) to the first line's
1436 ;; end of the last item, we ensure the new item will be
1437 ;; inserted after the last item, and not after any of its
1438 ;; hypothetical sub-items.
1454 ;; Send ITEM at the end of the list.
1462 ;; Store inner overlays (to preserve visibility).
1474 ;; 1. Structure returned by `org-list-insert-item' may not be
1475 ;; accurate, as it cannot see sub-items included in BODY.
1476 ;; Thus, first compute the real structure so far.
1484 ;; 1.1. Remove the item just created in structure.
1486 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1489 struct
1497 new-end
1499 moved-items))
1501 ;; 2. Restore inner overlays.
1506 ;; 3. Eventually delete extra copy of the item and clean marker.
1512 "Outdent items between positions START and END.
1514 STRUCT is the list structure. PARENTS is the alist of items'
1515 parents, as returned by `org-list-parents-alist'.
1517 START is included, END excluded."
1523 ;; Item not yet in zone: keep association.
1525 ;; Item out of zone: follow associations in ACC.
1529 ;; Item has no parent: error
1532 ;; Parent is outdented: keep association.
1536 ;; Parent isn't outdented: reparent to grand-parent.
1538 parent struct parents)))
1544 "Indent items between positions START and END.
1546 STRUCT is the list structure. PARENTS is the alist of parents
1547 and PREVS is the alist of previous items, returned by,
1548 respectively, `org-list-parents-alist' and
1549 `org-list-prevs-alist'.
1551 START is included and END excluded.
1553 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1554 bullets between START and END."
1562 ;; Normalize ordered bullets.
1572 org-list-demote-modify-bullet))))
1579 ;; Item not yet in zone: keep association.
1582 ;; Item out of zone: follow associations in ACC.
1586 ;; Item is in zone...
1588 ;; Check if bullet needs to be changed.
1591 ;; First item indented but not parent: error
1594 ;; First item and parent indented: keep same
1595 ;; parent.
1597 ;; Previous item not indented: reparent to it.
1599 ;; Previous item indented: reparent like it.
1606 \f
1607 ;;; Repairing structures
1610 "Non-nil if list starting at FIRST can have alphabetical bullets.
1612 STRUCT is list structure. PREVS is the alist of previous items,
1613 as returned by `org-list-prevs-alist'."
1617 ;; Pretend that bullets are uppercase and check if alphabet
1618 ;; is sufficient, taking counters into account.
1621 ;; Virtually determine current bullet
1623 ;; Counters are not case-sensitive.
1626 ;; Test if bullet would be over z or Z.
1630 ;; All items checked. All good.
1631 t))))
1634 "Increment BULLET if applicable."
1637 ;; Num bullet: increment it.
1641 nil nil bullet))
1642 ;; Alpha bullet: increment it.
1646 nil nil bullet))
1647 ;; Unordered bullet: leave it.
1651 "Verify and correct bullets in STRUCT.
1652 PREVS is the alist of previous items, as returned by
1653 `org-list-prevs-alist'.
1655 This function modifies STRUCT."
1659 ;; Set bullet of ITEM in STRUCT, depending on the type of
1660 ;; first item of the list, the previous bullet and counter
1661 ;; if any.
1670 item struct
1673 ;; Alpha counter in alpha list: use counter.
1677 ;; Use cond to be sure `string-match' is used in
1678 ;; both cases.
1684 ;; Num counter in a num list: use counter.
1689 ;; No counter: increase, if needed, previous bullet.
1692 ;; Alpha counter at first item: use counter.
1701 ;; Num counter at first item: use counter.
1706 ;; First bullet is alpha uppercase: use "A".
1709 ;; First bullet is alpha lowercase: use "a".
1712 ;; First bullet is num: use "1".
1715 ;; Not an ordered list: keep bullet.
1720 "Verify and correct indentation in STRUCT.
1722 PARENTS is the alist of parents, as returned by
1723 `org-list-parents-alist'.
1725 If numeric optional argument BULLET-SIZE is set, assume all
1726 bullets in list have this length to determine new indentation.
1728 This function modifies STRUCT."
1735 ;; Indent like parent + length of parent's bullet +
1736 ;; sub-list offset.
1742 org-list-indent-offset))
1743 ;; If no parent, indent like top-point.
1748 "Verify and correct checkboxes in STRUCT.
1750 PARENTS is the alist of parents and PREVS is the alist of
1751 previous items, as returned by, respectively,
1752 `org-list-parents-alist' and `org-list-prevs-alist'.
1754 If ORDERED is non-nil, a checkbox can only be checked when every
1755 checkbox before it is checked too. If there was an attempt to
1756 break this rule, the function will return the blocking item. In
1757 all others cases, the return value will be nil.
1759 This function modifies STRUCT."
1769 item struct
1775 ;; Parent has no boxed child: leave box as-is.
1777 parent-list)
1778 ;; 1. List all parents with a checkbox.
1785 all-items)
1786 ;; 2. Sort those parents by decreasing indentation.
1791 ;; 3. For each parent, get all children's checkboxes to determine
1792 ;; and set its checkbox accordingly.
1794 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1799 ;; There are boxes checked after an unchecked one: fix that.
1806 ;; Verify once again the structure, without ORDERED.
1808 ;; Return blocking item.
1812 "Verify and correct each item end position in STRUCT.
1814 This function modifies STRUCT."
1821 ;; To determine real ind of an ending position that is
1822 ;; not at an item, we have to find the item it belongs
1823 ;; to: it is the last item (ITEM-UP), whose ending is
1824 ;; further than the position we're interested in.
1827 ;; Else part is for the bottom point.
1829 end-pos)
1830 end-list)))
1833 struct)
1838 "Apply set difference between STRUCT and OLD-STRUCT to the buffer.
1840 OLD-STRUCT is the structure before any modifications, and STRUCT
1841 the structure to be applied. The function will only modify parts
1842 of the list which have changed.
1844 Initial position of cursor is restored after the changes."
1851 ;; Shift the indentation between END and BEG by DELTA.
1852 ;; Start from the line before END.
1861 ;; Skip inline tasks.
1864 ;; Shift only non-empty lines.
1870 ;; Replace ITEM first line elements with new elements from
1871 ;; STRUCT, if appropriate.
1881 ;; a. Replace bullet
1884 ;; b. Replace checkbox.
1895 ;; c. Indent item to appropriate column.
1900 ;; 1. First get list of items and position endings. We maintain
1901 ;; two alists: ITM-SHIFT, determining indentation shift needed
1902 ;; at item, and END-LIST, a pseudo-alist where key is ending
1903 ;; position and value point.
1916 ;; To determine real ind of an ending position that
1917 ;; is not at an item, we have to find the item it
1918 ;; belongs to: it is the last item (ITEM-UP), whose
1919 ;; ending is further than the position we're
1920 ;; interested in.
1924 ;; 2. Slice the items into parts that should be shifted by the
1925 ;; same amount of indentation. Each slice follow the pattern
1926 ;; (END BEG DELTA). Slices are returned in reverse order.
1929 #'<)
1937 ;; If we're not at an item, there's a child of the
1938 ;; item point belongs to above. Make sure the less
1939 ;; indented line in this slice has the same column
1940 ;; as that child.
1947 ;; Ignore empty lines. Also ignore blocks and
1948 ;; drawers contents.
1956 down t)))
1959 down t)))))
1963 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1964 ;; end to beginning. Take a special action when beginning is
1965 ;; at item bullet.
1972 ;; 4. Go back to initial position and clean marker.
1977 "Correct bullets, checkboxes and indentation in list at point.
1979 STRUCT is the list structure. PARENTS is the alist of parents,
1980 as returned by `org-list-parents-alist'.
1982 When non-nil, optional argument OLD-STRUCT is the reference
1983 structure of the list. It should be provided whenever STRUCT
1984 doesn't correspond anymore to the real list in buffer."
1985 ;; Order of functions matters here: checkboxes and endings need
1986 ;; correct indentation to be set, and indentation needs correct
1987 ;; bullets.
1988 ;;
1989 ;; 0. Save a copy of structure before modifications
1991 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
1992 ;; order to get items endings and bullets properly
1994 ;; 2. Fix each item end to get correct prevs alist.
1996 ;; 3. Get bullets right.
1999 ;; 4. Now get real indentation.
2001 ;; 5. Eventually fix checkboxes.
2003 ;; 6. Apply structure modifications to buffer.
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."
2069 ;; Descriptive list item. Body starts after item's tag, if
2070 ;; possible.
2075 start))
2076 ;; Regular item. Body starts after bullet.
2082 2
2086 \f
2087 ;;; Interactive functions
2092 "Go to the beginning of the current item.
2093 Throw an error when not in a list."
2099 "Go to the beginning item of the current list or sublist.
2100 Throw an error when not in a list."
2111 "Go to the end of the current list or sublist.
2112 Throw an error when not in a list."
2123 "Go to the end of the current item.
2124 Throw an error when not in a list."
2134 "Move to the beginning of the previous item.
2135 Throw an error when not in a list. Also throw an error when at
2136 first item, unless `org-list-use-circular-motion' is non-nil."
2152 "Move to the beginning of the next item.
2153 Throw an error when not in a list. Also throw an error when at
2154 last item, unless `org-list-use-circular-motion' is non-nil."
2170 "Move the item at point down, i.e. swap with following item.
2171 Sub-items (items with larger indentation) are considered part of
2172 the item, so this really moves item trees."
2191 "Move the item at point up, i.e. swap with previous item.
2192 Sub-items (items with larger indentation) are considered part of
2193 the item, so this really moves item trees."
2210 "Insert a new item at the current level.
2211 If cursor is before first character after bullet of the item, the
2212 new item will be created before the current one.
2214 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2216 Return t when things worked, nil when we are not in an item, or
2217 item is invisible."
2221 ;; If cursor isn't is a list or if list is invisible, return nil.
2229 ;; Timer list: delegate to `org-timer-item'.
2234 ;; If we're in a description list, ask for the new term.
2248 t)))))
2251 "Fix indentation, bullets and checkboxes in the list at point."
2259 "Cycle through the different itemize/enumerate bullets.
2260 This cycle the entire list level through the sequence:
2262 `-' -> `+' -> `*' -> `1.' -> `1)'
2264 If WHICH is a valid string, use that as the new bullet. If WHICH
2265 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2266 `previous', cycle backwards."
2286 ;; Compute list of possible bullets, depending on context.
2289 ;; *-bullets are not allowed at column 0.
2291 ;; Description items cannot be numbered.
2314 ;; Use a short variation of `org-list-write-struct' as there's
2315 ;; no need to go through all the steps.
2323 "Toggle the checkbox in the current line.
2325 With prefix argument TOGGLE-PRESENCE, add or remove checkboxes.
2328 When there is an active region, toggle status or presence of the
2329 first checkbox there, and make every item inside have the same
2330 status or presence, respectively.
2332 If point is on a headline, apply this to all checkbox items in
2333 the text below the heading, taking as reference the first item in
2334 subtree, ignoring planning line and any drawer following it."
2338 block-item
2339 lim-up
2340 lim-down
2343 ;; In a region, start at first item in region.
2353 ;; On a heading, start at first item after drawers and
2354 ;; time-stamps (scheduled, etc.).
2361 ;; Just one item: set SINGLEP flag.
2367 ;; Determine the checkbox going to be applied to all items
2368 ;; within bounds.
2379 ;; When an item is found within bounds, grab the full list at
2380 ;; point structure, then: (1) set check-box of all its items
2381 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2382 ;; whole list, (3) move point after the list.
2396 e struct
2397 ;; If there is no box at item, leave as-is
2398 ;; unless function was called with C-u prefix.
2401 ref-checkbox
2402 cur-box))))
2403 items-to-toggle)
2405 struct parents prevs orderedp))
2406 ;; Report some problems due to ORDERED status of subtree.
2407 ;; If only one box was being checked, throw an error, else,
2408 ;; only signal problems.
2412 "Checkbox blocked because of unchecked box at line %d"
2416 "Checkboxes were removed due to unchecked box at line %d"
2425 "Reset all checkboxes in an entry subtree."
2442 "Update the checkbox statistics in the current section.
2444 This will find all statistic cookies like [57%] and [6/12] and
2445 update them with the current numbers.
2447 With optional prefix argument ALL, do this for the whole buffer."
2468 ;; Return number of checked boxes and boxes of all types
2469 ;; in all structures in STRUCTS. If RECURSIVEP is
2470 ;; non-nil, also count boxes in sub-lists. If ITEM is
2471 ;; nil, count across the whole structure, else count only
2472 ;; across subtree whose ancestor is ITEM.
2487 items))))
2490 cookies-list cache)
2491 ;; Move to start.
2495 ;; Build an alist for each cookie found. The key is the position
2496 ;; at beginning of cookie and values ending position, format of
2497 ;; cookie, number of checked boxes to report and total number of
2498 ;; boxes.
2508 context
2510 quote-block special-block verse-block)))
2526 structs)
2531 structs)
2532 ;; Skip whole list since we have its
2533 ;; structure anyway.
2538 end))))))
2539 ;; Cache count for cookies applying to the same
2540 ;; area. Then return it.
2547 structs
2548 recursivep)))
2550 count))))))
2551 cookies-list))))
2552 ;; Apply alist to buffer.
2568 "Select the face for checkbox statistics.
2569 The face will be `org-done' when all relevant boxes are checked.
2570 Otherwise it will be `org-todo'."
2573 'org-checkbox-statistics-done
2577 'org-checkbox-statistics-done
2581 "Update checkbox statistics unless turned off by user.
2582 With an optional argument ALL, update them in the whole buffer."
2590 "Indent a local list item including its children.
2591 When number ARG is a negative, item will be outdented, otherwise
2592 it will be indented.
2594 If a region is active, all items inside will be moved.
2596 If NO-SUBTREE is non-nil, only indent the item itself, not its
2597 children.
2599 STRUCT is the list structure.
2601 Return t if successful."
2609 ;; Are we going to move the whole list?
2617 t))))
2618 ;; Determine begin and end points of zone to indent. If moving
2619 ;; more than one item, save them for subsequent moves.
2635 ;; Special case: moving top-item with indent rule.
2643 ;; Change bullet if necessary.
2649 ;; Shift every item by OFFSET and fix bullets. Then
2650 ;; apply changes to buffer.
2654 struct)
2657 ;; Forbidden move:
2659 ;; If only one item is moved, it mustn't have a child.
2663 ;; If a subtree or region is moved, the last item
2664 ;; of the subtree mustn't have a child.
2669 struct)))))
2672 ;; Normal shifting
2680 t)
2683 "Outdent a local list item, but not its children.
2684 If a region is active, all items inside will be moved."
2700 "Indent a local list item, but not its children.
2701 If a region is active, all items inside will be moved."
2717 "Outdent a local list item including its children.
2718 If a region is active, all items inside will be moved."
2734 "Indent a local list item including its children.
2735 If a region is active, all items inside will be moved."
2753 "Cycle levels of indentation of an empty item.
2754 The first run indents the item, if applicable. Subsequent runs
2755 outdent it at meaningful levels in the list. When done, item is
2756 put back at its original position with its original bullet.
2758 Return t at each successful move."
2764 ;; Accept empty items or if cycle has already started.
2775 ;; When in the middle of the cycle, try to outdent first. If
2776 ;; it fails, and point is still at initial position, indent.
2777 ;; Else, re-create it at its original position.
2786 ;; Break cycle
2788 ;; If a cycle is starting, remember indentation and bullet,
2789 ;; then try to indent. If it fails, try to outdent.
2795 t))))
2799 "Sort list items.
2800 The cursor may be at any item of the list that should be sorted.
2801 Sublists are not sorted. Checkboxes, if any, are ignored.
2803 Sorting can be alphabetically, numerically, by date/time as given
2804 by a time stamp, by a property or by priority.
2806 Comparing entries ignores case by default. However, with an
2807 optional argument WITH-CASE, the sorting considers case as well.
2809 The command prompts for the sorting type unless it has been given
2810 to the function through the SORTING-TYPE argument, which needs to
2811 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F ?x ?X). Here is the
2812 detailed meaning of each character:
2814 n Numerically, by converting the beginning of the item to a number.
2815 a Alphabetically. Only the first line of item is checked.
2816 t By date/time, either the first active time stamp in the entry, if
2817 any, or by the first inactive one. In a timer list, sort the timers.
2820 Capital letters will reverse the sort order.
2822 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2823 a function to be called with point at the beginning of the
2824 record. It must return a value that is compatible with COMPARE-FUNC,
2825 the function used to compare entries.
2827 Sorting is done against the visible part of the headlines, it
2828 ignores hidden links.
2830 A non-nil value for INTERACTIVE? is used to signal that this
2831 function is being called interactively."
2890 ;; If it is a timer list, convert timer to seconds
2907 value))
2911 next-record
2912 end-record
2913 value-to-sort
2914 nil
2915 sort-func)
2916 ;; Read and fix list again, as `sort-subr' probably destroyed
2917 ;; its structure.
2923 "Convert headings or normal lines to items, items to normal lines.
2924 If there is no active region, only the current line is considered.
2926 If the first non blank line in the region is a headline, convert
2927 all headlines to items, shifting text accordingly.
2929 If it is an item, convert all items to normal lines.
2931 If it is normal text, change region into a list of items.
2932 With a prefix argument ARG, change the region in a single item."
2936 ;; Shift text in current section to IND, from point to END.
2937 ;; The function leaves point to END line.
2939 ;; First determine the minimum indentation (MIN-I) of
2940 ;; the text.
2946 ;; Skip blank lines and inline tasks.
2949 ;; We can't find less than 0 indentation.
2953 ;; Then indent each line so that a line indented to
2954 ;; MIN-I becomes indented to IND. Ignore blank lines
2955 ;; and inline tasks in the process.
2964 ;; Return beginning of first non-blank line, starting from
2965 ;; line at POS.
2970 beg end)
2971 ;; Determine boundaries of changes.
2977 ;; Depending on the starting line, choose an action on the text
2978 ;; between BEG and END.
2983 ;; Case 1. Start at an item: de-itemize. Note that it only
2984 ;; happens when a region is active: `org-ctrl-c-minus'
2985 ;; would call `org-cycle-list-bullet' otherwise.
2992 ;; Case 2. Start at an heading: convert to items.
2996 ;; Indentation of the first heading. It should be
2997 ;; relative to the indentation of its parent, if any.
3003 ;; Level of first heading. Further headings will be
3004 ;; compared to it to determine hierarchy in the list.
3010 ;; If current headline is less indented than the first
3011 ;; one, set it as reference, in order to preserve
3012 ;; subtrees.
3014 ;; Remove stars and TODO keyword.
3020 ;; Turn TODO keyword into a check box.
3026 struct
3028 "[X]"
3032 old)))
3033 ;; Ensure all text down to END (or SECTION-END) belongs
3034 ;; to the newly created item.
3041 ;; Case 3. Normal line with ARG: make the first line of region
3042 ;; an item, and shift indentation of others lines to
3043 ;; set them as item's body.
3051 ;; Ensure that lines less indented than first one
3052 ;; still get included in item body.
3058 ;; Case 4. Normal line without ARG: turn each non-item line
3059 ;; into an item.
3068 \f
3069 ;;; Send and receive lists
3072 "Parse the list at point and maybe DELETE it.
3074 Return a list whose car is a symbol of list type, among
3075 `ordered', `unordered' and `descriptive'. Then, each item is
3076 a list of strings and other sub-lists.
3078 For example, the following list:
3080 1. first item
3081 + sub-item one
3082 + [X] sub-item two
3083 more text in first item
3084 2. [@3] last item
3086 is parsed as
3088 (ordered
3090 (unordered
3096 Point is left at list's end."
3104 ;; Remove indentation and final newline from TEXT.
3108 text))))
3111 ;; Return a list whose car is list type and cdr a list
3112 ;; of items' body.
3117 ;; Return a list containing counter of item, if any,
3118 ;; text and any sublist inside it.
3127 trim
3137 ;; Remove whole sub-list from children.
3139 ;; There is a chunk of text belonging to the item
3140 ;; if last child doesn't end where next child
3141 ;; starts or where item ends.
3146 trim
3148 body)))))
3150 ;; Store output, take care of cursor position and deletion of
3151 ;; list, then return output.
3160 "Convert the plain list at point into a subtree."
3168 "Convert a LIST parsed through `org-list-to-lisp' to a custom format.
3170 LIST is a list as returned by `org-list-to-lisp', which see.
3171 PARAMS is a property list of parameters used to tweak the output
3172 format.
3174 Valid parameters are:
3176 :backend, :raw
3178 Export back-end used as a basis to transcode elements of the
3179 list, when no specific parameter applies to it. It is also
3180 used to translate its contents. You can prevent this by
3181 setting :raw property to a non-nil value.
3183 :splice
3185 When non-nil, only export the contents of the top most plain
3186 list, effectively ignoring its opening and closing lines.
3188 :ustart, :uend
3190 Strings to start and end an unordered list. They can also be
3191 set to a function returning a string or nil, which will be
3192 called with the depth of the list, counting from 1.
3194 :ostart, :oend
3196 Strings to start and end an ordered list. They can also be set
3197 to a function returning a string or nil, which will be called
3198 with the depth of the list, counting from 1.
3200 :dstart, :dend
3202 Strings to start and end a descriptive list. They can also be
3203 set to a function returning a string or nil, which will be
3204 called with the depth of the list, counting from 1.
3206 :dtstart, :dtend, :ddstart, :ddend
3208 Strings to start and end a descriptive term.
3210 :istart, :iend
3212 Strings to start or end a list item, and to start a list item
3213 with a counter. They can also be set to a function returning
3214 a string or nil, which will be called with two arguments: the
3215 type of list and the depth of the item, counting from 1.
3217 :icount
3219 Strings to start a list item with a counter. It can also be
3220 set to a function returning a string or nil, which will be
3221 called with three arguments: the type of list, the depth of the
3222 item, counting from 1, and the counter. Its value, when
3223 non-nil, has precedence over `:istart'.
3225 :isep
3227 String used to separate items. It can also be set to
3228 a function returning a string or nil, which will be called with
3229 two arguments: the type of list and the depth of the item,
3230 counting from 1. It always start on a new line.
3232 :ifmt
3234 Function to be applied to the contents of every item. It is
3235 called with two arguments: the type of list and the contents.
3237 :cbon, :cboff, :cbtrans
3239 String to insert, respectively, an un-checked check-box,
3240 a checked check-box and a check-box in transitional state."
3246 :transcoders
3250 data info)
3251 ;; Write LIST back into Org syntax and parse it.
3281 ;; When`:raw' property has a non-nil value, turn all objects back
3282 ;; into Org syntax.
3288 ;; We use a low-level mechanism to export DATA so as to skip all
3289 ;; usual pre-processing and post-processing, i.e., hooks, filters,
3290 ;; Babel code evaluation, include keywords and macro expansion,
3291 ;; and filters.
3293 ;; Remove final newline.
3297 "Return the level of ELEMENT within current plain list.
3298 ELEMENT is either an item or a plain list."
3303 "Return the number of trailing newlines in STRING."
3310 "Evaluate VALUE according to its type.
3311 VALUE is either nil, a string or a function. In the latter case,
3312 it is called with arguments ARGS."
3319 "Return a transcoder for `plain-list' elements.
3320 PARAMS is a plist used to tweak the behavior of the transcoder."
3338 depth)))
3345 depth))))
3346 ;; Make sure trailing newlines in END appear in the output by
3347 ;; setting `:post-blank' property to their number.
3351 ;; Build output.
3354 contents
3356 end)))))
3359 "Return a transcoder for `item' elements.
3360 PARAMS is a plist used to tweak the behavior of the transcoder."
3386 ;; When a closing line or a separator is provided, make sure
3387 ;; its trailing newlines are taken into account when building
3388 ;; output. This is done by setting `:post-blank' property to
3389 ;; the number of such lines in the last line to be added.
3393 item
3394 :post-blank
3396 ;; Build output.
3414 tag backend info)
3416 dtend))
3422 contents))
3425 ;; Remove final newline.
3428 closing
3429 separator)))))
3432 "Convert LIST into a LaTeX list.
3433 LIST is a parsed plain list, as returned by `org-list-to-lisp'.
3434 PARAMS is a property list with overruling parameters for
3435 `org-list-to-generic'. Return converted list as a string."
3440 "Convert LIST into a HTML list.
3441 LIST is a parsed plain list, as returned by `org-list-to-lisp'.
3442 PARAMS is a property list with overruling parameters for
3443 `org-list-to-generic'. Return converted list as a string."
3448 "Convert LIST into a Texinfo list.
3449 LIST is a parsed plain list, as returned by `org-list-to-lisp'.
3450 PARAMS is a property list with overruling parameters for
3451 `org-list-to-generic'. Return converted list as a string."
3456 "Convert LIST into an Org plain list.
3457 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3458 with overruling parameters for `org-list-to-generic'."
3465 :icount make-item
3475 "Convert LIST into an Org subtree.
3476 LIST is as returned by `org-list-to-lisp'. PARAMS is a property
3477 list with overruling parameters for `org-list-to-generic'."
3486 ;; Return the string for the heading, depending on DEPTH
3487 ;; of current sub-list.
3491 oddeven-level)
3492 ?*)
3495 list
3498 :istart make-stars
3499 :icount make-stars
3503 params))))
3507 ;;; org-list.el ends here