Template:Sidenote/doc
This is a documentation subpage for Template:Sidenote. It contains usage information, categories and other content that is not part of the original template page. |
This template uses a See H:DIVSPAN for details. |
This template uses TemplateStyles: |
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.
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.
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.
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
[edit]- Category:Sidenotes begin with override width: if {{sidenotes begin}} used with a width
Sidenote
No description.
Parameter | Description | Type | Status | |
---|---|---|---|---|
1 | 1 | Text of the side-note to apply. | Unknown | required |
2 | 2 | Additional CSS styles to apply to sidenote | Unknown | optional |
class | class | CSS class to apply to sidenote | Unknown | optional |
size | size | Font sizing of the sidenote (CSS Units) | Unknown | optional |
height | height | Line height of sidenote (CSS units) | String | optional |
alignment | align | Text alignment of the sidenote.
| Unknown | optional |
side | side | Which side of the page the sidenote is on.
| Unknown | optional |
demospace | demospace | For testing purposes, the namespace.
| Unknown | optional |