lists_tables.rst

Lists & Tables

Table of Contents

Lists

Enumerated Lists

1. Arabic numerals.
   1. lower alpha)
      1. (lower roman)
         1. upper alpha.
            1. upper roman)

2. Lists that don't start at 1:

   3. Three
   4. Four
   3. C
   4. D
   3. iii
   4. iv
3. List items may also be auto-enumerated.

Definition Lists

Term

Definition

Term : classifier

Definition paragraph 1.

Definition paragraph 2.

Term

Definition

Option Lists

For listing command-line options:

-a command-line option "a" -b file options can have arguments and long descriptions --long options can be long also --input=file long options can also have arguments

--very-long-option

The description can also start on the next line.

The description may contain multiple body elements, regardless of where it starts.

-x, -y, -z Multiple options are an "option group". -v, --verbose Commonly-seen: short & long options. -1 file, --one=file, --two file Multiple options with arguments. /V DOS/VMS-style options too

There must be at least two spaces between the option and the description.

Field list

Author

David Goodger

Address

123 Example Street Example, EX Canada A1B 2C3

Contact

docutils-develop@lists.sourceforge.net

Authors

Me; Myself; I

organization

humankind

date

$Date: 2012-01-03 19:23:53 +0000 (Tue, 03 Jan 2012) $

status

This is a "work in progress"

revision

$Revision: 7302 $

version

1

copyright

This document has been placed in the public domain. You may do with it as you wish. You may copy, modify, redistribute, reattribute, sell, buy, rent, lease, destroy, or improve it, quote it at length, excerpt, incorporate, collate, fold, staple, or mutilate it, or do anything else to it that your or anyone else's heart desires.

field name

This is a generic bibliographic field.

field name 2

Generic bibliographic fields may contain multiple body elements.

Like this.

Dedication

For Docutils users & co-developers.

abstract

This document is a demonstration of the reStructuredText markup language, containing examples of all basic reStructuredText constructs and many advanced constructs.

Bullet Lists

• A bullet list
  • Nested bullet list.
  • Nested item 2.

• Item 2.

  Paragraph 2 of item 2.

  • Nested bullet list.
  • Nested item 2.
    • Third level.
    • Item 2.
  • Nested item 3.
• inline literall
• inline literall
• inline literall

Second list level

• here is a list in a second-level section.
• yahoo
• yahoo
  • yahoo
  • here is an inner bullet oh

    • one more with an inline literally. yahoo

      heh heh. child. try to beat this embed:

      test_py_module/test.py

  • and another. yahoo
  • yahoo
  • hi
• and hehe

But deeper down the rabbit hole

• I kept saying that, "deeper down the rabbit hole". yahoo
  • I cackle at night yahoo.
• I'm so lonely here in GZ guangzhou
• A man of python destiny, hopes and dreams. yahoo
  • yahoo
    • yahoo hi
    • destiny

Hlists

• First item
• Second item
• Third item
• Forth item
• Fifth item
• Sixths item

Hlist with images

• 
• 

Numbered List

1. One,
2. Two.
3. Three with long text. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed feugiat sagittis neque quis eleifend. Duis rutrum lectus sit amet mattis suscipit.

• 1. Using bullets and letters. (A)
• 2. Using bullets and letters. (B)
• 3. Using bullets and letters. (C)

Tables

Grid Tables

Here's a grid table followed by a simple table:

+------------------------+------------+----------+----------+ | Header row, column 1 | Header 2 | Header 3 | Header 4 | | (header rows optional) | | | | +========================+============+==========+==========+ | body row 1, column 1 | column 2 | column 3 | column 4 | +------------------------+------------+----------+----------+ | body row 2 | Cells may span columns. | +------------------------+------------+---------------------+ | body row 3 | Cells may | - Table cells | +------------------------+ span rows. | - contain | | body row 4 | | - body elements. | +------------------------+------------+----------+----------+ | body row 5 | Cells may also be | | | | empty: --> | | +------------------------+-----------------------+----------+

Inputs	Output
A B	A or B
===== =====	======
False False	False
True False	True
False True	True
True True	True

Giant Tables

Header 1	Header 2	Header 3	Header 1	Header 2	Header 3	Header 1	Header 2	Header 3	Header 1	Header 2	Header 3
body row 1	column 2	column 3	body row 1	column 2	column 3	body row 1	column 2	column 3	body row 1	column 2	column 3
body row 1	column 2	column 3	body row 1	column 2	column 3	body row 1	column 2	column 3	body row 1	column 2	column 3
body row 1	column 2	column 3	body row 1	column 2	column 3	body row 1	column 2	column 3	body row 1	column 2	column 3
body row 1	column 2	column 3	body row 1	column 2	column 3	body row 1	column 2	column 3	body row 1	column 2	column 3

List Tables

List tables can have captions like this one.

List table	Header 1	Header 2	Header 3 long. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam sit amet mauris arcu.
Stub Row 1	Row 1	Column 2	Column 3 long. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam sit amet mauris arcu.
Stub Row 2	Row 2	Column 2	Column 3 long. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam sit amet mauris arcu.
Stub Row 3	Row 3	Column 2	Column 3 long. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam sit amet mauris arcu.

This is a list table with images in it.