Template:Prevnext2: Difference between revisions

From KDE Wiki Sandbox
Line 10: Line 10:




== How to use this template ==
== Arguments ==


Write
<code>{{Prevnext2
| prevpage  = The path of the previous article.
| prevtext  = The link name for prevpage.*
| nextpage  = The path to the next article.*
| nexttext  = The link name for nextpage.*
| index    = The path to the manual index.*
| indextext = The link name for index.*
}}
</code>


(* - Optional arguments.)
== Example usage ==
Writing this:
<code>{{Prevnext2
<code>{{Prevnext2
| prevpage=path/to/article | nextpage=path/to/article
| prevpage=path/to/article | nextpage=path/to/article
| prevtext=previous section| nexttext=The next section
| prevtext=previous section| nexttext=The next section
}}</code>
}}</code>
 
Gets you this:
which will be returned as,
----
----
{{Prevnext2
{{Prevnext2

Revision as of 14:47, 3 June 2010

Template:I18n/Language Navigation Bar

Information
This template is a work-in-progress and will probably be re-named to something less obtuse quite soon, so avoid using it just at the moment.


Use this template when you want to provide links to the previous and the next sections of the article so the user isn't forced to go back to the index to navigate.


Arguments

← The link name for prevpage.* ↑ The link name for index.* ↑ The link name for nextpage.*→

(* - Optional arguments.)

Example usage

Writing this:

← previous section Prevnext2 The next section→

Gets you this:


← previous section Prevnext2 The next section→

Optional arguments

The arguments in this template are optional. That is, if there is no previous page to link to, you don't have to include it in the template. You can just write this:

Prevnext2 The next section→

Which would be rendered as:


Prevnext2 The next section→

This works the other way around, too. This:

← previous section Prevnext2

is rendered as:


← previous section Prevnext2

Omitting link descriptions

Finally, the link description text doesn't have to be specified, either. The text will default to the name of the article you are linking to. So, the following syntax,

← path/to/lastsection Prevnext2 path/to/article→

will render as:


← path/to/lastsection Prevnext2 path/to/article→

This might be useful in some situations. But often it looks ugly, so try to specify link text whenever you can!

Extra options

There are two more completely optional arguments for this template. These replace the text in the middle of the template with a link to wherever you like (most usually the index of the article). To use them, write this:

← previous section ↑ Contents page ↑ The next section→

which will be rendered as:


← previous section ↑ Contents page ↑ The next section→

You don't need to use both of them. If you just want to specify the text in the middle without making it a link, simply omit the index argument completely:

Contents section The next section→

Which will be rendered as:


Contents section The next section→

Template source code

Prevnext2