Template:FamilySearch Collection/doc

From FamilySearch Wiki

(Difference between revisions)
(add example using multiple CID references)
(Purpose: clarify need for future edit)
Line 3: Line 3:
 
This template can be used to add a header to articles about collections available for search from the [[FamilySearch Record Search]] – Pilot Site. Using the template it is possible to add a link in the wiki inviting users to search the records described in the article.
 
This template can be used to add a header to articles about collections available for search from the [[FamilySearch Record Search]] – Pilot Site. Using the template it is possible to add a link in the wiki inviting users to search the records described in the article.
  
Once ''Record Search'' comes out of ''pilot'', articles that have used this template will be updated with a single edit to this template.  
+
Once ''Record Search'' comes out of ''pilot'', articles that have used this template will be updated with a single edit to the '''{{tl|RecordSearch}}''' template.
  
 
== Parameters ==
 
== Parameters ==

Revision as of 17:40, 23 March 2010

Purpose

This template can be used to add a header to articles about collections available for search from the FamilySearch Record Search – Pilot Site. Using the template it is possible to add a link in the wiki inviting users to search the records described in the article.

Once Record Search comes out of pilot, articles that have used this template will be updated with a single edit to the {{RecordSearch}} template.

Parameters

CID
The reference for the collection, including the prefix CID optional.
If included this parameter must be formatted like {{Record Search article|CID=CIDxxxxxxx }}.
NOTE: There is a space after the reference and before the closing braces (or following parameters). It is important to include a space as this is the format used by Record Search to link to the article in question. If the space is missing the link will not be found.
title
The text to be displayed in the link. optional
NOTE: If either of the parameters, CID or title are omitted the URL for the site will be displayed.
location
The country or region to which the records relate. Used to add the category location FamilySearch Record Collections. If omitted the article will be added to Category:FamilySearch Record Collections.
NOTE: The auto-categorization of the article can be suppressed by adding category= as an additional parameter.
scheduled
Define this parameter (schedule=) when the collection is not yet available but is scheduled to be so in the future.

Multiple CID references

If the collection that is being refered to has more than one CID reference, then you can define these in the template along with a display title in pairs, up to a maximum of nine.

For example

{{Record Search article
|location=England
|CID=CIDxxxxxx1
|title=Baptisms 1700-1900
|CID2=CIDxxxxxx2
|title2=Marriages 1700-1900
|CID3=CIDxxxxxx3
|title3=Deaths 1700-1900
}}