← All docs

Model Documentation

Model Documentation

Adding text

ravel-tutorial figure

Ravel’s text tool enables you to place text anywhere on the wiring canvas. There are two ways to enter text:

  • Click on this tool, which attaches the default text string “Enter your note here” to your cursor; or
  • Type the # key anywhere on the wiring canvas. That brings up the Text Input form shown in Figure 68, which is also used for defining Variables and Parameters. When you press Enter or click OK, this text string will be attached to your cursor.
ravel-tutorial figure

Figure 68: The Text Input form opened by typing # on the canvas

Once you have clicked to place the string where you want it on the canvas, you can then edit it further to, if you wish, include paragraphs of text. There are two ways to commence the editing process:

  • Double-click on the text string; or
  • Right-click and choose “Description” from the menu

Either action will bring up the text editing window shown in Figure 69. You can type entire paragraphs of text into this window, and the text formatting capabilities that LaTeX enables for variable and parameter names in Ravel are available here as well.

ravel-tutorial figure

Figure 69: The text editing window and its result on the canvas

Two other methods to document a Ravel