Template:RecordSearch/doc: Difference between revisions
(add access=waypoint example) |
m (→Usage: copyedit) |
||
| Line 9: | Line 9: | ||
# 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 | # '''access=''' ''optional named parameter''. If the parameter is omitted it will default to the correct output for searchable collections | ||
#* Used for linking to ''Browse image only'' collection. This is done by using ''access=browse''. | #* Used for linking to a ''Browse image only'' collection. This is done by using ''access=browse''. | ||
#* Used for linking to specific browsing ''waypoint'' within a collection. This is done by using ''access=waypoint''. | #* Used for linking to a specific browsing ''waypoint'' within a collection. This is done by using ''access=waypoint''. | ||
=== Example === | === Example === | ||
Revision as of 09:37, 17 March 2011
 |
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 beta, 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 specific FamilySearch Historical Record Collections available for search. 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. 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[edit source]
| You type | You get |
|---|---|
{{RecordSearch|1610550}}
|
|
{{RecordSearch |1610550|England, Cheshire Nonconformist Church Records}}
|
|
{{RecordSearch|1462401|Argentina National Census, 1869|access=browse}}
|
|
{{RecordSearch|7998096|Probate records for Williamson County|access=waypoint}}
|
|
{{RecordSearch}}
|