Dichotomous key

Index

Each project can have one dichotomous key. That key consists of a theoretically unlimited number of steps. Each step consists of a number, a title and a description, plus one or more choices. Each choice consists of a title and a text and/or an image. Also, each choice has a target: the connection to the next element within the key. The target can either be another step, or a taxon.
You have the option to use images instead of text and therefore to build keys based on visual identification.
You can edit the key from the startpoint, following its structure as the users will see it. Additionally, you can create sections of your key that are not yet connected to the main key. In that way, several people can work on different parts of the key at the same time. Once finished, a section can be hooked up to the main key by simply choosing the sections starting step as the target of a choice already part of the main key.
While navigating through your key or key sections, a keypath is maintained at the top of the screen, just beneath the navigational breadcrumb trail. You can navigate within your key by clicking elements in the keypath. As the keypath can become quite large, only the last few elements are shown. To see the complete keypath, click the ∇ symbol at its very beginning.

On this page you find an automatic generated list of the different steps in the key. You can jump to a step by clicking on its name.

Show key step

On this page you can set up or edit a dichotomous key. Enter the title and text of this step in your key in the various languages within your project. Title and text are saved automatically after you have entered the text in the appropriate input.
To change the step-number from the automatically generated one, enter a new number and click 'save'. Please note that the numbers have to be unique in your key.

Editing an existing step in the key:
Step section. To change the name of the step click "edit". Click "delete" to delete or "preview" to preview a step.
Choices section. To edit an existing choice click "edit". For deleting a choice click "delete". To add a new choice, click "add new choice". You can change the order of the choices by clicking the ↑ and ↓ arrows.

While navigating through your key or key sections, a keypath is maintained at the top of the screen, just beneath the navigational breadcrumb trail. You can navigate within your key by clicking elements in the keypath. As the keypath can become quite large, only the last few elements are shown. To see the complete keypath, click the ∇ symbol at its very beginning.
Click "Contents" on top of the page to see a list of all the steps in the key, "Management" to jump to the starting page of the module, "Insert new step" to insert a new step before the first step or between two existing steps. To enhance the performance of this page you can check "do not show remaining and excluded taxa" on the bottom of the page. This has no effect on the front-end.

Edit step

On this page you can edit a step in the key. You can change the number, title or text (description of the step). Enter the title and text of this step in your key in the various languages within your project. Title and text are saved automatically after you have entered the text in the appropriate input.
To change the step-number from the automatically generated one, enter a new number and click "save". Please note that the numbers have to be unique in your key.

Edit choice

On this page you can edit a choice in the key. Enter the text and the target of this choice. You can add an image by clicking "Upload or attach media". As a target you can choose an existing or a new step or a taxon from the pop-up menu. Click save after editing the choice.
On this page you can add a choice to a step in the key. Enter the text and the target of this choice. You can add an image by clicking "Upload or attach media". As a target you can choose an existing or a new step or a taxon from the pop-up menu. Click "save" after adding the choice.

Insert a step before step x

On this page you can insert a new step before step 1. After clicking "insert" the step is inserted and you come back on the "Edit key" page. From here you can go to the step you just inserted and edit it.

Insert a step between step x and y

On this page you can insert a new step between two other steps. After clicking "insert" the step is inserted and you come back on the "Edit key" page. From here you can go to the step you just inserted and edit it.

Key sections

On this page you can jump tot the different key sections in the project. Key sections are parts of the key that are not connected to the main key. In that way, several people can work on different parts of the key at the same time. Once finished, a section can be hooked up to the main key by simply choosing the sections starting step as the target of a choice already part of the main key.
You can click an available section to edit. When you click "set as key start" the section in question will become the main key from where you can hook up other key sections.

Starting a new subsection
You also can start a new key section by clicking "Start a new subsection". Note that a new key section is automatically added, regardless if you click "save" or not. After clicking "Start a new subsection" the new subsection is automatically opened in the "Edit step" screen where you can enter a title and text for the new section.

Key map

On this page you find a graphic representation of the main key. Click a node to see the steps that follow from it. Click and drag to move the entire tree.

Clean up

On this page you can clean up orphaned choices and ghostly targets of your key. Clicking "clean up" will perform the following actions:
- delete choices that belong to a non-existing step
- delete choices that have no text, image or target
- reset non-existent target steps
- reset non-existent target taxa

Taxa not part of the key

This page shows a list of taxa that are not yet part of your key.

Key validation

This page shows a list of irregularities in your key:
- Steps without any choices. To edit, click the name the step.
- Steps with only one choice. To edit, click the name the step.
- Unconnected choices.

Taxon ranks in key

On this page you can define taxa of what rank or ranks will be part of your key.
The taxa that are of a rank below the red line in the list below are available in your key. To change the selection, move the red line up or down by clicking the ↑ and ↓ arrows. To include all ranks, move the line to the top of the list, above the first rank. As at least one rank is required to be included, the line cannot be moved below the lowest rank. When you are satisfied with your selection, click the save-button.
Please note that changing this setting will not detach any taxa that have already been attached to an end-point of your key. Taxa that have a rank that is no longer part of the selection below will remain connected to the key, until you manually detach them.

Store key tree

On this page you can have the system store a tree-structured representation of the key, required for runtime purposes. Click "store key tree" to perform this action.
Please note that, depending on the size of your key, this might take a few minutes.

LinnaeusAdminPages

Linnaeus NG Wiki : Single-accessKey

Revision [298]