Skip to content

Commit e3aded9

Browse files
committed
Clarify image attributes in site descriptor
Mention in which HTML element and attribute they end up in to clarify the syntax. This relates to #618
1 parent f976f25 commit e3aded9

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

doxia-site-model/src/main/mdo/site.mdo

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -582,12 +582,12 @@ under the License.
582582

583583
<class java.clone="deep">
584584
<name>Image</name>
585-
<description>An image.</description>
585+
<description>An image. Generates an "img" element (https://html.spec.whatwg.org/#the-img-element).</description>
586586
<version>2.0.0+</version>
587587
<fields>
588588
<field xml.attribute="true">
589589
<name>src</name>
590-
<description>The source location.</description>
590+
<description>The source location. Ends up in the "img src" attribute (https://html.spec.whatwg.org/#attr-img-src).</description>
591591
<version>2.0.0+</version>
592592
<type>String</type>
593593
<required>true</required>
@@ -603,28 +603,28 @@ under the License.
603603
</field>
604604
<field xml.attribute="true">
605605
<name>alt</name>
606-
<description>The alternative text to use.</description>
606+
<description>The alternative text to use. Ends up in the "img alt" attribute (https://html.spec.whatwg.org/#alt).(</description>
607607
<version>2.0.0+</version>
608608
<type>String</type>
609609
<identifier>true</identifier>
610610
</field>
611611
<field xml.attribute="true">
612612
<name>width</name>
613-
<description>The width to use.</description>
613+
<description>The width to use. Added to the generated "img style" attribute (https://html.spec.whatwg.org/#the-style-attribute) prefixed by "width: ".</description>
614614
<version>2.0.0+</version>
615615
<type>String</type>
616616
<identifier>true</identifier>
617617
</field>
618618
<field xml.attribute="true">
619619
<name>height</name>
620-
<description>The height to use.</description>
620+
<description>The height to use. Added to the generated "img style" attribute (https://html.spec.whatwg.org/#the-style-attribute) prefixed by "height: ".</description>
621621
<version>2.0.0+</version>
622622
<type>String</type>
623623
<identifier>true</identifier>
624624
</field>
625625
<field xml.attribute="true">
626626
<name>style</name>
627-
<description>The style to use.</description>
627+
<description>The style to use. Ends up in the "img style" attribute (https://html.spec.whatwg.org/#the-style-attribute) as is.</description>
628628
<version>2.0.0+</version>
629629
<type>String</type>
630630
<identifier>true</identifier>

0 commit comments

Comments
 (0)