Category: Lucid Builder v4

Lucid Builder v4 Help

Categories
Lucid Builder v4

Lucid Builder Entities Tree – Context Pop-up Menu

Lucid Builder banner

Additional commands available via the context pop-up menu. The context menu can be accessed by right clicking on an item (or an empty section) within the Entities Tree panel.

Lucid Builder Entities Tree Context Pop-up menu
Lucid Builder Entities Tree context pop-up menu.

Add sub menu

Lucid Builder Entities Tree context pop-up menu - Add sub menu

Add Entity icon Add Entity

Adds a new Entity to the Entities tree. The Entity will be added at the same level within the tree based on where in the tree the context menu was initiated. The Add Entity option will only become available to select when it is logically appropriate. For example, the Builder will not allow an Entity to be created at the same or child level of a Specimen.

Add Entity as Child icon Add Entity as Child

Adds a new Entity as child of the selected Entity within the Entities tree. The Add Entity as Child option will only become available to select when it is logically appropriate. For example, the Builder will not allow an Entity to be created at the same or child level of a Specimen.

Add Entity as Parent icon Add Entity as Parent

Adds a new Entity as a parent of the selected Entity within the Entities tree. The Add Entity as Parent option will only become available to select when it is logically appropriate. For example, the Builder will not allow an Entity to be created as a parent if a Specimen was selected.

Add Specimen icon Add Specimen

Adds a new Specimen to an existing Entity within the Entities tree. See the help topic on Specimens for more information.

copy icon Copy

Copies a selected Entity or Specimen to the system clipboard. A copy of the item may then be pasted elsewhere in the Entity tree.

If a copied item has children, all descendents will be copied along with the selected item. If an item has scores or other properties associated with it (media etc), all scores and properties will remain associated with the copied item and will be pasted with it.

paste icon Paste

Pastes a previously cut or copied item as a child of the selected item.

If a cut or copied item has children, all descendents will be cut or copied and pasted along with the selected item. If an item has scores or other properties associated with it (media etc), all scores and properties will remain associated with the item and will be pasted with it.

Paste As Sibling Paste as sibling

Pastes a previously cut or copied item as a sibling of the selected item.

If a cut or copied item has children, all descendents will be cut or copied and pasted along with the selected item. If an item has scores or other properties associated with it (media etc), all scores and properties will remain associated with the item and will be pasted with it.

Rename iconRename

Renames a selected item in the Entities tree. The item will be placed into edit mode for renaming. Rename can also be invoked by pressing the F2 key.

delete icon Delete

Deletes one or more selected Entities or Specimens.

If the Builder Preferences option Prompt for confirmation during tree delete operations is checked, a Confirm Delete dialog will appear to confirm that the operation should go ahead. If Prompt for confirmation during tree delete operations is unchecked, the item will be deleted immediately without confirmation.

The selected item will be permanently deleted from the key. This operation cannot be undone.

Modify sub menu

Lucid Builder Entity context menu - Modify sub menu - Convert Entity to Specimen option
Lucid Builder Entity context menu - Modify sub menu - Convert Entity to Specimen option.
Lucid Builder Entities tree context pop-up menu - Modify sub menu - Change Specimen to Entity option
Lucid Builder Entities tree context pop-up menu - Modify sub menu - Change Specimen to Entity option.

The Modify sub menu allows you to convert Entity types (Grouping Entity, Entity, Specimen). The menu option available is determined by the Entity type selected. For example, a single Entity can be converted to a specimen if it is the only child Entity. To convert all child Entities of  a Grouping Entity, you must first select all child Entities, then initiate the context menu. All the selected child Entities will then be converted to Specimens. The same process applies for converting Specimens back to regular Entities.

Change type icon Change Entity to Specimen

Converts one (or more) selected child Entities to Specimen Entities. All children of the Grouping Entity must be selected for conversion since a child Entity and Specimen Entity cannot be at the same level within the Entity tree.

Change type icon Change Specimen to Entity

Converts one (or more) selected Specimen Entities to child Entities. All Specimens of the Parent Entity must be selected for conversion since Specimens and Entities cannot be at the same level within the Entity tree.

Filter Tree sub menu

Lucid Builder Entities Tree context pop-up menu - Filter Tree sub menu
Lucid Builder Entities Tree context pop-up menu – Filter Tree sub menu.

The options within the Filter Tree sub menu depend on what Entity Subsets have been created. All Entity Subsets will be listed as menu options. Each available Entity Subset can be toggled on or off by selecting or un-selecting the Subset within the menu. When an Entity Subset is toggled on, the Entities scored for that Subset will be displayed, while non-scored Entities for that Subset will be hidden. That is only Entities that are scored in the selected Subsets will be displayed.

Media sub menu

Lucid Builder Entities tree context pop-up menu - Media sub menu
Lucid Builder Entities tree context pop-up menu – Media sub menu.

Attach HTML icon Attach HTML File

Allows the attachment of a HTML (or PDF) file present within your keys Media folder to the selected Entity or Specimen.

Attach URL icon Attach HTML Url

Allows the attachment of a Url based resource (E.g. web page) to the selected Entity or Specimen.

Attach Image icon Attach Image File

Allows the attachment of an image(s) to the selected Entity or Specimen. Multiple image files can be attached via the file browse dialog by using Ctrl (individual selection) or the Shift key (block selection).

Attach HTML icon Attach Description

Attaches a Description to the Entity. Descriptions cannot be attached to a specimen. For the Description to contain a description about the Entity you must create and/or attach a Description template (output template) for the key and associate this and the transform template (e.g. Sentence, paragraph or table etc) via the Key Options…Descriptions tab. See Creating Natural Language Descriptions help topic for more information.

Export sub menu

Lucid Builder Entity tree context pop-up menu - Export sub menu
Lucid Builder Entities tree context pop-up menu – Export sub menu.

Export Media icon Export Media

Creates a Media List file containing references to all media associated with the selected Entity or Specimen. The Media List file will be automatically saved to the same location as the key (I.e. Where the  .lk5 file is located). The file name is automatically generated based on the tree path to the Entity or Specimen and will include the selected items label.

See Media File help topic for more information.

Export scores icon Export Scores

Creates a LIF3 file containing all the score information associated with the selected Entity or Specimen for all Features scored. The Export Scores function can be initiated from the Feature or a State of the Feature. The LIF3 file will be automatically saved to the same location as the key (I.e. Where the  .lk5 file is located). The file name is automatically generated based on the tree path to the Feature or State and will include the selected items label.

See the LIF3 help topic for more information.

Categories
Lucid Builder v4

Lucid Builder Feature Tree – Context Pop-up menu

Lucid Builder banner

Applies to Matrix key projects

Additional commands available via the context pop-up menu. The context menu can be accessed by right clicking on an item (or an empty section) within the Feature Tree panel.

Lucid Builder Edit Context Pop-up Menu
Lucid Builder Edit Context Pop-up Menu.

Add sub menu

Lucid Builder Edit Context Pop-up Add Sub Menu
Lucid Builder Edit Context Pop-up Add Sub Menu.

Add Feature icon Add Feature

Adds a new Feature to the the Feature tree.

Add Feature As Child icon Add Feature as Child

Adds a new Feature to an existing Feature as a child node. A Feature can only be added as a child node if it doesn’t contain any states.

Add Feature As Parent icon Add Feature as Parent

Adds a new Feature as the parent of the currently selected Feature.

Add State icon Add State

Adds a new State to the selected Feature. This option is only available where the selected Feature doesn’t already contain a Feature.

copy icon Copy

Copies a selected Feature, State to the system clipboard. A copy of the item may then be pasted elsewhere in the Feature tree.

If a copied item has children, all descendents will be copied along with the selected item. If an item has scores or other properties associated with it (media etc), all scores and properties will remain associated with the copied item and will be pasted with it.

paste icon Paste

Pastes a previously cut or copied item as a child of the selected item.

If a cut or copied item has children, all descendents will be cut or copied and pasted along with the selected item. If an item has scores or other properties associated with it (media etc), all scores and properties will remain associated with the item and will be pasted with it.

Paste As Sibling Paste as sibling

Pastes a previously cut or copied item as a sibling of the selected item.

