Template:Floatable index/Documentation

From GodWiki
Jump to navigation Jump to search

The {{Floatable index}} template creates a floating alphabetic or alphanumeric index down the right-hand side of the page, designed to assist with navigation on large list pages.


Set this to any yes-like value to include numbers, special characters, and top. The example on the right-hand side on this page has |full=y. The example above does not.
The anchor or heading to which the ! link should point. Default is Special.
The anchor or heading to which the link should point. Default is top.

Required page layout

For this template to be useful, the following must be true:

  • The page it is used on must have headings (or anchors) that are the capital letters of the English alphabet. If those headings are not present, tapping the letters will do nothing.
  • For the full index, there must also be headings (or anchors) for the 10 numerals, and also one for special, non-alphanumeric characters.
  • This index obscures the right-hand edge of the page on mobile devices. All tables should have the table property style="width: 95%;" or a suitable margin-right (about 2.5em). If you don't know how to do this, ask for help.
  • Because this index obscures the right-hand edge, it can make mobile editing of the page very difficult. The template should be placed at the top of the page, or away from the sections most likely to be edited, to minimise the chance it will appear on the user's screen while they are trying to edit your list.