Template:FSHI/doc: Difference between revisions
(Created page with "I think this template will need 3 parameters: {| class="wikitable" |- ! # !! URL value !! usage !! Parameter Name |- | 1 || imageGroupNumbers= || DGS only || DGS |- | 2 || rms...") |
No edit summary |
||
| (19 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
== Purpose == | |||
This template will allow the creation of links to specific images in acquired via Infinity and published as FamilySearch Images/ Explore Historical Images/ Explore Images. | |||
=== Parameters === | |||
This template has 4 parameters: | |||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
! | ! Parameter !! Value !! Display | ||
|- | |- | ||
| | | DGS || DGS number || DGS number | ||
|- | |- | ||
| | | ID || rmsID || none | ||
|- | |- | ||
| | | Image || Image number || Image number | ||
|- | |||
| Item || Item number || Item | |||
|} | |||
=== Operation === | |||
{| class="wikitable" | |||
|- | |||
! Condition !! DGS<br>Parameter !! ID<br>Parameter !! Image<br>Parameter !! Item<br>Parameter !! Sample Code !! Display !! Result | |||
|- | |||
| Only DGS number is given || 8417088 || || || || <nowiki>{{FSHI|DGS=8417008}}</nowiki> || {{FSHI|DGS=8417008}} || Link goes to list of folder content | |||
|- | |||
| DGS, ID, and Image given || 8417088 || M9DP-VQB || 6 || || <nowiki>{{FSHI|DGS=8417088|ID=M9DP-VQB|Image=6}}</nowiki> || {{FSHI|DGS=8417088|ID=M9DP-VQB|Image=6}} || Link goes to specific image in folder | |||
|- | |||
| DGS, ID, and Item given || 8417008 || M9DP-VQB || || 2 || <nowiki>{{FSHI|DGS=8417088|ID=M9DP-VQB|Item=2}}</nowiki> || {{FSHI|DGS=8417088|ID=M9DP-VQB|Item=2}} || Link goes to specific item in folder | |||
|} | |} | ||
'''Note:''' The template will not work correctly if the ID parameter (rmsID) is not provided along with either the Image or Item parameter. | |||
== Operation == | |||
The template should go through the parameters and check them against what is required to return the correct URL. | |||
#If the DGS number is the only one given it should return a string as found in #1 below. | |||
#If the item and nr parameters are also present it should return a string as in #2 below. | |||
#If all four parameters are present it should return a string as in #3 below. | |||
Sample input: | |||
<pre> | <pre> | ||
#1 {{FSHI|DGS=8417008}} | |||
#2 {{FSHI|DGS=8417008 |iD=M9DP-VQB |Item=2}} | |||
#3 {{FSHI|DGS=8417008 |iD=M9DP-VQY |image=6}} | |||
</pre> | </pre> | ||
Expected output: | |||
{| class="wikitable" | |||
|- | |||
! Example !! Display !! Concatenated URL | |||
|- | |||
| #1 || DGS 8417008 || https://www.familysearch.org/records/images/search-results?imageGroupNumbers=8417008&page=1 | |||
|- | |||
| #2 || DGS 8417008 item 2 || https://www.familysearch.org/records/images/image-details?imageGroupNumbers=8417008&page=1&rmsId=M9DP-VQB&imageIndex=0 | |||
|- | |||
| #3 || DGS 8417008 image# 6 || https://www.familysearch.org/records/images/image-details?imageGroupNumbers=8417008&page=1&rmsId=M9DP-VQY&imageIndex=6&singleView=true | |||
|} | |||
See also [https://www.familysearch.org/en/wiki/FamilySearch_Wiki:Manual_of_Style-Formatting#FamilySearch_Explore_Images_-_Links_to_Digital_Images Explore Images - Links to Digital Images]. | See also [https://www.familysearch.org/en/wiki/FamilySearch_Wiki:Manual_of_Style-Formatting#FamilySearch_Explore_Images_-_Links_to_Digital_Images Explore Images - Links to Digital Images]. | ||
<noinclude>[[Category:Template documentation]]</noinclude> | |||
Latest revision as of 15:11, 9 May 2024
Purpose
This template will allow the creation of links to specific images in acquired via Infinity and published as FamilySearch Images/ Explore Historical Images/ Explore Images.
Parameters
This template has 4 parameters:
| Parameter | Value | Display |
|---|---|---|
| DGS | DGS number | DGS number |
| ID | rmsID | none |
| Image | Image number | Image number |
| Item | Item number | Item |
Operation
| Condition | DGS Parameter |
ID Parameter |
Image Parameter |
Item Parameter |
Sample Code | Display | Result |
|---|---|---|---|---|---|---|---|
| Only DGS number is given | 8417088 | {{FSHI|DGS=8417008}} | DGS 8417008 | Link goes to list of folder content | |||
| DGS, ID, and Image given | 8417088 | M9DP-VQB | 6 | {{FSHI|DGS=8417088|ID=M9DP-VQB|Image=6}} | DGS 8417088 Image# 6 | Link goes to specific image in folder | |
| DGS, ID, and Item given | 8417008 | M9DP-VQB | 2 | {{FSHI|DGS=8417088|ID=M9DP-VQB|Item=2}} | DGS 8417088 Item 2 | Link goes to specific item in folder |
Note: The template will not work correctly if the ID parameter (rmsID) is not provided along with either the Image or Item parameter.
Operation
The template should go through the parameters and check them against what is required to return the correct URL.
- If the DGS number is the only one given it should return a string as found in #1 below.
- If the item and nr parameters are also present it should return a string as in #2 below.
- If all four parameters are present it should return a string as in #3 below.
Sample input:
#1 {{FSHI|DGS=8417008}}
#2 {{FSHI|DGS=8417008 |iD=M9DP-VQB |Item=2}}
#3 {{FSHI|DGS=8417008 |iD=M9DP-VQY |image=6}}
Expected output:
| Example | Display | Concatenated URL |
|---|---|---|
| #1 | DGS 8417008 | https://www.familysearch.org/records/images/search-results?imageGroupNumbers=8417008&page=1 |
| #2 | DGS 8417008 item 2 | https://www.familysearch.org/records/images/image-details?imageGroupNumbers=8417008&page=1&rmsId=M9DP-VQB&imageIndex=0 |
| #3 | DGS 8417008 image# 6 | https://www.familysearch.org/records/images/image-details?imageGroupNumbers=8417008&page=1&rmsId=M9DP-VQY&imageIndex=6&singleView=true |
See also Explore Images - Links to Digital Images.