Overview
The Image User Item adds an image to a page.
The Image User Item is for images that are not image exhibits. Image exhibits are images that are attached to records in your genealogy program. You manage image exhibits via properties in the Data > Exhibits section.
Image Section Properties
Title
The Title property identifies the User Item in the User Items list. The Title has no other purpose for Image User Items.
Enabled
See Enabled in the Common Properties section of the User Items help page.
Image
Click the Image button to select the image file you want to add to the page. Gedcom Publisher will open a standard Windows "open file" dialog window. Use the navigation controls in that dialog window to move to the folder that contains the image you want to use. Select the image file, then click the [Open] button. Gedcom Publisher will display the image.
Image File Handling
Immediately after you select the image file, Gedcom Publisher will respond as follows:
- If the image file is located outside the Input (-i) folder, Gedcom Publisher copies the image file to the
ui(user images) subfolder of the Input (-i) folder. - If the image file is located in a subfolder of the Input (-i) folder, including the
ui(user images) subfolder or any other subfolder, Gedcom Publisher uses that image file and does not copy it. - If the image file is located in the Input (-i) folder, and not in a subfolder, Gedcom Publisher copies the image file to the
ui(user images) subfolder of the Input (-i) folder.
The processing described above allows you to define subfolders under the Input (-i) folder to organize or categorize images. However, you must create the subfolders manually and copy the image files into the Input (-i) folder subfolders manually before you click the [Image...] button to choose the image.
If Gedcom Publisher makes a copy of the image file, the original date is retained.
In any instance where Gedcom Publisher makes a copy of the image file, if you subsequently change the original image file, the change will not be reflected in the book contents. You must edit the Image User Item and re-select the original file to update the copy used by the book. Optionally, you may manually update the copy of the file that is stored in a subfolder of the Input (-i) folder.
Use Embedded Caption
When the Use Embedded Caption property is checked, Gedcom Publisher will attempt to read a caption from the metadata stored with the image in the image file.
When the Use Embedded Caption property is unchecked, Gedcom Publisher will ignore the caption (if any) stored in the image file and use the Caption property text instead.
Caption
The Caption property is enabled when Use Embedded Caption is unchecked. When the Caption property is enabled, Gedcom Publisher will use the contents of the Caption textbox as the caption for the image.
Clear
See Clear in the Common Properties section of the User Items help page.
Class
The Class textbox allows you to specify the name of a CSS class that will be added to the image's container. You may use the class in the selector of a User Style to customize the appearance of any Image User Items with the specified class name.
Thumbnail Section Properties
Option
If the Option property is set to "Thumbnail", Gedcom Publisher will make a reduced-size version of the image and insert the reduced size image on the page. The Width and Height properties determine the maximum dimensions of the reduced-size image. If the Width and Height properties are larger than the Width and Height of the image, the image will not be enlarged.
When Gedcom Publisher creates a thumbnail image, the thumbnail will have the same aspect ratio as the original image.
Width
The Width property determines the maximum width of the reduced-size version of the image.
Height
The Height property determines the maximum height of the reduced-size version of the image.
Link Section Properties
Type
The Type property may be set to "No Link", "Link to person", or "Link to URL". When Type is set to "No Link", the image is not a link. This is the default.
URL
When Type is set to "Link to URL", the URL textbox is enabled. Enter the URL of a page. The image will become a link to the designated URL.
ID
When Type is set to "Link to person", the ID textbox is enabled and you may set it by keying the ID number of a person or choosing a person via the Picklist... button. The image will become a link to the designated person.
Add Reference
When Type is set to "Link to person", the Add Reference checkbox is enabled. If Add Reference is checked, Gedcom Publisher will add a link-type reference to the linked person. The reference will will create a link to the page where this image appears.