Template:FamilySearch Collection/doc: Difference between revisions

← Older edit

Template:FamilySearch Collection/doc (view source)

Revision as of 15:12, 5 July 2012

1,736 bytes added , 5 July 2012

examples

VisualWikitext

Lotje2

2,605

edits

@@ Line 1: / Line 1: @@
 {{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 [[FamilySearch Historical Record Collections]] available to search or browse. Using the template it is possible to add a link in the wiki inviting users to search or browse 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.
+When the site changed from ''beta'' to production, articles that had used this template were updated with a single edit to the '''{{tl|RecordSearch}}''' template.
-==== Parameters ====
+== Parameters ==
-;CID: The reference for the collection ''optional''.
+;CID: The reference for the collection, including the prefix CID ''optional''.<br>If included this parameter must be formatted like {{tlx|FamilySearch Collection|''<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 FamilySearch 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]]'''.
+;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 Historical Records]]'''.
 :'''NOTE:''' The auto-categorization of the article can be suppressed by adding ''category='' as an additional parameter.
-;scheduled: Define this parameter as ''yes'' when the collection is not yet available but is scheduled to be so in the future.
+;scheduled: Define this parameter (''scheduled='') 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>
+{{FamilySearch Collection
+|location=England
+|CID=CIDxxxxxx1
+|title=Baptisms 1700-1900
+|CID2=CIDxxxxxx2
+|title2=Marriages 1700-1900
+|CID3=CIDxxxxxx3
+|title3=Deaths 1700-1900
+}}
+</pre>
+=== Examples ===
+'''Scheduled:'''
+{{FamilySearch_Collection|CID=CID1368704|title=New York Passenger Arrival Lists (Ellis Island) 1892-1924|location=United States|scheduled=|category=}}<br>
+'''No Collection ID:'''
+{{FamilySearch_Collection|CID=|title=New York Passenger Arrival Lists (Ellis Island) 1892-1924|location=United States|category=}}<br>
+'''Collection available:'''
+One collection:
+{{FamilySearch_Collection|CID=CID1368704|title=New York Passenger Arrival Lists (Ellis Island) 1892-1924|location=United States|category=}}<br>
+Multiple collections:
+{{FamilySearch_Collection|CID=CID1784529 |title=Spain, Catholic Church Records, 1500-1930|CID2=CID1865748 |title2=Spain, Granada, Pre-Marriage Investigation Index, 1556-1899|location=Spain|category=}}
+=== Redirects ===
+*{{Tl|Record Search article}}
 <includeonly>
 <!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
+[[Category:Article header templates|{{PAGENAME}}]]
 [[Category:External link templates|{{PAGENAME}}]]
 </includeonly>