Skip to main content

Help

Scripts, DockerMods and Webhooks can have help: instructions for anyone using them, written in markdown.

Help is most useful when sharing to the repository, where the people using what you shared did not write it. Instead of putting long instructions in the description or in comments in the code, put them in the help: what it does, how to set it up, what it needs, and anything to watch out for.

Help is optional.

Where Help Is Shown​

  • The Help tab of the script, DockerMod or webhook editor.
  • The Help tab of a script's flow element in the flow editor, so it can be read while filling in the fields. This tab is only shown when the script has help.
  • When previewing an item in the repository, before importing it.

Help is shared with a script, DockerMod or webhook, and is imported with it.

Editing Help​

Open the Help tab. Existing help is shown formatted, hover over it and click Edit to change it, then Preview to see how it looks. A new script, DockerMod or webhook opens the help ready to edit.

While editing, the number of characters used is shown. Help can be up to 20,000 characters, a few pages of text.

Help is checked when it is saved. If it uses something that is not allowed, the save fails and the message says what and on which line.

Formatting​

Help is markdown, with the following allowed.

Headings​

# Heading 1
## Heading 2
### Heading 3

Text​

**bold**, *italic*, ~~strikethrough~~ and `inline code`.

A blank line starts a new paragraph.
End a line with two spaces to break the line without a new paragraph.

Lists​

1. First step
2. Second step
   - A nested item
   - Another nested item

- An item
- Another item

Quotes​

> A quote, for example from the documentation of another app.

Code Blocks​

Fence code with three backticks, optionally followed by the language.

```bash
apt-get install -y ffmpeg
```

Hover over a code block to show a button to copy its contents.

The language is optional, and can only be a plain name such as bash, js, c# or powershell.

Code can also be indented by four spaces.

Tables​

| Variable | Description |
|----------|-------------|
| `file.Name` | The name of the file |
| `file.Size` | The size of the file |
See the [FileFlows documentation](https://fileflows.com/docs) or <https://fileflows.com>.

Links open in a new window.

Horizontal Rule​

---

Callouts​

Callouts highlight something, each type with its own color and icon.

:::note
Something to note.
:::

:::info
Some information.
:::

:::tip
A helpful tip.
:::

:::warning
Something to be careful of.
:::

:::danger
Something that can go wrong, such as losing files.
:::

A callout is titled with its type (Note, Information, Tip, Warning or Danger). To use a different title, add it after the type:

:::tip[Hardware Encoding]
Enable hardware encoding in the settings for much faster conversions.
:::

A callout can contain any of the other formatting, such as lists and code blocks.

What Is Not Allowed​

Help is shown to users who did not write it, so only the formatting above is allowed. Help that uses anything else cannot be saved or shared.

Not AllowedWhy
HTMLHelp is formatted with markdown only. HTML in a code block or inline code is fine, it is shown as text.
ImagesImages are loaded from other sites.
Links other than http and httpsFor example javascript:, data:, mailto: or relative links.
Other callout typesOnly note, info, tip, warning and danger.
Code block languages that are not a plain nameThe language is used for formatting, it can only be letters, numbers and + # . - _.
Deep nestingLists, quotes and callouts can be nested up to 10 levels deep.
Control charactersOther than tabs and new lines.
More than 20,000 characters

Sharing​

When shared, the help is checked again by the repository, and it is reviewed as part of approving what was shared.

Writing Good Help​

  • Start with what it does and why someone would use it.
  • List what it needs, such as other DockerMods, plugins, variables or an API key, and where to get them.
  • Explain how to set it up step by step, using a numbered list.
  • Explain each parameter or output that is not obvious.
  • Use a callout for anything that could cause a problem, such as files being deleted.
  • Keep the description short, it is shown in lists, and put the details in the help.