| blob | 067f4556801145f831e25443ddb0e68668ec0d74 |
1 ;;; org-list.el --- Plain lists for Org -*- lexical-binding: t; -*-
2 ;;
3 ;; Copyright (C) 2004-2016 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: http://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 <http://www.gnu.org/licenses/>.
24 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
25 ;;
26 ;;; Commentary:
28 ;; This file contains the code dealing with plain lists in Org-mode.
30 ;; The core concept behind lists is their structure. A structure is
31 ;; a snapshot of the list, in the shape of a data tree (see
32 ;; `org-list-struct').
34 ;; Once the list structure is stored, it is possible to make changes
35 ;; on it that will be mirrored to the real list or to get information
36 ;; about the list, using accessors and methods provided in the
37 ;; library. Most of them require the use of one or two helper
38 ;; functions, namely `org-list-parents-alist' and
39 ;; `org-list-prevs-alist'.
41 ;; Structure is eventually applied to the buffer with
42 ;; `org-list-write-struct'. This function repairs (bullets,
43 ;; indentation, checkboxes) the list in the process. It should be
44 ;; called near the end of any function working on structures.
46 ;; Thus, a function applying to lists should usually follow this
47 ;; template:
49 ;; 1. Verify point is in a list and grab item beginning (with the same
50 ;; function `org-in-item-p'). If the function requires the cursor
51 ;; to be at item's bullet, `org-at-item-p' is more selective. It
52 ;; is also possible to move point to the closest item with
53 ;; `org-list-search-backward', or `org-list-search-forward',
54 ;; applied to the function `org-item-beginning-re'.
56 ;; 2. Get list structure with `org-list-struct'.
58 ;; 3. Compute one, or both, helper functions,
59 ;; (`org-list-parents-alist', `org-list-prevs-alist') depending on
60 ;; needed accessors.
62 ;; 4. Proceed with the modifications, using methods and accessors.
64 ;; 5. Verify and apply structure to buffer, using
65 ;; `org-list-write-struct'.
67 ;; 6. If changes made to the list might have modified check-boxes,
68 ;; call `org-update-checkbox-count-maybe'.
70 ;; Computing a structure can be a costly operation on huge lists (a
71 ;; few thousand lines long). Thus, code should follow the rule:
72 ;; "collect once, use many". As a corollary, it is usually a bad idea
73 ;; to use directly an interactive function inside the code, as those,
74 ;; being independent entities, read the whole list structure another
75 ;; time.
77 ;;; Code:
113 org-element-map "org-element"
163 \f
164 ;;; Configuration variables
167 "Options concerning plain lists in Org-mode."
172 "When t, make TAB cycle visibility on plain list items.
173 Cycling plain lists works only when the cursor is on a plain list
174 item. When the cursor is on an outline heading, plain lists are
175 treated as text. This is the most stable way of handling this,
176 which is why it is the default.
178 When this is the symbol `integrate', then integrate plain list
179 items when cycling, as if they were children of outline headings.
181 This setting can lead to strange effects when switching visibility
184 plain list item with an implied large level number, all true
185 children and grand children of the outline heading will be
186 exposed in a children' view."
195 "Default bullet type installed when demoting an item.
196 This is an association list, for each bullet type, this alist will point
197 to the bullet that should be used when this item is demoted.
198 For example,
200 (setq org-list-demote-modify-bullet
203 will make
205 + Movies
206 + Silence of the Lambs
207 + My Cousin Vinny
208 + Books
209 + The Hunt for Red October
210 + The Road to Omaha
212 into
214 + Movies
215 - Silence of the Lambs
216 - My Cousin Vinny
217 + Books
218 - The Hunt for Red October
219 - The Road to Omaha"
237 "The character that makes a line with leading number an ordered list item.
238 Valid values are ?. and ?\). To get both terminators, use t.
240 This variable needs to be set before org.el is loaded. If you
241 need to make a change while Emacs is running, use the customize
242 interface or run the following code after updating it:
253 "Non-nil means single character alphabetical bullets are allowed.
255 Both uppercase and lowercase are handled. Lists with more than
256 26 items will fallback to standard numbering. Alphabetical
259 This variable needs to be set before org.el is loaded. If you
260 need to make a change while Emacs is running, use the customize
261 interface or run the following code after updating it:
271 "A regular expression matching bullets that should have 2 spaces after them.
272 When nil, no bullet will have two spaces after them. When
273 a string, it will be used as a regular expression. When the
274 bullet type of a list is changed, the new bullet type will be
275 matched against this regexp. If it matches, there will be two
276 spaces instead of one after the bullet in each item of the list."
284 "Non-nil means apply set of rules when acting on lists.
285 By default, automatic actions are taken when using
290 rules by setting them to nil. Valid rules are:
292 checkbox when non-nil, checkbox statistics is updated each time
293 you either insert a new checkbox or toggle a checkbox.
294 indent when non-nil, indenting or outdenting list top-item
295 with its subtree will move the whole list and
296 outdenting a list whose bullet is * to column 0 will
301 :key-type
305 :value-type
309 "Non-nil means commands implying motion in lists should be cyclic.
311 In that case, the item following the last item is the first one,
312 and the item preceding the first item is the last one.
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."
344 "Additional indentation for sub-items in a list.
345 By setting this to a small number, usually 1 or 2, one can more
346 clearly distinguish sub-items in a list."
353 % END RECEIVE ORGLST %n
355 #+ORGLST: SEND %n org-list-to-latex
356 -
359 @c END RECEIVE ORGLST %n
360 @ignore
361 #+ORGLST: SEND %n org-list-to-texinfo
362 -
365 <!-- END RECEIVE ORGLST %n -->
366 <!--
367 #+ORGLST: SEND %n org-list-to-html
368 -
370 "Templates for radio lists in different major modes.
371 All occurrences of %n in a template will be replaced with the name of the
372 list, obtained by prompting the user."
379 "Names of blocks where lists are not allowed.
383 "Context types where lists will be interpreted during export.
385 Valid types are `drawer', `inlinetask' and `block'. More
386 specifically, type `block' is determined by the variable
390 \f
391 ;;; Predicates and regexps
401 "Matches a list item and puts everything into groups:
402 group 1: bullet
403 group 2: counter
404 group 3: checkbox
408 "Return the correct regular expression for plain lists."
419 "Regexp matching the beginning of a plain list item."
423 "Is point at a list item with REGEXP after bullet?"
432 ;; Ignore counter if any
437 "Is point in a context where lists are allowed?"
441 "Return item beginning position when in a plain list, nil otherwise."
450 ;; Indentation isn't meaningful when point starts at an empty
451 ;; line or an inline task.
454 10000
460 ;; Detect if cursor in amidst `org-list-end-re'. First, count
461 ;; number HL of hard lines it takes, then call `org-in-regexp'
462 ;; to compute its boundaries END-BOUNDS. When point is
463 ;; in-between, move cursor before regexp beginning.
474 ;; Look for an item, less indented that reference line.
479 ;; This is exactly what we want.
482 ;; At upper bound of search or looking at the end of a
483 ;; previous list: search is over.
486 ;; Skip blocks, drawers, inline-tasks, blank lines
496 ;; Text at column 0 cannot belong to a list: stop.
498 ;; Normal text less indented than reference line, take
499 ;; it as new reference.
506 "Is point in a line starting a hand-formatted item?"
512 "Is point at the bullet of a plain list item?"
518 "Is point at a line starting a plain list item with a timer?"
523 "Is point at a description list item?"
527 "Is point at a line starting a plain-list item with a checklet?"
531 "Is point at a line starting a plain-list item with a counter?"
537 \f
538 ;;; Structures and helper functions
541 "Determine context, and its boundaries, around point.
543 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
544 are boundaries and CONTEXT is a symbol among `drawer', `block',
545 `invalid', `inlinetask' and nil.
547 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
553 ;; Get positions of surrounding headings. This is the
554 ;; default context.
559 ;; Is point inside a drawer?
569 lim-down))
572 ;; Is point strictly in a block, and of which type?
583 lim-down))
589 ;; Is point in an inlinetask?
602 ;; Return context boundaries and type.
606 "Return structure of list at point.
608 A list structure is an alist where key is point at item, and
609 values are:
610 1. indentation,
611 2. bullet with trailing whitespace,
612 3. bullet counter, if any,
613 4. checkbox, if any,
614 5. description tag, if any,
615 6. position at item end.
617 Thus the following list, where numbers in parens are
618 point-at-bol:
620 - [X] first item (1)
621 1. sub-item 1 (18)
622 5. [@5] sub-item 2 (34)
623 some other text belonging to first item (55)
624 - last item (97)
625 + tag :: description (109)
626 (131)
628 will get the following structure:
636 Assume point is at an item."
648 itm-lst itm-lst-2 end-lst end-lst-2 struct
651 ;; Return association at point.
656 ind
657 bullet
660 ;; Description tag.
665 ;; Ensure list ends at the first blank line.
669 ;; 1. Read list from starting item to its beginning, and save
670 ;; top item position and indentation in BEG-CELL. Also store
671 ;; ending position of items in END-LST.
678 ;; At upward limit: if we ended at an item, store it,
679 ;; else dismiss useless data recorded above BEG-CELL.
680 ;; Jump to part 2.
687 ;; Looking at a list ending regexp. Dismiss useless
688 ;; data recorded above BEG-CELL. Jump to part 2.
693 ;; Point is at an item. Add data to ITM-LST. It may
694 ;; also end a previous item: save it in END-LST. If
695 ;; ind is less or equal than BEG-CELL and there is no
696 ;; end at this ind or lesser, this item becomes the new
697 ;; BEG-CELL.
703 ;; Skip blocks, drawers, inline tasks, blank lines.
714 ;; From there, point is not at an item. Interpret
715 ;; line's indentation:
716 ;; - text at column 0 is necessarily out of any list.
717 ;; Dismiss data recorded above BEG-CELL. Jump to
718 ;; part 2.
719 ;; - any other case may be an ending position for an
720 ;; hypothetical item above. Store it and proceed.
729 ;; 2. Read list from starting point to its end, that is until we
730 ;; get out of context, or that a non-item line is less or
731 ;; equally indented than BEG-CELL's cdr. Also, store ending
732 ;; position of items in END-LST-2.
738 ;; At downward limit: this is de facto the end of the
739 ;; list. Save point as an ending position, and jump to
740 ;; part 3.
743 ;; Looking at a list ending regexp. Save point as an
744 ;; ending position and jump to part 3.
748 ;; Point is at an item. Add data to ITM-LST-2. It may
749 ;; also end a previous item, so save it in END-LST-2.
753 ;; Skip inline tasks and blank lines along the way
758 ;; Ind is lesser or equal than BEG-CELL's. The list is
759 ;; over: store point as an ending position and jump to
760 ;; part 3.
764 ;; Else, if ind is lesser or equal than previous item's,
765 ;; this is an ending position: store it. In any case,
766 ;; skip block or drawer at point, and move to next line.
778 ;; 3. Associate each item to its end position.
780 ;; 4. Return STRUCT
781 struct)))
784 "Associate proper ending point to items in STRUCT.
786 END-LIST is a pseudo-alist where car is indentation and cdr is
787 ending position.
789 This function modifies STRUCT."
795 ;; Remove end candidates behind current item.
798 ;; Add end position to item assoc.
804 struct)))
807 "Return alist between item and previous item in STRUCT."
809 struct)))
813 struct)))
816 "Return alist between item and parent in STRUCT."
828 ;; A sub-list is over. Find the associated
829 ;; origin in IND-TO-ORI. If it cannot be
830 ;; found (ill-formed list), set its parent as
831 ;; the first item less indented. If there is
832 ;; none, make it a top-level item.
840 ind-to-ori)
843 ;; A sub-list starts. Every item at IND will
844 ;; have previous item as its parent.
849 ;; Another item in the same sub-list: it shares
850 ;; the same parent as the previous item.
855 \f
856 ;;; Accessors
859 "Return the Nth value of KEY in STRUCT."
863 "Set the Nth value of KEY in STRUCT to NEW.
868 "Return indentation of ITEM in STRUCT."
872 "Set indentation of ITEM in STRUCT to IND.
877 "Return bullet of ITEM in STRUCT."
881 "Set bullet of ITEM in STRUCT to BULLET.
886 "Return counter of ITEM in STRUCT."
890 "Return checkbox of ITEM in STRUCT or nil."
894 "Set checkbox of ITEM in STRUCT to CHECKBOX.
899 "Return end position of ITEM in STRUCT."
903 "Return end position of ITEM in STRUCT."
907 "Return point at end of ITEM in STRUCT, before any blank line.
908 Point returned is at end of line."
915 "Return parent of ITEM or nil.
916 STRUCT is the list structure. PARENTS is the alist of parents,
917 as returned by `org-list-parents-alist'."
922 "Non-nil if ITEM has a child.
924 STRUCT is the list structure.
926 Value returned is the position of the first child of ITEM."
931 child-maybe)))
934 "Return next item in same sub-list as ITEM, or nil.
935 STRUCT is the list structure. PREVS is the alist of previous
936 items, as returned by `org-list-prevs-alist'."
940 "Return previous item in same sub-list as ITEM, or nil.
941 STRUCT is the list structure. PREVS is the alist of previous
942 items, as returned by `org-list-prevs-alist'."
946 "List all items having ITEM as a common ancestor, or nil.
947 STRUCT is the list structure."
950 subtree)
955 sub-struct))
959 "List all items in the same sub-list as ITEM.
960 STRUCT is the list structure. PREVS is the alist of previous
961 items, as returned by `org-list-prevs-alist'."
964 before-item after-item)
972 "List all children of ITEM, or nil.
973 STRUCT is the list structure. PARENTS is the alist of parents,
974 as returned by `org-list-parents-alist'."
982 "Return point at beginning of list.
983 STRUCT is the list structure."
987 "Return point at bottom of list.
988 STRUCT is the list structure."
993 "Return point at beginning of sub-list ITEM belongs.
994 STRUCT is the list structure. PREVS is the alist of previous
995 items, as returned by `org-list-prevs-alist'."
999 first-item))
1004 "Return point at last item of sub-list ITEM belongs.
1005 STRUCT is the list structure. PREVS is the alist of previous
1006 items, as returned by `org-list-prevs-alist'."
1010 last-item))
1013 "Return point at end of sub-list ITEM belongs.
1014 STRUCT is the list structure. PREVS is the alist of previous
1015 items, as returned by `org-list-prevs-alist'."
1019 "Return the type of the list containing ITEM, as a symbol.
1021 STRUCT is the list structure. PREVS is the alist of previous
1022 items, as returned by `org-list-prevs-alist'.
1024 Possible types are `descriptive', `ordered' and `unordered'. The
1025 type is determined by the first item of the list."
1033 "Return ITEM's sequence number.
1035 STRUCT is the list structure. PREVS is the alist of previous
1036 items, as returned by `org-list-prevs-alist'. PARENTS is the
1037 alist of ancestors, as returned by `org-list-parents-alist'.
1039 Return value is a list of integers. Counters have an impact on
1040 that value."
1044 ;; Return relative sequence number of ITEM in the sub-list
1045 ;; it belongs. STRUCT is the list structure. PREVS is
1046 ;; the alist of previous items.
1055 seq))
1059 ;; Cons each parent relative number into return value (OUT).
1064 ;; Return value.
1065 out)))
1068 \f
1069 ;;; Searching
1072 "Search a string in valid contexts for lists.
1073 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1074 in `re-search-forward'."
1078 ;; 1. No match: return to origin or bound, depending on NOERR.
1081 nil)))
1082 ;; 2. Match in valid context: return point. Else, continue
1083 ;; searching.
1087 "Like `re-search-backward' but stop only where lists are recognized.
1088 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1089 `re-search-backward'."
1094 "Like `re-search-forward' but stop only where lists are recognized.
1095 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1096 `re-search-forward'."
1101 \f
1102 ;;; Methods on structures
1105 "Return BULLET with the correct number of whitespaces.
1106 It determines the number of whitespaces to append by looking at
1107 `org-list-two-spaces-after-bullet-regexp'."
1111 org-list-two-spaces-after-bullet-regexp bullet))
1112 " "
1116 bullet))))
1119 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1121 Blank lines at the end of items are left in place. Item
1122 visibility is preserved. Return the new structure after the
1123 changes.
1125 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1126 to the same sub-list.
1128 This function modifies STRUCT."
1141 ;; Store overlays responsible for visibility status. We
1142 ;; also need to store their boundaries as they will be
1143 ;; removed from buffer.
1158 ;; 1. Move effectively items in buffer.
1162 ;; 2. Now modify struct. No need to re-read the list, the
1163 ;; transformation is just a shift of positions. Some special
1164 ;; attention is required for items ending at END-A and END-B
1165 ;; as empty spaces are not moved there. In others words,
1166 ;; item BEG-A will end with whitespaces that were at the end
1167 ;; of BEG-B and the same applies to BEG-B.
1190 ;; Restore visibility status, by moving overlays to their new
1191 ;; position.
1201 ;; Return structure.
1202 struct)))
1205 "Return number of blank lines that should separate items in list.
1207 POS is the position of point where `org-list-insert-item' was called.
1209 STRUCT is the list structure. PREVS is the alist of previous
1210 items, as returned by `org-list-prevs-alist'.
1212 Assume point is at item's beginning. If the item is alone, apply
1213 some heuristics to guess the result."
1218 usr-blank
1222 ;; Count blank lines above beginning of line.
1229 ;; Trivial cases where there should be none.
1231 ;; When `org-blank-before-new-entry' says so, it is 1.
1233 ;; `plain-list-item' is 'auto. Count blank lines separating
1234 ;; neighbors' items in list.
1237 ;; Is there a next item?
1240 ;; Is there a previous item?
1243 ;; User inserted blank lines, trust him.
1248 usr-blank)
1249 ;; Are there blank lines inside the list so far?
1252 ;; Do not use `org-list-search-forward' so blank lines
1253 ;; in blocks can be counted in.
1257 ;; Default choice: no blank line.
1261 "Insert a new list item at POS and return the new structure.
1262 If POS is before first character after bullet of the item, the
1263 new item will be created before the current one.
1265 STRUCT is the list structure. PREVS is the alist of previous
1266 items, as returned by `org-list-prevs-alist'.
1268 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1269 after the bullet. Cursor will be after this text once the
1270 function ends.
1272 This function modifies STRUCT."
1274 ;; 1. Get information about list: position of point with regards
1275 ;; to item start (BEFOREP), blank lines number separating items
1276 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1283 (<= pos
1286 ;; Ignore tag in a non-descriptive list.
1295 pos struct prevs))
1296 ;; 2. Build the new item to be created. Concatenate same
1297 ;; bullet as item, checkbox, text AFTER-BULLET if
1298 ;; provided, and text cut from point to end of item
1299 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1300 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1301 ;; between what was cut and what was inserted in buffer
1302 ;; is stored in SIZE-OFFSET.
1306 ind))
1313 ;; If POS is greater than ITEM-END, then point is
1314 ;; in some white lines after the end of the list.
1315 ;; Those must be removed, or they will be left,
1316 ;; stacking up after the list.
1326 text-cut))))
1330 ;; 4. Insert effectively item into buffer.
1334 ;; 5. Add new item to STRUCT.
1338 ;; Before inserted item, positions don't change but
1339 ;; an item ending after insertion has its end shifted
1340 ;; by SIZE-OFFSET.
1343 ;; Trivial cases where current item isn't split in
1344 ;; two. Just shift every item after new one by
1345 ;; ITEM-SIZE.
1349 ;; Item is split in two: elements before POS are just
1350 ;; shifted by ITEM-SIZE. In the case item would end
1351 ;; after split POS, ending is only shifted by
1352 ;; SIZE-OFFSET.
1358 ;; Elements after POS are moved into new item.
1359 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1360 ;; doesn't appear in buffer yet.
1366 (+ end size-offset
1368 ;; Elements at ITEM-END or after are only shifted by
1369 ;; SIZE-OFFSET.
1372 struct)
1375 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1376 ;; exchange ITEM with the next item in list. Position cursor
1377 ;; after bullet, counter, checkbox, and label.
1383 struct)))
1386 "Remove ITEM from the list and return the new structure.
1388 STRUCT is the list structure."
1391 ;; If ITEM ends with the list, delete blank lines
1392 ;; before it.
1397 item)))
1398 ;; Remove item from buffer.
1400 ;; Remove item from structure and shift others items accordingly.
1401 ;; Don't forget to shift also ending position when appropriate.
1419 struct)))))
1422 "Send ITEM to destination DEST.
1424 STRUCT is the list structure.
1426 DEST can have various values.
1428 If DEST is a buffer position, the function will assume it points
1429 to another item in the same list as ITEM, and will move the
1430 latter just before the former.
1432 If DEST is `begin' (respectively `end'), ITEM will be moved at
1433 the beginning (respectively end) of the list it belongs to.
1436 be moved at the Nth position in the list.
1438 If DEST is `kill', ITEM will be deleted and its body will be
1439 added to the kill-ring.
1441 If DEST is `delete', ITEM will be deleted.
1443 Visibility of item is preserved.
1445 This function returns, destructively, the new list structure."
1448 ;; Grab full item body minus its bullet.
1457 item-end)))
1458 ;; Change DEST into a buffer position. A trick is needed
1459 ;; when ITEM is meant to be sent at the end of the list.
1460 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1461 ;; nil and insertion point (INS-POINT) to the first line's
1462 ;; end of the last item, we ensure the new item will be
1463 ;; inserted after the last item, and not after any of its
1464 ;; hypothetical sub-items.
1480 ;; Send ITEM at the end of the list.
1488 ;; Store inner overlays (to preserve visibility).
1500 ;; 1. Structure returned by `org-list-insert-item' may not be
1501 ;; accurate, as it cannot see sub-items included in BODY.
1502 ;; Thus, first compute the real structure so far.
1510 ;; 1.1. Remove the item just created in structure.
1512 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1515 struct
1523 new-end
1525 moved-items))
1527 ;; 2. Restore inner overlays.
1532 ;; 3. Eventually delete extra copy of the item and clean marker.
1538 "Outdent items between positions START and END.
1540 STRUCT is the list structure. PARENTS is the alist of items'
1541 parents, as returned by `org-list-parents-alist'.
1543 START is included, END excluded."
1549 ;; Item not yet in zone: keep association.
1551 ;; Item out of zone: follow associations in ACC.
1555 ;; Item has no parent: error
1558 ;; Parent is outdented: keep association.
1562 ;; Parent isn't outdented: reparent to grand-parent.
1564 parent struct parents)))
1570 "Indent items between positions START and END.
1572 STRUCT is the list structure. PARENTS is the alist of parents
1573 and PREVS is the alist of previous items, returned by,
1574 respectively, `org-list-parents-alist' and
1575 `org-list-prevs-alist'.
1577 START is included and END excluded.
1579 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1580 bullets between START and END."
1588 ;; Normalize ordered bullets.
1598 org-list-demote-modify-bullet))))
1605 ;; Item not yet in zone: keep association.
1608 ;; Item out of zone: follow associations in ACC.
1612 ;; Item is in zone...
1614 ;; Check if bullet needs to be changed.
1617 ;; First item indented but not parent: error
1620 ;; First item and parent indented: keep same
1621 ;; parent.
1623 ;; Previous item not indented: reparent to it.
1625 ;; Previous item indented: reparent like it.
1632 \f
1633 ;;; Repairing structures
1636 "Non-nil if list starting at FIRST can have alphabetical bullets.
1638 STRUCT is list structure. PREVS is the alist of previous items,
1639 as returned by `org-list-prevs-alist'."
1643 ;; Pretend that bullets are uppercase and check if alphabet
1644 ;; is sufficient, taking counters into account.
1647 ;; Virtually determine current bullet
1649 ;; Counters are not case-sensitive.
1652 ;; Test if bullet would be over z or Z.
1656 ;; All items checked. All good.
1657 t))))
1660 "Increment BULLET if applicable."
1663 ;; Num bullet: increment it.
1667 nil nil bullet))
1668 ;; Alpha bullet: increment it.
1672 nil nil bullet))
1673 ;; Unordered bullet: leave it.
1677 "Verify and correct bullets in STRUCT.
1678 PREVS is the alist of previous items, as returned by
1679 `org-list-prevs-alist'.
1681 This function modifies STRUCT."
1685 ;; Set bullet of ITEM in STRUCT, depending on the type of
1686 ;; first item of the list, the previous bullet and counter
1687 ;; if any.
1696 item struct
1699 ;; Alpha counter in alpha list: use counter.
1703 ;; Use cond to be sure `string-match' is used in
1704 ;; both cases.
1710 ;; Num counter in a num list: use counter.
1715 ;; No counter: increase, if needed, previous bullet.
1718 ;; Alpha counter at first item: use counter.
1727 ;; Num counter at first item: use counter.
1732 ;; First bullet is alpha uppercase: use "A".
1735 ;; First bullet is alpha lowercase: use "a".
1738 ;; First bullet is num: use "1".
1741 ;; Not an ordered list: keep bullet.
1746 "Verify and correct indentation in STRUCT.
1748 PARENTS is the alist of parents, as returned by
1749 `org-list-parents-alist'.
1751 If numeric optional argument BULLET-SIZE is set, assume all
1752 bullets in list have this length to determine new indentation.
1754 This function modifies STRUCT."
1761 ;; Indent like parent + length of parent's bullet +
1762 ;; sub-list offset.
1768 org-list-indent-offset))
1769 ;; If no parent, indent like top-point.
1774 "Verify and correct checkboxes in STRUCT.
1776 PARENTS is the alist of parents and PREVS is the alist of
1777 previous items, as returned by, respectively,
1778 `org-list-parents-alist' and `org-list-prevs-alist'.
1780 If ORDERED is non-nil, a checkbox can only be checked when every
1781 checkbox before it is checked too. If there was an attempt to
1782 break this rule, the function will return the blocking item. In
1783 all others cases, the return value will be nil.
1785 This function modifies STRUCT."
1795 item struct
1801 ;; Parent has no boxed child: leave box as-is.
1803 parent-list)
1804 ;; 1. List all parents with a checkbox.
1811 all-items)
1812 ;; 2. Sort those parents by decreasing indentation.
1817 ;; 3. For each parent, get all children's checkboxes to determine
1818 ;; and set its checkbox accordingly.
1820 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1825 ;; There are boxes checked after an unchecked one: fix that.
1832 ;; Verify once again the structure, without ORDERED.
1834 ;; Return blocking item.
1838 "Verify and correct each item end position in STRUCT.
1840 This function modifies STRUCT."
1847 ;; To determine real ind of an ending position that is
1848 ;; not at an item, we have to find the item it belongs
1849 ;; to: it is the last item (ITEM-UP), whose ending is
1850 ;; further than the position we're interested in.
1853 ;; Else part is for the bottom point.
1855 end-pos)
1856 end-list)))
1859 struct)
1864 "Apply set difference between STRUCT and OLD-STRUCT to the buffer.
1866 OLD-STRUCT is the structure before any modifications, and STRUCT
1867 the structure to be applied. The function will only modify parts
1868 of the list which have changed.
1870 Initial position of cursor is restored after the changes."
1877 ;; Shift the indentation between END and BEG by DELTA.
1878 ;; Start from the line before END.
1887 ;; Skip inline tasks.
1890 ;; Shift only non-empty lines.
1896 ;; Replace ITEM first line elements with new elements from
1897 ;; STRUCT, if appropriate.
1907 ;; a. Replace bullet
1910 ;; b. Replace checkbox.
1921 ;; c. Indent item to appropriate column.
1926 ;; 1. First get list of items and position endings. We maintain
1927 ;; two alists: ITM-SHIFT, determining indentation shift needed
1928 ;; at item, and END-LIST, a pseudo-alist where key is ending
1929 ;; position and value point.
1942 ;; To determine real ind of an ending position that
1943 ;; is not at an item, we have to find the item it
1944 ;; belongs to: it is the last item (ITEM-UP), whose
1945 ;; ending is further than the position we're
1946 ;; interested in.
1950 ;; 2. Slice the items into parts that should be shifted by the
1951 ;; same amount of indentation. Each slice follow the pattern
1952 ;; (END BEG DELTA). Slices are returned in reverse order.
1955 #'<)
1963 ;; If we're not at an item, there's a child of the
1964 ;; item point belongs to above. Make sure the less
1965 ;; indented line in this slice has the same column
1966 ;; as that child.
1973 ;; Ignore empty lines. Also ignore blocks and
1974 ;; drawers contents.
1982 down t)))
1985 down t)))))
1989 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1990 ;; end to beginning. Take a special action when beginning is
1991 ;; at item bullet.
1998 ;; 4. Go back to initial position and clean marker.
2003 "Correct bullets, checkboxes and indentation in list at point.
2005 STRUCT is the list structure. PARENTS is the alist of parents,
2006 as returned by `org-list-parents-alist'.
2008 When non-nil, optional argument OLD-STRUCT is the reference
2009 structure of the list. It should be provided whenever STRUCT
2010 doesn't correspond anymore to the real list in buffer."
2011 ;; Order of functions matters here: checkboxes and endings need
2012 ;; correct indentation to be set, and indentation needs correct
2013 ;; bullets.
2014 ;;
2015 ;; 0. Save a copy of structure before modifications
2017 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
2018 ;; order to get items endings and bullets properly
2020 ;; 2. Fix each item end to get correct prevs alist.
2022 ;; 3. Get bullets right.
2025 ;; 4. Now get real indentation.
2027 ;; 5. Eventually fix checkboxes.
2029 ;; 6. Apply structure modifications to buffer.
2033 \f
2034 ;;; Misc Tools
2037 "Call FUNCTION on each item of the list at point.
2038 FUNCTION must be called with at least one argument: INIT-VALUE,
2039 that will contain the value returned by the function at the
2040 previous item, plus ARGS extra arguments.
2042 FUNCTION is applied on items in reverse order.
2044 As an example, \(org-apply-on-list \(lambda \(result) \(1+ result)) 0)
2045 will return the number of items in the current list.
2047 Sublists of the list are skipped. Cursor is always at the
2048 beginning of the item."
2060 value))
2063 "Set visibility of ITEM in STRUCT to VIEW.
2065 Possible values are: `folded', `children' or `subtree'. See
2066 `org-cycle' for more information."
2070 ;; Hide from eol
2072 item-end t)))
2074 ;; First show everything.
2076 ;; Then fold every child.
2081 children)))
2083 ;; Show everything
2088 "Return column at which body of ITEM should start."
2100 2
2104 \f
2105 ;;; Interactive functions
2110 "Go to the beginning of the current item.
2111 Throw an error when not in a list."
2117 "Go to the beginning item of the current list or sublist.
2118 Throw an error when not in a list."
2129 "Go to the end of the current list or sublist.
2130 Throw an error when not in a list."
2141 "Go to the end of the current item.
2142 Throw an error when not in a list."
2152 "Move to the beginning of the previous item.
2153 Throw an error when not in a list. Also throw an error when at
2154 first item, unless `org-list-use-circular-motion' is non-nil."
2170 "Move to the beginning of the next item.
2171 Throw an error when not in a list. Also throw an error when at
2172 last item, unless `org-list-use-circular-motion' is non-nil."
2188 "Move the item at point down, i.e. swap with following item.
2189 Sub-items (items with larger indentation) are considered part of
2190 the item, so this really moves item trees."
2209 "Move the item at point up, i.e. swap with previous item.
2210 Sub-items (items with larger indentation) are considered part of
2211 the item, so this really moves item trees."
2228 "Insert a new item at the current level.
2229 If cursor is before first character after bullet of the item, the
2230 new item will be created before the current one.
2232 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2234 Return t when things worked, nil when we are not in an item, or
2235 item is invisible."
2238 ;; If cursor isn't is a list or if list is invisible, return nil.
2246 ;; Timer list: delegate to `org-timer-item'.
2251 ;; If we're in a description list, ask for the new term.
2265 t)))))
2268 "Fix indentation, bullets and checkboxes in the list at point."
2276 "Cycle through the different itemize/enumerate bullets.
2277 This cycle the entire list level through the sequence:
2279 `-' -> `+' -> `*' -> `1.' -> `1)'
2281 If WHICH is a valid string, use that as the new bullet. If WHICH
2282 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2283 `previous', cycle backwards."
2303 ;; Compute list of possible bullets, depending on context.
2306 ;; *-bullets are not allowed at column 0.
2308 ;; Description items cannot be numbered.
2331 ;; Use a short variation of `org-list-write-struct' as there's
2332 ;; no need to go through all the steps.
2340 "Toggle the checkbox in the current line.
2341 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2342 double prefix, set checkbox to [-].
2344 When there is an active region, toggle status or presence of the
2345 first checkbox there, and make every item inside have the same
2346 status or presence, respectively.
2348 If the cursor is in a headline, apply this to all checkbox items
2349 in the text below the heading, taking as reference the first item
2350 in subtree, ignoring drawers."
2354 block-item
2355 lim-up
2356 lim-down
2364 ;; In a region, start at first item in region.
2374 ;; On an heading, start at first item after drawers and
2375 ;; time-stamps (scheduled, etc.).
2387 ;; Just one item: set SINGLEP flag.
2393 ;; Determine the checkbox going to be applied to all items
2394 ;; within bounds.
2405 ;; When an item is found within bounds, grab the full list at
2406 ;; point structure, then: (1) set check-box of all its items
2407 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2408 ;; whole list, (3) move point after the list.
2422 e struct
2423 ;; If there is no box at item, leave as-is
2424 ;; unless function was called with C-u prefix.
2427 ref-checkbox
2428 cur-box))))
2429 items-to-toggle)
2431 struct parents prevs orderedp))
2432 ;; Report some problems due to ORDERED status of subtree.
2433 ;; If only one box was being checked, throw an error, else,
2434 ;; only signal problems.
2438 "Checkbox blocked because of unchecked box at line %d"
2442 "Checkboxes were removed due to unchecked box at line %d"
2451 "Reset all checkboxes in an entry subtree."
2468 "Update the checkbox statistics in the current section.
2470 This will find all statistic cookies like [57%] and [6/12] and
2471 update them with the current numbers.
2473 With optional prefix argument ALL, do this for the whole buffer."
2494 ;; Return number of checked boxes and boxes of all types
2495 ;; in all structures in STRUCTS. If RECURSIVEP is
2496 ;; non-nil, also count boxes in sub-lists. If ITEM is
2497 ;; nil, count across the whole structure, else count only
2498 ;; across subtree whose ancestor is ITEM.
2513 items))))
2516 cookies-list cache)
2517 ;; Move to start.
2521 ;; Build an alist for each cookie found. The key is the position
2522 ;; at beginning of cookie and values ending position, format of
2523 ;; cookie, number of checked boxes to report and total number of
2524 ;; boxes.
2534 context
2536 quote-block special-block verse-block)))
2552 structs)
2557 structs)
2558 ;; Skip whole list since we have its
2559 ;; structure anyway.
2564 end))))))
2565 ;; Cache count for cookies applying to the same
2566 ;; area. Then return it.
2573 structs
2574 recursivep)))
2576 count))))))
2577 cookies-list))))
2578 ;; Apply alist to buffer.
2594 "Select the face for checkbox statistics.
2595 The face will be `org-done' when all relevant boxes are checked.
2596 Otherwise it will be `org-todo'."
2599 'org-checkbox-statistics-done
2603 'org-checkbox-statistics-done
2607 "Update checkbox statistics unless turned off by user.
2608 With an optional argument ALL, update them in the whole buffer."
2616 "Indent a local list item including its children.
2617 When number ARG is a negative, item will be outdented, otherwise
2618 it will be indented.
2620 If a region is active, all items inside will be moved.
2622 If NO-SUBTREE is non-nil, only indent the item itself, not its
2623 children.
2625 STRUCT is the list structure.
2627 Return t if successful."
2635 ;; Are we going to move the whole list?
2643 t))))
2644 ;; Determine begin and end points of zone to indent. If moving
2645 ;; more than one item, save them for subsequent moves.
2661 ;; Special case: moving top-item with indent rule.
2669 ;; Change bullet if necessary.
2675 ;; Shift every item by OFFSET and fix bullets. Then
2676 ;; apply changes to buffer.
2680 struct)
2683 ;; Forbidden move:
2685 ;; If only one item is moved, it mustn't have a child.
2689 ;; If a subtree or region is moved, the last item
2690 ;; of the subtree mustn't have a child.
2695 struct)))))
2698 ;; Normal shifting
2706 t)
2709 "Outdent a local list item, but not its children.
2710 If a region is active, all items inside will be moved."
2726 "Indent a local list item, but not its children.
2727 If a region is active, all items inside will be moved."
2743 "Outdent a local list item including its children.
2744 If a region is active, all items inside will be moved."
2760 "Indent a local list item including its children.
2761 If a region is active, all items inside will be moved."
2779 "Cycle levels of indentation of an empty item.
2780 The first run indents the item, if applicable. Subsequent runs
2781 outdent it at meaningful levels in the list. When done, item is
2782 put back at its original position with its original bullet.
2784 Return t at each successful move."
2790 ;; Accept empty items or if cycle has already started.
2801 ;; When in the middle of the cycle, try to outdent first. If
2802 ;; it fails, and point is still at initial position, indent.
2803 ;; Else, re-create it at its original position.
2812 ;; Break cycle
2814 ;; If a cycle is starting, remember indentation and bullet,
2815 ;; then try to indent. If it fails, try to outdent.
2821 t))))
2824 "Sort list items.
2825 The cursor may be at any item of the list that should be sorted.
2826 Sublists are not sorted. Checkboxes, if any, are ignored.
2828 Sorting can be alphabetically, numerically, by date/time as given
2829 by a time stamp, by a property or by priority.
2831 Comparing entries ignores case by default. However, with an
2832 optional argument WITH-CASE, the sorting considers case as well.
2834 The command prompts for the sorting type unless it has been given
2835 to the function through the SORTING-TYPE argument, which needs to
2836 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F ?x ?X). Here is the
2837 detailed meaning of each character:
2839 n Numerically, by converting the beginning of the item to a number.
2840 a Alphabetically. Only the first line of item is checked.
2841 t By date/time, either the first active time stamp in the entry, if
2842 any, or by the first inactive one. In a timer list, sort the timers.
2845 Capital letters will reverse the sort order.
2847 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2848 a function to be called with point at the beginning of the
2849 record. It must return either a string or a number that should
2850 serve as the sorting key for that record. It will then use
2851 COMPARE-FUNC to compare entries.
2853 Sorting is done against the visible part of the headlines, it
2854 ignores hidden links."
2905 ;; If it is a timer list, convert timer to seconds
2922 value))
2926 next-record
2927 end-record
2928 value-to-sort
2929 nil
2930 sort-func)
2931 ;; Read and fix list again, as `sort-subr' probably destroyed
2932 ;; its structure.
2938 "Convert headings or normal lines to items, items to normal lines.
2939 If there is no active region, only the current line is considered.
2941 If the first non blank line in the region is a headline, convert
2942 all headlines to items, shifting text accordingly.
2944 If it is an item, convert all items to normal lines.
2946 If it is normal text, change region into a list of items.
2947 With a prefix argument ARG, change the region in a single item."
2951 ;; Shift text in current section to IND, from point to END.
2952 ;; The function leaves point to END line.
2954 ;; First determine the minimum indentation (MIN-I) of
2955 ;; the text.
2961 ;; Skip blank lines and inline tasks.
2964 ;; We can't find less than 0 indentation.
2968 ;; Then indent each line so that a line indented to
2969 ;; MIN-I becomes indented to IND. Ignore blank lines
2970 ;; and inline tasks in the process.
2979 ;; Return beginning of first non-blank line, starting from
2980 ;; line at POS.
2985 beg end)
2986 ;; Determine boundaries of changes.
2992 ;; Depending on the starting line, choose an action on the text
2993 ;; between BEG and END.
2998 ;; Case 1. Start at an item: de-itemize. Note that it only
2999 ;; happens when a region is active: `org-ctrl-c-minus'
3000 ;; would call `org-cycle-list-bullet' otherwise.
3007 ;; Case 2. Start at an heading: convert to items.
3011 ;; Indentation of the first heading. It should be
3012 ;; relative to the indentation of its parent, if any.
3018 ;; Level of first heading. Further headings will be
3019 ;; compared to it to determine hierarchy in the list.
3025 ;; If current headline is less indented than the first
3026 ;; one, set it as reference, in order to preserve
3027 ;; subtrees.
3029 ;; Remove stars and TODO keyword.
3035 ;; Turn TODO keyword into a check box.
3041 struct
3043 "[X]"
3047 old)))
3048 ;; Ensure all text down to END (or SECTION-END) belongs
3049 ;; to the newly created item.
3056 ;; Case 3. Normal line with ARG: make the first line of region
3057 ;; an item, and shift indentation of others lines to
3058 ;; set them as item's body.
3066 ;; Ensure that lines less indented than first one
3067 ;; still get included in item body.
3073 ;; Case 4. Normal line without ARG: turn each non-item line
3074 ;; into an item.
3083 \f
3084 ;;; Send and receive lists
3087 "Parse the list at point and maybe DELETE it.
3089 Return a list whose car is a symbol of list type, among
3090 `ordered', `unordered' and `descriptive'. Then, each item is
3091 a list of strings and other sub-lists.
3093 For example, the following list:
3095 1. first item
3096 + sub-item one
3097 + [X] sub-item two
3098 more text in first item
3099 2. [@3] last item
3101 is parsed as
3103 \(ordered
3105 \(unordered
3111 Point is left at list's end."
3119 ;; Remove indentation and final newline from TEXT.
3123 text))))
3126 ;; Return a list whose car is list type and cdr a list
3127 ;; of items' body.
3132 ;; Return a list containing counter of item, if any,
3133 ;; text and any sublist inside it.
3142 trim
3152 ;; Remove whole sub-list from children.
3154 ;; There is a chunk of text belonging to the item
3155 ;; if last child doesn't end where next child
3156 ;; starts or where item ends.
3161 trim
3163 body)))))
3165 ;; Store output, take care of cursor position and deletion of
3166 ;; list, then return output.
3175 "Convert the plain list at point into a subtree."
3183 "Insert a radio list template appropriate for this major mode."
3187 name pos)
3198 "Send a transformed version of this list to the receiver position.
3199 With argument MAYBE, fail quietly if no transformation is defined
3200 for this list."
3229 ;; Find the insertion(s) place(s).
3234 name))
3236 name)))
3253 "Convert a LIST parsed through `org-list-to-lisp' to a custom format.
3255 LIST is a list as returned by `org-list-to-lisp', which see.
3256 PARAMS is a property list of parameters used to tweak the output
3257 format.
3259 Valid parameters are:
3261 :backend, :raw
3263 Export back-end used as a basis to transcode elements of the
3264 list, when no specific parameter applies to it. It is also
3265 used to translate its contents. You can prevent this by
3266 setting :raw property to a non-nil value.
3268 :splice
3270 When non-nil, only export the contents of the top most plain
3271 list, effectively ignoring its opening and closing lines.
3273 :ustart, :uend
3275 Strings to start and end an unordered list. They can also be
3276 set to a function returning a string or nil, which will be
3277 called with the depth of the list, counting from 1.
3279 :ostart, :oend
3281 Strings to start and end an ordered list. They can also be set
3282 to a function returning a string or nil, which will be called
3283 with the depth of the list, counting from 1.
3285 :dstart, :dend
3287 Strings to start and end a descriptive list. They can also be
3288 set to a function returning a string or nil, which will be
3289 called with the depth of the list, counting from 1.
3291 :dtstart, :dtend, :ddstart, :ddend
3293 Strings to start and end a descriptive term.
3295 :istart, :iend
3297 Strings to start or end a list item, and to start a list item
3298 with a counter. They can also be set to a function returning
3299 a string or nil, which will be called with the depth of the
3300 item, counting from 1.
3302 :icount
3304 Strings to start a list item with a counter. It can also be
3305 set to a function returning a string or nil, which will be
3306 called with two arguments: the depth of the item, counting from
3307 1, and the counter. Its value, when non-nil, has precedence
3308 over `:istart'.
3310 :isep
3312 String used to separate items. It can also be set to
3313 a function returning a string or nil, which will be called with
3314 the depth of the items, counting from 1. It always start on
3315 a new line.
3317 :cbon, :cboff, :cbtrans
3319 String to insert, respectively, an un-checked check-box,
3320 a checked check-box and a check-box in transitional state."
3326 :transcoders
3330 data info)
3331 ;; Write LIST back into Org syntax and parse it.
3361 ;; When`:raw' property has a non-nil value, turn all objects back
3362 ;; into Org syntax.
3368 ;; We use a low-level mechanism to export DATA so as to skip all
3369 ;; usual pre-processing and post-processing, i.e., hooks, filters,
3370 ;; Babel code evaluation, include keywords and macro expansion,
3371 ;; and filters.
3373 ;; Remove final newline.
3377 "Return the level of ELEMENT within current plain list.
3378 ELEMENT is either an item or a plain list."
3383 "Return the number of trailing newlines in STRING."
3390 "Evaluate VALUE according to its type.
3391 VALUE is either nil, a string or a function. In the latter case,
3392 it is called with arguments ARGS."
3399 "Return a transcoder for `plain-list' elements.
3400 PARAMS is a plist used to tweak the behavior of the transcoder."
3418 depth)))
3425 depth))))
3426 ;; Make sure trailing newlines in END appear in the output by
3427 ;; setting `:post-blank' property to their number.
3431 ;; Build output.
3434 contents
3436 end)))))
3439 "Return a transcoder for `item' elements.
3440 PARAMS is a plist used to tweak the behavior of the transcoder."
3465 ;; When a closing line or a separator is provided, make sure
3466 ;; its trailing newlines are taken into account when building
3467 ;; output. This is done by setting `:post-blank' property to
3468 ;; the number of such lines in the last line to be added.
3472 item
3473 :post-blank
3475 ;; Build output.
3493 tag backend info)
3495 dtend))
3500 ;; Remove final newline.
3503 closing
3504 separator)))))
3507 "Convert LIST into a LaTeX list.
3508 LIST is a parsed plain list, as returned by `org-list-to-lisp'.
3509 Return converted list as a string."
3514 "Convert LIST into a HTML list.
3515 LIST is a parsed plain list, as returned by `org-list-to-lisp'.
3516 Return converted list as a string."
3521 "Convert LIST into a Texinfo list.
3522 LIST is a parsed plain list, as returned by `org-list-to-lisp'.
3523 Return converted list as a string."
3528 "Convert LIST into an Org subtree.
3529 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3530 with overruling parameters for `org-list-to-generic'."
3539 ;; Return the string for the heading, depending on DEPTH
3540 ;; of current sub-list.
3544 oddeven-level)
3545 ?*)
3548 list
3551 :istart make-stars
3552 :icount make-stars
3556 params))))
3560 ;;; org-list.el ends here