Template:Prognav/doc

Usage

This template supports up to for parametres. These are

Par.	Short	Explanation	Notes
1	book name	name of the project	mandatory
2	previous link	page that comes before this page	should exist
3	next link	page that comes after this page	should exist
4	sub index link	name of a subindex	optional
prog	order of page search parametre	0 or 1	optional

Examples

The following call is for the Perl project page "Keywords" that is placed between the pages "Concept Index" and "Reference Cards"

 {{prognav|Perl|Concept Index|Reference Cards}}

As an example, the previous link is created as Perl_Programming/Concept_Index.

If you use this template for a sub-index page, you should do it like in this example for the page "Keywords" in "Perl programming", where the optional fourth parameter "Keywords" causes the links to the previous and next page to be placed appropriately inside the Keywords index.

 {{prognav|Perl|msgsnd|ne|Keywords}}

Now, the previous link is created as Perl_Programming/Keywords/msgsnd, the next link as Perl_Programming/Keywords/ne.

Another option is for the case that the project pages do not have the " Programming" at the end. This is the case in some projects like "JavaScript", where the page names are equal to this one word. In this case, the optional prog parametre with the value 0 for "page name does not end with programming", the order of search for an existing page is changed such that first, a page without this ending is searched for:

 {{prognav|JavaScript|Operators|Functions and Objects|prog=0}}

This results in

Without this parametre, the template would first search for the page JavaScript Programming, which exists and is a link to the JavaScript page. But the link does link only to this one page; other pages like JavaScript/Numbers do not exist also as JavaScript Programming/Numbers, which would result in non-existant links, as you can see below:

 {{prognav|JavaScript|Operators|Functions and Objects}}

results in

See also

• Wikibooks:Templates/Navigation