Template:Sidenote/doc

From Wikisource
Jump to navigation Jump to search

About

[edit]

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. Both templates are based on {{Sidenote}}.

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

[edit]

Usage is as follows:

  • 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 for {{Sidenotes begin}}
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

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

Parameters for {{Right sidenote}}
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 for {{Left sidenote}}
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:

Tracking categories

[edit]


This is the TemplateData documentation for this template used by VisualEditor and other tools.

Sidenote

No description.

Template parameters

ParameterDescriptionTypeStatus
11

Text of the side-note to apply.

Unknownrequired
22

Additional CSS styles to apply to sidenote

Unknownoptional
classclass

CSS class to apply to sidenote

Unknownoptional
sizesize

Font sizing of the sidenote (CSS Units)

Unknownoptional
heightheight

Line height of sidenote (CSS units)

Stringoptional
alignmentalign

Text alignment of the sidenote.

Suggested values
left right center
Unknownoptional
sideside

Which side of the page the sidenote is on.

Suggested values
left right
Unknownoptional
demospacedemospace

For testing purposes, the namespace.

Suggested values
Page Template
Unknownoptional