How to add a component / workflow page

Before adding a tool/function/implementations/scripts, you should decide if it is a component or workflow. If you are not sure with these terms, please first read here.. A collection of components, without specific workflow, is called software including library.

To add a component page:

Component page is for

  • a menu item in GUI (such as plugin, e.g. "ManualTracking" in Fiji)
  • a single command in CUI (e.g. r.watershed in R)

Step-by-step instruction

  1. In the left navigation panel, click "Add Content". "Add Content" panel opens.
  2. Click "Component".
  3. Fill following fields:
    1. Title (required): name of the menu item or the command
    2. Tags: Tags that describe the function of the item. If the title is "watershed" it could be something like "segmentation", "overlaps", "morphology" and so on. tags can be edited afterwards, so don't be too cautious. More tags are better than less.
    3. URL: Links to the web page of this item (if this item is ImageJ manual tracking, it will be http://rsb.info.nih.gov/ij/plugins/track/track.html)
    4. Authors: Not you, but the author of the item. If this item is ImageJ manual tracking, then "Fabrice Cordelieres"
    5. Description: Write in text what this component does.
    6. Workflow: workflow page in the BIII that uses this component.
    7. Package / Library: Choose a package that this component is included. You could not find one from the list, please add a software / library page. It will then appear automatically in the list.
  4. Preview button is at the bottom. Check the preview, and if everything looks ok, please "Save".

To add a workflow page:

Workflow pages are for

  • Practical workflow starting from a microscope image to analysis results.
  • We recommend only links and short description to external site, not to write the whole workflow directly in BIII.

Step-by-step instruction

  1. In the left navigation panel, click "Add Content". "Add Content" panel opens.
  2. Click "Workflows".
  3. Fill following fields:
    1. Workflows (required): name of the workflow
    2. Tags (required): Tags that describe what this workflow does.
    3. Workflow URL: Links to the web page of this item.
    4. Example Image URL: Link to the example image for testing the workflow.
    5. Comment/ Instructions: Please explain what this workflow does. It will be very helpful which organism is the target. (It could be "general" as well).
    6. Workflow Authors: Not you, but the author of the workflow.
    7. Description: Write in text what this component does.
    8. Workflow: workflow page in the BIII that uses this component.
    9. Dependencies: Select one or more software/libraries that is required for the workflow.
    10. Language: if the workflow is in a form of a macro or script, please select a language. If there is none, you do not have to choose, or you could write about it in "comment/instructions" about the special programming language that is used.
  4. Preview button is at the bottom. Check the preview, and if everything looks ok, please "Save".