Project Help Content

There are currently three types of help you can give your project's users:

1. A Project Tutorial

A project tutorial should orient a user to your project's overall goals and workflows. This will show as a pop-up modal when a user first tries a task. To enable this, create a tutorial.json and place in your project's directory:

my_project/
+-- tutorial/
|   +-- tutorial.json

A typical 3-step tutorial file may look like:

{
    "name": "Tutorial",
    "first_task": "learn_marking",
    "tasks": {
        "learn_marking": {
            "next_task": "learn_transcribing",
            "help": {
                "title": "Marking Regions",
                "file": "learn_marking"
            }
        },
        "learn_transcribing": {
            "next_task": "learn_verifying",
            "help": {
                "title": "Transcribing",
                "file": "learn_transcribing"
            }
        },
        "learn_verifying": {
            "next_task": null,
            "help": {
                "title": "Learn To Verify",
                "file": "learn_verifying"
            }
        }
    }
}

The help hash can be constructed in one of two ways:

1. As a markdown file. For example, this configuration looks for the file learn_marking.md in the /project/my-project/content/help folder:

"help": {
  "file": "learn_marking"
},

2. As a hash in the following format:

"help": {
  "title": "How To Mark Documents",
  "body": "Use your mouse to draw a box on the image around each place that the field appears. "
}

2. Task-specific Help

You can give a user help on the task-level in the workflow configuration like so:

...
  tasks: {
    "determine_has_records": {
      "tool": "pickOne",
      "instruction": "First, let's determine if this document has records",
      "help": {
        "file": "help_records"
      }
    }
  }
...

The help hash works the same as the first section in this document.

3. Subject-specific Help

You can give a user help on the subject-level in the workflow configuration like so:

...
      "tool_config" : {
        "options": [
          {"type": "rectangleTool", "label": "Record Date", "help": {"file": "help_record_date"}}
        ]
      }
...

The help hash works the same as the first section in this document.

---

Next step: Customize the design