Template:Bc/doc

From FamilySearch Wiki
Jump to navigation Jump to search

Template's Purpose: Use this template to place a FamilySearch Wiki style breadcrumb trail near the top of a Wiki article.

Purpose of a Breadcrumb Trail: A breadcrumb trail is used to display topics related to the subject of a Wiki page. It is a navigational sign post that also shows the context of where the current page fits in relation to a hierarchy of subjects in the Wiki. The topics in a breadcrumb usually appear in a hierarchy that drills down from general to more specific topics. The final topic in the breadcrumb trail usually reflects the title of the page where the trail is displayed. Think of the Wiki as a guidebook through the jungle of genealogical knowledge, and a breadcrumb trail is a reference tab that shows the section and chapter where that Wiki page fits in the guidebook.

The term comes from the trail of bread crumbs left by Hansel and Gretel in the fairy tale of the same name.

Samples:

Usage

{{Template:Bc|link1=|link2=|link3=|link4=|link5=}}

  • You can insert up to five links.
  • You must insert a minimum of two links.
  • Important: link5 must always be used for the final link.
  • If fewer than five links are needed, leave some template middle links empty. For example, for three links insert the first two into link1 and link2, leave link3 and link4 blank, and insert the last link into link5.
Copy and paste the contents of this box below to the spot where you wish the breadcrumb to appear, and then fill-in each line as appropriate with a Wiki page link after the = .

{{bc
| link1=
| link2=
| link3=
| link4=
| link5=
}}

Parameters

Parameter name Description Default value required or optional?

link1 an internal link to a Wiki page title (with a broadly general topic), for example [[United States Genealogy|United States]] empty required
link2 to a more narrowly specific page title (if any), for example [[Massachusetts Genealogy|Massachusetts]] empty optional
link3 to a more narrowly specific page title (if any), for example [[Suffolk County, Massachusetts Genealogy|Suffolk]] empty optional
link4 to a more narrowly specific page title (if any), for example [[Boston Massachusetts genealogy|Boston]] empty optional
link5 title of the page where the breadcrumb appears, for example [[Boston Massachusetts Family History Center|Family History Center]] empty required

Additional information

The template is intended to be used in the following namespaces: no namespace specified

The template is intended to be used by the following user groups: no user group specified

Placement

Place this template at or near the top of the Wiki page.

The only thing that should ever appear on a Wiki page above a breadcrumb trail is a "hat note" such as a disambiguation note.

Occasionally, part of a Table of Contents box or part of a Navigation box (sidebar) can appear on the same level as a breadcrumb trail as long as they are not on the line above it.

Example

Assuming the following template were inserted near the top of the Illinois Cemeteries Wiki page:

{{bc
| link1=[[United States Genealogy|United States]]
| link2=[[Illinois Genealogy|Illinois]]
| link3=
| link4=
| link5=[[Illinois Cemeteries|Cemeteries]]
}}

it would render as:   United States  Green arrow.png  Illinois  Green arrow.png  Cemeteries