| blob | a84452d30bca7685ad860692c0706be802b424ce |
1 ;;; org-list.el --- Plain lists for Org -*- lexical-binding: t; -*-
2 ;;
3 ;; Copyright (C) 2004-2017 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.
286 By default, automatic actions are taken when using
296 You can disable individually these rules by setting them to nil.
297 Valid rules are:
299 checkbox when non-nil, checkbox statistics is updated each time
300 you either insert a new checkbox or toggle a checkbox.
301 indent when non-nil, indenting or outdenting list top-item
302 with its subtree will move the whole list and
303 outdenting a list whose bullet is * to column 0 will
308 :key-type
312 :value-type
316 "Non-nil means commands implying motion in lists should be cyclic.
318 In that case, the item following the last item is the first one,
319 and the item preceding the first item is the last one.
321 This affects the behavior of
331 "Hook that is run whenever Org thinks checkbox statistics should be updated.
332 This hook runs even if checkbox rule in
333 `org-list-automatic-rules' does not apply, so it can be used to
334 implement alternative ways of collecting statistics
338 "Non-nil means checkbox statistics counts only the state of direct children.
339 When nil, all boxes below the cookie are counted.
340 This can be set to nil on a per-node basis using a COOKIE_DATA property
346 "Maximum indentation for the second line of a description list.
347 When the indentation would be larger than this, it will become
348 5 characters instead."
353 "Additional indentation for sub-items in a list.
354 By setting this to a small number, usually 1 or 2, one can more
355 clearly distinguish sub-items in a list."
362 % END RECEIVE ORGLST %n
364 #+ORGLST: SEND %n org-list-to-latex
365 -
368 @c END RECEIVE ORGLST %n
369 @ignore
370 #+ORGLST: SEND %n org-list-to-texinfo
371 -
374 <!-- END RECEIVE ORGLST %n -->
375 <!--
376 #+ORGLST: SEND %n org-list-to-html
377 -
379 "Templates for radio lists in different major modes.
380 All occurrences of %n in a template will be replaced with the name of the
381 list, obtained by prompting the user."
388 "Names of blocks where lists are not allowed.
392 "Context types where lists will be interpreted during export.
394 Valid types are `drawer', `inlinetask' and `block'. More
395 specifically, type `block' is determined by the variable
399 \f
400 ;;; Predicates and regexps
410 "Matches a list item and puts everything into groups:
411 group 1: bullet
412 group 2: counter
413 group 3: checkbox
417 "Return the correct regular expression for plain lists."
428 "Regexp matching the beginning of a plain list item."
432 "Is point at a list item with REGEXP after bullet?"
441 ;; Ignore counter if any
446 "Is point in a context where lists are allowed?"
450 "Return item beginning position when in a plain list, nil otherwise."
459 ;; Indentation isn't meaningful when point starts at an empty
460 ;; line or an inline task.
463 10000
469 ;; Detect if cursor in amidst `org-list-end-re'. First, count
470 ;; number HL of hard lines it takes, then call `org-in-regexp'
471 ;; to compute its boundaries END-BOUNDS. When point is
472 ;; in-between, move cursor before regexp beginning.
483 ;; Look for an item, less indented that reference line.
488 ;; This is exactly what we want.
491 ;; At upper bound of search or looking at the end of a
492 ;; previous list: search is over.
495 ;; Skip blocks, drawers, inline-tasks, blank lines
505 ;; Text at column 0 cannot belong to a list: stop.
507 ;; Normal text less indented than reference line, take
508 ;; it as new reference.
515 "Is point in a line starting a hand-formatted item?"
521 "Is point at the bullet of a plain list item?"
527 "Is point at a line starting a plain list item with a timer?"
532 "Is point at a description list item?"
536 "Is point at a line starting a plain-list item with a checklet?"
540 "Is point at a line starting a plain-list item with a counter?"
546 \f
547 ;;; Structures and helper functions
550 "Determine context, and its boundaries, around point.
552 Context will be a cell like (MIN MAX CONTEXT) where MIN and MAX
553 are boundaries and CONTEXT is a symbol among `drawer', `block',
554 `invalid', `inlinetask' and nil.
556 Contexts `block' and `invalid' refer to `org-list-forbidden-blocks'."
562 ;; Get positions of surrounding headings. This is the
563 ;; default context.
568 ;; Is point inside a drawer?
578 lim-down))
581 ;; Is point strictly in a block, and of which type?
592 lim-down))
598 ;; Is point in an inlinetask?
611 ;; Return context boundaries and type.
615 "Return structure of list at point.
617 A list structure is an alist where key is point at item, and
618 values are:
619 1. indentation,
620 2. bullet with trailing whitespace,
621 3. bullet counter, if any,
622 4. checkbox, if any,
623 5. description tag, if any,
624 6. position at item end.
626 Thus the following list, where numbers in parens are
627 point-at-bol:
629 - [X] first item (1)
630 1. sub-item 1 (18)
631 5. [@5] sub-item 2 (34)
632 some other text belonging to first item (55)
633 - last item (97)
634 + tag :: description (109)
635 (131)
637 will get the following structure:
645 Assume point is at an item."
657 itm-lst itm-lst-2 end-lst end-lst-2 struct
660 ;; Return association at point.
665 ind
666 bullet
669 ;; Description tag.
674 ;; Ensure list ends at the first blank line.
678 ;; 1. Read list from starting item to its beginning, and save
679 ;; top item position and indentation in BEG-CELL. Also store
680 ;; ending position of items in END-LST.
687 ;; At upward limit: if we ended at an item, store it,
688 ;; else dismiss useless data recorded above BEG-CELL.
689 ;; Jump to part 2.
696 ;; Looking at a list ending regexp. Dismiss useless
697 ;; data recorded above BEG-CELL. Jump to part 2.
702 ;; Point is at an item. Add data to ITM-LST. It may
703 ;; also end a previous item: save it in END-LST. If
704 ;; ind is less or equal than BEG-CELL and there is no
705 ;; end at this ind or lesser, this item becomes the new
706 ;; BEG-CELL.
712 ;; Skip blocks, drawers, inline tasks, blank lines.
723 ;; From there, point is not at an item. Interpret
724 ;; line's indentation:
725 ;; - text at column 0 is necessarily out of any list.
726 ;; Dismiss data recorded above BEG-CELL. Jump to
727 ;; part 2.
728 ;; - any other case may be an ending position for an
729 ;; hypothetical item above. Store it and proceed.
738 ;; 2. Read list from starting point to its end, that is until we
739 ;; get out of context, or that a non-item line is less or
740 ;; equally indented than BEG-CELL's cdr. Also, store ending
741 ;; position of items in END-LST-2.
747 ;; At downward limit: this is de facto the end of the
748 ;; list. Save point as an ending position, and jump to
749 ;; part 3.
752 ;; Looking at a list ending regexp. Save point as an
753 ;; ending position and jump to part 3.
757 ;; Point is at an item. Add data to ITM-LST-2. It may
758 ;; also end a previous item, so save it in END-LST-2.
762 ;; Skip inline tasks and blank lines along the way
767 ;; Ind is lesser or equal than BEG-CELL's. The list is
768 ;; over: store point as an ending position and jump to
769 ;; part 3.
773 ;; Else, if ind is lesser or equal than previous item's,
774 ;; this is an ending position: store it. In any case,
775 ;; skip block or drawer at point, and move to next line.
787 ;; 3. Associate each item to its end position.
789 ;; 4. Return STRUCT
790 struct)))
793 "Associate proper ending point to items in STRUCT.
795 END-LIST is a pseudo-alist where car is indentation and cdr is
796 ending position.
798 This function modifies STRUCT."
804 ;; Remove end candidates behind current item.
807 ;; Add end position to item assoc.
813 struct)))
816 "Return alist between item and previous item in STRUCT."
818 struct)))
822 struct)))
825 "Return alist between item and parent in STRUCT."
837 ;; A sub-list is over. Find the associated
838 ;; origin in IND-TO-ORI. If it cannot be
839 ;; found (ill-formed list), set its parent as
840 ;; the first item less indented. If there is
841 ;; none, make it a top-level item.
849 ind-to-ori)
852 ;; A sub-list starts. Every item at IND will
853 ;; have previous item as its parent.
858 ;; Another item in the same sub-list: it shares
859 ;; the same parent as the previous item.
864 \f
865 ;;; Accessors
868 "Return the Nth value of KEY in STRUCT."
872 "Set the Nth value of KEY in STRUCT to NEW.
877 "Return indentation of ITEM in STRUCT."
881 "Set indentation of ITEM in STRUCT to IND.
886 "Return bullet of ITEM in STRUCT."
890 "Set bullet of ITEM in STRUCT to BULLET.
895 "Return counter of ITEM in STRUCT."
899 "Return checkbox of ITEM in STRUCT or nil."
903 "Set checkbox of ITEM in STRUCT to CHECKBOX.
908 "Return end position of ITEM in STRUCT."
912 "Return end position of ITEM in STRUCT."
916 "Return point at end of ITEM in STRUCT, before any blank line.
917 Point returned is at end of line."
924 "Return parent of ITEM or nil.
925 STRUCT is the list structure. PARENTS is the alist of parents,
926 as returned by `org-list-parents-alist'."
931 "Non-nil if ITEM has a child.
933 STRUCT is the list structure.
935 Value returned is the position of the first child of ITEM."
940 child-maybe)))
943 "Return next item in same sub-list as ITEM, or nil.
944 STRUCT is the list structure. PREVS is the alist of previous
945 items, as returned by `org-list-prevs-alist'."
949 "Return previous item in same sub-list as ITEM, or nil.
950 STRUCT is the list structure. PREVS is the alist of previous
951 items, as returned by `org-list-prevs-alist'."
955 "List all items having ITEM as a common ancestor, or nil.
956 STRUCT is the list structure."
959 subtree)
964 sub-struct))
968 "List all items in the same sub-list as ITEM.
969 STRUCT is the list structure. PREVS is the alist of previous
970 items, as returned by `org-list-prevs-alist'."
973 before-item after-item)
981 "List all children of ITEM, or nil.
982 STRUCT is the list structure. PARENTS is the alist of parents,
983 as returned by `org-list-parents-alist'."
991 "Return point at beginning of list.
992 STRUCT is the list structure."
996 "Return point at bottom of list.
997 STRUCT is the list structure."
1002 "Return point at beginning of sub-list ITEM belongs.
1003 STRUCT is the list structure. PREVS is the alist of previous
1004 items, as returned by `org-list-prevs-alist'."
1008 first-item))
1013 "Return point at last item 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 last-item))
1022 "Return point at end of sub-list ITEM belongs.
1023 STRUCT is the list structure. PREVS is the alist of previous
1024 items, as returned by `org-list-prevs-alist'."
1028 "Return the type of the list containing ITEM, as a symbol.
1030 STRUCT is the list structure. PREVS is the alist of previous
1031 items, as returned by `org-list-prevs-alist'.
1033 Possible types are `descriptive', `ordered' and `unordered'. The
1034 type is determined by the first item of the list."
1042 "Return ITEM's sequence number.
1044 STRUCT is the list structure. PREVS is the alist of previous
1045 items, as returned by `org-list-prevs-alist'. PARENTS is the
1046 alist of ancestors, as returned by `org-list-parents-alist'.
1048 Return value is a list of integers. Counters have an impact on
1049 that value."
1053 ;; Return relative sequence number of ITEM in the sub-list
1054 ;; it belongs. STRUCT is the list structure. PREVS is
1055 ;; the alist of previous items.
1064 seq))
1068 ;; Cons each parent relative number into return value (OUT).
1073 ;; Return value.
1074 out)))
1077 \f
1078 ;;; Searching
1081 "Search a string in valid contexts for lists.
1082 Arguments SEARCH, RE, BOUND and NOERR are similar to those used
1083 in `re-search-forward'."
1087 ;; 1. No match: return to origin or bound, depending on NOERR.
1090 nil)))
1091 ;; 2. Match in valid context: return point. Else, continue
1092 ;; searching.
1096 "Like `re-search-backward' but stop only where lists are recognized.
1097 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1098 `re-search-backward'."
1103 "Like `re-search-forward' but stop only where lists are recognized.
1104 Arguments REGEXP, BOUND and NOERROR are similar to those used in
1105 `re-search-forward'."
1110 \f
1111 ;;; Methods on structures
1114 "Return BULLET with the correct number of whitespaces.
1115 It determines the number of whitespaces to append by looking at
1116 `org-list-two-spaces-after-bullet-regexp'."
1120 org-list-two-spaces-after-bullet-regexp bullet))
1121 " "
1125 bullet))))
1128 "Swap item starting at BEG-A with item starting at BEG-B in STRUCT.
1130 Blank lines at the end of items are left in place. Item
1131 visibility is preserved. Return the new structure after the
1132 changes.
1134 Assume BEG-A is lesser than BEG-B and that BEG-A and BEG-B belong
1135 to the same sub-list.
1137 This function modifies STRUCT."
1150 ;; Store overlays responsible for visibility status. We
1151 ;; also need to store their boundaries as they will be
1152 ;; removed from buffer.
1167 ;; 1. Move effectively items in buffer.
1171 ;; 2. Now modify struct. No need to re-read the list, the
1172 ;; transformation is just a shift of positions. Some special
1173 ;; attention is required for items ending at END-A and END-B
1174 ;; as empty spaces are not moved there. In others words,
1175 ;; item BEG-A will end with whitespaces that were at the end
1176 ;; of BEG-B and the same applies to BEG-B.
1199 ;; Restore visibility status, by moving overlays to their new
1200 ;; position.
1210 ;; Return structure.
1211 struct)))
1214 "Return number of blank lines that should separate items in list.
1216 POS is the position of point where `org-list-insert-item' was called.
1218 STRUCT is the list structure. PREVS is the alist of previous
1219 items, as returned by `org-list-prevs-alist'.
1221 Assume point is at item's beginning. If the item is alone, apply
1222 some heuristics to guess the result."
1227 usr-blank
1231 ;; Count blank lines above beginning of line.
1238 ;; Trivial cases where there should be none.
1240 ;; When `org-blank-before-new-entry' says so, it is 1.
1242 ;; `plain-list-item' is 'auto. Count blank lines separating
1243 ;; neighbors' items in list.
1246 ;; Is there a next item?
1249 ;; Is there a previous item?
1252 ;; User inserted blank lines, trust him.
1257 usr-blank)
1258 ;; Are there blank lines inside the list so far?
1261 ;; Do not use `org-list-search-forward' so blank lines
1262 ;; in blocks can be counted in.
1266 ;; Default choice: no blank line.
1270 "Insert a new list item at POS and return the new structure.
1271 If POS is before first character after bullet of the item, the
1272 new item will be created before the current one.
1274 STRUCT is the list structure. PREVS is the alist of previous
1275 items, as returned by `org-list-prevs-alist'.
1277 Insert a checkbox if CHECKBOX is non-nil, and string AFTER-BULLET
1278 after the bullet. Cursor will be after this text once the
1279 function ends.
1281 This function modifies STRUCT."
1283 ;; 1. Get information about list: position of point with regards
1284 ;; to item start (BEFOREP), blank lines number separating items
1285 ;; (BLANK-NB), if we're allowed to (SPLIT-LINE-P).
1292 (<= pos
1295 ;; Ignore tag in a non-descriptive list.
1304 pos struct prevs))
1305 ;; 2. Build the new item to be created. Concatenate same
1306 ;; bullet as item, checkbox, text AFTER-BULLET if
1307 ;; provided, and text cut from point to end of item
1308 ;; (TEXT-CUT) to form item's BODY. TEXT-CUT depends on
1309 ;; BEFOREP and SPLIT-LINE-P. The difference of size
1310 ;; between what was cut and what was inserted in buffer
1311 ;; is stored in SIZE-OFFSET.
1315 ind))
1322 ;; If POS is greater than ITEM-END, then point is
1323 ;; in some white lines after the end of the list.
1324 ;; Those must be removed, or they will be left,
1325 ;; stacking up after the list.
1335 text-cut))))
1339 ;; 4. Insert effectively item into buffer.
1343 ;; 5. Add new item to STRUCT.
1347 ;; Before inserted item, positions don't change but
1348 ;; an item ending after insertion has its end shifted
1349 ;; by SIZE-OFFSET.
1352 ;; Trivial cases where current item isn't split in
1353 ;; two. Just shift every item after new one by
1354 ;; ITEM-SIZE.
1358 ;; Item is split in two: elements before POS are just
1359 ;; shifted by ITEM-SIZE. In the case item would end
1360 ;; after split POS, ending is only shifted by
1361 ;; SIZE-OFFSET.
1367 ;; Elements after POS are moved into new item.
1368 ;; Length of ITEM-SEP has to be removed as ITEM-SEP
1369 ;; doesn't appear in buffer yet.
1375 (+ end size-offset
1377 ;; Elements at ITEM-END or after are only shifted by
1378 ;; SIZE-OFFSET.
1381 struct)
1384 ;; 6. If not BEFOREP, new item must appear after ITEM, so
1385 ;; exchange ITEM with the next item in list. Position cursor
1386 ;; after bullet, counter, checkbox, and label.
1392 struct)))
1395 "Remove ITEM from the list and return the new structure.
1397 STRUCT is the list structure."
1400 ;; If ITEM ends with the list, delete blank lines
1401 ;; before it.
1406 item)))
1407 ;; Remove item from buffer.
1409 ;; Remove item from structure and shift others items accordingly.
1410 ;; Don't forget to shift also ending position when appropriate.
1428 struct)))))
1431 "Send ITEM to destination DEST.
1433 STRUCT is the list structure.
1435 DEST can have various values.
1437 If DEST is a buffer position, the function will assume it points
1438 to another item in the same list as ITEM, and will move the
1439 latter just before the former.
1441 If DEST is `begin' (respectively `end'), ITEM will be moved at
1442 the beginning (respectively end) of the list it belongs to.
1445 be moved at the Nth position in the list.
1447 If DEST is `kill', ITEM will be deleted and its body will be
1448 added to the kill-ring.
1450 If DEST is `delete', ITEM will be deleted.
1452 Visibility of item is preserved.
1454 This function returns, destructively, the new list structure."
1457 ;; Grab full item body minus its bullet.
1466 item-end)))
1467 ;; Change DEST into a buffer position. A trick is needed
1468 ;; when ITEM is meant to be sent at the end of the list.
1469 ;; Indeed, by setting locally `org-M-RET-may-split-line' to
1470 ;; nil and insertion point (INS-POINT) to the first line's
1471 ;; end of the last item, we ensure the new item will be
1472 ;; inserted after the last item, and not after any of its
1473 ;; hypothetical sub-items.
1489 ;; Send ITEM at the end of the list.
1497 ;; Store inner overlays (to preserve visibility).
1509 ;; 1. Structure returned by `org-list-insert-item' may not be
1510 ;; accurate, as it cannot see sub-items included in BODY.
1511 ;; Thus, first compute the real structure so far.
1519 ;; 1.1. Remove the item just created in structure.
1521 ;; 1.2. Copy ITEM and any of its sub-items at NEW-ITEM.
1524 struct
1532 new-end
1534 moved-items))
1536 ;; 2. Restore inner overlays.
1541 ;; 3. Eventually delete extra copy of the item and clean marker.
1547 "Outdent items between positions START and END.
1549 STRUCT is the list structure. PARENTS is the alist of items'
1550 parents, as returned by `org-list-parents-alist'.
1552 START is included, END excluded."
1558 ;; Item not yet in zone: keep association.
1560 ;; Item out of zone: follow associations in ACC.
1564 ;; Item has no parent: error
1567 ;; Parent is outdented: keep association.
1571 ;; Parent isn't outdented: reparent to grand-parent.
1573 parent struct parents)))
1579 "Indent items between positions START and END.
1581 STRUCT is the list structure. PARENTS is the alist of parents
1582 and PREVS is the alist of previous items, returned by,
1583 respectively, `org-list-parents-alist' and
1584 `org-list-prevs-alist'.
1586 START is included and END excluded.
1588 STRUCT may be modified if `org-list-demote-modify-bullet' matches
1589 bullets between START and END."
1597 ;; Normalize ordered bullets.
1607 org-list-demote-modify-bullet))))
1614 ;; Item not yet in zone: keep association.
1617 ;; Item out of zone: follow associations in ACC.
1621 ;; Item is in zone...
1623 ;; Check if bullet needs to be changed.
1626 ;; First item indented but not parent: error
1629 ;; First item and parent indented: keep same
1630 ;; parent.
1632 ;; Previous item not indented: reparent to it.
1634 ;; Previous item indented: reparent like it.
1641 \f
1642 ;;; Repairing structures
1645 "Non-nil if list starting at FIRST can have alphabetical bullets.
1647 STRUCT is list structure. PREVS is the alist of previous items,
1648 as returned by `org-list-prevs-alist'."
1652 ;; Pretend that bullets are uppercase and check if alphabet
1653 ;; is sufficient, taking counters into account.
1656 ;; Virtually determine current bullet
1658 ;; Counters are not case-sensitive.
1661 ;; Test if bullet would be over z or Z.
1665 ;; All items checked. All good.
1666 t))))
1669 "Increment BULLET if applicable."
1672 ;; Num bullet: increment it.
1676 nil nil bullet))
1677 ;; Alpha bullet: increment it.
1681 nil nil bullet))
1682 ;; Unordered bullet: leave it.
1686 "Verify and correct bullets in STRUCT.
1687 PREVS is the alist of previous items, as returned by
1688 `org-list-prevs-alist'.
1690 This function modifies STRUCT."
1694 ;; Set bullet of ITEM in STRUCT, depending on the type of
1695 ;; first item of the list, the previous bullet and counter
1696 ;; if any.
1705 item struct
1708 ;; Alpha counter in alpha list: use counter.
1712 ;; Use cond to be sure `string-match' is used in
1713 ;; both cases.
1719 ;; Num counter in a num list: use counter.
1724 ;; No counter: increase, if needed, previous bullet.
1727 ;; Alpha counter at first item: use counter.
1736 ;; Num counter at first item: use counter.
1741 ;; First bullet is alpha uppercase: use "A".
1744 ;; First bullet is alpha lowercase: use "a".
1747 ;; First bullet is num: use "1".
1750 ;; Not an ordered list: keep bullet.
1755 "Verify and correct indentation in STRUCT.
1757 PARENTS is the alist of parents, as returned by
1758 `org-list-parents-alist'.
1760 If numeric optional argument BULLET-SIZE is set, assume all
1761 bullets in list have this length to determine new indentation.
1763 This function modifies STRUCT."
1770 ;; Indent like parent + length of parent's bullet +
1771 ;; sub-list offset.
1777 org-list-indent-offset))
1778 ;; If no parent, indent like top-point.
1783 "Verify and correct checkboxes in STRUCT.
1785 PARENTS is the alist of parents and PREVS is the alist of
1786 previous items, as returned by, respectively,
1787 `org-list-parents-alist' and `org-list-prevs-alist'.
1789 If ORDERED is non-nil, a checkbox can only be checked when every
1790 checkbox before it is checked too. If there was an attempt to
1791 break this rule, the function will return the blocking item. In
1792 all others cases, the return value will be nil.
1794 This function modifies STRUCT."
1804 item struct
1810 ;; Parent has no boxed child: leave box as-is.
1812 parent-list)
1813 ;; 1. List all parents with a checkbox.
1820 all-items)
1821 ;; 2. Sort those parents by decreasing indentation.
1826 ;; 3. For each parent, get all children's checkboxes to determine
1827 ;; and set its checkbox accordingly.
1829 ;; 4. If ORDERED is set, see if we need to uncheck some boxes.
1834 ;; There are boxes checked after an unchecked one: fix that.
1841 ;; Verify once again the structure, without ORDERED.
1843 ;; Return blocking item.
1847 "Verify and correct each item end position in STRUCT.
1849 This function modifies STRUCT."
1856 ;; To determine real ind of an ending position that is
1857 ;; not at an item, we have to find the item it belongs
1858 ;; to: it is the last item (ITEM-UP), whose ending is
1859 ;; further than the position we're interested in.
1862 ;; Else part is for the bottom point.
1864 end-pos)
1865 end-list)))
1868 struct)
1873 "Apply set difference between STRUCT and OLD-STRUCT to the buffer.
1875 OLD-STRUCT is the structure before any modifications, and STRUCT
1876 the structure to be applied. The function will only modify parts
1877 of the list which have changed.
1879 Initial position of cursor is restored after the changes."
1886 ;; Shift the indentation between END and BEG by DELTA.
1887 ;; Start from the line before END.
1896 ;; Skip inline tasks.
1899 ;; Shift only non-empty lines.
1905 ;; Replace ITEM first line elements with new elements from
1906 ;; STRUCT, if appropriate.
1916 ;; a. Replace bullet
1919 ;; b. Replace checkbox.
1930 ;; c. Indent item to appropriate column.
1935 ;; 1. First get list of items and position endings. We maintain
1936 ;; two alists: ITM-SHIFT, determining indentation shift needed
1937 ;; at item, and END-LIST, a pseudo-alist where key is ending
1938 ;; position and value point.
1951 ;; To determine real ind of an ending position that
1952 ;; is not at an item, we have to find the item it
1953 ;; belongs to: it is the last item (ITEM-UP), whose
1954 ;; ending is further than the position we're
1955 ;; interested in.
1959 ;; 2. Slice the items into parts that should be shifted by the
1960 ;; same amount of indentation. Each slice follow the pattern
1961 ;; (END BEG DELTA). Slices are returned in reverse order.
1964 #'<)
1972 ;; If we're not at an item, there's a child of the
1973 ;; item point belongs to above. Make sure the less
1974 ;; indented line in this slice has the same column
1975 ;; as that child.
1982 ;; Ignore empty lines. Also ignore blocks and
1983 ;; drawers contents.
1991 down t)))
1994 down t)))))
1998 ;; 3. Shift each slice in buffer, provided delta isn't 0, from
1999 ;; end to beginning. Take a special action when beginning is
2000 ;; at item bullet.
2007 ;; 4. Go back to initial position and clean marker.
2012 "Correct bullets, checkboxes and indentation in list at point.
2014 STRUCT is the list structure. PARENTS is the alist of parents,
2015 as returned by `org-list-parents-alist'.
2017 When non-nil, optional argument OLD-STRUCT is the reference
2018 structure of the list. It should be provided whenever STRUCT
2019 doesn't correspond anymore to the real list in buffer."
2020 ;; Order of functions matters here: checkboxes and endings need
2021 ;; correct indentation to be set, and indentation needs correct
2022 ;; bullets.
2023 ;;
2024 ;; 0. Save a copy of structure before modifications
2026 ;; 1. Set a temporary, but coherent with PARENTS, indentation in
2027 ;; order to get items endings and bullets properly
2029 ;; 2. Fix each item end to get correct prevs alist.
2031 ;; 3. Get bullets right.
2034 ;; 4. Now get real indentation.
2036 ;; 5. Eventually fix checkboxes.
2038 ;; 6. Apply structure modifications to buffer.
2042 \f
2043 ;;; Misc Tools
2046 "Call FUNCTION on each item of the list at point.
2047 FUNCTION must be called with at least one argument: INIT-VALUE,
2048 that will contain the value returned by the function at the
2049 previous item, plus ARGS extra arguments.
2051 FUNCTION is applied on items in reverse order.
2053 As an example, \(org-apply-on-list \(lambda \(result) \(1+ result)) 0)
2054 will return the number of items in the current list.
2056 Sublists of the list are skipped. Cursor is always at the
2057 beginning of the item."
2069 value))
2072 "Set visibility of ITEM in STRUCT to VIEW.
2074 Possible values are: `folded', `children' or `subtree'. See
2075 `org-cycle' for more information."
2079 ;; Hide from eol
2081 item-end t)))
2083 ;; First show everything.
2085 ;; Then fold every child.
2090 children)))
2092 ;; Show everything
2097 "Return column at which body of ITEM should start."
2104 ;; Descriptive list item. Body starts after item's tag, if
2105 ;; possible.
2110 start))
2111 ;; Regular item. Body starts after bullet.
2117 2
2121 \f
2122 ;;; Interactive functions
2127 "Go to the beginning of the current item.
2128 Throw an error when not in a list."
2134 "Go to the beginning item of the current list or sublist.
2135 Throw an error when not in a list."
2146 "Go to the end of the current list or sublist.
2147 Throw an error when not in a list."
2158 "Go to the end of the current item.
2159 Throw an error when not in a list."
2169 "Move to the beginning of the previous item.
2170 Throw an error when not in a list. Also throw an error when at
2171 first item, unless `org-list-use-circular-motion' is non-nil."
2187 "Move to the beginning of the next item.
2188 Throw an error when not in a list. Also throw an error when at
2189 last item, unless `org-list-use-circular-motion' is non-nil."
2205 "Move the item at point down, i.e. swap with following item.
2206 Sub-items (items with larger indentation) are considered part of
2207 the item, so this really moves item trees."
2226 "Move the item at point up, i.e. swap with previous item.
2227 Sub-items (items with larger indentation) are considered part of
2228 the item, so this really moves item trees."
2245 "Insert a new item at the current level.
2246 If cursor is before first character after bullet of the item, the
2247 new item will be created before the current one.
2249 If CHECKBOX is non-nil, add a checkbox next to the bullet.
2251 Return t when things worked, nil when we are not in an item, or
2252 item is invisible."
2256 ;; If cursor isn't is a list or if list is invisible, return nil.
2264 ;; Timer list: delegate to `org-timer-item'.
2269 ;; If we're in a description list, ask for the new term.
2283 t)))))
2286 "Fix indentation, bullets and checkboxes in the list at point."
2294 "Cycle through the different itemize/enumerate bullets.
2295 This cycle the entire list level through the sequence:
2297 `-' -> `+' -> `*' -> `1.' -> `1)'
2299 If WHICH is a valid string, use that as the new bullet. If WHICH
2300 is an integer, 0 means `-', 1 means `+' etc. If WHICH is
2301 `previous', cycle backwards."
2321 ;; Compute list of possible bullets, depending on context.
2324 ;; *-bullets are not allowed at column 0.
2326 ;; Description items cannot be numbered.
2349 ;; Use a short variation of `org-list-write-struct' as there's
2350 ;; no need to go through all the steps.
2358 "Toggle the checkbox in the current line.
2359 With prefix arg TOGGLE-PRESENCE, add or remove checkboxes. With
2360 double prefix, set checkbox to [-].
2362 When there is an active region, toggle status or presence of the
2363 first checkbox there, and make every item inside have the same
2364 status or presence, respectively.
2366 If the cursor is in a headline, apply this to all checkbox items
2367 in the text below the heading, taking as reference the first item
2368 in subtree, ignoring drawers."
2372 block-item
2373 lim-up
2374 lim-down
2382 ;; In a region, start at first item in region.
2392 ;; On an heading, start at first item after drawers and
2393 ;; time-stamps (scheduled, etc.).
2405 ;; Just one item: set SINGLEP flag.
2411 ;; Determine the checkbox going to be applied to all items
2412 ;; within bounds.
2423 ;; When an item is found within bounds, grab the full list at
2424 ;; point structure, then: (1) set check-box of all its items
2425 ;; within bounds to REF-CHECKBOX, (2) fix check-boxes of the
2426 ;; whole list, (3) move point after the list.
2440 e struct
2441 ;; If there is no box at item, leave as-is
2442 ;; unless function was called with C-u prefix.
2445 ref-checkbox
2446 cur-box))))
2447 items-to-toggle)
2449 struct parents prevs orderedp))
2450 ;; Report some problems due to ORDERED status of subtree.
2451 ;; If only one box was being checked, throw an error, else,
2452 ;; only signal problems.
2456 "Checkbox blocked because of unchecked box at line %d"
2460 "Checkboxes were removed due to unchecked box at line %d"
2469 "Reset all checkboxes in an entry subtree."
2486 "Update the checkbox statistics in the current section.
2488 This will find all statistic cookies like [57%] and [6/12] and
2489 update them with the current numbers.
2491 With optional prefix argument ALL, do this for the whole buffer."
2512 ;; Return number of checked boxes and boxes of all types
2513 ;; in all structures in STRUCTS. If RECURSIVEP is
2514 ;; non-nil, also count boxes in sub-lists. If ITEM is
2515 ;; nil, count across the whole structure, else count only
2516 ;; across subtree whose ancestor is ITEM.
2531 items))))
2534 cookies-list cache)
2535 ;; Move to start.
2539 ;; Build an alist for each cookie found. The key is the position
2540 ;; at beginning of cookie and values ending position, format of
2541 ;; cookie, number of checked boxes to report and total number of
2542 ;; boxes.
2552 context
2554 quote-block special-block verse-block)))
2570 structs)
2575 structs)
2576 ;; Skip whole list since we have its
2577 ;; structure anyway.
2582 end))))))
2583 ;; Cache count for cookies applying to the same
2584 ;; area. Then return it.
2591 structs
2592 recursivep)))
2594 count))))))
2595 cookies-list))))
2596 ;; Apply alist to buffer.
2612 "Select the face for checkbox statistics.
2613 The face will be `org-done' when all relevant boxes are checked.
2614 Otherwise it will be `org-todo'."
2617 'org-checkbox-statistics-done
2621 'org-checkbox-statistics-done
2625 "Update checkbox statistics unless turned off by user.
2626 With an optional argument ALL, update them in the whole buffer."
2634 "Indent a local list item including its children.
2635 When number ARG is a negative, item will be outdented, otherwise
2636 it will be indented.
2638 If a region is active, all items inside will be moved.
2640 If NO-SUBTREE is non-nil, only indent the item itself, not its
2641 children.
2643 STRUCT is the list structure.
2645 Return t if successful."
2653 ;; Are we going to move the whole list?
2661 t))))
2662 ;; Determine begin and end points of zone to indent. If moving
2663 ;; more than one item, save them for subsequent moves.
2679 ;; Special case: moving top-item with indent rule.
2687 ;; Change bullet if necessary.
2693 ;; Shift every item by OFFSET and fix bullets. Then
2694 ;; apply changes to buffer.
2698 struct)
2701 ;; Forbidden move:
2703 ;; If only one item is moved, it mustn't have a child.
2707 ;; If a subtree or region is moved, the last item
2708 ;; of the subtree mustn't have a child.
2713 struct)))))
2716 ;; Normal shifting
2724 t)
2727 "Outdent a local list item, but not its children.
2728 If a region is active, all items inside will be moved."
2744 "Indent a local list item, but not its children.
2745 If a region is active, all items inside will be moved."
2761 "Outdent a local list item including its children.
2762 If a region is active, all items inside will be moved."
2778 "Indent a local list item including its children.
2779 If a region is active, all items inside will be moved."
2797 "Cycle levels of indentation of an empty item.
2798 The first run indents the item, if applicable. Subsequent runs
2799 outdent it at meaningful levels in the list. When done, item is
2800 put back at its original position with its original bullet.
2802 Return t at each successful move."
2808 ;; Accept empty items or if cycle has already started.
2819 ;; When in the middle of the cycle, try to outdent first. If
2820 ;; it fails, and point is still at initial position, indent.
2821 ;; Else, re-create it at its original position.
2830 ;; Break cycle
2832 ;; If a cycle is starting, remember indentation and bullet,
2833 ;; then try to indent. If it fails, try to outdent.
2839 t))))
2843 "Sort list items.
2844 The cursor may be at any item of the list that should be sorted.
2845 Sublists are not sorted. Checkboxes, if any, are ignored.
2847 Sorting can be alphabetically, numerically, by date/time as given
2848 by a time stamp, by a property or by priority.
2850 Comparing entries ignores case by default. However, with an
2851 optional argument WITH-CASE, the sorting considers case as well.
2853 The command prompts for the sorting type unless it has been given
2854 to the function through the SORTING-TYPE argument, which needs to
2855 be a character, \(?n ?N ?a ?A ?t ?T ?f ?F ?x ?X). Here is the
2856 detailed meaning of each character:
2858 n Numerically, by converting the beginning of the item to a number.
2859 a Alphabetically. Only the first line of item is checked.
2860 t By date/time, either the first active time stamp in the entry, if
2861 any, or by the first inactive one. In a timer list, sort the timers.
2864 Capital letters will reverse the sort order.
2866 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
2867 a function to be called with point at the beginning of the
2868 record. It must return a value that is compatible with COMPARE-FUNC,
2869 the function used to compare entries.
2871 Sorting is done against the visible part of the headlines, it
2872 ignores hidden links.
2874 A non-nil value for INTERACTIVE? is used to signal that this
2875 function is being called interactively."
2934 ;; If it is a timer list, convert timer to seconds
2951 value))
2955 next-record
2956 end-record
2957 value-to-sort
2958 nil
2959 sort-func)
2960 ;; Read and fix list again, as `sort-subr' probably destroyed
2961 ;; its structure.
2967 "Convert headings or normal lines to items, items to normal lines.
2968 If there is no active region, only the current line is considered.
2970 If the first non blank line in the region is a headline, convert
2971 all headlines to items, shifting text accordingly.
2973 If it is an item, convert all items to normal lines.
2975 If it is normal text, change region into a list of items.
2976 With a prefix argument ARG, change the region in a single item."
2980 ;; Shift text in current section to IND, from point to END.
2981 ;; The function leaves point to END line.
2983 ;; First determine the minimum indentation (MIN-I) of
2984 ;; the text.
2990 ;; Skip blank lines and inline tasks.
2993 ;; We can't find less than 0 indentation.
2997 ;; Then indent each line so that a line indented to
2998 ;; MIN-I becomes indented to IND. Ignore blank lines
2999 ;; and inline tasks in the process.
3008 ;; Return beginning of first non-blank line, starting from
3009 ;; line at POS.
3014 beg end)
3015 ;; Determine boundaries of changes.
3021 ;; Depending on the starting line, choose an action on the text
3022 ;; between BEG and END.
3027 ;; Case 1. Start at an item: de-itemize. Note that it only
3028 ;; happens when a region is active: `org-ctrl-c-minus'
3029 ;; would call `org-cycle-list-bullet' otherwise.
3036 ;; Case 2. Start at an heading: convert to items.
3040 ;; Indentation of the first heading. It should be
3041 ;; relative to the indentation of its parent, if any.
3047 ;; Level of first heading. Further headings will be
3048 ;; compared to it to determine hierarchy in the list.
3054 ;; If current headline is less indented than the first
3055 ;; one, set it as reference, in order to preserve
3056 ;; subtrees.
3058 ;; Remove stars and TODO keyword.
3064 ;; Turn TODO keyword into a check box.
3070 struct
3072 "[X]"
3076 old)))
3077 ;; Ensure all text down to END (or SECTION-END) belongs
3078 ;; to the newly created item.
3085 ;; Case 3. Normal line with ARG: make the first line of region
3086 ;; an item, and shift indentation of others lines to
3087 ;; set them as item's body.
3095 ;; Ensure that lines less indented than first one
3096 ;; still get included in item body.
3102 ;; Case 4. Normal line without ARG: turn each non-item line
3103 ;; into an item.
3112 \f
3113 ;;; Send and receive lists
3116 "Parse the list at point and maybe DELETE it.
3118 Return a list whose car is a symbol of list type, among
3119 `ordered', `unordered' and `descriptive'. Then, each item is
3120 a list of strings and other sub-lists.
3122 For example, the following list:
3124 1. first item
3125 + sub-item one
3126 + [X] sub-item two
3127 more text in first item
3128 2. [@3] last item
3130 is parsed as
3132 (ordered
3134 (unordered
3140 Point is left at list's end."
3148 ;; Remove indentation and final newline from TEXT.
3152 text))))
3155 ;; Return a list whose car is list type and cdr a list
3156 ;; of items' body.
3161 ;; Return a list containing counter of item, if any,
3162 ;; text and any sublist inside it.
3171 trim
3181 ;; Remove whole sub-list from children.
3183 ;; There is a chunk of text belonging to the item
3184 ;; if last child doesn't end where next child
3185 ;; starts or where item ends.
3190 trim
3192 body)))))
3194 ;; Store output, take care of cursor position and deletion of
3195 ;; list, then return output.
3204 "Convert the plain list at point into a subtree."
3212 "Insert a radio list template appropriate for this major mode."
3216 name pos)
3227 "Send a transformed version of this list to the receiver position.
3228 With argument MAYBE, fail quietly if no transformation is defined
3229 for this list."
3258 ;; Find the insertion(s) place(s).
3263 name))
3265 name)))
3282 "Convert a LIST parsed through `org-list-to-lisp' to a custom format.
3284 LIST is a list as returned by `org-list-to-lisp', which see.
3285 PARAMS is a property list of parameters used to tweak the output
3286 format.
3288 Valid parameters are:
3290 :backend, :raw
3292 Export back-end used as a basis to transcode elements of the
3293 list, when no specific parameter applies to it. It is also
3294 used to translate its contents. You can prevent this by
3295 setting :raw property to a non-nil value.
3297 :splice
3299 When non-nil, only export the contents of the top most plain
3300 list, effectively ignoring its opening and closing lines.
3302 :ustart, :uend
3304 Strings to start and end an unordered list. They can also be
3305 set to a function returning a string or nil, which will be
3306 called with the depth of the list, counting from 1.
3308 :ostart, :oend
3310 Strings to start and end an ordered list. They can also be set
3311 to a function returning a string or nil, which will be called
3312 with the depth of the list, counting from 1.
3314 :dstart, :dend
3316 Strings to start and end a descriptive list. They can also be
3317 set to a function returning a string or nil, which will be
3318 called with the depth of the list, counting from 1.
3320 :dtstart, :dtend, :ddstart, :ddend
3322 Strings to start and end a descriptive term.
3324 :istart, :iend
3326 Strings to start or end a list item, and to start a list item
3327 with a counter. They can also be set to a function returning
3328 a string or nil, which will be called with two arguments: the
3329 type of list and the depth of the item, counting from 1.
3331 :icount
3333 Strings to start a list item with a counter. It can also be
3334 set to a function returning a string or nil, which will be
3335 called with three arguments: the type of list, the depth of the
3336 item, counting from 1, and the counter. Its value, when
3337 non-nil, has precedence over `:istart'.
3339 :isep
3341 String used to separate items. It can also be set to
3342 a function returning a string or nil, which will be called with
3343 two arguments: the type of list and the depth of the item,
3344 counting from 1. It always start on a new line.
3346 :ifmt
3348 Function to be applied to the contents of every item. It is
3349 called with two arguments: the type of list and the contents.
3351 :cbon, :cboff, :cbtrans
3353 String to insert, respectively, an un-checked check-box,
3354 a checked check-box and a check-box in transitional state."
3360 :transcoders
3364 data info)
3365 ;; Write LIST back into Org syntax and parse it.
3395 ;; When`:raw' property has a non-nil value, turn all objects back
3396 ;; into Org syntax.
3402 ;; We use a low-level mechanism to export DATA so as to skip all
3403 ;; usual pre-processing and post-processing, i.e., hooks, filters,
3404 ;; Babel code evaluation, include keywords and macro expansion,
3405 ;; and filters.
3407 ;; Remove final newline.
3411 "Return the level of ELEMENT within current plain list.
3412 ELEMENT is either an item or a plain list."
3417 "Return the number of trailing newlines in STRING."
3424 "Evaluate VALUE according to its type.
3425 VALUE is either nil, a string or a function. In the latter case,
3426 it is called with arguments ARGS."
3433 "Return a transcoder for `plain-list' elements.
3434 PARAMS is a plist used to tweak the behavior of the transcoder."
3452 depth)))
3459 depth))))
3460 ;; Make sure trailing newlines in END appear in the output by
3461 ;; setting `:post-blank' property to their number.
3465 ;; Build output.
3468 contents
3470 end)))))
3473 "Return a transcoder for `item' elements.
3474 PARAMS is a plist used to tweak the behavior of the transcoder."
3500 ;; When a closing line or a separator is provided, make sure
3501 ;; its trailing newlines are taken into account when building
3502 ;; output. This is done by setting `:post-blank' property to
3503 ;; the number of such lines in the last line to be added.
3507 item
3508 :post-blank
3510 ;; Build output.
3528 tag backend info)
3530 dtend))
3536 contents))
3539 ;; Remove final newline.
3542 closing
3543 separator)))))
3546 "Convert LIST into a LaTeX list.
3547 LIST is a parsed plain list, as returned by `org-list-to-lisp'.
3548 PARAMS is a property list with overruling parameters for
3549 `org-list-to-generic'. Return converted list as a string."
3554 "Convert LIST into a HTML list.
3555 LIST is a parsed plain list, as returned by `org-list-to-lisp'.
3556 PARAMS is a property list with overruling parameters for
3557 `org-list-to-generic'. Return converted list as a string."
3562 "Convert LIST into a Texinfo list.
3563 LIST is a parsed plain list, as returned by `org-list-to-lisp'.
3564 PARAMS is a property list with overruling parameters for
3565 `org-list-to-generic'. Return converted list as a string."
3570 "Convert LIST into an Org plain list.
3571 LIST is as returned by `org-list-parse-list'. PARAMS is a property list
3572 with overruling parameters for `org-list-to-generic'."
3579 :icount make-item
3589 "Convert LIST into an Org subtree.
3590 LIST is as returned by `org-list-to-lisp'. PARAMS is a property
3591 list with overruling parameters for `org-list-to-generic'."
3600 ;; Return the string for the heading, depending on DEPTH
3601 ;; of current sub-list.
3605 oddeven-level)
3606 ?*)
3609 list
3612 :istart make-stars
3613 :icount make-stars
3617 params))))
3621 ;;; org-list.el ends here