Template:RecordSearch/doc: Difference between revisions

From FamilySearch Wiki
VisualWikitext
(→‎Example: change example)
(add {{documentation subpage}})
(16 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 specific [[FamilySearch Historical Record Collections]] available for search. It can take three parameters
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
# The reference for the collection ''optional''
# The CID reference for the collection
#* 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 CID 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
 
#* Used for linking to a ''Browse image only'' collection. This is done by using ''access=browse''.
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 specific browsing ''waypoint'' within a collection. This is done by using ''access=waypoint''.


=== Example ===
=== Example ===
Line 20: Line 15:
|
|
<pre>
<pre>
{{RecordSearch|1610550}}
{{CID|1610550}}
</pre>
|
{{RecordSearch |1610550}}
|-
|
<pre>
{{RecordSearch
|1610550
|England, Cheshire Nonconformist Church Records
}}
</pre>
</pre>
|
|
{{RecordSearch |1610550|England, Cheshire Nonconformist Church Records}}
{{CID|1610550}}
|-
|-
|
|
<pre>
<pre>
{{RecordSearch
{{CID|1610550|England, Cheshire Nonconformist Church Records}}
|1462401
|Argentina National Census, 1869
|access=browse
}}
</pre>
</pre>
|
|
{{RecordSearch|1462401|Argentina National Census, 1869|access=browse}}
{{CID|1610550|England, Cheshire Nonconformist Church Records}}
|-
|
<pre>
{{RecordSearch
|14031753
|Probate records for Rensselaer County
|access=waypoint
}}
</pre>
|
{{RecordSearch|14031753|Probate records for Rensselaer County|access=waypoint}}
|-
|
<pre>
{{RecordSearch}}
</pre>
|
{{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 -->
[[Category:External link templates|CID]]
[[Category:External link templates|{{PAGENAME}}]]
</includeonly>
</includeonly>

Revision as of 13:37, 9 August 2009

Edit-copy green.svg.png This is a documentation subpage for Template:RecordSearch (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.

Usage[edit source]

This template can be used to link to collections available for search from the FamilySearch Record Search – Pilot Site. It takes two parameters

  1. The CID reference for the collection
  2. The text to be displayed in the link. optional
    • If omitted the CID reference number will be displayed instead.

Once Record Search comes out of pilot, article that have used this template will be updated with a single edit to this template.

Example[edit source]

You type You get 
{{CID|1610550}}

Record Collection 1610550 

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

England, Cheshire Nonconformist Church Records

Retrieved from "https://integration-ru.familysearch.org/en/wiki/index.php?title=Template:RecordSearch/doc&oldid=201369"