Reviewers raised some significant questions about <imagemap> elements. In particular, the questions focus on <shape> and <coords>. Note that the equivalents in HTML5 are attributes (@coords and @shape) on the <area> element.
<shape>
| DITA 2.0 draft |
“If the <shape> element is left empty, a rectangular shape is assumed.” |
|
| DITA 1.3 spec |
“If you leave the <shape> element
blank, a rectangular shape is assumed.” |
Definition of "rect" value |
| HTML 5 spec |
“The [@shape] attribute may be omitted. The missing value default is the rectangle state.” |
The @shape attribute
|
Reviewers comments about the DITA 2.0 draft sentence:
- (Dawn) I found this somewhat confusing. If the shape is blank, wouldn't default be the value, so the region is the entire image, which is assumed to be rectangular?
- (Nancy) Also, are we saying that the shape element is required, or not? The above says 'if it's left empty", but that's different from omitting the shape element completely,
as is apparently the case in HTML5. If we're following their paradigm, the element should be optional. [Eberlein: The <shape> element is required.]
<coords>
Eberlein: For DITA 2.0, I completely revised what the spec said about the syntax for the <coords> element. The draft DITA 2.0 content is drawn from the HTML5 spec. The DITA 1.3 content was rather weak, at best.
| DITA 2.0 draft |
(Definition of syntax for when the shape is “default)
“The default shape is the entire image. The <coords> element should be empty.
|
|
| DITA 1.3 spec |
Nothing. We did not list “default” as an option.
"The syntax of the coordinate data depends on the shape described by the coordinates, and is based on the image map definition in HTML."
|
<coords> topic |
| HTML 5 spec |
“In the default state state, area elements must not have a coords attribute.
(The area is the whole image.)” |
The @coords attribute |
Reviewer comments:
- (Nancy) So just to confirm, if there is no shape element inside the imagemap (or an empty shape element? see my comment for <shape>), I would need 4 comma-separated digits in coords, but if the value of shape is "default," there would be no coords element
at all?
<sort-as>
Two suggestions for changing the short description:
- Current: “For elements that are sorted, the element provides text that is combined with the base sort phrase to construct the effective sort phrase.”
- Suggested change: “For elements that are sorted, the element provides text that is prepended to the base sort phrase in order to construct the effective sort phrase.”
- Suggested change: “The <sort-as> element can be used to specify an effective sort phrase when the base sort phrase is not appropriate for sorting; for example, Japanese characters or letters with diacritics. This element prepends text with
the base content to construct an effective sort phrase."
Best,
Kris
Kristen James Eberlein
Chair, OASIS DITA Technical Committee
Owner, Eberlein Consulting LLC
kris@eberleinconsulting.com
Skype: kriseberlein; voice: +1 (919) 622-1501