Since we have a large discussion running and the threads in our discussion
mailing list got very long, we have decided to introduce a discussion document.
It always contains the current state of discussion and will be updated frequently.
This document describes the file format of the discussion document.
|
 |
Description of the Format
|
 |
In the description of the file format we will use <> - brackets for tags
and [] - brackets for attributes. Example: <tag attribute="value"> in the file
will be described here as <tag> and [attribute].
|
Starting a Discussion Document
|
|
The platypus discussion documents are written in xml, so the first two lines
should be:
 <?xml version="1.0">
<!DOCTYPE platypusDiscussion>
|
<platypusDiscussion>
Location: Root Element
<introduction>
Location: In <platypusDiscussion>
Attributes:
[status]: The status of the <introduction>. In fact it could be
every String you want to use to identify the status, but I suggest to use
"draft", "pre-final", "final" and "deprecated". It should never be
set to "final" as long as some child sections are still "pre-final" or
"draft".
<?xml version="1.0">
<!DOCTYPE platypusDiscussion>
<platypusDiscussion>
<introduction status="draft">
</introduction>
</platypusDiscussion>
|
<section>
Location: In <platypusDiscussion>,
<introduction> and in <section>.
Attributes:
[Status]: Same as status in <introduction>
|
Elements
|
|
<title>
Location: In <platypusDiscussion>, <introduction>,
<section> and <feature>.
<feature>
Location: In <section>.
Attributes:
[status]: Same usage as in <introduction>.
<section status="draft">
<title>Some Section</title>
<feature status="draft">
<title>Feature one</title>
</feature>
</section>
|
<description>
Location: In <section> and <feature>
Attributes:
[status]: Same usage as in <introduction>.
<examples>
Location: In <section> and <feature>
Attributes:
[status]: Same usage as in <introduction>.
<arguments>
Location: In <section> and <feature>
Attributes:
[status]: Same usage as in <introduction>.
|
Grouping Elements
|
|
<p>
Location: In <section>, <introduction>,
int<description>, <examples>, <pro> and <contra>.
<pro>
Location: In <arguments>.
<contra>
Location: In <arguments>.
|
