SVG element page template

Remove before publishing

Title and slug

An SVG element page should have a title of "<" + NameOfTheElement + ">". For example, the g element has a title of <g>.

The Slug (the last segment at the end of the URL) should be filled in as NameOfTheElement, so g's slug is g.

Top macros

There are four macro calls at the top of the template by default. You should update or delete them according to the advice below:

  • {{draft()}} — this generates a Draft banner that indicates that the page is not yet complete, and should only be removed when the first draft of the page is completely finished. After it is ready to be published, you can remove this.
  • {{SeeCompatTable}} — this generates a This is an experimental technology banner that indicates the technology is experimental). If the technology you are documenting is not experimental, you can remove this. If it is experimental, and the technology is hidden behind a pref in Firefox, you should also fill in an entry for it in the Experimental features in Firefox page.
  • {{deprecated_header}} — this generates a Deprecated banner that indicates the technology is deprecated. If it isn't, then you can remove the macro call.
  • {{svgref}} — this generates a suitable SVG sidebar, depending on what tags are included on the page.

Tags

In an SVG element subpage, you need to include the following tags (see the Tags section at the bottom of the editor UI): SVG, Reference, Element, the name of the Element (e.g. g), SVG container/SVG animation/SVG light source/SVG text content/SVG font as appropriate, Experimental (if the technology is experimental), and Deprecated (if it is deprecated).

Browser compatibility

To fill in the browser compat data, you first need to fill in an entry for the API into our Browser compat data repo — see our guide on how to do this.

Once that is done, you can show the compat data for the method with a {{Compat()}} macro call.

Draft

This page is not complete.

Experimental

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

Deprecated

This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

The summary paragraph — start by naming the element and saying what it does. This should ideally be 1 or 2 short sentences.

Usage context

missing

Note — for the correct information to appear here, you need to fill in an entry for the element in the {{svginfo}} macro, if it is not in there already.

Attributes

Global attributes

Specific attributes

  • Include bulleted
  • list of all
  • the SVG attributes
  • It can take

DOM Interface

This element implements the NameOfSVGDOMElement interface.

Examples

Fill in a simple example that nicely shows a typical usage of the element, then perhaps some more complex examples (see our guide on how to add code examples for more information).

my code block

And/or include a list of links to useful code samples that live elsewhere:

  • x
  • y
  • z

Specifications

Specification Status Comment
Unknown
The definition of 'NameOfTheElement' in that specification.		 Unknown Initial definition.

See also

  • Include list of
  • other links related to
  • this Element that might
  • be useful