If a cut or copied item has children, all descendents will be cut or copied and pasted along with the selected item. If an item has scores or other properties associated with it (media etc), all scores and properties will remain associated with the item and will be pasted with it.

Rename iconRename

Renames a selected item in the Features tree. The item will be placed into edit mode for renaming. Rename can also be invoked by pressing the F2 key.

delete icon Delete

Deletes one or more selected Feature or State.

If the Builder Preferences option Prompt for confirmation during tree delete operations is checked, a Confirm Delete dialog will appear to confirm that the operation should go ahead. If Prompt for confirmation during tree delete operations is unchecked, the item will be deleted immediately without confirmation.

The selected item will be permanently deleted from the key. This operation cannot be undone.

Modify sub menu

Lucid Builder Edit Menu Context Pop-up Modify Sub Menu
Lucid Builder Edit Menu Context Pop-up Modify Sub Menu.

Merge States icon Merge Selected States

This option will take the selected States (two or more) and merge them into one State. It is important to understand the effect this will have on the scoring the merged State will retain from the merging process.

If score data is present on the merging States the following rules will apply as to what score data will be retained for the merged State.

In order, the following score types will take priority and will be applied.

  1. common score icon Present (common)
  2. rare score icon Rare
  3. uncertain score icon Uncertain
  4. not scoped score icon Not Scoped
  5. common misinterpreted score icon Present (common), misinterpreted
  6. rare misinterpreted score icon Rare, misinterpreted
  7. Absent score icon Absent

For example, if Agaricus had scores on the following feature:

Feature icon Spore shape
Lucid Feature State icon globose Absent score icon (Absent)

Lucid Feature State icon subglobose rare score icon (Rare)

Lucid Feature State icon ellipsoid common score icon (Present)

If ‘globose’ and ‘subglobose’ were merged, the merged State would retain the ‘Rare’ score for the Entity ‘Agaricus’.

The selection order of the States is also important. The last selected State is retained for label purposes, but as described above the State score data is derived from the merging rules.

Warning

There is no undo for associated with merging States. Make sure you backup your key prior to performing this action, if you have scored your key.

Change States to Features icon Change States to Features

Converts all selected States of a Feature back to Features. That is the parent Feature is converted from a Multistate Feature back to a Grouping Feature.

TIP: All States of the Feature need to be selected before this option becomes available in the sub menu.

Warning

There is no undo for associated with Changing States to Features. The score data associated with the States that are converted to Features will be lost. Ensure you have a back of your key prior to performing this action.

Filter Tree sub menu

Lucid Builder Feature tree context pop-up Filter Tree sub menu
Lucid Builder Feature tree context pop-up Filter Tree sub menu.

The options within the Filter Tree sub menu depend on what Feature Subsets have been created. All Feature Subsets will be listed as menu options. Each available Feature Subset can be toggled on or off by selecting or un-selecting the Subset within the menu. When a Feature Subset is toggled on, the Features scored for that Subset will be displayed, while non-scored Features for that Subset will be hidden. That is only Features that are scored in the selected Subsets will be displayed.

Tip

You can see that the Feature tree is filtered in the header section of the Features Panel, where (FILTERED) is added the Feature and State counts.

Lucid Builder Features panel filtered
Lucid Builder Features panel filtered.

Media sub menu

Lucid Builder Feature Tree context menu - Media Sub Menu.
Lucid Builder Feature Tree Context Menu – Media Sub Menu.

Attach HTML icon Attach HTML File

Allows the attachment of a HTML (or PDF) file present within your keys Media folder to the selected Feature or State.

Attach URL icon Attach HTML Url

Allows the attachment of a Url based resource (E.g. web page) to the selected Feature or State.

Attach Image icon Attach Image File

Allows the attachment of an image(s) to the selected Feature or State. Multiple image files can be attached via the file browse dialog by using Ctrl (individual selection) or the Shift key (block selection).

Export sub menu

Lucid Builder Feature Tree Context Menu - Export Sub Menu
Lucid Builder Feature Tree Context Menu – Export Sub Menu.

Export Media icon Export Media

Creates a Media List file containing references to all media associated with the selected Feature or State. The Media List file will be automatically saved to the same location as the key (I.e. Where the  .lk5 file is located). The file name is automatically generated based on the tree path to the Feature or State and will include the selected items label.

See Media File help topic for more information.

Export scores icon Export Scores

Creates a LIF3 file containing all the score information associated with the selected Feature and its States for all Entities. The Export Scores function can be initiated from the Feature or a State of the Feature. The LIF3 file will be automatically saved to the same location as the key (I.e. Where the  .lk5 file is located). The file name is automatically generated based on the tree path to the Feature or State and will include the selected items label.

See the LIF3 help topic for more information.

Categories
Lucid Builder v4

Lucid Builder Edit Menu

Lucid Builder banner

All edit operations for features, states and entities can be performed by selecting the appropriate item from the Edit menu. The menu items Cut, Copy, Paste, Paste as sibling, Rename, Delete, Toggle feature type (multi-state or numeric) and Change Feature to State can also be accessed by right clicking on a selected item and choosing from the pop-up menu (see further below for the additional commands available on this menu).

Lucid Builder Edit Menu
Lucid Builder Edit Menu.

undo icon Undo

Undoes the last edit operation. See Undoing and Redoing edits for more information.

redo icon Redo

Redoes the last edit operation. See Undoing and Redoing edits for more information.

cut icon Cut

Cuts a selected feature, state or entity to the system clipboard. The item may then be pasted elsewhere in its tree.

If the Builder Preferences option Prompt for confirmation during tree cut operations is checked, a Confirm Cut dialog will appear to confirm that the operation should go ahead. If Prompt for confirmation during tree cut operations is unchecked, the item will be cut immediately without confirmation.

If an item to be cut has children, all descendents will be cut along with the selected item. If an item has scores or other properties associated with it (media etc), all scores and properties will remain associated with the cut item and will be pasted with it.

copy icon Copy

Copies a selected feature, state or entity to the system clipboard. A copy of the item may then be pasted elsewhere in its tree.

If a copied item has children, all descendents will be copied along with the selected item. If an item has scores or other properties associated with it (media etc), all scores and properties will remain associated with the copied item and will be pasted with it.

paste icon Paste

Pastes a previously cut or copied item as a child of the selected item.

If a cut or copied item has children, all descendents will be cut or copied and pasted along with the selected item. If an item has scores or other properties associated with it (media etc), all scores and properties will remain associated with the item and will be pasted with it.

Paste As Sibling Paste as sibling

Pastes a previously cut or copied item as a sibling of the selected item.

If a cut or copied item has children, all descendents will be cut or copied and pasted along with the selected item. If an item has scores or other properties associated with it (media etc), all scores and properties will remain associated with the item and will be pasted with it.

Note

Rules in the Builder prevent feature items from being pasted at logically inappropriate positions in the features tree. For example, a state may not be pasted at a position where it would become a child of an item that already has other features as children, and a feature item may not be pasted into a position where it would become a sibling of a state. If the selected item cannot receive the cut or copied item, the Paste as child option will be unavailable.

Rename iconRename

Renames a selected item in the Features or Entities tree. The item will be placed into edit mode for renaming. Rename can also be invoked by pressing the F2 key.

delete icon Delete

Deletes one or more selected Features, States, Entities or Subset.

If the Builder Preferences option Prompt for confirmation during tree delete operations is checked, a Confirm Delete dialog will appear to confirm that the operation should go ahead. If Prompt for confirmation during tree delete operations is unchecked, the item will be deleted immediately without confirmation.

The selected item will be permanently deleted from the key. This operation cannot be undone.

Warning

If an item to be deleted has children, all descendents will be deleted along with the selected item.

Find icon Find feature/entity

Finds an element within the selected Entity or Feature tree.

Select All iconSelect All

Selects all items in the currently selected tree.

sort icon Sort tree items

Sorts items in the entities or features trees alphabetically. For more information on sorting options see the topic Sorting items in the feature and entity trees.

Builder Preferences icon Preferences

Provides options for configuring the Builder to suit your work practices.

Categories
Lucid Builder v4

Lucid Builder File Menu

Lucid Builder banner
Lucid Builder File Menu
Lucid Builder File Menu

New

