[emacs-wiki-discuss] Nested list publishing ready for use and testing

[Michael Olson]

I've finally got nested list publishing into a state that I am happy
with.  Please feel free to test it and report any unexpected or
erroneous behavior.

The changes are in both the GNA archive for Muse and my own archive.

Here's a quick summary of the rules for nested lists.  Comments and
suggestions are welcome.  This will eventually make its way into the
Muse manual.

** Indentation and levels

 - Nesting of items depends solely on indentation of the initial list
   character, i.e. "1.", "-", "term ::".

 - TAB characters, space characters, and/or (in Emacs22) "special"
   whitespace characters are used to determine the level of an item.

 - Ordered and unordered lists have one initial space at the 0th
   level.

 - Definition lists have no initial spaces at the 0th level.

 - Consecutive items at different levels will be nested.

 - Items of the same type of last at the same level will be placed in
   the same containing list.

 - Paragraphs that follow definition list items on the 0th level will
   not be pulled into the definition list.

 - Thus, the following are all at the same level, and will not be
   nested.

______________________
 1. ordered list item

 - unordered list item

term :: definition

Paragraph text.
______________________

One consequence of this is that the following publishes two distinct
lists, rather than an unordered list nested inside of a definition
list.  The latter was an accidental side effect in some earlier Muse
releases.

__________________
foo ::
 - bar
 - baz
 - quux
__________________

To achieve the nested behavior, it is necessary to indent the
unordered list one extra level, as follows.

__________________
foo ::
  - bar
  - baz
  - quux
__________________

** Blank lines

 - One blank line is permitted between consecutive list items.

 - List items may optionally have no blank line separating them.

 - Two blank lines effectively delimit any list.

** Definition list peculiarities

 - A definition list consists of a term and zero or more definitions.

 - If a term has no corresponding definition, it will be published
   with an empty definition.

 - A definition is prefixed with at least one space, two colons
   ("::"), zero or more spaces, and optionally one newline.

 - Definitions may occur on the same line as a term, the consecutive
   line, or be separated by only one blank line.

 - If a definition has no term, it will be treated as a blockquote if
   it has one or more initial spaces, or a paragraph otherwise.

 - Definition lists may not (yet) be nested inside one another.  I am
   interested in hearing whether this behavior is desired.  Example
   text is good.

 - Definition lists should successfully nest inside other list types,
   and other list types may be nested inside of them.

-- 
Michael Olson -- FSF Associate Member #652 -- http://www.mwolson.org/
Interests: anime, manga, Debian, XHTML, wiki, Emacs Lisp
  /` |\ | | | IRC: mwolson on freenode.net: #hcoop, #muse, #PurdueLUG
 |_] | \| |_| Jabber: mwolson_at_hcoop.net

pgpskuqfhWK2G.pgp
Description: PGP signature