Template:Breadcrumb/doc: Difference between revisions

No edit summary
m (Text replacement - " " to " ")
 
(12 intermediate revisions by 4 users not shown)
Line 1: Line 1:
__NOTOC__{{TemplateBox
{{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 Family History Center|Family History Center]]</nowiki>
|5d=title of the page '''where the breadcrumb appears''', ''for example'' <nowiki>[[Boston Massachusetts FamilySearch Center|FamilySearch 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 [https://en.wikipedia.org/wiki/Breadcrumb_(navigation) breadcrumb trail] near the top of a Wiki article.<br><br>  
|desc='''Template's Purpose:''' Use this template to place a ''FamilySearch Wiki'' style [[Breadcrumb Trails|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 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>
'''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. <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]] [[File:Gotoarrow.png]] [[Maryland Genealogy|Maryland]] [[File:Gotoarrow.png]] [[Anne Arundel County, Maryland Genealogy|Anne Arundel]]'' [[File:Gotoarrow.png]] '''Annapolis''' &nbsp;&nbsp;(for the '''Annapolis, Maryland''' page)
:*''[[United States Genealogy|United States]] [[File:Green arrow.png|10px]] [[Maryland Genealogy|Maryland]] [[File:Green arrow.png|10px]] [[Anne Arundel County, Maryland Genealogy|Anne Arundel]]'' [[File:Green arrow.png|10px]] '''Annapolis'''   (for the '''Annapolis, Maryland''' page)
:*''[[England Genealogy|England]] [[Image:Gotoarrow.png]] [[Lancashire Genealogy|Lancashire]] [[Image:Gotoarrow.png]] [[Lancashire Parishes]]'' [[Image:Gotoarrow.png]] '''Liverpool St Bride''' &nbsp;&nbsp;(for the '''Liverpool St Bride, Lancashire Genealogy''' page)
:*''[[England Genealogy|England]] [[File:Green arrow.png|10px]] [[Lancashire Genealogy|Lancashire]] [[File:Green arrow.png|10px]] [[Lancashire Parishes]]'' [[File:Green arrow.png|10px]] '''Liverpool St Bride'''   (for the '''Liverpool St Bride, Lancashire Genealogy''' page)
:*''[[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''' &nbsp;&nbsp;(for the '''Oregon Trail''' page)
:*''[[United States Genealogy|United States]] [[File:Green arrow.png|10px]] [[United States Migration Internal|Migration]] [[File:Green arrow.png|10px]] [[US Migration Trails and Roads|Trails and Roads]]'' [[File:Green arrow.png|10px]] '''Oregon Trail'''   (for the '''Oregon Trail''' page)
:*''[[Principles of Family History Research|Principles of Family History Research]] [[Image:Gotoarrow.png]] [[Obtain and Search the Records|Step 4.&nbsp;Obtain and Search the Records]] [[Image:Gotoarrow.png]]'' '''Obtain the Records''' &nbsp;&nbsp;(for the '''Obtain the Records''' page)
:*''[[Principles of Family History Research|Principles of Family History Research]] [[File:Green arrow.png|10px]] [[Obtain and Search the Records|Step 4. Obtain and Search the Records]]''  [[File:Green arrow.png|10px]] '''Obtain the Records'''   (for the '''Obtain the Records''' page)
:*''[[Germany Genealogy|Germany]] [[Image:Gotoarrow.png]] [[Bavaria, Germany Genealogy|Bayern (Bavaria)]]'' [[Image:Gotoarrow.png]] '''Biography''' &nbsp;&nbsp;(for the '''Bavaria Biography''' page)  
:*''[[Germany Genealogy|Germany]] [[File:Green arrow.png|10px]] [[Bavaria, Germany Genealogy|Bayern (Bavaria)]]'' [[File:Green arrow.png|10px]] '''Biography'''   (for the '''Bavaria Biography''' page)  
:*''[[United States Genealogy|United States]] [[Image:Gotoarrow.png]]'' '''American Indian Genealogy''' &nbsp;&nbsp;(for the '''American Indian Genealogy''' page)
:*''[[United States Genealogy|United States]]''  [[File:Green arrow.png|10px]] '''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.'''
*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.


<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
&#124; link1=
| link1=
&#124; link2=
| link2=
&#124; link3=
| link3=
&#124; link4=
| link4=
&#124; link5=
| 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:&nbsp;&nbsp;&nbsp;''[[United States Genealogy|United States]] [[Image:Gotoarrow.png]] [[Illinois Genealogy|Illinois]] [[Image:Gotoarrow.png]]'' '''Cemeteries'''<br>
it would render as:   ''[[United States Genealogy|United States]] [[File:Green arrow.png|10px]] [[Illinois Genealogy|Illinois]]''  [[File:Green arrow.png|10px]] '''Cemeteries'''<br>

Latest revision as of 16:47, 30 October 2023

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:Breadcrumb|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 = .

{{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 FamilySearch Center|FamilySearch 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]]
}}

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