Categories
Fact Sheet Fusion v2

Entity Subsets

Entity Subset Interface
Entity Subset Interface

Subsets within Fact Sheet Fusion are a way to group entities. These groups of entities can then be used to help filter the entities while editing or exporting.

Add buttonCreating a Subset

To create a new subset, click on the add button from the main menu bar or via the subset pop-up context menu. Enter the name for the Subset and click the Add button.

Add Subset dialog
Add Subset dialog

Once the subset has been created it will be listed in the current subset list.

Subset context pop-up menu.
Subset context pop-up menu.
Tip

Subsets can also be created and populated via the Entity Import option.

Edit buttonEdit a subset

To edit the name of an existing Subset select it, then select the ‘Edit Subset’ menu option.

Update Subset dialog
Update Subset dialog

Delete buttonDelete a subset

Select the subset to be deleted. Then click on the delete button, or select the delete subset option from the menu. Confirmation is required prior to deletion.

Delete Subset confirmation dialog
Delete Subset confirmation dialog
Warning

There is no undo option when deleting a subset.

Note

No entities are deleted when a subset is deleted.

Adding and removing Entities from a Subset

When a subset is selected, all the entities within the project will be loaded into the entities panel to the right. Entities already associated with the subset will be displayed with a check in the checkbox. To associated one or more entities to the selected subset click on the entity check box or name. Selecting an entity that is already checked will unselect it from the subset.

Select All buttonSelect All Entities

To add all entities to the selected subset in one action, rather than select each entity individually select the ‘Select All’ option from the main menu or the Entity List context pop-up menu (accessed by right clicking within the entity list).

Unselect All buttonUnselect All Entities

To unselect all currently selected entities in the current subset in one action, rather than unselecting each entity individually select the ‘Unselect All’ option from the main menu or the Entity List context pop-up menu (accessed by right clicking within the entity list).

Subset Entity list context pop-up menu options
Subset Entity list context pop-up menu options

Subsets and Exporting

Within the Entities tab of the Fact Sheet export dialog subsets can be selected for export. The export output will be limited to a unique list of entities drawn from the selected subsets.

Subset export options in the main fact sheet export dialog
Subset export options in the main fact sheet export dialog
Categories
Fact Sheet Fusion v2

Entities

An entity is the object for which the fact sheet is being created. An entity can be anything such as an insect, fish or plant species, a medical disorder, or any other series of objects that are described according to specific topics. For more information see Components of a fact sheet.

Adding Entities

To add a new Entity to the Entity list, first give focus to the Entity list by clicking on it. You can tell when the Entity has focus as its background will change color. Adding a new Entity can be done in several ways:

Add Entity dialog
Add Entity dialog
  1. Via the Entities Menu…Add (Ctrl + E)
  2. Via the pop-up context menu accessible by right clicking within the Entity list.
  3. Via the Import (Ins) option (available via the Entities menu or the context menu).

You can also elect to add the entities to an existing or new Subset automatically. To do this either select an existing Subset from the dropdown menu or type in the name of a new Subset.

Tip

You can use this import process to automatically add entities to a subset, even if they already exist in the current project.

Import Entities dialog
Import Entities dialog
Tip

You can browse to load text into the import dialog from a file by using the folder button.

Note

When an entity is created a corresponding Media Category of the same name will also be created, if it doesn't exist.

Editing Entities

To edit an existing entity select the entity by clicking on it (or use the up or down arrow keys to navigate to it). Then you can select the edit option (via the Entities menu or context menu), or simply press Ctrl+E. Make the desired changes and click the update button to complete the task.

Update Entity dialog
Update Entity dialog
Note

When an entity is renamed, it's corresponding Media Category will also be renamed.

Delete buttonDeleting Entities

To delete an Entity, first select it by clicking on it (or use the up or down arrow keys to navigate to it). Then select the delete option from the Entities menu or context menu, or simply press the delete key. You will need to confirm that you wish to delete the Entity.

Delete Entity confirmation dialog
Delete Entity confirmation dialog

Deleting a Entity will also automatically remove all Topic text and media references (but will not delete the media files) from the Entity.

Note

There is no undo for this action.

Sort descending button Sort ascending buttonSorting Entities

By default Fact Sheet Fusion will list the Entities in the order you enter them. However you can sort Entities in two ways. You can either sort all the Entities automatically in to ascending or descending order via the Entities Sort sub menu or context menu. Or you can manually sort the Entities using Drag and Drop.

Entity Properties

Entity Properties panel
Entity Properties panel

When you give focus to an Entity its properties will be listed within the Properties section of the interface located top right. When you give focus to an Entity property you will get a small help topic listed at the bottom of the properties describing its function.

General

Entity Name – You can edit the Entity name in the properties panel or as described above.

Alternative Names – This property allows you to assign alternative names associated with the Entity. For example, common names, synonyms etc. See the Alternative Names help topic for further information.

Tip

You can access the Alternative Name dialog by using the shortcut key combination (Ctrl + Right Arrow) for the selected Entity.

Entity Order – The sort order of the entities is controlled by the Entity list. See the Sorting options for Entities above.

Entity Parent – You may select another entity as the parent of the selected entity. This can be used when grouping and listing entities, for example, within the index page.

Author – You may enter the author of the entity fact sheet here. The author information can be exported out into the fact sheet meta-data or wherever it is supported in the export template.

Tip

The author field allows for token replacement. E.g. [EntityName] and [Topic:].

Author Notes – These are private notes relating to the entity. They will not be included as a part of the export process.

Tip

The Author Notes field allows for token replacement. E.g. [EntityName] and [Topic:].

Review – Mark the entity as needing review. E.g. For further editing. Marking an Entity for review will give you the option of excluding the entity in the export process. See the Export Entity Options help topic for further information.

Description –  The description field is a short summary of the entity fact sheet. It can be used in the Fact Sheet meta-data or wherever it is supported in the export template.

Tip

The Description field allows for token replacement. E.g. [EntityName] and [Topic:].

Specialized
Unique Identifier – The unique identifier is a code (number, text or combination thereof) such as an LSID or database ID that can be used where supported in specialized export templates. For example, it could be used as a part of a query string to filter or to return additional information from an online system.

Exclusions
Exclude – If set to true the entity will be excluded from the export process and no fact sheet will be created, unless overridden by Export options.

Exclude as Heading – Normally most export templates place the entity name at the top of the fact sheet to identify its content. However, if needed, you can mark the entity name to be excluded as a heading, if the export template supports this.

Exclude Entities – This property allows you to exclude the cross-linking of other entities found within the entities topics.

Exclude Glossary – This property allows you to exclude the cross-linking of glossary terms found within the entities topics.

Overrides
Entity Heading Color – Normally the export template will define the color (and style) of the Entity headings within the fact sheet. However you can override this with your preferred color.

Entity Heading color picker
Entity Heading color picker

Custom Style – Normally the export template will define the style and formatting of the Entity heading. However you can completely override the export templates style sheet by defining your own in-line styles.
The styles defined should follow the same rules for applying a HTML in-line style. e.g. An in-line style on a heading tag:

<h1 style=”color:#333;text-transform:uppercase;border:none;”>My Entity</h1>

The Custom Style should only define the style definitions, not the tags. i.e. The highlighted section below from the example above:

<h1 style=”color:#333;text-transform:uppercase;border:none;“>My Entity</h1>

Exporting

Export Fact Sheets

Please see Exporting Fact Sheets for further information.

To file buttonEntity Names to File

This takes the currently listed entities and saves them to a text file. Once the file has been created you will be asked where to save it.

ClipboardEntity Names to Clipboard

This takes the current listed entities and saves them to the clipboard where you can for example paste them into another document etc.

Filtering Entities

When dealing with a large number of entities it’s often useful to temporarily filter the list. You can do this via the filter option found at the top of the entity list. To access the filter options click on the dropdown list.

Tip

If the entity list is selected use the following keyboard shortcut to access the filter option: Ctrl + spacebar.

Entity filter option
Entity filter option

Two filter options are available:

  • Text filter: Enter search criteria (text) you wish to match within the entity list and their alternative names, if present.
    Note: If a match is made on an alternative name the associated Entity will be listed, not the alternative name. This can give the appearance the entity listed didn’t match the criteria you entered in the filter.
  • Subset filter: Selected subset(s) will filter the entities list based on the entities contained within the subset(s).
Entity Filter option expand showing example filtering by entity labels contain'Acacia' and via the Entity Subset 'Environmental Weeds of Australia'
Entity Filter option expand showing example filtering by entity labels contain’Acacia’ and via the Entity Subset ‘Environmental Weeds of Australia’
Entity Filter option showing the results of the filter
Entity Filter option showing the results of the filter

If filter criteria and subsets have both selected they will work in conjunction with each other. That is the entities are restricted to the selected subset(s), which are in turn restricted by the filter text.

Once Filter criteria has been entered and/or subsets selected click on the filter button (or press return). This will apply the filter. If the filter dropdown is closed without selecting to filter (i.e. clicking the filter button), the filter options will not be applied.

To clear the filters remove filter criteria and un-select all subsets then click the filter button.