Template:FSHI/doc: Difference between revisions
m (→Operation) |
|||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
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. | 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 === | === Parameters === | ||
This template has | This template has 4 parameters: | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| Line 14: | Line 14: | ||
|- | |- | ||
| Item || Item number || Item | | Item || Item number || Item | ||
|} | |} | ||
| Line 39: | Line 37: | ||
#If the item and nr parameters are also present it should return a string as in #2 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. | #If all four parameters are present it should return a string as in #3 below. | ||
Sample input: | |||
<pre> | |||
#1 {{FSHI|DGS=8417008}} | |||
#2 {{FSHI|DGS=8417008 |iD=M9DP-VQB |Item=2}} | |||
#3 {{FSHI|DGS=8417008 |iD=M9DP-VQY |image=6}} | |||
</pre> | |||
Expected output: | Expected output: | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
! Example | ! 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 | ||
|} | |} | ||
Revision as of 09:36, 28 June 2024
Purpose[edit source]
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[edit source]
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[edit source]
The ID, Image, and Item parameters are representative only. You will need to check the folder and image to know what the correct parameter to use it.
| 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[edit source]
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.