Template:FSHI/doc: Difference between revisions

From FamilySearch Wiki
VisualWikitext
No edit summary
(23 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== Purpose ==
I think this template will need 4 parameters:
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 5 parameters:
{| class="wikitable"
{| class="wikitable"
|-
|-
! Parameter !! Value !! Display
! # !! URL value !! usage !! Parameter Name
|-
|-
| DGS || DGS number || DGS number
| 1 || imageGroupNumbers= || DGS only || DGS
|-
|-
| ID || rmsID || none
| 2 || rmsId= || itemized in RMS ||item
|-
|-
| Image || Image number || Image number
| 3 || null || display item number || nr
|-
|-
| Item || Item number || Item
| 4 || imageIndex=  || specific image (starting with 1) || image
|-
| alt || Alternative Text || Display for link
|}
 
=== Operation ===
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.
{| 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.
The template should go through the parameters and check them against what is required to return the correct URL.


Line 39: Line 18:
#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.
#If the alt parameter is present display only that.


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>


Expected output:
For testing purposes:
{| class="wikitable"
 
|-
1. This URL is for the first image in a folder
! Example !! Wikicode !! Display !! Concatenated URL !! Result
<pre>
|-
https://www.familysearch.org/records/images/search-results?imageGroupNumbers=8417008&page=1
| #1 || <code><nowiki>{{FSHI|DGS=8417008}}</nowiki></code> || DGS 8417008 || https://www.familysearch.org/records/images/search-results?imageGroupNumbers=8417008&page=1 || {{FSHI2|DGS=8417008}}
</pre>
|-
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.
| #2 || <code><nowiki>{{FSHI|DGS=8417008 |ID=M9DP-VQB |Item=2}}</nowiki></code> || DGS 8417008 item 2 || https://www.familysearch.org/records/images/image-details?imageGroupNumbers=8417008&page=1&rmsId=M9DP-VQB&imageIndex=0 || {{FSHI2|DGS=8417008 |ID=M9DP-VQB |Item=2}}
<pre>
|-
https://www.familysearch.org/records/images/image-details?imageGroupNumbers=8417008&page=1&rmsId=M9DP-VQY&imageIndex=0
| #3 || <code><nowiki>{{FSHI|DGS=8417008 |ID=M9DP-VQY |Image=6}}</nowiki></code> || DGS 8417008 image# 6 || https://www.familysearch.org/records/images/image-details?imageGroupNumbers=8417008&page=1&rmsId=M9DP-VQY&imageIndex=6&singleView=true || {{FSHI2|DGS=8417008 |ID=M9DP-VQY |Image=6}}
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
| #4 || <code><nowiki>{{FSHI|DGS=110264677 |alt=605-1-34}}</nowiki></code> || 605-1-34 || https://www.familysearch.org/records/images/search-results?imageGroupNumbers=110264677 || {{FSHI2|DGS=110264677 |alt=605-1-34}}
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
</pre>
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'''.
<pre>
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
</pre>
 
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.
<pre>
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
</pre>


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>

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.

DGS stands for Digital Genealogical Society also known as an Image Group Number. Each set of digital images is assigned a DGS number for identification purposes.

Retrieved from "https://integration-ru.familysearch.org/en/wiki/index.php?title=Template:FSHI/doc&oldid=5270587"