|
1
|
Tim Bergsma, 8-22-2002, Suggestions for content of eml-paragraph.
|
|
2
|
|
|
3
|
As per the eml conference call action items, I am suggesting elements that, as children of paragraph, would give eml the ability to represent hierarchically structured text. Below, I consider both xhtml and DocBook element sets. I am suggesting a few other elements that are relatively common, are presentation-neutral, and represent features typically available in "methods" sections of research publications.
|
|
4
|
|
|
5
|
I divide elements into 4 categories: should include (I consider essential), could include (I'd like to see them, but will concede if opposed), could exlude (I don't want to see them, but would concede if opposed) and should exclude (I really think eml shouldn't bother with them).
|
|
6
|
|
|
7
|
Items in comma-separated groups need to be adopted or rejected together.
|
|
8
|
|
|
9
|
XHTML, under p
|
|
10
|
|
|
11
|
should include:
|
|
12
|
ul, ol, li; (provide recursive nesting of content, can themselves contain paragraphs)
|
|
13
|
i; (universal convention for indicating species names)
|
|
14
|
|
|
15
|
could include:
|
|
16
|
sub, sup; (needed for clarity in units, etc)
|
|
17
|
u; (historical alternative to i)
|
|
18
|
h1, h2, h3, h4, h5, h6; (for headers)
|
|
19
|
b; (common, but more display-oriented than semantic)
|
|
20
|
|
|
21
|
could exclude:
|
|
22
|
blockquote;
|
|
23
|
dl, dt, dd;
|
|
24
|
table, tr, td;
|
|
25
|
strike;
|
|
26
|
|
|
27
|
should exclude:
|
|
28
|
img;
|
|
29
|
a;
|
|
30
|
br;
|
|
31
|
hr;
|
|
32
|
pre;
|
|
33
|
strong; (imprecise)
|
|
34
|
em; (imprecise, at least as an alternative to i)
|
|
35
|
li type=; (display-oriented)
|
|
36
|
ol type=; (display-oriented).
|
|
37
|
|
|
38
|
DocBook, under para
|
|
39
|
|
|
40
|
should include:
|
|
41
|
ItemizedList, OrderedList, ListItem; (corresponds to ul,ol,li)
|
|
42
|
emphasis; (no italics in DocBook, predictably.)
|
|
43
|
procedure, step, substep; (Great! substeps nestable to any depth!)
|
|
44
|
|
|
45
|
could include:
|
|
46
|
equation;
|
|
47
|
subscript, superscirpt;
|
|
48
|
|
|
49
|
could exclude:
|
|
50
|
variableList;
|
|
51
|
blockquote;
|
|
52
|
table;
|
|
53
|
section, title; (sections are great, but unfortunately cannot be in paragraphs.)
|
|
54
|
|
|
55
|
should exclude:
|
|
56
|
(no comment).
|
|
57
|
|
|
58
|
I think the DocBook solution is more elegant. The fact(?) that headers are allowed in html paragraphs, but the docbook equivalent section/title is not, probably indicates a problem with html. If eml is too far along to consider grouping paragraphs into sections, we could always cast section titles as standalone paragraphs. Care should be taken that procedure/step/substep is not redundant to our current methodStep etc.
|