User:Mtew/templates/PageNav/NavBar/doc

NavBar Template

---

‌		‌	‌	General	‌	‌	Talk	‌	‌	Characters	‌	‌	Diaries	‌	‌	Projects	‌		My templates		‌	Special Pages	‌

‌		‌		Page Navigation		‌	Quest Progress	‌	‌	Standard Formats	‌

‌	LocLegend	‌	‌	Cat all values	‌	‌	Five Rows of Four	‌	‌	100 Rows of Four	‌	‌	For all 1's Digits	‌	‌	For all 10's Digits	‌	‌	For all 100's Digits	‌

	‌	For all Guideline Items	‌

‌		‌		NavBar		‌	Folder Tabs	‌	‌	Internal: A Folder Tab	‌	‌	Region Info	‌

Usage

Parameters

All parameters are nominally links to other pages. 

Positional

None. 

Required keywords

• next – defaults to 'next' — Links to the next page in the nominal sequence. 
• prev – defaults to 'prev' — Links to the previous page in the nominal seuence. 

Optional keywords

• up &mdash Links to the next level up.  If this is the first page of a sub-level, this might link to the previous page on the parent pages level or th the 'grandparent' page. 
• skip — Links past the rest of the pages on this sub-level.  This is normally the next page on the parent page's level, but it may be several levels up instead. 
• root — Links to the page at the start of the document.  This is usually the Table of Contents. 
• tail — Links to the page(s) at the end of the document.  This is usually the Index. 

Examples

In-line form

{{ NaveBar | prev = Link to Prev TBS | next = Link to Next TBS | up = Link to Parent OPT | skip = Link to Skip OPT | root = Link to Table of Contents OPT | tail = Link to Index }}

Multi-line form

{{ NaveBar
| prev = Link to Prev TBS
| next = Link to Next TBS
| up = Link to Parent OPT
| skip = Link to Skip OPT
| root = Link to Table of Contents OPT
| tail = Link to Index OPT
}}

Results

In-line form

Parent	Table of Contents	Skip
Prev	Index	Next

Multi-line form

Parent	Table of Contents	Skip
Prev	Index	Next

Contributors

mtew(talk)           November 2008       – Initiial Development.

Requirements

Goals

• Displays navigation links for pages with an intended sequence.  Nominally:
  • A 'next' link.   There are two distinct forms that affect the corresponding 'skip link':
    1. A link to the next sequential page at the current sub-page level.  In this form, the 'skip link' should point to the sequentially next page at the parent page's level. 
    2. A link to the next sequential page at the parent page's level.  In this form, the 'skip link' will go to a successor page at least two levels up.  This should only occur for the llast sub-page in a sequence.
  • A 'previoous' link.  Again there are two distinct forms that affect the corresponding 'up link':
    1. A link to the previous page at the current sin=page level.  In this for, the 'up link' will go to the parent page. 
    2. A link to the parent page.  In this form, the 'up link' will go to the predecessor page at the parent page's level.
  • A 'skip' link.  See the 'next' requirements for details.
  • An 'up' link.  See the 'previous' requirements for details.
  • Optionally, a link to the 'root' of the document.  This is often the 'table of contents'. 
  • Optionally, a link to the 'tail' of the document.  This is often the 'index'. 
• Sequential links of the same type must not form a loop. 
• Western (as opposed to Manga) conventions. 

Non-Goals

None at this time. 

Desirabilia

• Usable at both the top and bottom of a page. 
• One or two rows, three columns. 
• No boarders. 

Internals

This section needs revision – Some of the details have changed.

The page sequencing template – It constructs a two row, three column table of links.

• Starts with the HTML table tag and style specifications.  The columns should split 33%, 34%, 33% boarders.
• The first row HTML tags and style specifications come next unless all three entries are blank.
  • The Up link comes next.  If no 'up' parameter is not specified, this 'link' should be gray and inactive.
  • The Table of Contens link comes next.  If no 'toc' parameter is specified, this 'link' should not be seen.
  • The Skip link comes next.  If no 'skip' parameter is specified, this 'link' should be gray and inactive.
• the first row HTML end tages come next, followed by the second row HTML tag and style specification.
  • The Back link comes next.  If no 'back' parameter is specified, this 'link' should be gray and inactive.
  • The Index link comes next.  If no 'index' parameter is specified, this 'link' should not be seen.
  • The Next link comes next.  If no 'next' parameter is specified, this 'link' should be gray and inactive.
• The HTML end of row and end of table tags come next, followed by the end of the template.

---

NavBar Template