வார்ப்புரு:Sidenotes begin/doc

This is a documentation subpage for வார்ப்புரு:Sidenotes begin.
It contains usage information, categories and other content that is not part of the original வார்ப்புரு page.

About

Templates {{Right sidenote}}, and {{Left sidenote}} are used to create a text in which notes appear to the side of the text, rather than as footnotes at the end.

These templates are compatible with dynamic layouts. Thus, the way notes are rendered in mainspace partly depends on the layout. Index-based CSS can also be used to target the sidenotes using the .wst-sidenote class.

Usage

Usage is as follows:

This template uses block elements, e.g. <div> or <p>.
It should not be nested inside an inline element, e.g. <span>, or a template that produces such an element.

See H:DIVSPAN for details.

In the Page Namespace, {{Sidenotes begin}} should be placed in the header of the page, and {{Sidenotes end}} in the footer, in order to create margins. (Note: these templates will be deprecated in the future, as css style properties will be imported from the index page)
In the main namespace, these templates are no longer necessary.

Parameters
Parameter	Mandatory	Definition	Default
1	No	Unused, temporarily retained for access to 2	—
2	No	Width of left and right margin to apply(measured in em values)	11
side	No	Side of page to place a sidenotes column (options: `left`, `right`, `both`)	`both`

This template uses a <span> element for formatting.
Block-based templates and paragraph breaks cannot be nested inside it.

See H:DIVSPAN for details.

{{Right sidenote}} is used to create a sidenote appearing to the right of the text.

This template uses TemplateStyles:

Template:Sidenote/styles.css

Parameters
Parameter	Mandatory	Definition	Default
1	Yes	The text to appear at the right, possibly including wiki markup.
2	No	The css style of the note

{{Left sidenote}} is used to create a sidenote appearing to the left of the text.

Parameters
Parameter	Mandatory	Definition	Default
1	Yes	The text to appear at the left, possibly including wiki markup.
2	No	The css style of the note

Example:

The Solar System/Chapter 1 (try the different layouts to check how notes are rendered in each of them)

Tracking categories

Category:Sidenotes begin with override width - if {{sidenotes begin}} used with a width