Template:Default layout/doc

From Wikisource
Jump to navigation Jump to search

Usage[edit]

This template is used to mark a page as having a default dynamic layout, overriding the standard "Layout 1" and the user's currently set default. This does not set the cookie, so it won't affect the next page the user visits.

There is a single parameter: the name of the layout

 {{default layout|Layout 2}}

This template requires the "Allow layout override" Gadget, which can be enabled or disabled in your your preferences (it is enabled by default). If you do not wish to have the layout overriden for you, turn off this gadget. The gadget's Javascript definition can be found here.

This template will have no effect for users without Javascript, since the whole dynamic layout framework requires Javascript.

Usable layouts[edit]

You can use any of the standard layouts. You should not use any layouts that exist only for a subset of users, because they will not appear for any other users.

The following table shows the default layouts available for all users.

Layout name Description
Layout 1 The default layout as seen by a user with no options already set. The text spans across the page, sidenotes are enclosed in a bordered box.
Layout 2 The text is justified and enclosed in a centered fixed-width column (36em). Sidenotes are displayed in empty margins of the page, on the left and right. Similar to the style used on the French and Italian Wikisources.
Layout 3 Header is displayed on the right of the pages, the text content on the left, justified. Sidenotes are shown in the space under the header. Similar to the style at German Wikisource.
Layout 4 Equivalent to Layout 2 (central fixed-width column, justified)


Technical notes[edit]

This section describes how this template achieves the default layout. It is only required to read this if you want to modify it.

The template adds a hidden (by display:none) span element to the page with the layout name in the tag body:

<span style="display:none" id="dynamic_layout_overrider">Layout Name<span>

A Javascript function then checks the page when it loads for an element with the id "dynamic_layout_overrider" and if it exists, extracts the name and sets the layout as appropriate. If the layout name does not exist, nothing happens.


See also[edit]

  • Help:Layout for a description of the dynamic layout system.