| blob | 0d688ef785bc19765ca8417413eb57231bf59faf |
1 ;;; org-list.el --- Plain lists for Org -*- lexical-binding: t; -*-
2 ;;
3 ;; Copyright (C) 2004-2019 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Bastien Guerry <bzg@gnu.org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: https://orgmode.org
9 ;;
10 ;; This file is part of GNU Emacs.
11 ;;
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
24 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
25 ;;
26 ;;; Commentary:
28 ;; This file contains the code dealing with plain lists in Org mode.
30 ;; The core concept behind lists is their structure. A structure is
31 ;; a snapshot of the list, in the shape of a data tree (see
32 ;; `org-list-struct').
34 ;; Once the list structure is stored, it is possible to make changes
35 ;; on it that will be mirrored to the real list or to get information
36 ;; about the list, using accessors and methods provided in the
37 ;; library. Most of them require the use of one or two helper
38 ;; functions, namely `org-list-parents-alist' and
39 ;; `org-list-prevs-alist'.
41 ;; Structure is eventually applied to the buffer with
42 ;; `org-list-write-struct'. This function repairs (bullets,
43 ;; indentation, checkboxes) the list in the process. It should be
44 ;; called near the end of any function working on structures.
46 ;; Thus, a function applying to lists should usually follow this
47 ;; template:
49 ;; 1. Verify point is in a list and grab item beginning (with the same
50 ;; function `org-in-item-p'). If the function requires the cursor
51 ;; to be at item's bullet, `org-at-item-p' is more selective. It
52 ;; is also possible to move point to the closest item with
53 ;; `org-list-search-backward', or `org-list-search-forward',
54 ;; applied to the function `org-item-beginning-re'.
56 ;; 2. Get list structure with `org-list-struct'.
58 ;; 3. Compute one, or both, helper functions,
59 ;; (`org-list-parents-alist', `org-list-prevs-alist') depending on
60 ;; needed accessors.
62 ;; 4. Proceed with the modifications, using methods and accessors.
64 ;; 5. Verify and apply structure to buffer, using
65 ;; `org-list-write-struct'.
67 ;; 6. If changes made to the list might have modified check-boxes,
68 ;; call `org-update-checkbox-count-maybe'.
70 ;; Computing a structure can be a costly operation on huge lists (a
71 ;; few thousand lines long). Thus, code should follow the rule:
72 ;; "collect once, use many". As a corollary, it is usually a bad idea
73 ;; to use directly an interactive function inside the code, as those,
74 ;; being independent entities, read the whole list structure another
75 ;; time.
77 ;;; Code:
111 (declare-function org-element-map "org-element" (data types fun &optional info first-match no-recursion with-affiliated))
149 \f
150 ;;; Configuration variables
153 "Options concerning plain lists in Org mode."
158 "When t, make TAB cycle visibility on plain list items.
159 Cycling plain lists works only when the cursor is on a plain list
160 item. When the cursor is on an outline heading, plain lists are
161 treated as text. This is the most stable way of handling this,
162 which is why it is the default.
164 When this is the symbol `integrate', then integrate plain list
165 items when cycling, as if they were children of outline headings.
167 This setting can lead to strange effects when switching visibility
170 plain list item with an implied large level number, all true
171 children and grand children of the outline heading will be
172 exposed in a children' view."
181 "Default bullet type installed when demoting an item.
182 This is an association list, for each bullet type, this alist will point
183 to the bullet that should be used when this item is demoted.
184 For example,
186 (setq org-list-demote-modify-bullet
189 will make
191 + Movies
192 + Silence of the Lambs
193 + My Cousin Vinny
194 + Books
195 + The Hunt for Red October
196 + The Road to Omaha
198 into
200 + Movies
201 - Silence of the Lambs
202 - My Cousin Vinny
203 + Books
204 - The Hunt for Red October
205 - The Road to Omaha"
223 "The character that makes a line with leading number an ordered list item.
224 Valid values are ?. and ?\). To get both terminators, use t.
226 This variable needs to be set before org.el is loaded. If you
227 need to make a change while Emacs is running, use the customize
228 interface or run the following code after updating it:
239 "Non-nil means single character alphabetical bullets are allowed.
241 Both uppercase and lowercase are handled. Lists with more than
242 26 items will fallback to standard numbering. Alphabetical
245 This variable needs to be set before org.el is loaded. If you
246 need to make a change while Emacs is running, use the customize
247 interface or run the following code after updating it:
257 "A regular expression matching bullets that should have 2 spaces after them.
258 When nil, no bullet will have two spaces after them. When
259 a string, it will be used as a regular expression. When the
260 bullet type of a list is changed, the new bullet type will be
261 matched against this regexp. If it matches, there will be two
262 spaces instead of one after the bullet in each item of the list."
270 "Non-nil means apply set of rules when acting on lists.
272 By default, automatic actions are taken when using
282 You can disable individually these rules by setting them to nil.
283 Valid rules are:
285 checkbox when non-nil, checkbox statistics is updated each time
286 you either insert a new checkbox or toggle a checkbox.
287 indent when non-nil, indenting or outdenting list top-item
288 with its subtree will move the whole list and
289 outdenting a list whose bullet is * to column 0 will
294 :key-type
298 :value-type
302 "Non-nil means commands implying motion in lists should be cyclic.
304 In that case, the item following the last item is the first one,
305 and the item preceding the first item is the last one.
307 This affects the behavior of
317 "Hook that is run whenever Org thinks checkbox statistics should be updated.
318 This hook runs even if checkbox rule in
319 `org-list-automatic-rules' does not apply, so it can be used to
320 implement alternative ways of collecting statistics
324 "Non-nil means checkbox statistics counts only the state of direct children.
325 When nil, all boxes below the cookie are counted.
326 This can be set to nil on a per-node basis using a COOKIE_DATA property
332 "Maximum indentation for the second line of a description list.
333 When the indentation would be larger than this, it will become
334 5 characters instead."
340 "Additional indentation for sub-items in a list.
341 By setting this to a small number, usually 1 or 2, one can more
342 clearly distinguish sub-items in a list."
348 "Names of blocks where lists are not allowed.
352 "Context types where lists will be interpreted during export.
354 Valid types are `drawer', `inlinetask' and `block'. More
355 specifically, type `block' is determined by the variable
359 \f
360 ;;; Predicates and regexps
370 "Matches a list item and puts everything into groups:
371 group 1: bullet
372 group 2: counter
373 group 3: checkbox
377 "Return the correct regular expression for plain lists."
388 "Regexp matching the beginning of a plain list item."
392 "Is point at a list item with REGEXP after bullet?"
401 ;; Ignore counter if any
406 "Is point in a context where lists are allowed?"
410 "Return item beginning position when in a plain list, nil otherwise."
419 ;; Indentation isn't meaningful when point starts at an empty
420 ;; line or an inline task.
423 10000
429 ;; Detect if cursor in amidst `org-list-end-re'. First, count
430 ;; number HL of hard lines it takes, then call `org-in-regexp'
431 ;; to compute its boundaries END-BOUNDS. When point is
432 ;; in-between, move cursor before regexp beginning.
443 ;; Look for an item, less indented that reference line.
448 ;; This is exactly what we want.
451 ;; At upper bound of search or looking at the end of a
452 ;; previous list: search is over.
455 ;; Skip blocks, drawers, inline-tasks, blank lines
465 ;; Text at column 0 cannot belong to a list: stop.
467 ;; Normal text less indented than reference line, take
468 ;; it as new reference.
475 "Is point in a line starting a hand-formatted item?"
481 "Is point at the bullet of a plain list item?"
487 "Is point at a line starting a plain list item with a timer?"
492 "Is point at a description list item?"
496 "Is point at a line starting a plain-list item with a checklet?"
500 "Is point at a line starting a plain-list item with a counter?"
506 \f
507 ;;; Structures and helper functions
510 "Determine context, and its boundaries, around point.
512 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
513 are boundaries and CONTEXT is a symbol among `drawer', `block',
514 `invalid', `inlinetask' and nil.
516 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
522 ;; Get positions of surrounding headings. This is the
523 ;; default context.
528 ;; Is point inside a drawer?
538 lim-down))
541 ;; Is point strictly in a block, and of which type?
552 lim-down))
558 ;; Is point in an inlinetask?
571 ;; Return context boundaries and type.
575 "Return structure of list at point.
577 A list structure is an alist where key is point at item, and
578 values are:
579 1. indentation,
580 2. bullet with trailing whitespace,
581 3. bullet counter, if any,
582 4. checkbox, if any,
583 5. description tag, if any,
584 6. position at item end.
586 Thus the following list, where numbers in parens are
587 point-at-bol:
589 - [X] first item (1)
590 1. sub-item 1 (18)
591 5. [@5] sub-item 2 (34)
592 some other text belonging to first item (55)
593 - last item (97)
594 + tag :: description (109)
595 (131)
597 will get the following structure:
605 Assume point is at an item."
617 itm-lst itm-lst-2 end-lst end-lst-2 struct
620 ;; Return association at point.
625 ind
626 bullet
629 ;; Description tag.
634 ;; Ensure list ends at the first blank line.
638 ;; 1. Read list from starting item to its beginning, and save
639 ;; top item position and indentation in BEG-CELL. Also store
640 ;; ending position of items in END-LST.
647 ;; At upward limit: if we ended at an item, store it,
648 ;; else dismiss useless data recorded above BEG-CELL.
649 ;; Jump to part 2.
656 ;; Looking at a list ending regexp. Dismiss useless
657 ;; data recorded above BEG-CELL. Jump to part 2.
662 ;; Point is at an item. Add data to ITM-LST. It may
663 ;; also end a previous item: save it in END-LST. If
664 ;; ind is less or equal than BEG-CELL and there is no
665 ;; end at this ind or lesser, this item becomes the new
666 ;; BEG-CELL.
672 ;; Skip blocks, drawers, inline tasks, blank lines.
683 ;; From there, point is not at an item. Interpret
684 ;; line's indentation:
685 ;; - text at column 0 is necessarily out of any list.
686 ;; Dismiss data recorded above BEG-CELL. Jump to
687 ;; part 2.
688 ;; - any other case may be an ending position for an
689 ;; hypothetical item above. Store it and proceed.
698 ;; 2. Read list from starting point to its end, that is until we
699 ;; get out of context, or that a non-item line is less or
700 ;; equally indented than BEG-CELL's cdr. Also, store ending
701 ;; position of items in END-LST-2.
707 ;; At downward limit: this is de facto the end of the
708 ;; list. Save point as an ending position, and jump to
709 ;; part 3.
712 ;; Looking at a list ending regexp. Save point as an
713 ;; ending position and jump to part 3.
717 ;; Point is at an item. Add data to ITM-LST-2. It may
718 ;; also end a previous item, so save it in END-LST-2.
722 ;; Skip inline tasks and blank lines along the way
727 ;; Ind is lesser or equal than BEG-CELL's. The list is
728 ;; over: store point as an ending position and jump to
729 ;; part 3.
733 ;; Else, if ind is lesser or equal than previous item's,
734 ;; this is an ending position: store it. In any case,
735 ;; skip block or drawer at point, and move to next line.
747 ;; 3. Associate each item to its end position.
749 ;; 4. Return STRUCT
750 struct)))
753 "Associate proper ending point to items in STRUCT.
755 END-LIST is a pseudo-alist where car is indentation and cdr is
756 ending position.
758 This function modifies STRUCT."
764 ;; Remove end candidates behind current item.
767 ;; Add end position to item assoc.
773 struct)))
776 "Return alist between item and previous item in STRUCT."
778 struct)))
782 struct)))
785 "Return alist between item and parent in STRUCT."
797 ;; A sub-list is over. Find the associated
798 ;; origin in IND-TO-ORI. If it cannot be
799 ;; found (ill-formed list), set its parent as
800 ;; the first item less indented. If there is
801 ;; none, make it a top-level item.
809 ind-to-ori)
812 ;; A sub-list starts. Every item at IND will
813 ;; have previous item as its parent.
818 ;; Another item in the same sub-list: it shares
819 ;; the same parent as the previous item.
824 "Delete metadata from the heading at point.
825 Metadata are tags, planning information and properties drawers."
835 \f
836 ;;; Accessors
839 "Return the Nth value of KEY in STRUCT."
843 "Set the Nth value of KEY in STRUCT to NEW.
848 "Return indentation of ITEM in STRUCT."
852 "Set indentation of ITEM in STRUCT to IND.
857 "Return bullet of ITEM in STRUCT."
861 "Set bullet of ITEM in STRUCT to BULLET.
866 "Return counter of ITEM in STRUCT."
870 "Return checkbox of ITEM in STRUCT or nil."
874 "Set checkbox of ITEM in STRUCT to CHECKBOX.
879 "Return end position of ITEM in STRUCT."
883 "Return end position of ITEM in STRUCT."
887 "Return point at end of ITEM in STRUCT, before any blank line.
888 Point returned is at end of line."
895 "Return parent of ITEM or nil.
896 STRUCT is the list structure. PARENTS is the alist of parents,
897 as returned by `org-list-parents-alist'."
902 "Non-nil if ITEM has a child.
904 STRUCT is the list structure.
906 Value returned is the position of the first child of ITEM."
911 child-maybe)))
914 "Return next 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 "Return previous item in same sub-list as ITEM, or nil.
921 STRUCT is the list structure. PREVS is the alist of previous
922 items, as returned by `org-list-prevs-alist'."
926 "List all items having ITEM as a common ancestor, or nil.
927 STRUCT is the list structure."
930 subtree)
935 sub-struct))
939 "List all items in the same sub-list as ITEM.
940 STRUCT is the list structure. PREVS is the alist of previous
941 items, as returned by `org-list-prevs-alist'."
944 before-item after-item)
952 "List all children of ITEM, or nil.
953 STRUCT is the list structure. PARENTS is the alist of parents,
954 as returned by `org-list-parents-alist'."
962 "Return point at beginning of list.
963 STRUCT is the list structure."
967 "Return point at bottom of list.
968 STRUCT is the list structure."
973 "Return point at beginning of sub-list ITEM belongs.
974 STRUCT is the list structure. PREVS is the alist of previous
975 items, as returned by `org-list-prevs-alist'."
979 first-item))
984 "Return point at last item of sub-list ITEM belongs.
985 STRUCT is the list structure. PREVS is the alist of previous
986 items, as returned by `org-list-prevs-alist'."
990 last-item))
993 "Return point at end 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 "Return the type of the list containing ITEM, as a symbol.
1001 STRUCT is the list structure. PREVS is the alist of previous
1002 items, as returned by `org-list-prevs-alist'.
1004 Possible types are `descriptive', `ordered' and `unordered'. The
1005 type is determined by the first item of the list."
1013 "Return ITEM's sequence number.
1015 STRUCT is the list structure. PREVS is the alist of previous
1016 items, as returned by `org-list-prevs-alist'. PARENTS is the
1017 alist of ancestors, as returned by `org-list-parents-alist'.
1019 Return value is a list of integers. Counters have an impact on
1020 that value."
1024 ;; Return relative sequence number of ITEM in the sub-list
1025 ;; it belongs. STRUCT is the list structure. PREVS is
1026 ;; the alist of previous items.
1035 seq))
1039 ;; Cons each parent relative number into return value (OUT).
1044 ;; Return value.
1045 out)))
1048 \f
1049 ;;; Searching
1052 "Search a string in valid contexts for lists.
1053 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1054 in `re-search-forward'."
1058 ;; 1. No match: return to origin or bound, depending on NOERR.
1061 nil)))
1062 ;; 2. Match in valid context: return point. Else, continue
1063 ;; searching.
1067 "Like `re-search-backward' but stop only where lists are recognized.
1068 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1069 `re-search-backward'."
1074 "Like `re-search-forward' but stop only where lists are recognized.
1075 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1076 `re-search-forward'."
1081 \f
1082 ;;; Methods on structures
1085 "Return BULLET with the correct number of whitespaces.
1086 It determines the number of whitespaces to append by looking at
1087 `org-list-two-spaces-after-bullet-regexp'."
1091 org-list-two-spaces-after-bullet-regexp bullet))
1092 " "
1096 bullet))))
1099 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1101 Blank lines at the end of items are left in place. Item
1102 visibility is preserved. Return the new structure after the
1103 changes.
1105 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1106 to the same sub-list.
1108 This function modifies STRUCT."
1121 ;; Store overlays responsible for visibility status. We
1122 ;; also need to store their boundaries as they will be
1123 ;; removed from buffer.
1138 ;; 1. Move effectively items in buffer.
1142 ;; 2. Now modify struct. No need to re-read the list, the
1143 ;; transformation is just a shift of positions. Some special
1144 ;; attention is required for items ending at END-A and END-B
1145 ;; as empty spaces are not moved there. In others words,
1146 ;; item BEG-A will end with whitespaces that were at the end
1147 ;; of BEG-B and the same applies to BEG-B.
1170 ;; Restore visibility status, by moving overlays to their new
1171 ;; position.
1181 ;; Return structure.
1182 struct)))
1185 "Return number of blank lines that should separate items in list.
1187 POS is the position of point where `org-list-insert-item' was called.
1189 STRUCT is the list structure. PREVS is the alist of previous
1190 items, as returned by `org-list-prevs-alist'.
1192 Assume point is at item's beginning. If the item is alone, apply
1193 some heuristics to guess the result."
1198 usr-blank
1202 ;; Count blank lines above beginning of line.
1209 ;; Trivial cases where there should be none.
1211 ;; When `org-blank-before-new-entry' says so, it is 1.
1213 ;; `plain-list-item' is 'auto. Count blank lines separating
1214 ;; neighbors' items in list.
1217 ;; Is there a next item?
1220 ;; Is there a previous item?
1223 ;; User inserted blank lines, trust him.
1228 usr-blank)
1229 ;; Are there blank lines inside the list so far?
1232 ;; Do not use `org-list-search-forward' so blank lines
1233 ;; in blocks can be counted in.
1237 ;; Default choice: no blank line.
1241 "Insert a new list item at POS and return the new structure.
1242 If POS is before first character after bullet of the item, the
1243 new item will be created before the current one.
1245 STRUCT is the list structure. PREVS is the alist of previous
1246 items, as returned by `org-list-prevs-alist'.
1248 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1249 after the bullet. Cursor will be after this text once the
1250 function ends.
1252 This function modifies STRUCT."
1254 ;; 1. Get information about list: ITEM containing POS, position of
1255 ;; point with regards to item start (BEFOREP), blank lines
1256 ;; number separating items (BLANK-NB), if we're allowed to
1257 ;; (SPLIT-LINE-P).
1265 inner-item))))
1271 (<= pos
1274 ;; Ignore tag in a non-descriptive list.
1283 pos struct prevs))
1284 ;; 2. Build the new item to be created. Concatenate same
1285 ;; bullet as item, checkbox, text AFTER-BULLET if
1286 ;; provided, and text cut from point to end of item
1287 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1288 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1289 ;; between what was cut and what was inserted in buffer
1290 ;; is stored in SIZE-OFFSET.
1294 ind))
1301 ;; If POS is greater than ITEM-END, then point is
1302 ;; in some white lines after the end of the list.
1303 ;; Those must be removed, or they will be left,
1304 ;; stacking up after the list.
1314 text-cut))))
1318 ;; 4. Insert effectively item into buffer.
1322 ;; 5. Add new item to STRUCT.
1326 ;; Before inserted item, positions don't change but
1327 ;; an item ending after insertion has its end shifted
1328 ;; by SIZE-OFFSET.
1331 ;; Trivial cases where current item isn't split in
1332 ;; two. Just shift every item after new one by
1333 ;; ITEM-SIZE.
1337 ;; Item is split in two: elements before POS are just
1338 ;; shifted by ITEM-SIZE. In the case item would end
1339 ;; after split POS, ending is only shifted by
1340 ;; SIZE-OFFSET.
1346 ;; Elements after POS are moved into new item.
1347 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1348 ;; doesn't appear in buffer yet.
1354 (+ end size-offset
1356 ;; Elements at ITEM-END or after are only shifted by
1357 ;; SIZE-OFFSET.
1360 struct)
1363 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1364 ;; exchange ITEM with the next item in list. Position cursor
1365 ;; after bullet, counter, checkbox, and label.
1371 struct)))
1374 "Remove ITEM from the list and return the new structure.
1376 STRUCT is the list structure."
1379 ;; If ITEM ends with the list, delete blank lines
1380 ;; before it.
1385 item)))
1386 ;; Remove item from buffer.
1388 ;; Remove item from structure and shift others items accordingly.
1389 ;; Don't forget to shift also ending position when appropriate.
1407 struct)))))
1410 "Send ITEM to destination DEST.
1412 STRUCT is the list structure.
1414 DEST can have various values.
1416 If DEST is a buffer position, the function will assume it points
1417 to another item in the same list as ITEM, and will move the
1418 latter just before the former.
1420 If DEST is `begin' (respectively `end'), ITEM will be moved at
1421 the beginning (respectively end) of the list it belongs to.
1424 be moved at the Nth position in the list.
1426 If DEST is `kill', ITEM will be deleted and its body will be
1427 added to the kill-ring.
1429 If DEST is `delete', ITEM will be deleted.
1431 Visibility of item is preserved.
1433 This function returns, destructively, the new list structure."
1436 ;; Grab full item body minus its bullet.
1445 item-end)))
1446 ;; Change DEST into a buffer position. A trick is needed
1447 ;; when ITEM is meant to be sent at the end of the list.
1448 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1449 ;; nil and insertion point (INS-POINT) to the first line's
1450 ;; end of the last item, we ensure the new item will be
1451 ;; inserted after the last item, and not after any of its
1452 ;; hypothetical sub-items.
1468 ;; Send ITEM at the end of the list.
1476 ;; Store inner overlays (to preserve visibility).
1488 ;; 1. Structure returned by `org-list-insert-item' may not be
1489 ;; accurate, as it cannot see sub-items included in BODY.
1490 ;; Thus, first compute the real structure so far.
1498 ;; 1.1. Remove the item just created in structure.
1500 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1503 struct
1511 new-end
1513 moved-items))
1515 ;; 2. Restore inner overlays.
1520 ;; 3. Eventually delete extra copy of the item and clean marker.
1526 "Outdent items between positions START and END.
1528 STRUCT is the list structure. PARENTS is the alist of items'
1529 parents, as returned by `org-list-parents-alist'.
1531 START is included, END excluded."
1537 ;; Item not yet in zone: keep association.
1539 ;; Item out of zone: follow associations in ACC.
1543 ;; Item has no parent: error
1546 ;; Parent is outdented: keep association.
1550 ;; Parent isn't outdented: reparent to grand-parent.
1552 parent struct parents)))
1558 "Indent items between positions START and END.
1560 STRUCT is the list structure. PARENTS is the alist of parents
1561 and PREVS is the alist of previous items, returned by,
1562 respectively, `org-list-parents-alist' and
1563 `org-list-prevs-alist'.
1565 START is included and END excluded.
1567 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1568 bullets between START and END."
1576 ;; Normalize ordered bullets.
1586 org-list-demote-modify-bullet))))
1593 ;; Item not yet in zone: keep association.
1596 ;; Item out of zone: follow associations in ACC.
1600 ;; Item is in zone...
1602 ;; Check if bullet needs to be changed.
1605 ;; First item indented but not parent: error
1608 ;; First item and parent indented: keep same
1609 ;; parent.
1611 ;; Previous item not indented: reparent to it.
1613 ;; Previous item indented: reparent like it.
1620 \f
1621 ;;; Repairing structures
1624 "Non-nil if list starting at FIRST can have alphabetical bullets.
1626 STRUCT is list structure. PREVS is the alist of previous items,
1627 as returned by `org-list-prevs-alist'."
1631 ;; Pretend that bullets are uppercase and check if alphabet
1632 ;; is sufficient, taking counters into account.
1635 ;; Virtually determine current bullet
1637 ;; Counters are not case-sensitive.
1640 ;; Test if bullet would be over z or Z.
1644 ;; All items checked. All good.
1645 t))))
1648 "Increment BULLET if applicable."
1651 ;; Num bullet: increment it.
1655 nil nil bullet))
1656 ;; Alpha bullet: increment it.
1660 nil nil bullet))
1661 ;; Unordered bullet: leave it.
1665 "Verify and correct bullets in STRUCT.
1666 PREVS is the alist of previous items, as returned by
1667 `org-list-prevs-alist'.
1669 This function modifies STRUCT."
1673 ;; Set bullet of ITEM in STRUCT, depending on the type of
1674 ;; first item of the list, the previous bullet and counter
1675 ;; if any.
1684 item struct
1687 ;; Alpha counter in alpha list: use counter.
1691 ;; Use cond to be sure `string-match' is used in
1692 ;; both cases.
1698 ;; Num counter in a num list: use counter.
1703 ;; No counter: increase, if needed, previous bullet.
1706 ;; Alpha counter at first item: use counter.
1715 ;; Num counter at first item: use counter.
1720 ;; First bullet is alpha uppercase: use "A".
1723 ;; First bullet is alpha lowercase: use "a".
1726 ;; First bullet is num: use "1".
1729 ;; Not an ordered list: keep bullet.
1734 "Verify and correct indentation in STRUCT.
1736 PARENTS is the alist of parents, as returned by
1737 `org-list-parents-alist'.
1739 If numeric optional argument BULLET-SIZE is set, assume all
1740 bullets in list have this length to determine new indentation.
1742 This function modifies STRUCT."
1749 ;; Indent like parent + length of parent's bullet +
1750 ;; sub-list offset.
1756 org-list-indent-offset))
1757 ;; If no parent, indent like top-point.
1762 "Verify and correct checkboxes in STRUCT.
1764 PARENTS is the alist of parents and PREVS is the alist of
1765 previous items, as returned by, respectively,
1766 `org-list-parents-alist' and `org-list-prevs-alist'.
1768 If ORDERED is non-nil, a checkbox can only be checked when every
1769 checkbox before it is checked too. If there was an attempt to
1770 break this rule, the function will return the blocking item. In
1771 all others cases, the return value will be nil.
1773 This function modifies STRUCT."
1783 item struct
1789 ;; Parent has no boxed child: leave box as-is.
1791 parent-list)
1792 ;; 1. List all parents with a checkbox.
1799 all-items)
1800 ;; 2. Sort those parents by decreasing indentation.
1805 ;; 3. For each parent, get all children's checkboxes to determine
1806 ;; and set its checkbox accordingly.
1808 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1813 ;; There are boxes checked after an unchecked one: fix that.
1820 ;; Verify once again the structure, without ORDERED.
1822 ;; Return blocking item.
1826 "Verify and correct each item end position in STRUCT.
1828 This function modifies STRUCT."
1835 ;; To determine real ind of an ending position that is
1836 ;; not at an item, we have to find the item it belongs
1837 ;; to: it is the last item (ITEM-UP), whose ending is
1838 ;; further than the position we're interested in.
1841 ;; Else part is for the bottom point.
1843 end-pos)
1844 end-list)))
1847 struct)
1852 "Apply set difference between STRUCT and OLD-STRUCT to the buffer.
1854 OLD-STRUCT is the structure before any modifications, and STRUCT
1855 the structure to be applied. The function will only modify parts
1856 of the list which have changed.
1858 Initial position of cursor is restored after the changes."
1865 ;; Shift the indentation between END and BEG by DELTA.
1866 ;; Start from the line before END.
1875 ;; Skip inline tasks.
1878 ;; Shift only non-empty lines.
1884 ;; Replace ITEM first line elements with new elements from
1885 ;; STRUCT, if appropriate.
1895 ;; a. Replace bullet
1898 ;; b. Replace checkbox.
1909 ;; c. Indent item to appropriate column.
1914 ;; 1. First get list of items and position endings. We maintain
1915 ;; two alists: ITM-SHIFT, determining indentation shift needed
1916 ;; at item, and END-LIST, a pseudo-alist where key is ending
1917 ;; position and value point.
1930 ;; To determine real ind of an ending position that
1931 ;; is not at an item, we have to find the item it
1932 ;; belongs to: it is the last item (ITEM-UP), whose
1933 ;; ending is further than the position we're
1934 ;; interested in.
1938 ;; 2. Slice the items into parts that should be shifted by the
1939 ;; same amount of indentation. Each slice follow the pattern
1940 ;; (END BEG DELTA). Slices are returned in reverse order.
1943 #'<)
1951 ;; If we're not at an item, there's a child of the
1952 ;; item point belongs to above. Make sure the less
1953 ;; indented line in this slice has the same column
1954 ;; as that child.
1961 ;; Ignore empty lines. Also ignore blocks and
1962 ;; drawers contents.
1970 down t)))
1973 down t)))))
1977 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1978 ;; end to beginning. Take a special action when beginning is
1979 ;; at item bullet.
1986 ;; 4. Go back to initial position and clean marker.
1991 "Correct bullets, checkboxes and indentation in list at point.
1993 STRUCT is the list structure. PARENTS is the alist of parents,
1994 as returned by `org-list-parents-alist'.
1996 When non-nil, optional argument OLD-STRUCT is the reference
1997 structure of the list. It should be provided whenever STRUCT
1998 doesn't correspond anymore to the real list in buffer."
1999 ;; Order of functions matters here: checkboxes and endings need
2000 ;; correct indentation to be set, and indentation needs correct
2001 ;; bullets.
2002 ;;
2003 ;; 0. Save a copy of structure before modifications
2005 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
2006 ;; order to get items endings and bullets properly
2008 ;; 2. Fix each item end to get correct prevs alist.
2010 ;; 3. Get bullets right.
2013 ;; 4. Now get real indentation.
2015 ;; 5. Eventually fix checkboxes.
2017 ;; 6. Apply structure modifications to buffer.
2019 ;; 7. Return the updated structure
2020 struct)
2023 \f
2024 ;;; Misc Tools
2027 "Call FUNCTION on each item of the list at point.
2028 FUNCTION must be called with at least one argument: INIT-VALUE,
2029 that will contain the value returned by the function at the
2030 previous item, plus ARGS extra arguments.
2032 FUNCTION is applied on items in reverse order.
2034 As an example, \(org-apply-on-list \(lambda \(result) \(1+ result)) 0)
2035 will return the number of items in the current list.
2037 Sublists of the list are skipped. Cursor is always at the
2038 beginning of the item."
2050 value))
2053 "Set visibility of ITEM in STRUCT to VIEW.
2055 Possible values are: `folded', `children' or `subtree'. See
2056 `org-cycle' for more information."
2060 ;; Hide from eol
2064 ;; First show everything.
2066 ;; Then fold every child.
2071 children)))
2073 ;; Show everything
2078 "Return column at which body of ITEM should start."
2085 ;; Descriptive list item. Body starts after item's tag, if
2086 ;; possible.
2091 start))
2092 ;; Regular item. Body starts after bullet.
2098 2
2102 \f
2103 ;;; Interactive functions
2108 "Go to the beginning of the current item.
2109 Throw an error when not in a list."
2115 "Go to the beginning item of the current list or sublist.
2116 Throw an error when not in a list."
2127 "Go to the end of the current list or sublist.
2128 Throw an error when not in a list."
2139 "Go to the end of the current item.
2140 Throw an error when not in a list."
2150 "Move to the beginning of the previous item.
2151 Throw an error when not in a list. Also throw an error when at
2152 first item, unless `org-list-use-circular-motion' is non-nil."
2168 "Move to the beginning of the next item.
2169 Throw an error when not in a list. Also throw an error when at
2170 last item, unless `org-list-use-circular-motion' is non-nil."
2186 "Move the item at point down, i.e. swap with following item.
2187 Sub-items (items with larger indentation) are considered part of
2188 the item, so this really moves item trees."
2207 "Move the item at point up, i.e. swap with previous item.
2208 Sub-items (items with larger indentation) are considered part of
2209 the item, so this really moves item trees."
2226 "Insert a new item at the current level.
2227 If cursor is before first character after bullet of the item, the
2228 new item will be created before the current one.
2230 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2232 Return t when things worked, nil when we are not in an item, or
2233 item is invisible."
2237 ;; If cursor isn't is a list or if list is invisible, return nil.
2245 ;; Timer list: delegate to `org-timer-item'.
2250 ;; If we're in a description list, ask for the new term.
2264 t)))))
2267 "Fix indentation, bullets and checkboxes in the list at point."
2275 "Cycle through the different itemize/enumerate bullets.
2276 This cycle the entire list level through the sequence:
2278 `-' -> `+' -> `*' -> `1.' -> `1)'
2280 If WHICH is a valid string, use that as the new bullet. If WHICH
2281 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2282 `previous', cycle backwards."
2302 ;; Compute list of possible bullets, depending on context.
2305 ;; *-bullets are not allowed at column 0.
2307 ;; Description items cannot be numbered.
2330 ;; Use a short variation of `org-list-write-struct' as there's
2331 ;; no need to go through all the steps.
2339 "Toggle the checkbox in the current line.
2341 With prefix argument TOGGLE-PRESENCE, add or remove checkboxes.
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 point is on a headline, apply this to all checkbox items in
2349 the text below the heading, taking as reference the first item in
2350 subtree, ignoring planning line and any drawer following it."
2354 block-item
2355 lim-up
2356 lim-down
2359 ;; In a region, start at first item in region.
2369 ;; On a heading, start at first item after drawers and
2370 ;; time-stamps (scheduled, etc.).
2377 ;; Just one item: set SINGLEP flag.
2383 ;; Determine the checkbox going to be applied to all items
2384 ;; within bounds.
2395 ;; When an item is found within bounds, grab the full list at
2396 ;; point structure, then: (1) set check-box of all its items
2397 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2398 ;; whole list, (3) move point after the list.
2412 e struct
2413 ;; If there is no box at item, leave as-is
2414 ;; unless function was called with C-u prefix.
2417 ref-checkbox
2418 cur-box))))
2419 items-to-toggle)
2421 struct parents prevs orderedp))
2422 ;; Report some problems due to ORDERED status of subtree.
2423 ;; If only one box was being checked, throw an error, else,
2424 ;; only signal problems.
2428 "Checkbox blocked because of unchecked box at line %d"
2432 "Checkboxes were removed due to unchecked box at line %d"
2441 "Reset all checkboxes in an entry subtree."
2458 "Update the checkbox statistics in the current section.
2460 This will find all statistic cookies like [57%] and [6/12] and
2461 update them with the current numbers.
2463 With optional prefix argument ALL, do this for the whole buffer."
2484 ;; Return number of checked boxes and boxes of all types
2485 ;; in all structures in STRUCTS. If RECURSIVEP is
2486 ;; non-nil, also count boxes in sub-lists. If ITEM is
2487 ;; nil, count across the whole structure, else count only
2488 ;; across subtree whose ancestor is ITEM.
2503 items))))
2506 cookies-list cache)
2507 ;; Move to start.
2511 ;; Build an alist for each cookie found. The key is the position
2512 ;; at beginning of cookie and values ending position, format of
2513 ;; cookie, number of checked boxes to report and total number of
2514 ;; boxes.
2524 context
2526 quote-block special-block verse-block)))
2542 structs)
2547 structs)
2548 ;; Skip whole list since we have its
2549 ;; structure anyway.
2554 end))))))
2555 ;; Cache count for cookies applying to the same
2556 ;; area. Then return it.
2563 structs
2564 recursivep)))
2566 count))))))
2567 cookies-list))))
2568 ;; Apply alist to buffer.
2584 "Select the face for checkbox statistics.
2585 The face will be `org-done' when all relevant boxes are checked.
2586 Otherwise it will be `org-todo'."
2589 'org-checkbox-statistics-done
2593 'org-checkbox-statistics-done
2597 "Update checkbox statistics unless turned off by user.
2598 With an optional argument ALL, update them in the whole buffer."
2606 "Indent a local list item including its children.
2607 When number ARG is a negative, item will be outdented, otherwise
2608 it will be indented.
2610 If a region is active, all items inside will be moved.
2612 If NO-SUBTREE is non-nil, only indent the item itself, not its
2613 children.
2615 STRUCT is the list structure.
2617 Return t if successful."
2625 ;; Are we going to move the whole list?
2633 t))))
2634 ;; Determine begin and end points of zone to indent. If moving
2635 ;; more than one item, save them for subsequent moves.
2651 ;; Special case: moving top-item with indent rule.
2659 ;; Change bullet if necessary.
2665 ;; Shift every item by OFFSET and fix bullets. Then
2666 ;; apply changes to buffer.
2670 struct)
2673 ;; Forbidden move:
2675 ;; If only one item is moved, it mustn't have a child.
2679 ;; If a subtree or region is moved, the last item
2680 ;; of the subtree mustn't have a child.
2685 struct)))))
2688 ;; Normal shifting
2696 t)
2699 "Outdent a local list item, but not its children.
2700 If a region is active, all items inside will be moved."
2716 "Indent a local list item, but not its children.
2717 If a region is active, all items inside will be moved."
2733 "Outdent a local list item including its children.
2734 If a region is active, all items inside will be moved."
2750 "Indent a local list item including its children.
2751 If a region is active, all items inside will be moved."
2769 "Cycle levels of indentation of an empty item.
2770 The first run indents the item, if applicable. Subsequent runs
2771 outdent it at meaningful levels in the list. When done, item is
2772 put back at its original position with its original bullet.
2774 Return t at each successful move."
2780 ;; Accept empty items or if cycle has already started.
2791 ;; When in the middle of the cycle, try to outdent first. If
2792 ;; it fails, and point is still at initial position, indent.
2793 ;; Else, re-create it at its original position.
2802 ;; Break cycle
2804 ;; If a cycle is starting, remember indentation and bullet,
2805 ;; then try to indent. If it fails, try to outdent.
2811 t))))
2815 "Sort list items.
2816 The cursor may be at any item of the list that should be sorted.
2817 Sublists are not sorted. Checkboxes, if any, are ignored.
2819 Sorting can be alphabetically, numerically, by date/time as given
2820 by a time stamp, by a property or by priority.
2822 Comparing entries ignores case by default. However, with an
2823 optional argument WITH-CASE, the sorting considers case as well,
2824 if the current locale allows for it.
2826 The command prompts for the sorting type unless it has been given
2827 to the function through the SORTING-TYPE argument, which needs to
2828 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F ?x ?X). Here is the
2829 detailed meaning of each character:
2831 n Numerically, by converting the beginning of the item to a number.
2832 a Alphabetically. Only the first line of item is checked.
2833 t By date/time, either the first active time stamp in the entry, if
2834 any, or by the first inactive one. In a timer list, sort the timers.
2837 Capital letters will reverse the sort order.
2839 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2840 a function to be called with point at the beginning of the
2841 record. It must return a value that is compatible with COMPARE-FUNC,
2842 the function used to compare entries.
2844 Sorting is done against the visible part of the headlines, it
2845 ignores hidden links.
2847 A non-nil value for INTERACTIVE? is used to signal that this
2848 function is being called interactively."
2907 ;; If it is a timer list, convert timer to seconds
2924 value))
2928 next-record
2929 end-record
2930 value-to-sort
2931 nil
2932 sort-func)
2933 ;; Read and fix list again, as `sort-subr' probably destroyed
2934 ;; its structure.
2940 "Convert headings or normal lines to items, items to normal lines.
2941 If there is no active region, only the current line is considered.
2943 If the first non blank line in the region is a headline, convert
2944 all headlines to items, shifting text accordingly.
2946 If it is an item, convert all items to normal lines.
2948 If it is normal text, change region into a list of items.
2949 With a prefix argument ARG, change the region in a single item."
2953 ;; Shift text in current section to IND, from point to END.
2954 ;; The function leaves point to END line.
2956 ;; First determine the minimum indentation (MIN-I) of
2957 ;; the text.
2963 ;; Skip blank lines and inline tasks.
2966 ;; We can't find less than 0 indentation.
2970 ;; Then indent each line so that a line indented to
2971 ;; MIN-I becomes indented to IND. Ignore blank lines
2972 ;; and inline tasks in the process.
2981 ;; Return beginning of first non-blank line, starting from
2982 ;; line at POS.
2987 beg end)
2988 ;; Determine boundaries of changes.
2994 ;; Depending on the starting line, choose an action on the text
2995 ;; between BEG and END.
3000 ;; Case 1. Start at an item: de-itemize. Note that it only
3001 ;; happens when a region is active: `org-ctrl-c-minus'
3002 ;; would call `org-cycle-list-bullet' otherwise.
3009 ;; Case 2. Start at an heading: convert to items.
3011 ;; Remove metadata
3016 ;; Indentation of the first heading. It should be
3017 ;; relative to the indentation of its parent, if any.
3023 ;; Level of first heading. Further headings will be
3024 ;; compared to it to determine hierarchy in the list.
3030 ;; If current headline is less indented than the first
3031 ;; one, set it as reference, in order to preserve
3032 ;; subtrees.
3034 ;; Remove metadata
3037 ;; Remove stars and TODO keyword.
3043 ;; Turn TODO keyword into a check box.
3049 struct
3051 "[X]"
3055 old)))
3056 ;; Ensure all text down to END (or SECTION-END) belongs
3057 ;; to the newly created item.
3064 ;; Case 3. Normal line with ARG: make the first line of region
3065 ;; an item, and shift indentation of others lines to
3066 ;; set them as item's body.
3074 ;; Ensure that lines less indented than first one
3075 ;; still get included in item body.
3081 ;; Case 4. Normal line without ARG: turn each non-item line
3082 ;; into an item.
3091 \f
3092 ;;; Send and receive lists
3095 "Parse the list at point and maybe DELETE it.
3097 Return a list whose car is a symbol of list type, among
3098 `ordered', `unordered' and `descriptive'. Then, each item is
3099 a list of strings and other sub-lists.
3101 For example, the following list:
3103 1. first item
3104 + sub-item one
3105 + [X] sub-item two
3106 more text in first item
3107 2. [@3] last item
3109 is parsed as
3111 (ordered
3113 (unordered
3119 Point is left at list's end."
3127 ;; Remove indentation and final newline from TEXT.
3131 text))))
3134 ;; Return a list whose car is list type and cdr a list
3135 ;; of items' body.
3140 ;; Return a list containing counter of item, if any,
3141 ;; text and any sublist inside it.
3150 trim
3160 ;; Remove whole sub-list from children.
3162 ;; There is a chunk of text belonging to the item
3163 ;; if last child doesn't end where next child
3164 ;; starts or where item ends.
3169 trim
3171 body)))))
3173 ;; Store output, take care of cursor position and deletion of
3174 ;; list, then return output.
3183 "Convert the plain list at point into a subtree."
3191 "Convert a LIST parsed through `org-list-to-lisp' to a custom format.
3193 LIST is a list as returned by `org-list-to-lisp', which see.
3194 PARAMS is a property list of parameters used to tweak the output
3195 format.
3197 Valid parameters are:
3199 :backend, :raw
3201 Export back-end used as a basis to transcode elements of the
3202 list, when no specific parameter applies to it. It is also
3203 used to translate its contents. You can prevent this by
3204 setting :raw property to a non-nil value.
3206 :splice
3208 When non-nil, only export the contents of the top most plain
3209 list, effectively ignoring its opening and closing lines.
3211 :ustart, :uend
3213 Strings to start and end an unordered list. They can also be
3214 set to a function returning a string or nil, which will be
3215 called with the depth of the list, counting from 1.
3217 :ostart, :oend
3219 Strings to start and end an ordered list. They can also be set
3220 to a function returning a string or nil, which will be called
3221 with the depth of the list, counting from 1.
3223 :dstart, :dend
3225 Strings to start and end a descriptive list. They can also be
3226 set to a function returning a string or nil, which will be
3227 called with the depth of the list, counting from 1.
3229 :dtstart, :dtend, :ddstart, :ddend
3231 Strings to start and end a descriptive term.
3233 :istart, :iend
3235 Strings to start or end a list item, and to start a list item
3236 with a counter. They can also be set to a function returning
3237 a string or nil, which will be called with two arguments: the
3238 type of list and the depth of the item, counting from 1.
3240 :icount
3242 Strings to start a list item with a counter. It can also be
3243 set to a function returning a string or nil, which will be
3244 called with three arguments: the type of list, the depth of the
3245 item, counting from 1, and the counter. Its value, when
3246 non-nil, has precedence over `:istart'.
3248 :isep
3250 String used to separate items. It can also be set to
3251 a function returning a string or nil, which will be called with
3252 two arguments: the type of list and the depth of the item,
3253 counting from 1. It always start on a new line.
3255 :ifmt
3257 Function to be applied to the contents of every item. It is
3258 called with two arguments: the type of list and the contents.
3260 :cbon, :cboff, :cbtrans
3262 String to insert, respectively, an un-checked check-box,
3263 a checked check-box and a check-box in transitional state."
3269 :transcoders
3273 data info)
3274 ;; Write LIST back into Org syntax and parse it.
3304 ;; When`:raw' property has a non-nil value, turn all objects back
3305 ;; into Org syntax.
3311 ;; We use a low-level mechanism to export DATA so as to skip all
3312 ;; usual pre-processing and post-processing, i.e., hooks, filters,
3313 ;; Babel code evaluation, include keywords and macro expansion,
3314 ;; and filters.
3316 ;; Remove final newline.
3320 "Return the level of ELEMENT within current plain list.
3321 ELEMENT is either an item or a plain list."
3326 "Return the number of trailing newlines in STRING."
3333 "Evaluate VALUE according to its type.
3334 VALUE is either nil, a string or a function. In the latter case,
3335 it is called with arguments ARGS."
3342 "Return a transcoder for `plain-list' elements.
3343 PARAMS is a plist used to tweak the behavior of the transcoder."
3361 depth)))
3368 depth))))
3369 ;; Make sure trailing newlines in END appear in the output by
3370 ;; setting `:post-blank' property to their number.
3374 ;; Build output.
3377 contents
3379 end)))))
3382 "Return a transcoder for `item' elements.
3383 PARAMS is a plist used to tweak the behavior of the transcoder."
3409 ;; When a closing line or a separator is provided, make sure
3410 ;; its trailing newlines are taken into account when building
3411 ;; output. This is done by setting `:post-blank' property to
3412 ;; the number of such lines in the last line to be added.
3416 item
3417 :post-blank
3419 ;; Build output.
3437 tag backend info)
3439 dtend))
3445 contents))
3448 ;; Remove final newline.
3451 closing
3452 separator)))))
3455 "Convert LIST into a LaTeX list.
3456 LIST is a parsed plain list, as returned by `org-list-to-lisp'.
3457 PARAMS is a property list with overruling parameters for
3458 `org-list-to-generic'. Return converted list as a string."
3463 "Convert LIST into a HTML list.
3464 LIST is a parsed plain list, as returned by `org-list-to-lisp'.
3465 PARAMS is a property list with overruling parameters for
3466 `org-list-to-generic'. Return converted list as a string."
3471 "Convert LIST into a Texinfo list.
3472 LIST is a parsed plain list, as returned by `org-list-to-lisp'.
3473 PARAMS is a property list with overruling parameters for
3474 `org-list-to-generic'. Return converted list as a string."
3479 "Convert LIST into an Org plain list.
3480 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3481 with overruling parameters for `org-list-to-generic'."
3488 :icount make-item
3498 "Convert LIST into an Org subtree.
3499 LIST is as returned by `org-list-to-lisp'. PARAMS is a property
3500 list with overruling parameters for `org-list-to-generic'."
3509 ;; Return the string for the heading, depending on DEPTH
3510 ;; of current sub-list.
3514 oddeven-level)
3515 ?*)
3518 list
3521 :istart make-stars
3522 :icount make-stars
3526 params))))
3530 ;;; org-list.el ends here