minirst: improve layout of field lists
Before, we used the padding following the key to compute where to wrap
the text. Long keys would thus give a big indentation. It also
required careful alignment of the source text, making it cumbersome to
items to the list.
We now compute the maximum key length and use that for all items in
the list. We also put a cap on the indentation: keys longer than 10
characters are put on their own line. This is similar to how rst2html
handles large keys: it uses 14 as the cutoff point, but I felt that 10
was better for monospaced text in the console.
paragraphs formatted to fit within 60 characters:
----------------------------------------------------------------------
This is some text in the first paragraph.
A small indented paragraph. It is followed by some lines
containing random whitespace.
The third and final paragraph.
----------------------------------------------------------------------
paragraphs formatted to fit within 30 characters:
----------------------------------------------------------------------
This is some text in the first
paragraph.
A small indented paragraph.
It is followed by some lines
containing random
whitespace.
The third and final paragraph.
----------------------------------------------------------------------
definitions formatted to fit within 60 characters:
----------------------------------------------------------------------
A Term
Definition. The indented lines make up the definition.
Another Term
Another definition. The final line in the definition
determines the indentation, so this will be indented
with four spaces.
A Nested/Indented Term
Definition.
----------------------------------------------------------------------
definitions formatted to fit within 30 characters:
----------------------------------------------------------------------
A Term
Definition. The indented
lines make up the
definition.
Another Term
Another definition. The
final line in the
definition determines the
indentation, so this will
be indented with four
spaces.
A Nested/Indented Term
Definition.
----------------------------------------------------------------------
literals formatted to fit within 60 characters:
----------------------------------------------------------------------
The fully minimized form is the most convenient form:
Hello
literal
world
In the partially minimized form a paragraph simply ends with
space-double-colon.
////////////////////////////////////////
long un-wrapped line in a literal block
\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
This literal block is started with '::',
the so-called expanded form. The paragraph
with '::' disappears in the final output.
----------------------------------------------------------------------
literals formatted to fit within 30 characters:
----------------------------------------------------------------------
The fully minimized form is
the most convenient form:
Hello
literal
world
In the partially minimized
form a paragraph simply ends
with space-double-colon.
////////////////////////////////////////
long un-wrapped line in a literal block
\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
This literal block is started with '::',
the so-called expanded form. The paragraph
with '::' disappears in the final output.
----------------------------------------------------------------------
lists formatted to fit within 60 characters:
----------------------------------------------------------------------
- This is the first list item.
Second paragraph in the first list item.
- List items need not be separated by a blank line.
- And will be rendered without one in any case.
We can have indented lists:
- This is an indented list item
- Another indented list item:
- A literal block in the middle
of an indented list.
(The above is not a list item since we are in the literal block.)
Literal block with no indentation (apart from
the two spaces added to all literal blocks).
1. This is an enumerated list (first item).
2. Continuing with the second item.
(1) foo
(2) bar
1) Another
2) List
----------------------------------------------------------------------
lists formatted to fit within 30 characters:
----------------------------------------------------------------------
- This is the first list item.
Second paragraph in the
first list item.
- List items need not be
separated by a blank line.
- And will be rendered without
one in any case.
We can have indented lists:
- This is an indented list
item
- Another indented list
item:
- A literal block in the middle
of an indented list.
(The above is not a list item since we are in the literal block.)
Literal block with no indentation (apart from
the two spaces added to all literal blocks).
1. This is an enumerated list
(first item).
2. Continuing with the second
item.
(1) foo
(2) bar
1) Another
2) List
----------------------------------------------------------------------
options formatted to fit within 60 characters:
----------------------------------------------------------------------
There is support for simple option lists, but only with long
options:
--all Output all.
--both Output both (this description is quite long).
--long Output all day long.
--par This option has two paragraphs in its
description. This is the first.
This is the second. Blank lines may be omitted
between options (as above) or left in (as here).
The next paragraph looks like an option list, but lacks the
two-space marker after the option. It is treated as a normal
paragraph:
--foo bar baz
----------------------------------------------------------------------
options formatted to fit within 30 characters:
----------------------------------------------------------------------
There is support for simple
option lists, but only with
long options:
--all Output all.
--both Output both (this
description is
quite long).
--long Output all day
long.
--par This option has two
paragraphs in its
description. This
is the first.
This is the second.
Blank lines may be
omitted between
options (as above)
or left in (as
here).
The next paragraph looks like
an option list, but lacks the
two-space marker after the
option. It is treated as a
normal paragraph:
--foo bar baz
----------------------------------------------------------------------
fields formatted to fit within 60 characters:
----------------------------------------------------------------------
a First item.
ab Second item. Indentation and wrapping is handled
automatically.
Next list:
small The larger key below triggers full indentation
here.
much too large
This key is big enough to get its own line.
----------------------------------------------------------------------
fields formatted to fit within 30 characters:
----------------------------------------------------------------------
a First item.
ab Second item. Indentation
and wrapping is handled
automatically.
Next list:
small The larger key
below triggers
full indentation
here.
much too large
This key is big
enough to get its
own line.
----------------------------------------------------------------------