Select either ‘Matrix Key’ or ‘Pathway Key’ to create a new (blank) project of the selected key type.

New keys can also be created by clicking on the Create a new key button on the button bar. in this case a pop-up dialog will prompt to select which key type project to create.

Lucid Builder key type selector dialog

If necessary, you will be prompted to save the currently open key before the new key is created.

open folder icon Open…

Opens an existing Lucid key.

Keys can also be opened using the keyboard shortcut (Ctrl+O) or clicking the Open Key… button on the button bar.

If necessary, you will be prompted to save the currently open key.

Recently opened or saved keys can also be opened from the key list at the bottom of the File menu.

save icon Save

Saves the current key.

Keys can also be saved using the keyboard shortcut (Ctrl+S) or clicking the Save Key button on the button bar.

If the key you are working on has not been saved before, you will be prompted for the file name and destination to save the key to.

You should save your key often. Setting the Save key automatically option in Builder Preferences will help by automatically saving the key at specified time intervals.

Save As icon Save As…

Saves the current key for the first time.

New keys can also be saved using the keyboard shortcuts Ctrl+S or Ctrl+A, or clicking the Save Key As… button on the button bar.

You will be prompted for the file name and destination to save the key to.

Import (Key, Feature List, Entity List)

Lucid Builder File...Import Menu
Lucid Builder File…Import Menu.

Allows text files containing lists of entities or features, and keys (saved in LIF, LIF3 or CSV formats), to be imported into a new, or currently opened key.

See the topics Importing and Exporting items from text files and Importing and Exporting keys for more information.

Export key (Key, Feature List, Entity List)

Lucid Builder File...Export Menu
Lucid Builder File…Export Menu.

Allows export of the key’s entity and feature lists to text files, and export of the entire key to LIF3 and CSV formats.

See the topics Importing and Exporting items from text files and Importing and Exporting keys for more information.

Recent Key List

A list of recently opened keys is displayed on the File menu, below Export key.  It holds up to four keys and can be used as a shortcut to open a recently used key.

Exit icon Exit

Quits the builder.  If the currently opened key has unsaved changes, you will be prompted to save the changes before exiting.

Categories
Lucid Builder v4

Lucid Builder Deploying a key

Lucid Builder banner

Applies to both Matrix and Pathway key projects

Lucid Key Deployment process allows you to distribute the key you have constructed in the Lucid Builder to your end users.

There are three ways to share your key:

  1. Share your key in Lucid Builder format. Normally this is only done when collaborating with colleagues who also have a Lucid Builder licence.
  2. Deploy your key with the Lucid Player. This option allows your key to be hosted on line, by any web service. Or shared via USB, CD, hard drive or network drive.
  3. Submit your key to Lucidcentral.org for packaging and deployment to the Lucid Mobile Platform. The Lucid Mobile Platform supports both Android and Apple iOS as native applications.

Sharing the Builder edition of your key

If you wish to provide your key data in an editable form you need to provide the Builder data files and folder to the user. The files and folder you need to send are the Lucid key file (file extension .lk5) and the folder of the same name as the key file, which is in the same folder as the key file. For example, if we had a key to frogs ready to share:

Key to frogs.lk5     <— Key file
Key to frogs            <— Key folder, which contains all the data and media.

Deploy your key with the Lucid Player

This deployment option is the most likely method you will use to deploy your key to end users. The end product of the deployment process is a copy of your key in a read only format, that requires no installation process for your end user and does not require any special software or plug-ins.  The end user of your key simply needs to open a HTML file that will automatically load the Lucid Player and your key in their preferred web browser.

The deployment process comprises several tasks:

  1. Compiling a copy of your key data into a ready-only format and the score data into an encrypted form.
  2. Copies the media associated with the key to the destination.
  3. Packages the Lucid Player and help files to the destination.
  4. Creates a hosting web page that loads the Lucid Player and sets the correct connections and settings to the key data.

The Builder’s key deployment option makes this process very easy and straight forward.  As the key author your only requirement is to select your preferences for the key data and what options you want for the Lucid Player.

Lucid Builder Key Deploy dialog
Lucid Builder Key Deploy dialog.

Deploy Options

To deploy your key for distribution, choose Deploy Key from the Key menu.

The Deploy Key Settings dialog box will then open to provide the following options for deploying a key.

Key Title

Enter a name for the key. The name should be short and appropriate, such as Key to Mangroves of Australia, Fly Families of the World or Common Diseases of Rice in South-east Asia.

Filename

The filename is the name used for the underlying key data files used by the Browser Player. The filename should only consist of alphabetic characters, numbers or underscores and be a maximum of 100 characters. It should not contain spaces or character symbols. If the Builder detects invalid characters it will warn you and offer to clean the character to produce a valid filename string.

Note

If you intend on deploying multiple keys into the same folder ensure that the Key title and filenames chosen are unique to prevent key data from being overridden.

Destination Folder

Enter a path name for the folder where you want the deployed key to be written, or click the Browse button to select a folder. If a key with the same name already exists in the selected folder you will be warned, and will be able to cancel before overwriting.

Tip

Deploy your key into an empty destination folder. This enables you to see exactly what needs to be distributed to your end user.

Deploy Media Files

If checked, media directly attached to key items (Features, Entities etc) will be copied as a part of the deployment process to the destination folder. Other supporting and linked media (e.g. CSS files, supporting images etc) will not be copied.

Copy additional media files

If selected all media files found within the media folder will be copied as a part of the deployment process.

However, if you have a large key with extensive media it may not be desirable to recopy the media if a simple change is made to the key, such as a score. Ensure this option is selected if you have made media related changes to the key before deploying.

Skip media needing revision

Any item (media, features or entities) that have been marked as needing revision will not be exported as a part of the deployment process.

Deploy filtered key

Your key data can be dynamically filtered by Subsets (if you have added them in your key), in both the Builder and the Player. You can use these Subsets to filter the data shown in the Builder then, via the deployment process, use the current Builder subset filter to output this data set as the key that will be deployed.

Output home page

