Template:FSHI/doc: Difference between revisions

From FamilySearch Wiki
No edit summary
No edit summary
Line 12: Line 12:
| 4 || imageIndex=  || specific image (starting with 1) || image
| 4 || imageIndex=  || specific image (starting with 1) || image
|}
|}
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 templates and output:
<pre>
#1 {{FSHI|DGS=8417008}}
#2 {{FSHI|DGS=8417008 |item=M9DP-VQB | nr=2}}
#3 {{FSHI|DGS=8417008 |item=M9DP-VQY |image=6}}
</pre>
Expecte output:
<pre>
#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
</pre>
For testing purposes:
For testing purposes:
1. This URL is for the first image in a folder
1. This URL is for the first image in a folder
<pre>
<pre>

Revision as of 19:47, 16 March 2023

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

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 templates and output:

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

Expecte 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

For testing purposes:

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.