Template:RecordSearch/doc: Difference between revisions
(update usage) |
(→Usage: add usage for access) |
||
| Line 1: | Line 1: | ||
{{documentation subpage}} | {{documentation subpage}} | ||
=== Purpose === | |||
Once ''Record Search'' comes out of ''pilot'', articles that have used this template will be updated with a single edit to this template. | |||
=== Usage === | === Usage === | ||
This template can be used to link to collections available for search from the [[FamilySearch Record Search]] – Pilot Site. It can take | This template can be used to link to collections available for search from the [[FamilySearch Record Search]] – Pilot Site. It can take three parameters | ||
# The reference for the collection ''optional'' | # The reference for the collection ''optional'' | ||
#* If omitted the URL for the site will be displayed | #* 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'' | |||
#* Used for ''Browse image only'' collection. This is done by using ''access=browse''. If the parameter is omitted it will default to the correct output for searchable collections | |||
=== Example === | === Example === | ||
Revision as of 16:10, 26 March 2010
 |
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. |
Purpose[edit source]
Once Record Search comes out of pilot, articles that have used this template will be updated with a single edit to this template.
Usage[edit source]
This template can be used to link to collections available for search from the FamilySearch Record Search – Pilot Site. It can take three parameters
- 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
- If omitted the reference number will be displayed instead.
- access= optional named parameter
- Used for Browse image only collection. This is done by using access=browse. If the parameter is omitted it will default to the correct output for searchable collections
Example[edit source]
| You type | You get |
|---|---|
{{RecordSearch|1610550}}
|
|
{{RecordSearch |1610550|England, Cheshire Nonconformist Church Records}}
|
|
{{RecordSearch}}
|