The Builder will create a home page for your key based on a template. It will output the key title, description and author information (entered via the Key Properties Panel. It will also create a link to start (open) the Lucid Player and the deployed key.

Copy player files to destination

Like the ‘Copy additional media files’ option, if you have previously deployed the key to the selected destination you can turn off the deployment of the Lucid Player files to speed up the deployment process.

Options Button

Opens the Key Options dialog to allow editing of various key settings prior to the keys deployment. Key settings such as show Feature or Entity thumbnails are set as default options in the deployed key or, if the key Features and Entities are displayed, as Lists or Trees etc.

doc icon Lucid Player Distribution Information

The Lucid Player is free to distribute under the following conditions:

  1. The key(s) is free to the end user. No commercial arrangement (E.g. Paywall or purchase of physical media) has been made to access the Lucid Player and key(s).
  2. You must own a Lucid Builder licence to distribute the Lucid Player. The Trial Edition Player must not be distributed under any circumstances.
  3. The Lucid Player must be distributed with a key created by the Lucid Builder. It cannot be distributed by itself.
  4. The Lucid Player is not to be used or distributed with a key(s) not created by the Lucid Builder.

The Lucid Player can be distributed under commercial arrangements, however you must obtain a commercial licence. Please contact the Help Desk to obtain more information on this option.

Please see the Lucid Builder and Player licence files for further information. Both can be found in the Lucid Builder’s installation folder.

Lucidcentral.org Free Key Hosting

The Lucid team currently offers free key hosting on Lucidcentral.org. If you would like your key hosted please see the FAQ on what to provide us.

Deploy to the Lucid Mobile Platform

Lucid Mobile Platform

The Lucid Mobile Platform allows your Lucid key(s) to be deployed as a native Android or Apple iOS application. As well as exposing your key to hundreds or thousands of potential users via the App Stores, your key will be available for smartphone and tablet devices for use anywhere without needing an internet connection. The Lucid Mobile application has many customization and add-on options to suit your needs. For example, full customization of the interface, home screen, content screens, colors and image viewing etc. You can also include data collection, mapping or custom modules (E.g. Calculators or models etc).

The process of deploying your key to the Lucid Mobile Platform isn’t an automatic process as with the regular Lucid Player. It requires the Lucid team to package and publish the App on your behalf. It’s also not a free option due to the time and work involved in creating the App. It requires an extensive amount of artwork that must meet Google and Apple design standards for submission to the App stores. Fact sheets and images associated with the key must also be mobile platform optimized. 

The Lucid team can produce the artwork and help optimize your keys content. Based on your needs, and whether you want to charge for downloading the app or making it freely available, we can provide a quotation specifically for  publishing your key as an App.  For more information on the Lucid Mobile Platform and its requirements please see the Lucidcentral.org mobile information.

Note: Fact Sheet Fusion can produce mobile optimized content for your key without duplication of effort.

Categories
Lucid Builder v4

Lucid Builder Creating Natural Language Descriptions

Lucid Builder banner

Applies to Matrix key projects

The Lucid Builder can be used to produce natural language descriptions of the Entities in the key, as well as descriptive tables and listings of Features.

Natural language is handled using the Descriptions panel, accessed by clicking on its tab located on the left hand side of the Builder window.

The Descriptions panel has four sections:

Wording Section is used to specify the wording of features and states to be used when generating natural language descriptions.

Score Modifiers are used to enter text modifiers for scores, to be inserted before or after the appropriate score string in the natural language description.

Description displays a chunk of a natural language description, relevant to the currently selected feature.

Export is used to export full natural language descriptions to an output file, and to transform the output using predefined template files.

The following topics describe the operations of each element of the Descriptions panel in more detail.

Specifying wording to be used in Natural Language Descriptions

It will often be the case that the best wording for a feature or state in the context of the list of features and states in the key is not the best wording in the context of a natural language description. For example, a key to fungi may have the following feature:

Lucid Builder Natural Language example features

It is clear from the context of the feature Translucent striations that it refers to the margin of the pileus. However, a description string for this feature would read:

“Translucent striations absent”

This may be adequate in some circumstances, but not in others. The Wording panel allows you to modify this description string so it would read instead:

“Pileus margin not translucent-striate”

To do this, select the state absent, and set the wording for the feature and state as follows:

Lucid Builder Natural Language Descriptions Panel example

How it works: the wording “Pileus margin” is used for the description of this feature in place
of “Translucent striations”; the wording “not translucent-striate” is used in place of “absent”.

Similarly, setting the wording for the state “present” to “translucent-striate” will result in a description string (for an entity scored as present) that reads “Pileus margin translucent-striate”.

Note

The Description panel displays only a short string from a description, for the current feature. The wordings set using the Wordings panel will affect both short single-feature descriptions and full-length descriptions.

Modifying a score using text modifiers

Sometimes it is useful to modify an individual score in a natural language description. Lucid already supports two important modifiers – rare and misinterpreted – in its scoring, and these are handled in descriptions automatically. For example, the following scoring for an entity will produce the accompanying description.

Lucid Builder Natural Language Descriptions Panel text modifiers example

How it works: the wording “Pileus overall shape” is used for the description of this feature in place of “Overall shape”. Since the state “cylindrical to parabolic” is scored using the “By Misinterpretation score”, the string “by misinterpretation” in parentheses is added after the score; since the state “infundibuliform” is scores using the Rarely Present score, the string “rarely” in parentheses is added after the score.

If other modifiers are needed in a description, use the Modifiers panel on the Descriptions tab. A modifier can be inserted before or after the state string in the description. For example, the following scoring and modifiers will produce the accompanying description.

How it works: the wording “Pileus” is used for the description of this feature in place of “Translucent striations”; the wording “translucent-striate” is used for the state instead of “present”.  The modifier “obscurely” is inserted before “translucent-striate”, and the modifier “on the very margin” is inserted after.

Note

The Score Modifiers edit boxes are unavailable unless the key is in score mode.

If the Ignore score in description checkbox is checked, the currently selected score will not be used in a description. For example, in the following description, the absent score is not used in the description: Lucid Builder Natural Language Descriptions Panel - Ignore score example How it works: the wording “Pileus” is used for the description of this feature in place of “Translucent striations”; the wording “not translucent striate” is used for the state “absent”, while the wording “translucent striate” is used for the state of “present; since Ignore score in description is checked for the state “Absent”, the feature description is “Pileus translucent-striate” instead of “Pileus not translucent-striate (by misinterpretation) or translucent-striate”.

Text Feature icon Text Features

New to version 4, a Text Feature is a special Feature that is used to help generate descriptions, rather than being output as a part of the identification or diagnostic key. A Text Feature is indicated by the Text Feature icon icon. The Text Feature can be treated in the same way as a regular Feature as far as the Description property options. The main difference is scoring of a Text Feature. A Text Feature is only treated as Present or Absent with or without a Text Score. When applying a score (using any score type option) present is indicated by a text value. While no text present as the score value indicates absent. Below shows an example of a Text Score value.
Lucid Builder Text Feature Score value example
Lucid Builder Text Feature Score value example.
The Text Feature score value, if present, is output for the Entity as a part of the description generation process.

Tip

While the Text Feature was designed primarily for use in generating descriptions, it could be applied to a multitude of other uses where you want to store text values against Entities or Specimens. E.g. Notes, catalogue numbers etc.

Exporting Natural Language Descriptions

The following diagram shows the process of description creation in Lucid: Lucid Builder process diagram for creating Natural Language descriptions wire frame
:uicd Builder process diagram for creating Natural Language descriptions
Lucid Builder process diagram for creating Natural Language descriptions.

Exporting xml output files without an Output Template or Transform File

On the Descriptions Panel, click the Export button. An export dialog will appear, select or enter the name of a new Output File. Once the Output File has been defined click dialogs save button. Next, select to either export just the selected Entities or descriptions for all Entities within the key.

Note

When creating an Output File an ‘.xml’ file extension will be automatically added, if not entered.

Once the export has been completed the description result will be displayed in the Lucid browser window. Or for non-Windows users your preferred web browser.

How this works

When no Output Template has been defined Lucid will automatically build one. The automatically generated Output Template will include all features within the key and is based on the author entered Feature/State tree. The Builder then applies the default ‘Sentence’ Transform File to produce the descriptive result. As you may notice the automatic description is unlikely to be an optimised written description, though this does depend on the keys features and/or the amount of customisation done within the Wording properties of the description panel. To build truly optimised descriptive text you should define an Output Template via the Template Editor and select or customise your preferred Transform File.

Tip

The output file is not designed to be a “human readable” description, rather think of it as a data file. However if you wish to view this file it can be opened using programs such as XMLSpy or your preferred text editor.

Exporting html files using Transform Files

Using a Transform file in the description generation process allows you to format the presentation of the description in just about any way you can image. The Transform file uses an open W3C defined transformation language called Extensible Stylesheet Language (XSL).

For more information on XSL please see: https://en.wikipedia.org/wiki/Extensible_Stylesheet_Language

We have provided several default example Transform files we feel would be useful when generating descriptions. They are:

  • The Sentence transform, creates each description comprising a single paragraph. This is the default template when no other template is defined.

  • The Sentence-Media, identical to the above Sentence transform but includes images in the description. The images are sourced from the images attached to the keys Entities.

  • The Paragraph transform, creates a description with each feature in a separate paragraph. Grouping features provide headings to sets of paragraphs.

  • The Paragraph-Sentence transform, creates a description with groups of features in separate paragraphs, with features within the group joined into sentences.

  • The Paragraph-Sentence-Media, identical to the Paragraph-Sentence transform above but includes images within the description. The images are sourced from the images attached to the key’s Entities.

  • The Table transform creates a tabular description, with rows for each entity and columns comprising grouping features as headers.

To create descriptions with a preferred Transform Template File, but without defining an Output Template,  select your preferred Transform Template via the Description settings within the Key Options dialog, accessible via the Key menu. After saving the Description options return to the Description panel and click the Export button. Select or enter the name of a new Output File. Export either the selected entities or all entities.  The description file will be created in the same folder where the Output File was defined and will be named the same except the file extension will be ‘.html’ rather than the Output Files ‘.xml’ extension. After the export has taken place Lucid will offer to open the description file in your preferred web browser.

Tip

The supplied Transform Template files can be found in the Lucid install folder under the following sub folders:

<Lucid Install Folder>\resource\transform\

Transform Template files have a ‘.xsl’ file extension.

Note

Subfolders within the transform folder contain additional supporting files associated with the Transform Template file such as CSS files, JavaScript’s and additional page graphics. Lucid will automatically copy the supporting folder needed for the export destination. The supporting folder name must be the same as the Transform Template file for this to occur.

Using Output Templates to customise descriptions

An Output Template is an XML file that provides customisation options for descriptions. Using an Output Template allows features to be included or excluded from descriptions, rearranged, grouped into sentences, paragraphs and table columns, and formatted using italics, bold etc.

Since Lucid 3.5 we have included an Output Template Editor that allows the easy creation of Output Templates, which previously had to be built “by hand” in version 3.4.

The Output Template Editor

Lucid Builder Natural Language Template Editor
Lucid Builder Natural Language Template Editor

To access the Output Template Editor click the Edit button within the Descriptions panel.

If no Output Template has been associated with the key previously then the Output Template Editor will offer to automatically build a default template based on the current open keys structure. An automatically generated template will reflect the current feature tree as closely as possible within the Feature Group, Feature and Feature Item structure of the editor.

Template Editor Features

Menus

File Menu

Lucid Builder Natural Language Template Editor File Menu
Lucid Builder Natural Language Template Editor File Menu
New iconNew Template (Ctrl+n /⌘+n)

Creates a new empty template. Prior to a new template being created, if an existing template is in use, you will be asked to save and close the current template or cancel the creation of the new template.

open folder icon Open (Ctrl +n/ ⌘+n)

Opens an existing template file from the folder system.

Note

Template file extensions are ‘.xml’.

save icon Save (Ctrl+s/ ⌘+s)

Saves the current open template. If the template is new and has not been saved before then the Save function will ask you to select a folder and filename for the template. Otherwise the save function will save to the current template file, overwriting any previous data.

Tip

To avoid confusion with other XML files we suggest that you adopt a naming convention such as:

<keyname>_template_v<variant number, date, or note>.xml

E.g. ‘Key to fungi_template_v22082009.xml’

Save As icon Save As

Saves the current template in use but allows you to specify a new filename and location for the template. If you select to save over an existing template file a warning dialog will be displayed and confirmation asked before this action is performed.

Preview icon Preview (ctrl+p/ ⌘+p)

The preview function will take the current template, key data, generate an Output file, and then apply a Transform file. The Sentence Transform is applied by default, if none is selected. It then creates a description for preview. This preview file will then be loaded into the Lucid Browser window: for OSX and Linux users this will be your default web browser.

Before rendering the preview the option to either view descriptions for all Entities or for only those currently selected within the Builder will be given.

The Output file and Description Preview file will be created in the same folder as the template file and will use the same name. The addition of ‘_preview’ is added to the Description Preview Filename. As the preview file is HTML based the file will have ‘.html’ file extension, while the Output file will have an ‘.xml’ file extension.

Tip

You can quickly switch Transformation files via the dropdown box located on the Template Editor Tool bar.

Exit icon Exit

Closes the Template Editor window.  If required, the ‘Save/Save As’ function will be offered on exit.

Edit Menu

Lucid Builder Natural Language Template Editor Edit Menu
Lucid Builder Natural Language Template Editor Edit Menu.
cut icon Cut (ctrl+x/ ⌘+x)

The cut operation allows either a Feature Group, Feature, Feature Item or text elements to be cut from the Description Template. The cut item is then available within the Paste clipboard. See the Paste function for further details on pasting cut or copied items.

copy icon Copy (ctrl+c/ ⌘+c)

The copy operation allows the copying of various element types within the Template Editor such as Feature Group, Feature, Feature Item or text element. The copied item then becomes available to the Paste Clipboard. See the Paste function for further details on pasting cut or copied items.

paste icon Paste (ctrl+v/ ⌘+v)

The Paste operation takes the current item from the Paste clipboard and transfers it to the selected location within the Template Editor. Depending on what has been cut or copied causes the template editor to enforce rules on the Paste operation that prevent illogical operations from occurring. For instance, the Paste option will become unavailable if you copied a Feature Item and tried to paste it at the same level as a Feature group.

delete icon Delete (Delete key)

The Delete operation will remove a selected item from the Description Template tree or in text boxes found in the Description property area. The delete option will only become available where it is valid to delete a selected item.

Tip

Care should be taken when using the Delete operation particularly when deleting higher level nodes within the Description Template tree, as all sub nodes will be deleted along with the parent node. No warning is currently given post the delete option being selected, nor is there an undo feature available with the delete operation.

Cog icon Generate (ctrl+g/ ⌘+g)

The generate operation will automatically create a template based on the current key structure. An automatically generated template will reflect the current key’s Feature tree as closely as possible within the Feature Group, Feature, Feature Item structure of the editor.  This automatically generated template can then be further developed and customised, if desired. See Manually Building a Template for further information on this.

Preference icon Preferences

The Preferences option opens the Description Options dialog. These same preference options can be also set via the Key Options..Descriptions tab found in the Builder. The two description settings allow you to set a default Output template and Transform file for the key. Once set, these defaults will be used when the key is opened. This removes the need for the Output Template and Transform File to be reselected each time you wish to generate your descriptions.

Template Editor Tool Bar

Lucid Builder Natural Language Editor Tool Bar
Lucid Builder Natural Language Editor Tool Bar.
New icon New Template (Ctrl+n /⌘+n)

Creates a new empty template. Prior to a new template being created, if an existing template is in use, you will be asked to save and close the template or cancel the creation of the new template.

open folder icon Open Template (ctrl +n/ ⌘+n)

Opens an existing template file from the folder system. Template file extensions are ‘.xml’.

save icon Save Template (ctrl+s/ ⌘+s)

Saves the current open template. If the template is new and has not been saved before then the Save function will ask you to select a folder and filename for the template. Otherwise the save function will save to the current template file, overwriting any previous data.

Tip

To avoid confusion with other XML files we suggest that you adopt a naming convention such as:

<keyname>_template_v<variant number, date, or note>.xml

E.g. ‘Key to fungi_template_v22082009.xml’

Lucid expand tree icon Expand Template Tree

This function will expand all nodes within the Template tree.

Lucid collapse tree icon Collapse Template Tree

This function will collapse all nodes within the Template tree to the Feature Group level.

Transformation Template Selection Dropdown
Lucid Builder Natural Language Editor Template selector Dropdown
Lucid Builder Natural Language Editor Template selector Dropdown.

This dropdown box allows the quick selection of available transformation templates. Available Transform Templates are located in the \resource\transform\ folder.

Preview icon Preview Template

 The Preview Template button (Green arrow) generates a preview copy of the description and automatically opens the description within the Lucid Browser window (Window’s Users), or within your default web browser (OSX & Linux users). Selecting to preview your description will trigger the save function if the template has been modified since the last save operation.  Additionally an option will be offered to preview the selected entity or entities within the key or to preview the descriptions for all entities.

Help icon Help

Opens this help file describing the Template Editor functions.

Manually Building a Template

While the Template Builder’s automatic generation of a Template is quick and convenient, there will be times where it is desirable to manually build a Template or adjust an automatically generated one.

To start the process of constructing a Template right click on the default “Description Template” root node. A context pop-up menu will appear.

Lucid Builder Natural Language Template Editor Context Pop-up Menu
Lucid Builder Natural Language Template Editor Context Pop-up Menu.

Note

This pop-up menu options will change depending on the type of node selected during the building process.

From the ‘Description Template’ root node the only option available from the pop-up menu is to add a Feature Group node. Select this option. A new node will be added below the ‘Description Template’ node called ‘undefined’.

Tip

Undefined nodes will appear in a light grey colour to show their status of having no defined name label.

Select the newly created ‘undefined’ Feature Group node. The Option panel on the right will allow you to enter a name for the Feature Group. E.g. Cap.

Tip

F2 can be used to rename a selected tree node.

Additional options can be set on the Feature Group node. See Template Editor Options Panel – Feature Group Selection for information on these.

Next, right click on the Feature Group node. The context pop-up menu will appear again, though this time it will contain more options

Lucid Builder Natural Language Template Editor Context Pop-up menu additional options
Lucid Builder Natural Language Template Editor Context Pop-up menu additional options.

In particular, to either add another Feature Group node or to add a Feature. In this instance select to add a Feature. A new node below the Feature Group node will appear. It also will be called ‘undefined’ by default.

Note

Features can only be created under a Feature Group node.

Select the undefined Feature node. The option panel to the right will then update to reflect the options available for the Feature node type. Enter a name for the Feature. E.g. shape.

Additional options can be set on the Feature node. See Template Editor Options Panel – Feature Selection for information on these.

Next, we need to add a Feature Item. Feature Items provide the mapping back to the desired Feature within the key. It is this mapped key’s scored Feature States for a given Entity that is used to build the description text. Mapping the Feature Item to the desired keys Feature can be done in two ways;

  1. Right click on the Feature Item, from the pop-up menu select the ‘Select Feature’ option.
Lucid Builder Natural Language Template editor Context Pop-up menu Select Feature option
Lucid Builder Natural Language Template editor Context Pop-up menu Select Feature option.
  1. From the Options panel click within the Path text box.
Lucid Builder Natural Language Template Editor Path selector
Lucid Builder Natural Language Template Editor Path selector.

Note

Only Features can be selected within the selected Feature Path dialog. Grouping Features and States cannot be selected. Once a valid Feature has been selected the OK button within the Select Feature Path dialog will become available.

To remove the Feature path mapping select the Feature, click on the Path label within the properties section. This will load the Select Feature Path dialog. Select the Clear button. This will remove the current Feature mapping. An empty Path label in the properties panel indicates no Feature mapping.

Organising the Description Template Tree

The order of Features Groups and Features within the Description template is important as this order is reflected in the description text that is generated.

Nodes within the Template Editor can be reorganised in a similar way Features can be in the Builders’ Feature tree. Nodes can be reordered and moved about by drag and drop with the mouse or through cut, copy and paste functions. The Template Editor enforces a set of rules when reordering and moving nodes to avoid mistakes during these operations.

For example, Feature Groups are enforced at the highest level within the template tree. You cannot have Feature Groups within Feature Groups. Features can only exist under a Feature Group. Feature Items can only exist under a Feature. Based on these simple rules you can move or copy Features to other Feature groups, or move or copy Feature Items to other Features.

To reorder a nodes position within its hierarchical level use the ctrl key while performing the drag and drop operation.

Note

The ctrl key is not needed when moving a node.

Template Editor Options Panel

The Template Editor Option panel allows you to adjust a number of parameters that effect the output of the description text. The options presented can change depending on the selection within the Description Template tree. Each of these options are outlined below.

Description Template – Selection of the root node

Lucid Builder Natural Language Editor Options Panel
Lucid Builder Natural Language Editor Options Panel.

Options

Ignore Uncertains

Checking this option will remove all Features from the description where they have been scored as uncertain.

Ignore Misinterpretations

Checking this option will remove all Features from the description where they have been scored as either “Common and Misinterpreted” or “Rare and Misinterpreted”.

Feature Group Selection

Lucid Builder Natural Language Editor Feature Group selection
Lucid Builder Natural Language Editor Feature Group selection.
Name

The Name textbox allows you to change the Feature Group label text. The Feature Group label forms part of the description text, unless it is turned off (see Use Name in Description below).

Use Name in Description

Checking this option will remove the Feature Group text label from the description.

Format

Allows simple formatting options to be applied to the Feature Group label such as bold, italics and underline.

Options – Ignore Uncertains

Checking this option will remove the Feature Group label and all children items from the description where the entity was scored as uncertain for the Feature Group.

Tip

To remove all uncertain features completely from a description select the Description Template root note and select this option.

Options – Ignore Misinterpretations

Checking this option will remove the Feature Group label and all children items from the description where the entity has been scored as either “Common and Misinterpreted” or “Rare and Misinterpreted”.

Tip: To remove all misinterpreted features completely from a description select the Description Template root note and select this option.

Leading Text

Text

Additional text can be added to the description prior to the Feature label.

For example, without leading text the description would be written:

 <Feature Group Name text> <Feature Name text>

With leading text it would be:

<Feature Group Name text> <Leading Text> <Feature Name text>

Format

Allows simple formatting options to be applied to the Leading Text label such as bold, italics and underline.

Trailing Text
Text

Additional text can be appended to the Feature label text within the description.

For example, without trailing text the description would be written:

 <Feature Group Name text> <Feature Name text>

With trailing text it would be:

<Feature Group Name text> <Feature Name text> <Trailing Text>

Format

Allows simple formatting options to be applied to the Trailing Text label such as bold, italics, underline.

Feature Selection

Lucid Builder Natural Language Editor Feature Group selection
Lucid Builder Natural Language Editor Feature selection.
Name

The Name textbox allows you to change the Feature label text. The Feature label forms part of the description text, unless it is turned off (see Use Name in Description below).

Use Name in Description

Checking this option will remove the Feature text label from the description.

Format

Allows simple formatting options to be applied to the Feature label such as bold, italics and underline.

Prefix

When a Feature Group has multiple Features each Feature within the description will be separated with a comma by default. The Prefix option allows you to override this separator.

Note

A prefix only starts to be applied on the second Feature within the Feature Group. A Prefix defined on the first Feature within the Feature group will be ignored.

An example without a defined Prefix the description output would look like:

<Feature Group Name text> <Feature Name text> <Feature Item text>, {Prefix – Comma by default} <Feature Name text> <Feature Item text>, {Prefix – Comma by default} …

With a Prefix defined as a semi-colon (;) the description output would look like:

<Feature Group Name text> <Feature Name text> <Feature Item text>; <Feature Name text> <Feature Item text>;  …

Tip

If you need to include a space prior to the prefix you can use the HTML code for a space “&nbsp;”. For example, to include a space prior to a dash (-) prefix:

&nbsp;-

A space will be automatically included post the prefix.

Options – Ignore Uncertains

Checking this option will remove the Feature from the description where the entity was scored as uncertain for the Feature.

Tip

To remove all uncertain features completely from a description select the Description Template root note and select this option.

Options – Ignore Misinterpretations

Checking this option will remove the Feature from the description where the entity has been scored as either “Common and Misinterpreted” or “Rare and Misinterpreted”.

Tip

To remove all misinterpreted features completely from a description select the Description Template root note and select this option.

Leading Text
Text

Additional text can be added to the description prior to the Feature text.

For example, without leading text the description would be written:

 <Feature Group Name text> <Feature Name text> <Feature State(s) text>

With leading text it would be:

<Feature Group Name text> <Feature Name text> <Leading Text> <Feature State(s) text>

Format

Allows simple formatting options to be applied to the Leading Text label such as bold, italics and underline.

Trailing Text
Text

Additional text can be appended to the Feature text within the description.

For example, without trailing text the description would be written:

 <Feature Group Name text> <Feature Name text> <Feature State(s) text>

With trailing text it would be:

<Feature Group Name text> <Feature Name text> <Feature State(s) text> <Trailing Text>

Format

Allows simple formatting options to be applied to the Trailing Text label such as bold, italics and underline.

Feature Item Selection

Lucid Builder Natural Language Template Editor Feature Item selection
Lucid Builder Natural Language Template Editor Feature Item selection.
Path

The Path is the mapping location to the Feature within the key. Clicking on the path text within the options panel will open the Feature Path Selection dialog, which will allow you to map to a feature within the key. The scored state(s) of this Feature will be output in the description.

Format

Allows simple formatting options to be applied to the Feature state text label such as bold, italics and underline.

Conjunction

Where multiple States of a Feature have been scored the state text will be joined by a comma the conjunction between the second last and last state is where the conjunction is applied. The default conjunction is “or”.

For example using the default “Or” option,

<Feature Group Name text> <Feature Name text> <Feature State>, <Feature State> or <Feature State>.

Using the “And” conjunction would give:

<Feature Group Name text> <Feature Name text> <Feature State>, <Feature State> and <Feature State>.

Categories
Lucid Builder v4

Lucid Builder Setting key options

Lucid Builder banner

Applies to Matrix key projects

Key options are set using the Key > Key Options menu. These options allow you to specify aspects of the behaviour of your key when opened in the Lucid Player.  In most cases, the key user can change these settings when using the player. For more information, consult the Lucid Player Help.

The Key option dialog has a number of options accessible via the tabs on the left. Select the desired tab option to view the options available.

The default options settings should cover most types of keys when opened in the Player. You should understand and carefully consider the implications of changing any of these settings.

Lucid Builder Key Options dialog.

Key Options

The Key options allow you to adjust the default operational settings the Lucid Player will use when it opens the key.

Matching Options

In the Lucid Player, Matching Options determine the way in which two special scores, Present by Misinterpretation and Uncertain are handled.  See the Player Help for more information.

Allow Misinterpretations

With Allow Misinterpretations checked, the Player will be set to treat entities scored using By Misinterpretation scores in the same way as ones scored using Common and Rare. This is the correct behaviour for normal identification as it allows you to pre-empt likely mistakes made by a user.

With Allow Misinterpretations unchecked, the Player will be set to treat entities scored using the By Misinterpretation scores in the same way as ones scored as Absent.

See the topic Present by misinterpretation for more information.

Retain uncertains

With Retain Uncertains checked, the Player will be set to treat entities scored as Uncertain for a feature in the same way as ones scored as Common. This is the correct behaviour for normal identification.

With Retain Uncertains unchecked, the Player will be set to treat entities scored as Uncertain for a feature in the same way as ones scored as Absent.

See the topic Uncertain for more information.

Sort Mode

In the Lucid Player, the Sorting Mode determines the way in which entities that do not match the selected features are handled. See the Player Help for more information.

Filtered

With Sort Mode set to Filtered, entities that do not match the currently chosen features will be removed from Entities Remaining into Entities Discarded. This is the most common mode for using the key.

Ranked

With Sort Mode set to Ranked, the Entities Discarded panel is removed and all entities remain in Entities Remaining throughout the key session. Entities are prefixed with a percentage value showing the proportion of chosen features that match the entity; the entities list is ranked by this value.

Matching Mode

In the Lucid Player, the Matching Mode determines the way in which the selection of one or more states of a feature results in entities being retained or discarded. See the Player Help for more information.

Any State

With Any State checked, the Player will be set to use the Any State match method. Under this method, an entity scored for several states of a feature will be retained in Entities Remaining if any of its scored states is selected. This is the default mode for normal identifications.

For instance, if a key has a feature Flower colour with states white, cream, yellow, red, and blue, and a user selects white and cream, Entities Remaining will list all entities with white or cream flowers.

All States

With All States checked, the Player will be set to use the All States match method. Under this method, an entity scored for several states of a feature will be retained in Entities Remaining only if all its scored states are selected.

For instance, if a key has a feature Flower colour with states white, cream, yellow, red, and blue, and a user selects white and cream, Entities Remaining will list only entities scored for both (and only) white and cream flowers.

Automation Options 

In the Lucid3 Player, two functions Best and Prune Redundants  can be automated so they are invoked after each state is selected. See the Player Help for more information.

Auto Best

Check Auto Best to set the Player to invoke the Best function automatically after each state is selected.

Auto Prune

Check Auto Prune to set the Player to invoke the Prune Redundants function automatically after each state is selected.

Display Options

Lucid Builder Key Options dialog Display tab
Lucid Builder Key Options dialog Display tab.

The Display options allow you to set how the Player interface and key should look when opened in the Lucid Player.

Features

Tree View

Check Tree View to set the Player to show the Features in Tree View (hierarchical view) mode. Selecting this option will automatically toggle off the List View, if selected.

List View

Check List View to set the Player to show Features in List View (flat list view) mode. Selecting this option will automatically toggle off the Tree View, if selected.

Feature Thumbnails

Check Feature Thumbnails to show thumbnail images in the keys Features.

Feature Gallery

Check Feature Gallery to show feature states in a gallery view rather than the vertical view.

Expand Top Level Nodes

Select Expand Top Level Nodes to open each of the top (root) level Features listed in the key when opened by the Player.

Note

This option will be ignored if the Features are set to List View.

Entities

Tree View

Check Tree View to set the Player to show the Entities in Tree View (hierarchical view) mode. Selecting this option will automatically toggle off the List View, if selected.

List View

Check List View to set the Player to show Entities in List View (flat list view) mode. Selecting this option will automatically toggle off the Tree View, if selected.

Image View

Check Image View to select the Entities remaining  image gallery as the default Entities view in the Player for the key.

Entity Thumbnails

Check Entity Thumbnails to set the Player to show default Entity thumbnails in either Tree View or List View.

Expand Top Level Nodes

Select Expand Top Level Nodes to open each of the top (root) level Entities listed in the key when opened by the Player.

Note

This option will be ignored if the Entities are set to List View.

Language

Locale

The local drop down box displays the available Player language files available. Additional language files can be created via the Lucid Builder and will be automatically listed here. For more information on creating language files see Multilingual Support.

Note

Certain languages, including eastern Asian languages such as Japanese, Chinese, and Thai, require specific font's to be able to display the extended character sets. If you are translating interface strings, or deploying a key using these languages, please add the font to the Lucid Player deployment folder (or an on-line source. E.g. Google Fonts.) and make a style sheet reference in the player container HTML file.

Media Options

Lucid Builder Key Options dialog - Media Tab
Lucid Builder Key Options dialog – Media Tab.

Media options determine the default settings for media when added to the key via the Builder.

Thumbnails

Max. Dimension (px)

The maximum height and/or width the thumbnail will be created to. See the ‘Aspect Fit’ option below for additional details that effect the thumbnail creation.

Aspect Fit

If checked (default), then the thumbnail will be created keeping its aspect ratio within the maximum dimension set. This stops the thumbnail from being distorted when fitting (size) to the maximum dimension.

Lucid Builder Thumbnail Aspect Fit example
Lucid Builder Thumbnail Aspect Fit example.

Media Panel

Display Image Thumbnails

If checked, thumbnail images, rather than the filename will be displayed within the Builder’s Media Panel.

Defaults

Image Caption

The Image Caption allows you to set a default caption for images. The default caption will be applied within the Media Panel caption text box when the image is first attached. You can override the default caption by replacing it with your preferred caption text.

Image Copyright

The Image Copyright option allows you to set a default copyright label to images. You can override the default copyright label by replacing it with your preferred copyright  text within the Media Panel.

HTML Caption

The HTML Caption allows you to set a default caption for HTML pages attached to the key. The default HTML caption text will be applied within the Media Panel caption text box when the HTML file is first attached. You can override the default caption by replacing it with your preferred caption text.

Item Name as Caption

If the Item Name as Caption is checked then the default caption for an attached image or HTML file will be the label text of the selected item (e.g. Feature, Feature State or Entity). You can override the default caption by replacing it with your preferred caption text within the Media Panel.

Descriptions Panel

Lucid Builder Key Options dialog - Descriptions tab
Lucid Builder Key Options dialog – Descriptions tab.

Entity Descriptions

Output Template

The Output Template option allows you to save your preferred template for customising the keys description structure. The output template is an XML based file with a ‘.xml’ file extension.

Transformation File

The Transformation Template option allows you to save your preferred template for transforming the XML based key data to “human” readable format. The transformation template file is an XSL based file with a ‘.xsl’ file extension.

Categories
Lucid Builder v4

Lucid Builder Multilingual Support

Lucid Builder banner

Multilingual support has been added to the Lucid Builder and Player applications, allowing the key author to customise the language string used within the Builder and Player user interface. Facilities to edit language resource files for both the Builder and Player have been added to the Lucid Builder.

Overview

Basic language files are included in the Builder and Player. These basic language files cannot be edited or customised, but can be used to derive new language files. These files are called “LucidBuilder_language.properties”, and “LucidPlayer_language.properties” respectively.

Customised language files are stored in a folder called ‘resource’ located in the Lucid workspace folder (typically your user profile folder on windows platforms. E.g., C:\users\<your username>\Lucid).

Reminder: The Workspace folder is defined the first time the Builder is run.

Lucid language resources are defined in text files, containing text of the format “property=value”, Thus, the term “accept_button=Accept”, consists of a property (accept_button), which is a string defining where the value is used with the application, and a value (Accept), which is the string value of the resource.

Language files are named using the following syntax:

– “LucidBuilder_language.properties”, with the locale (or language) information (such as a language code and country code) added to the name where appropriate. For instance, if a key developer wants to have a Spanish version of the Lucid Builder – then “LucidBuilder_language_sp.properties” defines a Spanish language resource file for the Lucid Builder. “LucidBuilder_language_sp_SP.properties” defines a Spanish language file, with the country code of Spain (SP) indicating the key is intended for use in Spain. An alternative regional or country code – such as “LucidBuilder_language_sp_EC.properties” indicates an Ecuadorian Spanish version – which is likely to have regional variations from the Spanish version used in Spain.

These Language files are hierarchical in nature, with the hierarchy based on the language or locale. So a series of Japanese language files are shown below

LucidBuilder?_language.properties
LucidBuilder?_language_ja.properties
LucidBuilder?_language_ja_JP.properties
LucidBuilder?_language_ja_JP_variant.properties

The first file in the above hierarchy is the base language file distributed with the Lucid Builder application. Japanese translated strings would be defined in the second file, and region or variant specific translations defined in the lower files. An example of a variant might be a Japanese weed key, where the term weeds is used instead of entities, etc. This allows more flexibility in translating and preparing translations based on region and other variants.

Here is an example Korean language file for the Builder interface.

To install, download the file (120kb) and then copy it to ‘resources’ folder, as describe above. E.g.,

C:\users\<your username>\Lucid\resources\

Once copied, open the Lucid Builder and via the ‘View…Languages’ menu option select the ‘Korean (CS1)’ language option to change the Builder language to Korean.

Please note this language file was kindly provided by Lucid user Soowon Cho, Chungbuk National University. Please check that this file is suitable for your needs.

Editing Language

Creating or editing language files from within the Builder can be done using the Tools…Edit Builder Language or Edit Player Language menu items.

Lucid Builder Language Selector dialog.

Selecting either of these menu items will open a dialog showing the language files (including the base language file) present on the system.

Lucid Builder New Language dialog
Lucid Builder New Language dialog.

A new language file can be created using the New button, and then selecting the desired language locale and entering an optional variant on the sub dialog. Selecting a language file from the list will open the Edit Language dialog.

The Edit Language dialog simplifies the language file editing process by displaying the original and translated string for each language string. The original language strings are taken from the bundled default language files, the translated string is the string present in the selected language file. The dialog also shows a description of the currently selected string or where in the application the string is used.

Lucid Builder Language Editor dialog
Lucid Builder Language Editor dialog.

Additionally the dialog will also show the translated language strings from language files higher in the hierarchy. To easily differentiate between translations in the current file, and those in higher files, the rows in the table are colour coded. Strings translated in the current file are highlighted with a pink background. Strings translated in a higher language file are highlighted with a grey background.

Lucid Builder Language Editor - Higher level translations highlighted with a grey background
Lucid Builder Language Editor – Higher level translations highlighted with a grey background.

Alternatively language files may be edited using a text editor or other text manipulation software, the language files must be named using the conventions described above and be located in the resource folder, also as described above.

Using Language Files

Alternative interface languages may be selected in the Builder by using the Language menu item located in the View menu, this will open the Select Language dialog displaying the available language files for use in the Builder.

The Select Language dialog displays a list of all Builder language files available, this includes the bundled base language file containing untranslated strings, and any translated language files located in the resource folder. Selecting a translated language file will update the interface of the Builder with the translated strings present in the selected file. Any interface strings not present in the selected file will be loaded from a file higher in the locale hierarchy, as described above.

Likewise, the interface language may be selected in the Player by using the Language menu item in the View menu. The Select Language dialog in the Player will show the base language file, and any translated Player specific language files located in the resource folder.

Specifying the Lucid Player Language File

You can set your preferred language for the Lucid Player, via the Key Options dialog under the Display tab.

Lucid Builder Key Options dialog, select from available languages
Lucid Builder Key Options dialog, select from available.

Note

Certain languages, including eastern Asian languages such as Japanese, Chinese, and Thai, require specific font's to be able to display the extended character sets. If you are translating interface strings, or deploying a key using these languages, please add the font to the Lucid Player deployment folder (or an on-line source. E.g. Google Fonts.) and make a style sheet reference in the player container HTML file.

Categories
Lucid Builder v4

Lucid Builder Key Reporter

Lucid Builder banner
Lucid Builder Key Reporter Items tab.

The Key Report allows you to create reports on various aspects of your key such as the status of a key’s media and scoring.

The Key Reporter can be accessed from the Tools > Key Reporter menu.

The Key Reporter interface is split into three sections, accessible via the tabs at the top of the dialog. They include Items, Media and Scoring and are described below.

Items

Features Needing Revision

All Features and States marked, via the Items properties tab, as ‘Needs Revision’ will be listed in this report.

Entities Needing Revision

All Entities marked, via the Items Properties tab, as ‘Needs Revision’ will be listed in this report.

Features Included in Best

Reports any Features that have been or not been excluded from the Best function by un-checking the ‘Include in Best’ option within the Items Property panel.

Features Excluded From Best

Reports on all Features that have had their ‘Include in Best’ property un-checked in the Items Properties panel.

Media

Lucid Builder Key Reporter Media tab
Lucid Builder Key Reporter Media tab.

No Caption

All images within the key that do not contain a value for a caption will be listed in the report.

Needs Revision

Items that have been marked as needing revision via the media panel will be listed in the report.

No Copyright

Any media item without a copyright statement will be listed in the report.

Do Not Publish

Any media item checked do not publish in the media panel will be listed in the report.

No Comment

Any media item without a comment will be listed in the report.

No Images Attached

Any item (Feature or Entity) without an attached image will be listed in the report.

No HTML Attached

Any item (Feature or Entity) without an attached HTML page or URL will be listed in the report.

Scoring

Lucid Builder Key Reporter Scoring tab
Lucid Builder Key Reporter Scoring tab.

Featured Scored

Report on all Features that have a score associated with them.

Features Scored:

Lucid Builder Key Reporter Score Selector
Lucid Builder Key Reporter Score Selector

Report on all Features scored based on the selected score type. Click on the ‘Features Scored: ‘ checkbox or text label to open the Score Selector dialog which will allow you to select the score type you wish to report on.

Features Unscored

Report on all features that have no score applied to them across any Entities.

Entities Scored

Report on all Entities that have any score type associated with them.

Entities Scored:

Lucid Builder Key Reporter Score Selector
Lucid Builder Key Reporter Score Selector

Entities Unscored

Report on all Entities that have been scored based on the selected score type. Click on the ‘Entities Unscored: ‘ checkbox or label to open the Score Selector dialog which will allow you to select the score type you wish to report on.

Positive Dependencies

Report on all Positive Dependencies set on Features within the key.

Negative Dependencies

Report on all Negative Dependencies set on Features within the key.

Scoped Features

Report all Scoped in Features for Entities.

Not Scoped Features

Report all Not Scoped Features within the key and along with the associated Entities.

Subsets

Report on all Subsets (Feature Subsets and Entity Subsets) contained within the key along with the associated Feature or Entities they contain.

Categories
Lucid Builder v4

Lucid Builder Automatic backup of key data files

Lucid Builder banner

The Lucid Builder now creates a series of back files (or snap shots) of the key data each time you open a key.

The builder will keep a maximum four versions of your key data (the latest versions), older versions being deleted. These backup files can be found in the keys Data folder. Each snap shot of a data file has the same file extension. For example:

Current in use data files have the following extensions:

.data
.dep
.sco
.fil

Backup data sets have the following extensions:

.data.bak{1-3}
.dep.bak{1-3}
.sco.bak{1-3}
.fil.bak{1-3}

E.g.

.data.bak1
.dep.bak1
.sco.bak1
.fil.bak1

If you do need to recover to a prior back up set ensure the following:

  1. The Builder is closed.
  2. Back up the “in use” data files to a safe location (e.g. network drive or backup device).
  3. Remove or delete the in use data files (e.g. the files without the .bak extension).
  4. Make a copy of the desired back set in the Data folder and remove the .bak file extensions.

Warning

Ensure you only use the related back set files.

Warning

Lucid’s automatic backup sets of data are not a total backup solution for your key data. You should always back up all your key data and media on a regular basis, preferably to an alternative storage location. If unsure, please talk to your systems administrator about how to implement an adequate backup strategy.