Template:Breadcrumb/doc: Difference between revisions
m (Text replacement - " " to " ") |
No edit summary |
||
(12 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
{{TemplateBox | __NOTOC__{{TemplateBox | ||
|1=link1 | |1=link1 | ||
|1d=an internal link to a Wiki page title (with a broadly general topic), ''for example'' <nowiki>[[United States Genealogy|United States]]</nowiki> | |1d=an internal link to a Wiki page title (with a broadly general topic), ''for example'' <nowiki>[[United States Genealogy|United States]]</nowiki> | ||
Line 17: | Line 17: | ||
|4stat=optional | |4stat=optional | ||
|5=link5 | |5=link5 | ||
|5d=title of the page '''where the breadcrumb appears''', ''for example'' <nowiki>[[Boston Massachusetts | |5d=title of the page '''where the breadcrumb appears''', ''for example'' <nowiki>[[Boston Massachusetts Family History Center|Family History Center]]</nowiki> | ||
|5def= | |5def= | ||
|5stat=required | |5stat=required | ||
|name=Template:Breadcrumb | |name=Template:Breadcrumb | ||
|desc='''Template's Purpose:''' Use this template to place a ''FamilySearch Wiki'' style [ | |desc='''Template's Purpose:''' Use this template to place a ''FamilySearch Wiki'' style [https://en.wikipedia.org/wiki/Breadcrumb_(navigation) breadcrumb trail] near the top of a Wiki article.<br><br> | ||
'''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 | '''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 showing 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 a breadcrumb trails as a brief topical guide to that Wiki page. <br><br> | ||
The term comes from the trail of bread crumbs left by [https://en.wikipedia.org/wiki/Hansel_and_Gretel Hansel and Gretel] in the fairy tale of the same name.<br><br> | The term comes from the trail of bread crumbs left by [https://en.wikipedia.org/wiki/Hansel_and_Gretel Hansel and Gretel] in the fairy tale of the same name.<br><br> | ||
'''Samples:''' | '''Samples:''' | ||
:*''[[United States Genealogy|United States]] | :*''[[United States Genealogy|United States]] [[File:Gotoarrow.png]] [[Maryland Genealogy|Maryland]] [[File:Gotoarrow.png]] [[Anne Arundel County, Maryland Genealogy|Anne Arundel]]'' [[File:Gotoarrow.png]] '''Annapolis''' (for the '''Annapolis, Maryland''' page) | ||
:*''[[England Genealogy|England]] | :*''[[England Genealogy|England]] [[Image:Gotoarrow.png]] [[Lancashire Genealogy|Lancashire]] [[Image:Gotoarrow.png]] [[Lancashire Parishes]]'' [[Image:Gotoarrow.png]] '''Liverpool St Bride''' (for the '''Liverpool St Bride, Lancashire Genealogy''' page) | ||
:*''[[United States Genealogy|United States]] | :*''[[United States Genealogy|United States]] [[Image:Gotoarrow.png]] [[United States Migration Internal|Migration]] [[Image:Gotoarrow.png]] [[US Migration Trails and Roads|Trails and Roads]]'' [[Image:Gotoarrow.png]] '''Oregon Trail''' (for the '''Oregon Trail''' page) | ||
:*''[[Principles of Family History Research|Principles of Family History Research]] | :*''[[Principles of Family History Research|Principles of Family History Research]] [[Image:Gotoarrow.png]] [[Obtain and Search the Records|Step 4. Obtain and Search the Records]] [[Image:Gotoarrow.png]]'' '''Obtain the Records''' (for the '''Obtain the Records''' page) | ||
:*''[[Germany Genealogy|Germany]] | :*''[[Germany Genealogy|Germany]] [[Image:Gotoarrow.png]] [[Bavaria, Germany Genealogy|Bayern (Bavaria)]]'' [[Image:Gotoarrow.png]] '''Biography''' (for the '''Bavaria Biography''' page) | ||
:*''[[United States Genealogy|United States]] | :*''[[United States Genealogy|United States]] [[Image:Gotoarrow.png]]'' '''American Indian Genealogy''' (for the '''American Indian Genealogy''' page) | ||
|usage-notes=*You can insert up to five links. | |usage-notes=*You can insert up to five links. | ||
*You must insert a minimum of two links. | *You must insert a minimum of two links. | ||
*If there were only three total links, for example, insert the first two into link1 and link2, leave link3 and link4 blank, and insert the last link into link5. | |||
*'''Important:''' link5 '''must''' always be used for the final link.''' | *'''Important:''' link5 '''must''' always be used for the final link.''' | ||
<pre>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 = . | <pre>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 = . | ||
{{breadcrumb | {{breadcrumb | ||
| link1= | |||
| link2= | |||
| link3= | |||
| link4= | |||
| link5= | |||
}}</pre> | }}</pre> | ||
Line 65: | Line 65: | ||
::<nowiki>| link5=[[Illinois Cemeteries|Cemeteries]]</nowiki><br> | ::<nowiki>| link5=[[Illinois Cemeteries|Cemeteries]]</nowiki><br> | ||
::<nowiki>}}</nowiki><br><br> | ::<nowiki>}}</nowiki><br><br> | ||
it would render as: | it would render as: ''[[United States Genealogy|United States]] [[Image:Gotoarrow.png]] [[Illinois Genealogy|Illinois]] [[Image:Gotoarrow.png]]'' '''Cemeteries'''<br> |
Revision as of 07:39, 3 February 2017
![]() |
This is a documentation subpage for (see that page for the template itself). It contains usage information, categories and other content that is not part of the original template page. |
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 showing 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 a breadcrumb trails as a brief topical guide to that Wiki page.
The term comes from the trail of bread crumbs left by Hansel and Gretel in the fairy tale of the same name.
Samples:
- United States
Maryland
Anne Arundel
Annapolis (for the Annapolis, Maryland page)
- England
Lancashire
Lancashire Parishes
Liverpool St Bride (for the Liverpool St Bride, Lancashire Genealogy page)
- United States
Migration
Trails and Roads
Oregon Trail (for the Oregon Trail page)
- Principles of Family History Research
Step 4. Obtain and Search the Records
Obtain the Records (for the Obtain the Records page)
- Germany
Bayern (Bavaria)
Biography (for the Bavaria Biography page)
- United States
American Indian Genealogy (for the American Indian Genealogy page)
- United States
Usage
{{Template:Breadcrumb|link1=|link2=|link3=|link4=|link5=}}
- You can insert up to five links.
- You must insert a minimum of two links.
- If there were only three total links, for example, insert the first two into link1 and link2, leave link3 and link4 blank, and insert the last link into link5.
- Important: link5 must always be used for the final link.
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 = . {{breadcrumb | 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:
- {{breadcrumb
- | link1=[[United States Genealogy|United States]]
- | link2=[[Illinois Genealogy|Illinois]]
- | link3=
- | link4=
- | link5=[[Illinois Cemeteries|Cemeteries]]
- }}
- {{breadcrumb
it would render as: United States Illinois
Cemeteries