Overview
A Custom Index User Item produces a name index that mimics the format of the name index that GedSite produces automatically. In a Custom Index, however, you can filter the contents. For example, you could add a Custom Index to your site that lists the names of people who have a specific event, or who descend from a certain progenitor.
A Custom Index User Item is a Page Item. It creates a page of its own and cannot be added to a Page User Item. If you add a Custom Index to a Page User Item, the page will have a link to the Custom Index, not the contents of the index.
A Custom Index comprises one or more surname index pages and one or more name index pages. All the pages are placed in a folder whose name you designate with the Folder property. As in the default name index, the surname index has a list of surnames that are links into the name index pages.
A Custom Index will only include names that:
- Use a Name Tag Type that is selected in the Tag Type list in the Data > Tags Section.
- Pass the Name Filter, if any.
Properties
Title
Enter a title for the User Item. The User Item title becomes a prefix for the surname index and name index pages.
Enabled
See Enabled in the Common Properties section of the User Items help page.
Folder
The Folder property indicates the name of the folder GedSite will create to hold the surname index and name index pages. The folder will be created in the Output (-o) folder when GedSite makes the site.
For best results, use a short, all-lowercase name with no special characters or spaces.
Each Custom Index requires its own folder.
Menu
The Menu property determines whether or not a link to the index is added to one or more of the site's menus. The Menu property defaults to "none". Change it to one of the other choices to make the item appear in a menu.
The Menu property is ignored when the link is not at the top-level (left-most) of User Items.
Link To
The Link To property determines whether links to the Custom Index open the first page of the surname index or the first page of the name index.
- Name page
- Links to the Custom Index will open the first name index page.
- Surname page
- Links to the Custom Index will open the first surname index page. This is the default.
The default is "Surname page" because that is the best choice for a name index with many names. If you have a name index with a relatively small number of names, you may opt to set the Link To property to "Name page".
Description
The Description text will appear next to a link to the Custom Index when the link appears in lists on a Page Item.
First Page Content
A Custom Index is a Page Item and you cannot add other User Items to the page to add content, such as an introduction for the Custom Index contents. Use the First Page Content property to provide text that will appear at the top of the first surname index page (when Link To is set to "Surname page") or at the top of the first name index page (when Link To is set to "Name page").
Person Filter
Add Filter terms to the Person Filter list to select the people you want to include in the list.
Name Filter
Add Filter terms to the Name Filter list to select the names you want to include in the list.
Add References
If Add References is checked, GedSite will add a list-type reference for each name that is part of the Custom Index.