Lucid Help
You can check for updates to the Lucid Builder by using the ‘Check for updates’ option via the Help menu.
An Internet connection is required for the Builder to check for an update.
The Lucid Builder will show its progress on checking for an update. If an update is found you will be prompted if you wish to download and install it. Ensure the Lucid Builder is closed prior to installing the new update.
The About dialog will allow you to find your licence details and the full version information of the Lucid Builder.
The Lucid Builder Toolbar provides convenient shortcuts to the actions available from the Menu system.
HelpOpens the Lucid Builder on-line help, in your preferred web browser.
Check for Updates…Check for any updates to the Lucid Builder that are available for your edition. An online connection is required for this action to function.
Please see Checking for Updates help topic for additional information.
About Lucid Builder…Opens the About dialog where Lucid Builder version and copyright information can be found.
The Lucid Builder allows multiple dialogs to be opened at the same time. The Windows menu shows the currently opened dialogs, which you can select to bring them forward above the main Builder interface.
Bring all to frontAll opened dialogs will be brought to the front of the main Lucid Builder interface.
Import Items…Available for Matrix key project types
Opens either the Features or Entities Import Items dialog depending on which panel (Features or Entities) you have selected. The Import Items dialog allows you to quickly build Feature trees or Entity trees very quickly by either typing or pasting existing data.
See the Adding items to the Feature and Entity trees help topic for further information.
Import Entities…Available for Pathway key project types
Allows Entities to be quickly added either by typing or pasting existing data.
Check Media…Opens the Check Media dialog where any missing media for Features or Entities will be reported.
See the Check Media help topic for further information.
Key Reporter…Opens the Key Reporter dialog. The Key Reporter allows you to query many aspects of your key such as unscored Entities, items without media, items needing revision etc.
See the Key Reporter help topic for further information.
Edit Builder Language…Opens the Language Editor for the Builder interface.
See the Multilingual support help topic for further information.
Edit Player Language…Opens the Language editor for the Player interface.
See the Multilingual support help topic for further information.
Remove Feature Media…Enables the removal of either all media from Features and States, or the removal of image media or text media from the selected Feature or State.
See Removing Media help topic for more information.
Remove Entity Media…Enables the removal of either all media from Entities, or the removal of image media or text media from the selected Entity.
See Removing Media help topic for more information.
Update ThumbnailsForces the Builder regenerate the keys thumbnails from the attached images. This is useful if you have adjusted the preferred thumbnail size in the Key Options or have changed out images, outside the scope of the Builder (I.e. Via the file system). Regenerating thumbnails can be an intensive process for large keys with lots of images. You will be asked to confirm the action.
Edit Template…Opens the Natural Language Template Editor dialog.
Attach DescriptionsAttaches HTML based descriptions (generated by the Natural Language generator) to all Entities in the Entities tree. These can be individually added (or removed) via the Media Properties panel for the selected Entity.
Remove DescriptionsRemoves all HTML based descriptions (generated by the Natural Language generator) from the Entities in the Entities tree. These can be individually removed (or added) via the Media Properties panel for the selected Entity.
Update DescriptionsForces the regeneration of all Entity Natural Language description files, created by the Builder, based on your template and transform file.
View DependenciesOpens the View Dependencies dialog that allows you to check on your dependency scoring. See the View Dependencies help topic for further information.
View ScopesOpens the View Scopes dialog that allows you to easily view your scoped and not scoped Features. See the View Scopes help topic for further information.
View SubsetsOpens the View Subsets dialog that allows you to review your Subsets (and contained Features or Entities). See the View Subsets help topic for further information.
Deploy Key…Opens the Deploy Key dialog. See the Deploying a key help topic for further information.
Preview KeyAllows you to preview your key by opening it in the Lucid Player, via your preferred web browser.
Key Options…Opens the Key Options dialog, which allows you to set a number of preferences for your key. See the Setting key options help topic for further information.
Language…Opens the Language selection dialog for the Lucid Builder. A language file may be another language from what you are using (E.g. English, Spanish or Mandarin etc.), or a language can simply be a variant on a language, with customised strings to suit the key’s topic. For example, you may have an English language file variant for weeds, where all the terms for ‘Entity’ and ‘Entities’ are replaced with ‘Weed’ and ‘Weeds’.
See the Multilingual Support help topic for additional information.
Font…Opens the Font selection dialog. You may prefer a different font than the default system font. Or your language may require a specific font, not set via your operating system.
Larger (ctrl+ =) (⌘ + =)Increases the font size within the Lucid Builder.
Smaller (ctrl+ -) (⌘ + -)Decreases the font size with the Lucid Builder.
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.
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.
Refresh Item TreesThis option can be used to force the Lucid Builder to re-render the Feature and Entities trees. This can be useful for example, if you have change screen resolutions or resized thumbnails outside the scope of the Builder and want it to refresh the display.
Feature ThumbnailsToggle on or off the display of Feature (and States) thumbnails within the Features tree. The size of the thumbnail is set via the Key Options dialog.
Entity ThumbnailsToggle on or off the display of Entity thumbnails within the Entities tree. The size of the thumbnail is set via the Key Options dialog.
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.
Add EntityAdds 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 ChildAdds 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 ParentAdds 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 SpecimenAdds a new Specimen to an existing Entity within the Entities tree. See the help topic on Specimens for more information.
CopyCopies 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.
PastePastes 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 siblingPastes 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.
RenameRenames 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.
DeleteDeletes 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.
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 Entity to SpecimenConverts 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 Specimen to EntityConverts 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.
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.
Attach HTML FileAllows the attachment of a HTML (or PDF) file present within your keys Media folder to the selected Entity or Specimen.
Attach HTML UrlAllows the attachment of a Url based resource (E.g. web page) to the selected Entity or Specimen.
Attach Image FileAllows 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 DescriptionAttaches 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 MediaCreates 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 ScoresCreates 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.
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.
Add FeatureAdds a new Feature to the the Feature tree.
Add Feature as ChildAdds 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 ParentAdds a new Feature as the parent of the currently selected Feature.
Add StateAdds a new State to the selected Feature. This option is only available where the selected Feature doesn’t already contain a Feature.
CopyCopies 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.
PastePastes 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 siblingPastes 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.
RenameRenames 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.
DeleteDeletes 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.
Merge Selected StatesThis 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.
Present (common)
Rare
Uncertain
Not Scoped
Present (common), misinterpreted
Rare, misinterpreted
AbsentFor example, if Agaricus had scores on the following feature:
Spore shape
globose (Absent)
subglobose (Rare)
ellipsoid (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.
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 FeaturesConverts 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.
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.
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.
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.
Attach HTML FileAllows the attachment of a HTML (or PDF) file present within your keys Media folder to the selected Feature or State.
Attach HTML UrlAllows the attachment of a Url based resource (E.g. web page) to the selected Feature or State.
Attach Image FileAllows 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 MediaCreates 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 ScoresCreates 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.