Create Info/Help content

If you want to share patches, racks, workspaces, scripts or user modules, it can be useful to add information/help to give some explanations about your creations.

For the final user, if available, the Informations/Help will be accessible:

  • on the toolbar
  • with the show info button of the settings panel

Usine provides several efficient ways to do that with built-in a simple markdown editor. See markdown syntax bellow.

Simple Info

If you want to add simple text without images.

In the settings panel, info tab, click on the edit info button to open the info-editor-panel.

Then fill the editor with markdown text like:

The info text will be saved with the object.

with this method, you can't add images in the text.

Link to a page on Internet

To link the information/help content to an external page, proceed as above but just add the link at the first line in the info-editor-panel:

The info text will be linked to the internet page and saved with the object.

Info with images

You need a little bit more sofisticated procedure.

  1. create an /Info folder located in the patch, rack, workspace, script or user module directory. Example of an /Info folder for a patch.

    the /Info folder is key sensitive.

  2. In the /Info directory create a text file with the same name than the associated object, and with the extension .info. In this example, the file name is

        My Patch.info

    the file name is key sensitive.

  3. Now you can edit the file in your favorite text editor, and use the markdown syntax.

    You can also edit it with the info-editor-panel by clicking on edit info in the settings-panel. But in this case, it will edit the My Patch.info file.

  4. If you need images, just add them in /Info folder and use the markdown syntax, for example ![](image01.png). Content of the /Info folder.

    files of the /Info folder are also exported during the export procedure of patches, racks, workspaces.

Showing Info in patches

You can create a direct access to Info inside patches with the usine-workspace, usine-patch or usine-rack modules.

For example in the following patch:

Markdown syntax

Paragraphs, Headers, Blockquotes

A paragraph is simply one or more consecutive lines of text, separated by one or more blank lines. (A blank line is any line that looks like a blank line -- a line containing nothing spaces or tabs is considered blank.) Normal paragraphs should not be intended with spaces or tabs.

Markdown offers two styles of headers: Setext and atx. Setext-style headers for <h1> and <h2> are created by "underlining" with equal signs (=) and hyphens (-), respectively. To create an atx-style header, you put 1-6 hash marks (#) at the beginning of the line -- the number of hashes equals the resulting HTML header level.

Blockquotes are indicated using email-style '>' angle brackets.

Markdown:

A First Level Header
====================

A Second Level Header
---------------------

Now is the time for all good men to come to
the aid of their country. This is just a
regular paragraph.

The quick brown fox jumped over the lazy
dog's back.

# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5

> This is a blockquote.
> 
> This is the second paragraph in the blockquote.
>
> ## This is an H2 in a blockquote

Output:

A First Level Header

A Second Level Header

Now is the time for all good men to come to the aid of their country. This is just a regular paragraph.

The quick brown fox jumped over the lazy dog's back.

Header 1

Header 2

Header 3

Header 4

Header 5

This is a blockquote.

This is the second paragraph in the blockquote.

This is an H2 in a blockquote

Phrase Emphasis

Markdown uses asterisks and underscores to indicate spans of emphasis.

Markdown:

Some of these words *are emphasized*.
Some of these words _are emphasized also_.

Use two asterisks for **strong emphasis**.
Or, if you prefer, __use two underscores instead__.

Output:

Some of these words are emphasized. Some of these words are emphasized also.

Use two asterisks for strong emphasis. Or, if you prefer, use two underscores instead.

Lists

Unordered (bulleted) lists use asterisks, pluses, and hyphens (*, +, and -) as list markers. These three markers are interchangable; this:

*   Candy.
*   Gum.
*   Booze.

produce:

  • Candy.
  • Gum.
  • Booze.

Ordered (numbered) lists use regular numbers, followed by periods, as list markers:

1.  Red
2.  Green
3.  Blue

Output:

  1. Red
  2. Green
  3. Blue

If you put blank lines between items, you'll get <p> tags for the list item text. You can create multi-paragraph list items by indenting the paragraphs by 4 spaces or 1 tab:

*   A list item.

    With multiple paragraphs.

*   Another item in the list.

Output:

  • A list item.

    With multiple paragraphs.

  • Another item in the list.

Links

Markdown supports two styles for creating links: inline and reference. With both styles, you use square brackets to delimit the text you want to turn into a link.

Inline-style links use parentheses immediately after the link text. For example:

This is an [example link](http://example.com/).

Output:

This is an example link.

Optionally, you may include a title attribute in the parentheses:

This is an [example link](http://example.com/ "With a Title").

Output:

This is an example link.

Reference-style links allow you to refer to your links by names, which you define elsewhere in your document:

I get 10 times more traffic from [Google][1] than from
[Yahoo][2] or [MSN][3].

[1]: http://google.com/        "Google"
[2]: http://search.yahoo.com/  "Yahoo Search"
[3]: http://search.msn.com/    "MSN Search"

Output:

I get 10 times more traffic from Google than from Yahoo or MSN.

The title attribute is optional. Link names may contain letters, numbers and spaces, but are not case sensitive:

I start my morning with a cup of coffee and
[The New York Times][NY Times].

[ny times]: http://www.nytimes.com/

Output:

I start my morning with a cup of coffee and The New York Times.

Images

Image syntax is very much like link syntax.

Inline (titles are optional):

![alt text](img.jpg)

output: alt text

Code

In a regular paragraph, you can create code span by wrapping text in backtick quotes. Any ampersands (&) and angle brackets (< or >) will automatically be translated into HTML entities. This makes it easy to use Markdown to write about HTML example code:

`Example of code` tags.

Output:

Example of code tags.

To specify an entire block of pre-formatted code, indent every line of the block by 4 spaces or 1 tab. Just like with code spans, &, <, and > characters will be escaped automatically.

const DEFAULT_HEADER_HEIGHT     : single = 20.0;
const DEFAULT_TOOLBAR_SIZE      : single = 16.0;
const SHOW_BUTTON_DEFAULT_WIDTH : Single = 95;

See also

Edit All Pages