#3 Support for images and tables

[Agnar Renolen]

SUMMARY

It should be possible to specify images in te source
files.

RATIONALE

Coda is not only useful for generating source API
documentation, but also to write other techncal
documentation such as design specs, user manuals an so
on. In such documents, tables and figures are vital
elements.

EXAMPLE IMAGE

CodaText for figure includion could have the following
format:

[
\fig <filename> <caption>
]

EXAMPLE TABLE

Table format is mor trick. It should be readable also
in source code text. Column allignment is critical.
What about something like this:

Table with columns separator and header row.
[
\table | head1 | head2 | head3 |
| cell11 | cell12 | cell13 |
cell21 cell22 cell33
]

Table without column separator and without header row
[
\table . . . .
cell11 cell12 cell13
cell21 cell22 cell33
]

The vertical bars on the first line are required to
specifiy the columns in subsequent rows. Text in the
first line will appear in table heading style, if no
text is supplied in the first row, no table heading
will be generated.

If vertical bars are used on the first line, Coda
should generate a column seperator on all rows, if
periods (".") are used, Coda should not generate a
column separator.

Columns separators on subsequent rows are optional,
but can be provided for clarity, it's the first line
that specifies whether column separator should be
producedin output.

If the table contains a header row, it should be
sperated from the other columns by a vertical line.
If bar is used as columns sperators, output should
also conttain a line above the first and below the
last row.

Each row can only occupy one line of input.