Difference between revisions of "Template:RecordSearch/doc"

From FamilySearch Wiki
Jump to: navigation, search
(update to reflect template move)
(Example: change example)
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{documentation subpage}}
 
{{documentation subpage}}
 +
=== Purpose ===
 +
When ''Record Search'' changed from ''beta'' to production, articles that had used this template were all updated with a single edit to this template.
 +
 
=== Usage ===
 
=== Usage ===
This template can be used to link to collections available for search from the [http://pilot.familysearch.org FamilySearch Record Search – Pilot Site]. It takes two parameters
+
This template can be used to link to specific [[FamilySearch Historical Record Collections]] available for search. It can take three parameters
# The reference for the collection
+
# The reference for the collection ''optional''
 +
#* If omitted the URL for the site will be displayed
 
# The text to be displayed in the link. ''optional''
 
# The text to be displayed in the link. ''optional''
 
#* If omitted the reference number will be displayed instead.
 
#* If omitted the reference number will be displayed instead.
 
+
# '''access=''' ''optional named parameter''. If the parameter is omitted it will default to the correct output for searchable collections
Once ''Record Search'' comes out of ''pilot'', article that have used this template will be updated with a single edit to this template.  
+
#* Used for linking to a ''Browse image only'' collection. This is done by using ''access=browse''.
 +
#* Used for linking to a specific browsing ''waypoint'' within a collection. This is done by using ''access=waypoint''.
  
 
=== Example ===
 
=== Example ===
Line 22: Line 27:
 
|
 
|
 
<pre>
 
<pre>
 +
{{RecordSearch
 +
|1610550
 +
|England, Cheshire Nonconformist Church Records
 +
}}
 +
</pre>
 +
|
 
{{RecordSearch |1610550|England, Cheshire Nonconformist Church Records}}
 
{{RecordSearch |1610550|England, Cheshire Nonconformist Church Records}}
 +
|-
 +
|
 +
<pre>
 +
{{RecordSearch
 +
|1462401
 +
|Argentina National Census, 1869
 +
|access=browse
 +
}}
 +
</pre>
 +
|
 +
{{RecordSearch|1462401|Argentina National Census, 1869|access=browse}}
 +
|-
 +
|
 +
<pre>
 +
{{RecordSearch
 +
|14031753
 +
|Probate records for Rensselaer County
 +
|access=waypoint
 +
}}
 +
</pre>
 +
|
 +
{{RecordSearch|14031753|Probate records for Rensselaer County|access=waypoint}}
 +
|-
 +
|
 +
<pre>
 +
{{RecordSearch}}
 
</pre>
 
</pre>
 
|
 
|
{{RecordSearch |1610550|England, Cheshire Nonconformist Church Records}}
+
{{RecordSearch}}
 
|}
 
|}
 +
 +
== See also ==
 +
* {{tl|HistRecColl}} - used for formatting the text and links for [[FamilySearch Historical Record Collections]] citations
 +
 
<includeonly>
 
<includeonly>
 
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 
[[Category:External link templates|{{PAGENAME}}]]
 
[[Category:External link templates|{{PAGENAME}}]]
 
</includeonly>
 
</includeonly>

Latest revision as of 10:46, 21 April 2012

Purpose

When Record Search changed from beta to production, articles that had used this template were all updated with a single edit to this template.

Usage

This template can be used to link to specific FamilySearch Historical Record Collections available for search. It can take three parameters

  1. The reference for the collection optional
    • If omitted the URL for the site will be displayed
  2. The text to be displayed in the link. optional
    • If omitted the reference number will be displayed instead.
  3. access= optional named parameter. If the parameter is omitted it will default to the correct output for searchable collections
    • Used for linking to a Browse image only collection. This is done by using access=browse.
    • Used for linking to a specific browsing waypoint within a collection. This is done by using access=waypoint.

Example

You type You get
{{RecordSearch|1610550}}

Record Collection 1610550

{{RecordSearch 
|1610550
|England, Cheshire Nonconformist Church Records
}}

England, Cheshire Nonconformist Church Records

{{RecordSearch
|1462401
|Argentina National Census, 1869
|access=browse
}}

Argentina National Census, 1869

{{RecordSearch
|14031753
|Probate records for Rensselaer County
|access=waypoint
}}

Probate records for Rensselaer County

{{RecordSearch}}

Historical Record Collections

See also