Template:FamilySearch Collection/doc: Difference between revisions

add example using multiple CID references
(add cat)
(add example using multiple CID references)
Line 1: Line 1:
{{documentation subpage}}
{{documentation subpage}}
=== Purpose ===
== 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.
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 this template.  


==== Parameters ====
== Parameters ==
;CID: The reference for the collection, including the prefix CID ''optional''.<br>If included this parameter must be formatted like {{tlx|Record Search article|''<nowiki>CID=CIDxxxxxxx </nowiki>''}}.<br>'''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.
;CID: The reference for the collection, including the prefix CID ''optional''.<br>If included this parameter must be formatted like {{tlx|Record Search article|''<nowiki>CID=CIDxxxxxxx </nowiki>''}}.<br>'''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''
;title: The text to be displayed in the link. ''optional''
Line 14: Line 14:


;scheduled: Define this parameter (''schedule='') when the collection is not yet available but is scheduled to be so in the future.
;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'''
<pre>
{{Record Search article
|location=England
|CID=CIDxxxxxx1
|title=Baptisms 1700-1900
|CID2=CIDxxxxxx2
|title2=Marriages 1700-1900
|CID3=CIDxxxxxx3
|title3=Deaths 1700-1900
}}
</pre>




90,866

edits