Template:RecordSearch/doc: Difference between revisions
(→Example: change example) |
(update doc) |
||
(7 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{documentation subpage}} | {{documentation subpage}} | ||
=== Purpose === | === Purpose === | ||
Once ''Record Search'' comes out of ''beta'', articles that have used this template will be updated with a single edit to this template. | |||
=== Usage === | === Usage === | ||
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'' | # '''access=''' ''optional named parameter'' | ||
#* Used for | #* 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 === | ||
Line 27: | Line 26: | ||
| | | | ||
<pre> | <pre> | ||
{{RecordSearch | {{RecordSearch |1610550|England, Cheshire Nonconformist Church Records}} | ||
|1610550 | |||
|England, Cheshire Nonconformist Church Records | |||
}} | |||
</pre> | </pre> | ||
| | | | ||
Line 37: | Line 33: | ||
| | | | ||
<pre> | <pre> | ||
{{RecordSearch | {{RecordSearch|1416598|Norfolk CofE Parish Registers, 1538-1900|access=browse}} | ||
| | |||
| | |||
|access=browse | |||
}} | |||
</pre> | </pre> | ||
| | | | ||
{{RecordSearch| | {{RecordSearch|1416598|Norfolk CofE Parish Registers, 1538-1900|access=browse}} | ||
|- | |- | ||
| | | | ||
Line 64: | Line 45: | ||
{{RecordSearch}} | {{RecordSearch}} | ||
|} | |} | ||
<includeonly> | <includeonly> | ||
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS --> | <!-- CATEGORIES AND INTERWIKIS HERE, THANKS --> | ||
[[Category:External link templates|{{PAGENAME}}]] | [[Category:External link templates|{{PAGENAME}}]] | ||
</includeonly> | </includeonly> |
Revision as of 05:55, 13 October 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 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
- 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|1416598|Norfolk CofE Parish Registers, 1538-1900|access=browse}} |
|
{{RecordSearch}} |