User:Daric Gaersmith/Templates/GaerNav

This is a custom template created in a user space. It is not to be transcluded into any other namespace.

Please feel free to discuss this custom template, but please do not edit it.

Summary

This template adds a floating navigation box, in the shape of an open book, to the left side of a wiki page for The Gaersmith Legacy, a TES fan fiction tale. There are four buttons on the navigation bar, to take the reader quickly to the top of the current page, or to the next / previous chapters, and back to the Volume Index, the main table of contents for the tale.

Inter-page links

There are three inter-page links from this template. The first two are provided with the parameters you pass when calling the template. The third is hard-coded to link back to the Volume Index of my fan fiction series.

Intra-page links

For this template to work properly, the page it is used on must contain certain code apart from just the call to the template. With wiki markup, you cannot just use an HTML anchor name tag (<a name="myanchor"/>), but an id= works fine from most other HTML constructs, such as <span> and <div> tags.

Somewhere near the top of the page, you need a pagetop anchor.

<div id="pagetop"></div>

Also, the sections of the Steel Sword at the bottom of the GaerNav floating box link to sections on the current page, so each of these will need their own anchor as well. There are 5 parts to the Steel Sword, so there needs to be 5 corresponding anchors on the page, for them to link to, even if the page has less than 5 sections on it. Simply add empty <div> tags at the bottom of the page for each unused section, as per the example below which shows only 4 sections and one that is just a <div>.

<span id="sect-a" ... >

<span id="sect-b" ... >

<span id="sect-c" ... >

<span id="sect-d" ... >

<div id="sect-e"></div>

Parameters

Daric Gaersmith/Templates

Parameter	Scope	Description
prevchpt	optional	The wiki link to the previous chapter of the tale.
nextchpt	optional	The wiki link to the next chapter of the tale.

Examples

It is anticipated that this template will be implemented on the page under my Standard Definitions, so there should already be a {{{pathtotemplates}}} defined on the page.

Volume I, Chapter 1

Notice how this one can take the reader back to the Prologue.

{{{{{pathtotemplates}}}GaerNav
|prevchpt=User:Daric_Gaersmith/TES_Fan_Fiction_Collection/Gaersmith_Legacy/Prologue
|nextchpt=User:Daric_Gaersmith/TES_Fan_Fiction_Collection/Gaersmith_Legacy/Volume_I/Chapter_2
}}

Volume I, Chapter 8

Notice how this one jumps to the start of Volume II, from the end of Volume 1.

{{{{{pathtotemplates}}}GaerNav
|prevchpt=User:Daric_Gaersmith/TES_Fan_Fiction_Collection/Gaersmith_Legacy/Volume_I/Chapter_7
|nextchpt=User:Daric_Gaersmith/TES_Fan_Fiction_Collection/Gaersmith_Legacy/Volume_II/Chapter_1
}}

Volume II, Chapter 5

{{{{{pathtotemplates}}}GaerNav
|prevchpt=User:Daric_Gaersmith/TES_Fan_Fiction_Collection/Gaersmith_Legacy/Volume_II/Chapter_4
|nextchpt=User:Daric_Gaersmith/TES_Fan_Fiction_Collection/Gaersmith_Legacy/Volume_I/Chapter_6
}}