Workbench Markdown Editor

The Workbench Markdown Editor provides the ability to view and edit markdown files. Markdown is a lightweight language that creates formatted text in a defined markdown text file. You can use the Workbench Markdown Editor to edit markdown text files or view a formatted version of markdown syntax.

The Markdown Editor toolbar appears when you view a markdown file.

  1. Text Editor Mode—Displays only the markdown text file.

  2. Hybrid Mode—Displays both the text and formatted Markdown views. The left half of the window is the text editor and is editable. The right half of the window is the read-only viewer mode.

  3. Viewer Mode—Displays the formatted markdown file. This mode is read-only.

  4. Auto-Refresh—This toggle option is only available in the hybrid mode. Automatically refreshes the viewer display view when the text editor window is changed.

  5. Refresh—This option is available in viewer mode and hybrid mode. Updates the viewer window with any changes made to the markdown file outside of Workbench or in hybrid mode with Auto-Refresh off.

  6. Light Mode—This option applies to viewer mode and hybrid mode. Displays the markdown file as dark text on a white background.

  7. Dark Mode—This option applies to viewer mode and hybrid mode. Displays the markdown file as white text on a dark background.

You can use markdown files to link to files within your Workbench project. DI-specific notation allows you to navigate to specific lines or nodes in Spectre, Visual Integrator, or Production files.

Syntax Description
[Link to Integ Script: Task_2](<script.int?Task=Task_2>) Creates a link to the Task named Task_2 in the Visual Integrator script script.int.
[Link to Integ Script: Task_1:T1_Calc](<script.int?Node=T1_Calc>) Creates a link to the calc object named T1_Calc in the Visual Integrator script script.int.
[Link to Production Script: Node=Integ-1](<script.prd?Node=Integ-1>) Creates a link to the Production node named Integ-1 in the Production script script.prd.
[Link to Build Script: Node=output_2](<script.build?Node=output_2>) Creates a link to the Spectre node named output_2 in the Spectre script script.build.
[Link to Build Script: Node=output_2](<script.build?Editor=Text Editor&line=7>) Creates a link to the Spectre script script.build that opens the Text Editor and puts the cursor at line 7.

NOTES:

  • Using a backtick character in the link requires a second backtick for the markdown editor to properly process it. For example: (<Hawai``i.build>)

  • Braces ({ or }) in the display text portion of a markdown link (any text within brackets) must be escaped with a back slash. For example:

    [/{Displayed Link}]

Mentioned in: