Tag: Entities

Entity Reports

Post author By wp_help_lucidcentral
Post date 10 July 2020

Fact Sheet Fusion offers several Entity reports, which can be accessed via the Entities…Report menu.

Entity Properties Report

Entity properties such as ‘Exclude’, ‘Review’ and ‘Exclude as Heading’ can be reported on for all entities within the current project. This report allows reviewing the entity properties faster than reviewing each entity properties in turn, via the interface.

Tip

Copy and paste the report output to a spreadsheet application where the tab separated values will display in columns. You can then sort and query the report.

Entity Topics Report

This report will let you quickly assess which topics have text for each of the entities. It also indicates if the entity has any alternative names associated with it.

Tip

Copy and paste the report output to a spreadsheet application where the tab separated values will display in columns. You can then sort and query the report.

Note

The value 'TRUE(EMPTY)' indicates that the topic for the entity has value which would cause its inclusion in the fact sheet sheet, however it would appear as empty (no topic text). For example, if the Topic text contain HTML code such as '<div> </div>'. The empty rendering check only looks for common tagging issues and will not catch all possible scenarios where empty topic text may be rendered to the fact sheet.

Entity Media Report

This report will list all media attached to the entities in the currently opened project. It will also indicate entities without media attachments. A separate report is available for just checking on Entities without media attachments. See next report below.

Entity No Media Report

Reports on entities that have no media attachments for the current project.

Entity No Media report example — Entity No Media Report example

Scientific Name Non-Matching Report

If you have a ‘Scientific Name’ topic, you can check if the entity label now differs from the scientific name topic text (if was automatically generated via the Advanced Entity Options…Create Scientific Name topic option. For example, you may have corrected a spelling mistake within the entity label, but forgot to amend the Scientific Name topic text.

Ad Hoc Entity Report

See report details here.

Tags Entities, Reports

Fact Sheet Fusion v2

Entity Alternative Names

Post author By wp_help_lucidcentral
Post date 24 June 2020

The Alternative Names dialog can be accessed via the Entities Property panel from the Main Interface as shown below. Or when the Entity list has focus, the Alternative Name dialog can be opened by the keyboard shortcut (Ctrl + Right Arrow). The Alternative names for the selected Entity will then be displayed.

If there are alternative names present against the currently selected Entity the property value will show (present). If there are none it will show (none). To open the Alternative Names dialog click on the button on the right of the property (as highlighted in yellow in the screen shot above).

The Alternative Names dialog will show the currently selected Entity to which additional names can be applied.

Adding an Alternative Name

To add a new Alternative Name click within the empty row and type the name and authorship, if desired. The Alternative Name and Author fields have an autocomplete feature to help speed data entry (as shown above in the main interface). As you type the suggested words will narrow. Press the down arrow to select a suggested word. Once you have selected a suggested word you can either press the space bar, which will select the word and add a space ready for continued typing, or hit the enter key. This will simply select the desired suggested word, without the additional space, ready for continued typing. Once finished entering the alternative name data you can then click the save button () to the right (Shortcut option is (Ctrl + s)). Or enter several names and authors, then click the main Save and Close button at the bottom of the form. All unsaved Alternative names and authors will then be saved at once and the form closed, if no errors or warnings are reported. You will notice that the save icon(s) () next to unsaved Alternative names will turn to delete icons () after the save has occurred.

Editing an Alternative Name

Click on the Alternative name you wish to edit. After editing the name click the save button () located to the right or click the main save button at the bottom of the form. You will notice the save icon(s) () against unsaved Alternative names will turn to delete icons () after the save has occurred.

Deleting an Alternative Name

To delete an Alternative Name click on the delete icon () next to the name. Confirm that you wish to delete and it will be removed from the list of Alternative Names.

Alternative Name deletion confirmation dialog

Save and Button

The save and close button will save one or more unsaved Alternative names prior to the dialog closing. This is handy if you have entered several alternative names without pressing the individual save buttons located to the right of the name. The shortcut option to save and close is (Ctrl + Shift + x)

Tags Entities

Fact Sheet Fusion v2

Ad hoc Entity Report

Post author By wp_help_lucidcentral
Post date 22 June 2020

Often when dealing with large data sets it can be useful to search across the set based on a list of one or more Entities. When managing our own data sets we are asked “I have a list of species. Do you have any of these?”. Rather than manually searching through the list of entities you can now use the Ad hoc Entity Report.

To begin with one or more Entities need to be supplied to search. You can add these via the ‘Entities to Search for…‘ dialog as shown below:

Example usage of the add Search Entities dialog. A species list pasted from Excel.

Once one or more entities have be provided to the Ad hoc Entity report dialog, these are searched for across the current projects Entity list and their alternate names. Any matches will be listed in the ‘Matched Entities’ list box, while close matched (by distance) will be listed in the ‘Similar Entities‘ list box.

If you are only interested in exact matches then you can untick the ‘Include up to [x] similar Entities’ check box, before clicking the Report button. Otherwise you can select the top 1-20 similar species to be included in the report. The Report button will then ask for a location in which to save the report. Once saved, Fact Sheet Fusion will then automatically open the report in your preferred web browser.

The report uses the following layout:

Matched Entities
[Entity Name] (Synonym of: )
Associated Media
[Entity Media]
File:
Caption: …
Total Entities Matched:
—————————————————–
Remaining Entities with potential matches
Entity
Similar Entity names (by distance)
      Entity Name ()
      Associated Media
      [Entity Media]
    File:
      Caption: …
Total non-matched entities:

Example section of a report showing matched entities:

Example section of the end of matched Entities and the start of similar Entities:

Example report showing potential matches

Where a match distance is very close (3 or less) it is highlighted in green text to indicate closeness as outlined red in the example below.

Ad hoc report example with very close match

The report uses a very simple self contained HTML template page located in ‘Reports’ folder of Fact Sheet Fusion’s installation folder. If you have permission, you may customize the styles defined in this file, however do not change the filename. Or customize the saved report. Below is the report templates content:

{0}

Note

The reports content replaces the '{0}' token when generated to a file.

Tip 1

To have media displayed within the report relies on a previous export of the fact sheets as HTML. The export settings for the media are used as reference to the media in this report.

Tip 2

The report can be easily saved via your browser as a PDF document using a PDF print driver. E.g. 'Print as PDF'.

Tags Entities, Reports

Fact Sheet Fusion v2

Export – Entity Options

Post author By wp_help_lucidcentral
Post date 19 June 2020

Create Entity Index

If selected, an index page that lists all exported entities will be created. The page will be an index.htm (.pdf or .xml depending on the export type). Within the index page each entity listed will link to it’s corresponding fact sheet.*

Note

* This assumes the export template you have selected supports the creation of an index page.

Include Alternative Names

Entities may have alternative names associated with them. If this is the case you can also have Alternate Names listed within the index page. They will be treated exactly the same as a regular entity name and will contain a link to the corresponding Entity fact sheet they are associated with – i.e. the main Entity named fact sheet. For example, you may have an Entity called Acacia that has Wattle and Thorn tree as Alternative Names. The index will contain all three names and they will all link to the same fact sheet called Acacia.

Include Media

If selected, any media associated with the Entity will also be listed within the index, if the selected export template supports this.

Include Entities marked as Excluded

Select this option if you wish to include all Entities that have been marked to be excluded from the export.

Exclude Entities marked Review

By default, Entities marked for review are included in the export. However you can excluded these entities by selecting this option.

Index second part of Entity Name

Forces the entity sort order for the index page creation to use the second part of the entity label (if available). If you are dealing with scientific names as your entities and are creating fact sheets for a few or single genera, the index A…Z shortcuts can become superfluous.

For example, you were creating fact sheets for Eucalypts, which have over 800 species all starting with ‘Eucalyptus’, the Index A…Z shortcut menu would only be active for ‘e’ leaving the user to scroll through hundreds of species to find what’s of interest. This option allows you to sort the Index based on the second text element of the entity name, if it’s available. This generally will allow for a greater spread of names within the Index A…Z shortcut menu.

Include Inter-crosslink Entities in Topics

If selected, Fact Sheet Fusion will automatically create cross-links (hyperlinks) to Entity names it finds within the topic text.

Automatic abbreviated binomials

Often when scientific names are written they are abbreviated. For example, Escherichia coli is often referred to as E. coli. Fact Sheet Fusion can automatically look for these abbreviated names when creating cross-links. Therefore there is no need to enter the abbreviated name as an alternative name.

Include Alternative Names

Fact Sheet Fusion can also look for alternative names when cross-linking content. Cross-links on alternative names always link back to the Entity named fact sheet.

Override Inter-crosslinking exclusions

Using this option you can override topics that have been set to exclude cross-linking.

Inter-crosslink Glossary in Topics

If selected, Fact Sheet Fusion will cross-link on any glossary terms that are found within the Topic text.

Glossary cross-linking limit

By default, Fact Sheet Fusion will cross link on every instance of a found glossary term with the the topic text. The Glossary Cross-linking limit option allows you reduce the number of times a term is cross linked within the topic text to either 1, 2, 3, 4, 5. Unlimited (Default).

Note

If you have elected to limit the glossary term crosslinker, it will match first on exact matches, including case sensitivity.

For example, if you have a Glossary Term 'tree' with the following topic text and the limiter set to one (1):

"Tree is 60-70m tall. Seedlings of this tree have completely different leaves."

The glossary crosslinker will apply the crosslink as follows (yellow hightlight):

"Tree is 60-70m tall. Seedlings of this tree have completely different leaves."

Notice how the captialized first instance of 'Tree' isn't crosslinked due to the limit and an exact match being found within the text.

Override Glossary Cross-linking exclusions

If selected, any glossary terms that have been marked to be excluded from cross-linking will be overridden and the glossary link included.

Include Entities marked as Excluded

This option forces the inclusion of Entities that have been marked as Excluded from the export process. These Entities will have a fact sheet generated during the export process.

Exclude Entities marked Review

This option excludes any Entities marked as Review from having a fact sheet created during the export process.

Default Author

Optional. Enter the name or names of the default Author/(s). This information can be included in the META data within the fact sheet’s Head tags, if the selected export template supports this.

Tip

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

Default Description

Optional. Enter the default text for the fact sheet description META tag, if the template supports it.

Note

If the description field is set on an individual entity this will take precedents over the default description text.

Tip

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

Only Include Subsets

If entity subsets have been defined in the project these can be selected to limit the export to those entities contained within the subset(s).

Note

Limiting entities via subsets will effect entity cross linking (if selected) and the creation of the index page (again if selected) as they will be limited to the entities found in the subset(s).

Media Override Options

See the Media Override Options for further information on this topic.

Tags Entities, Export

Fact Sheet Fusion v2

Exporting Fact Sheets

Post author By wp_help_lucidcentral
Post date 19 June 2020

Once you have finished entering your data and media for the fact sheets it is time to export. The export dialog has many options to customize the fact sheets. Each set of related options have been grouped under tabs within the export dialog.

Tags Entities, Export, Glossary, Media, Topics

Fact Sheet Fusion v2

Main Interface Media

Post author By wp_help_lucidcentral
Post date 18 June 2020

Adding Media via the Main Interface

One or more media items can be linked to Entity Topics (An Entity Topic is the combination of the selected Entity and Topic) or directly to the Entity. Normally media that is attached to an entities topic is shown within the section relating to that topic in the fact sheet, while media attached to the entity are shown either at the top or bottom of the fact sheet. The layout of the media will vary depending on the export template selected. You can flip between the Entity Images and Topic Images using the tabs at the bottom of the media panel.

Entity and Topic Image tabs

For more information on media please see the Media topic or the Media Manager topic.

Media Properties

The Properties panel located at the top right of the main interface will show the properties of the currently selected item within the interface (e.g. Topics, Entities and Media). Properties can be edited by clicking on the property value on the right hand side of the property label. Depending on the type of property it may be as simple as choosing between true or false, or selecting from a drop down list. For other properties it may be more complex, requiring free form text. Each property when selected will show a help snippet at the bottom of the property panel, describing what it does. The property panel width can be adjusted by selecting the left hand border and dragging to the desired size. The height of the properties panel can also be adjusted by selecting the border below the help snippet and dragging it to the preferred height. For more details about each property please see the relevant help section (i.e. Entity Properties, Topic Properties, Media Properties)

Tags Entities, Media, Topics

Fact Sheet Fusion v2

Entities

Post author By wp_help_lucidcentral
Post date 18 June 2020

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:

Via the Entities Menu…Add (Ctrl + E)
Via the pop-up context menu accessible by right clicking within the Entity list.
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.

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.

Note

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

Deleting 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.

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.

Sorting 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

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.

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.

Entity 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.

Entity 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.

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

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.

Tags Entities, Reports, Services, Subsets

Fact Sheet Fusion v2

Menus

Post author By wp_help_lucidcentral
Post date 18 June 2020

File Menu

The file menu allows you to open a different Project (Ctrl+P) within the currently opened Fusion database, open a different Fusion Database (Ctrl+O) containing other projects, or to Import content from HTML or MS Word files.

Edit Menu

The edit menu gives you access to the Glossary (Ctrl+G), Media Library (Ctrl+M), Watermarks (Ctrl+W), Global Find & Replace (Ctrl+F), Global Topic Clean and Preferences.

Topics Menu

The Topic menu gives you access to actions available for managing Topics. Menu items will only be available if they are able to perform the action. For example, the Delete option would be unavailable if no topics are present. For more information on Topics please see the Topics help section below.

Entities Menu

The Entities menu gives you access to actions available for managing Entities. Menu items will only be available if they are able to perform the action. For example, the Delete option would be unavailable if no entities are present. For more information on Entities please see the Entities help section below.

Help Menu

The help menu gives access to this help file and to the about dialog, where version information and the log file is accessible. You can also check for updates to Fact Sheet Fusion that may have become available.

Tags Entities, Help, Main Interface, Menus, Topics