This page outlines the basic procedures for working with the Textual Editor and the textual notation.

For SysML v2 Textual Editor-related environment options, see the Environment options page.

Managing the Textual Editor

Opening the Textual Editor

To open the Textual Editor

  • In the Containment tree, right-click an element. In the shortcut menu, under Textual Editor, click Open.
  • On a view, right-click an element symbol. In the shortcut menu, under Textual Editor, click Open.
  • In the tabular view's toolbar, click the Open in Textual Editor button. 

Saving changes in the Textual Editor

To save changes in the Textual Editor

Do one of the following:

  • In the Textual Editor's toolbar, click the Synchronize button .
  • Use the Alt+S shortcut keys.

    You must synchronize the textual notation before saving your project. Otherwise, the project will be saved without the changes made via the Textual Editor.

    If the Synchronize model with errors environment option is set to:

    • true (default), an informational message is displayed informing you the notation contains errors. The notation cannot be synchronized. Fix the errors and synchronize the changes again.
    • false, the notation is synchronized as it is. This may lead to an incorrect model.

Updating changes in the Textual Editor

Making changes both in the textual notation and elsewhere in the model with the editor tab still open results in concurrent editing, which may lead to data loss. If you do make changes in the model while the Textual Editor is open, an informational message is displayed requesting you to refresh the textual notation displayed in the Textual Editor.

In this case, there are two options:

  • Click the Refresh button in the message. This updates the textual notation with the changes made elsewhere in the model, removing any changes made in the Textual Editor that were not previously saved.

  • Click the Synchronize  button in the editor toolbar. This updates the model with changes made in the textual notation, removing any changes made elsewhere in the model after making modifications in the Textual Editor.

    You can detect previously unsaved changes made in the Textual Editor that will be lost after clicking the Refresh button by looking for elements that do not have display IDs in the textual notation.

Commenting in the Textual Editor

  • There can be two types of comments:
    • A line note.
      • This type of comment is for the Textual Editor only; it does not create a comment element in your model.
      • Two ways to write it:
        • Write it using double forward slashes followed by the text you want to leave in the textual notation.
        • Place the cursor on the line you want to comment out and press Ctrl+/ on the keyboard.
    • A comment element. 
      • This type of comment creates a comment element in your model.
      • For more information, see the Annotations page.

  • By default, comments are indicated in #248000 color, differentiating them from other notational text.

    // May require revision - a comment that exists only in the Textual Editor 

    // the following two options are equivalent; both create a comment element with the 'May require revision' text:

    /* May require revision */
    comment /* May require revision */