Template:FSHI/doc: Difference between revisions

Latest revision as of 15:11, 9 May 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]

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

@@ Line 1: / Line 1: @@
-I think this template will need 3 parameters:
+== 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"
 |-
-! # !! URL value !! usage !! Parameter Name
+! Parameter !! Value !! Display
 |-
-| 1 || imageGroupNumbers= || DGS only || DGS
+| DGS || DGS number || DGS number
 |-
-| 2 || rmsId= || itemized in RMS ||item
+| ID || rmsID || none
 |-
-| 3 || imageIndex=  || specific image (starting with 1) || image
+| 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
 |}
-This is for the first image in a folder
+'''Note:''' The template will not work correctly if the ID parameter (rmsID) is not provided along with either the Image or Item parameter.
-<pre>
-https://www.familysearch.org/records/images/search-results?imageGroupNumbers=8417008&page=1
+== Operation ==
-</pre>
+The template should go through the parameters and check them against what is required to return the correct URL.
-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.
-<pre>
+#If the DGS number is the only one given it should return a string as found in #1 below.
-https://www.familysearch.org/records/images/image-details?imageGroupNumbers=8417008&page=1&rmsId=M9DP-VQY&imageIndex=0
+#If the item and nr parameters are also present it should return a string as in #2 below.
-https://www.familysearch.org/records/images/image-details?imageGroupNumbers=8417008&page=1&rmsId=M9DP-VQB&imageIndex=0
+#If all four parameters are present it should return a string as in #3 below.
-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
-</pre>
-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.
+Sample input:
 <pre>
-. https://www.familysearch.org/records/images/search-results?imageGroupNumbers=102152121
+#1 {{FSHI|DGS=8417008}}
-. https://www.familysearch.org/records/images/image-details?imageGroupNumbers=102152121&rmsId=TH-909-60368-30634-8&imageIndex=0
+#2 {{FSHI|DGS=8417008 |iD=M9DP-VQB |Item=2}}
-. https://www.familysearch.org/records/images/image-details?imageGroupNumbers=102152121&rmsId=TH-909-60368-30634-8&imageIndex=2&singleView=true
+#3 {{FSHI|DGS=8417008 |iD=M9DP-VQY |image=6}}
 </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].
+<noinclude>[[Category:Template documentation]]</noinclude>