Template:View Images Link/doc

This template is intended for the Wiki User Guidance team when creating browse instructions for Historical Records Collections. In its initial configuration it is designed to support a browse hierarchy with four levels.

Parameters[edit source]

This template uses the following parameters:

{{View_Images_Link
| scheduled = 
| CID = 
| browse_1 = 
| browse_2 = 
| browse_3 = 
| browse_4 = 
| browse_5 = 
}}

Values[edit source]

The following values are accepted:

scheduled = - used to identify if the collection is published
CID - the CID number goes here. The CID does not have to be prefixed with the letters CID.
browse_1 - the first level of the browse hierarchy
browse_2 - the second level of the browse hierarchy
browse_3 - the third level of the browse hierarchy
browse_4 - the fourth level of the browse hierarchy
browse_5 - the fifth level of the browse hierarchy

If the browse levels are not used the parameters must be left blank, and not removed. The only parameter that can be deleted is scheduled =.

Evaluation[edit source]

The template evaluates the parameters to determine first if the collection is published. If the collection is not published it returns, "You will be able to view the images in this collection when it is published." and ends.

If the collection is published it displays a link to the collection browse page with the browse hierarchy displayed as a numbered list.

Output[edit source]

Collection Not Yet Published[edit source]

{{View_Images_Link
| scheduled = 
| CID = 1614809
| browse_1 = Department
| browse_2 = City or Town
| browse_3 = Parish
| browse_4 = Record Type and Years
| browse_5 = 
}}

You will be able to view the images in this collection when it is published.

Collection Published[edit source]

{{View_Images_Link

| CID = 1614809
| browse_1 = Department
| browse_2 = City or Town
| browse_3 = Parish
| browse_4 = Record Type and Years
| browse_5 = 
}}

View images in this collection by visiting the Collection Browse Page:

Select Department
Select City or Town
Select Parish
Select Record Type and Years to view the images

Collection Published With 2-Level Browse[edit source]

{{View_Images_Link

| CID = 2333770
| browse_1 = Freedmen's Bureau Office or Subordinate Field Office Location
| browse_2 = NARA Roll Number-Contents
| browse_3 = 
| browse_4 = 
| browse_5 = 
}}

View images in this collection by visiting the Collection Browse Page:

Select Freedmen's Bureau Office or Subordinate Field Office Location
Select NARA Roll Number-Contents to view the images

Acknowledgements[edit source]

Special thanks to Ccsmith for his help with the coding.