Skip to content

Lucid keys

Paul Kiddle edited this page Sep 20, 2018 · 1 revision


Lucid software is a special type of expert system, specifically designed for identification and diagnostic purposes. Lucid identification keys are currently being used by a wide range of end-users, from high school and university students to taxonomists, quarantine identifiers, biodiversity scientists and conservation managers. If you have a Lucid key you can now embed and fully use it through the Scratchpads environment.

This will give you the opportunity to run the keys in separate standalone pages or embed them in selected taxon overview pages. You can have multiple lucid keys running in your Scratchpad, even on the same page.


To have a lucid key file displayed as a working key in your Scratchpad you will have to create a separate field in any of existing or in a new content type in your site. The following steps will guide you to embed a Lucid key in a new content type called Keys

Enabling the module

  1. Go to Structure > Tools
  2. Find and enable Scratchpads Lucid applet under the Other section of the page
  3. Click Save

Creating the new content type

You should skip this part if you want to add the lucid key field to an existing content type

  1. Go to Structure > Content types
  2. Click on + Add content type
  3. Provide a Name (e.g. Keys)
  4. Provide a description (not required)
  5. In the horizontal tabs go to Publishing options and select Published
  6. In the horizontal tabs go to Display settings and select Display on species pages if you want to have the keys appearing in the taxon overview pages
    • Select in which tab you want the new content type to appear in. If you want a separate tab select Own tab
  7. In the horizontal tabs go to Menu settings and select Main Menu if you want a link to your Lucid Keys from the main menu
  8. Click Save

Adding the Lucid key field in a content type

  1. Go to Structure > Content types and click on Manage fields next to content type you wish to add the lucid keys functionality

  2. Find the Add new Field section

  3. Provide a Labelfor the field: “Lucid Key”

  4. Under Select a field type drop-down select File

  5. In the next drop-down list select File

  6. If you want to tag the key with a taxonomic name so that will appear on the taxon overview pages then:

    1. Find the Add existing field section
    2. Under the Field to share drop-down list select Term reference: field_taxonomic_name (Taxonomic name)
    3. under the ''Form element to edit the data drop-down list select Autocomplete term widget (tagging) or any of the other ways to select a taxon from an existing classification
  7. Click Save

  8. In the next screen select Enable Display field and '' Files displayed by default''

  9. Click Save field settings

  10. In the next screen go to ALLOWED FILE EXTENSIONS and add the string “zip” separated by a space from the existing string ''txt'

  11. Click Save settings

  12. Click on Manage Display on the right top corner of the overlay window

  13. Find the Lucid key field you created and select Lucid3 Key player applet from the Format column drop-down box

  14. Click Save

Uploading your Lucid Key file

  1. Go to Content and click Add next to the content type in which you previously added the “Lucid Key” field

  2. Provide a title to your page (can be the higher taxon of the key or a short description of the key)

  3. Under the field “Lucid Key” click Browse to find a valid (lkc3/lkc4 file)

  4. Click Upload

  5. Once uploaded (might take several minutes) select Include file in display

  6. Provide a TAXONOMIC NAME if this field is available.

  7. From the Horizontal tabs menu go to Publishing options and click Published

  8. Click Save

Viewing your Key

Depending on whether you have selected for a link to be added to the main menu or/and if you have selected for the content type data to be displayed on the taxon overview pages you should be able to see your keys working

Browsing the Key

You can find more on how to use the Lucid environment by going to

Clone this wiki locally
You can’t perform that action at this time.