Template:FSHI/doc: Difference between revisions

From FamilySearch Wiki
No edit summary
Line 15: Line 15:
| 4 || imageIndex=  || specific image (starting with 1) || image
| 4 || imageIndex=  || specific image (starting with 1) || image
|}
|}
=== Results Display ===
How the results are displayed is dependent on what parameters are provided.
1. Only DGS number is given
<pre>
{{FSHI|DGS=8417008}}
</pre>
{| class="wikitable"
|-
! Condition !! DGS Parameter !! item Parameter !! nr Parameter !! image Parameter !! Display
|-
| Only DGS number is given || 8417008 ||  ||  ||  ||  DGS 8417008
|-
|}
=== Operation ===
=== Operation ===
The template should go through the parameters and check them against what is required to return the correct URL.
The template should go through the parameters and check them against what is required to return the correct URL.

Revision as of 11:29, 6 April 2023

Purpose[edit source]

This template will allow the creation of links to specific images in FamilySearch Historical Images ("Images").

Parameters[edit source]

I think this template will need 4 parameters:

# URL value usage Parameter Name
1 imageGroupNumbers= DGS only DGS
2 rmsId= itemized in RMS item
3 null display item number nr
4 imageIndex= specific image (starting with 1) image

Results Display[edit source]

How the results are displayed is dependent on what parameters are provided. 1. Only DGS number is given

{{FSHI|DGS=8417008}}
Condition DGS Parameter item Parameter nr Parameter image Parameter Display
Only DGS number is given 8417008 DGS 8417008


Operation[edit source]

The template should go through the parameters and check them against what is required to return the correct URL.

  1. If the DGS number is the only one given it should return a string as found in #1 below.
  2. If the item and nr parameters are also present it should return a string as in #2 below.
  3. If all four parameters are present it should return a string as in #3 below.

Sample input and output:

#1 {{FSHI|DGS=8417008}}
#2 {{FSHI|DGS=8417008 |item=M9DP-VQB |nr=2}}
#3 {{FSHI|DGS=8417008 |item=M9DP-VQY |image=6}}

Expected output:

#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 8417008 image# 6 - https://www.familysearch.org/records/images/image-details?imageGroupNumbers=8417008&page=1&rmsId=M9DP-VQY&imageIndex=6&singleView=true

Testing Data[edit source]

1. This URL is for the first image in a folder

https://www.familysearch.org/records/images/search-results?imageGroupNumbers=8417008&page=1

2. These results are for each item in a folder. In the the URL string search-results is replaced with image-details and the text rmsId=M9DP-VQY&imageIndex=0 is appended, where M9DP-VQY represents a unique value for that item.

https://www.familysearch.org/records/images/image-details?imageGroupNumbers=8417008&page=1&rmsId=M9DP-VQY&imageIndex=0
https://www.familysearch.org/records/images/image-details?imageGroupNumbers=8417008&page=1&rmsId=M9DP-VQB&imageIndex=0
https://www.familysearch.org/records/images/image-details?imageGroupNumbers=8417008&page=1&rmsId=M9DP-V79&imageIndex=0
https://www.familysearch.org/records/images/image-details?imageGroupNumbers=8417008&page=1&rmsId=M9DP-V7M&imageIndex=0
https://www.familysearch.org/records/images/image-details?imageGroupNumbers=8417008&page=1&rmsId=M9DP-VQR&imageIndex=0
https://www.familysearch.org/records/images/image-details?imageGroupNumbers=8417008&page=1&rmsId=M9DP-VQT&imageIndex=0
https://www.familysearch.org/records/images/image-details?imageGroupNumbers=8417008&page=1&rmsId=M9DP-VQ1&imageIndex=0

3. These are for specific images in a folder. This is the same URL string as that for an item, but the numeric value at the end of the string is replaced by the specific image number and the string &singleView=true.

https://www.familysearch.org/records/images/search-results?imageGroupNumbers=8417007&page=1
https://www.familysearch.org/records/images/image-details?imageGroupNumbers=8417007&page=1&rmsId=TH-909-80444-120928-39&imageIndex=6&singleView=true
https://www.familysearch.org/records/images/image-details?imageGroupNumbers=8417007&page=1&rmsId=TH-909-80444-120928-39&imageIndex=21&singleView=true

More samples using the same DGS showing 1) the URL for the DGS, 2) the first item on the DGS, and 3) a specific image on the DGS.

1. https://www.familysearch.org/records/images/search-results?imageGroupNumbers=102152121
2. https://www.familysearch.org/records/images/image-details?imageGroupNumbers=102152121&rmsId=TH-909-60368-30634-8&imageIndex=0
3. https://www.familysearch.org/records/images/image-details?imageGroupNumbers=102152121&rmsId=TH-909-60368-30634-8&imageIndex=2&singleView=true

See also Explore Images - Links to Digital Images.