Guide/AlternateElementTemplate

From HTML WG Wiki
Jump to: navigation, search

[These are comments in the template to describe to Guide writers what information should be included. Delete these when creating your page.]

The tagname Element

Element Summary

Purpose

  • [state the basic purpose of the element]

When this element may be used (context)

  • [where block-level, in-line, etc. are expected or allowed]

What this element may contain (content model)

  • [such as, zero or more block-level elements]

Tags

  • Start tag: [<tag> or <tag/> if void]
  • End tag: [</tag> or the word none if void]

Element specific attributes

  • [any attributes beyond the universal attributes]

HTML5 Specification References

  • [one or more descriptive titles with links to the HTML5 specification]

Discussion and Examples

General

[Restate the basic purpose of the element, even using the same words used in the Summary section. This is where one describes when and how the element is used. Keep this part of the discussion free of any element specific attributes. Link to page that describes proper use with other elements in more complex situations.]

Example

[Examples are included within the discussion, not as a separate section.]

Attributes

[The discussion of the effect of element specific attributes on the element is covered here.]

Example

[Examples are included within the discussion, not as a separate section.]

Best Practices

[Explain any best practices.]

Example

[Examples are included within the discussion, not as a separate section.]

Internationalisation Techniques

[Describe any techniques authors should use to help with internationalisation.]

Accessibility Techniques

[Describe any special techniques that authors should use to ensure accessibility.]

Example

[Examples are included within the discussion, not as a separate section.]

See Also

[Link to any other relevant articles, guidelines (e.g. WCAG techniques), tutorials, etc. The quality of these references should be very good and not teach any bad practices.]

Example

[Examples are included within the discussion, not as a separate section.]

Discussion

[General discussion here. This should be treated like a talk page on a MediaWiki wiki. Comments should be signed and preferably threaded. Anything in this section will not be incorporated directly into the guide, but the feedback will be taken into consideration.]

  • Since we are describing HTML elements in terms authors may better understand, I think the element template should be modified.
  • DOM interface information does not need to be included in an author's guide; it can be a required link to the specification.
  • Basic applications of the element should be included in examples, even using other elements. However, more involved discussions that use the element or its attributes with other elements should be on a linked page. That page would also be linked from pages discussing the other attributes and elements involved.