Skip to content
Snippets Groups Projects
Commit db3e9f1b authored by Stekelenburg, A.V. (Alexander, Student )'s avatar Stekelenburg, A.V. (Alexander, Student )
Browse files

User manual grammarly update

parent 03a4ba2f
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
docs/user_manual.md.html
+ 14
− 14
View file @ db3e9f1b
......@@ -31,12 +31,12 @@ Installation
============
Before installing the Modest Toolset VSCode extension make sure you have downloaded the Modest Toolset and extracted it somewhere.
Start by installing the Modest Toolset VSCode extension from the VSCode marketplace or by adding the provided vsix file to your workspace, right clicking it and clicking `Install Extension VSIX`.
Start by installing the Modest Toolset VSCode extension from the VSCode marketplace or by adding the provided vsix file to your workspace, right-clicking it and clicking `Install Extension VSIX`.
After the extension has been installed open a modest file or the extension's sidebar. You will get an error message with a button that will take you to the settings. There you should enter the location where you installed the Modest Toolset. Make sure to provide the path to the executable itself, called `modest.exe` on Windows and `modest` on Linux and macOS.
!!! WARNING
On macOS you may need to allow the Modest Toolset executable to run in the settings if you are not using a notarised version
On macOS, you may need to allow the Modest Toolset executable to run in the settings if you are not using a notarized version
## Optional: Enabling the DOT viewer (Graphviz)
To be able to use the DOT viewer you need to [install Graphviz](https://graphviz.org/download/). If Graphviz was added to your `Path` environment variable it should be possible for the extension to find it. If that is not the case edit the `Externals.defaults` file in the Modest Toolset installation location and set the `dot-path` option to the proper Graphviz directory.
......@@ -58,12 +58,12 @@ Features
- Document symbol highlighting
- Graphical user interface to run tools on files (see section [Running tools])
- Automatically extract all possible parameters of every tool and populate the sidebar with corresponding input boxes to set these parameters (see section [Parameters])
- Display a DOT file generated by Modest for the current file, updated in real time (see section [DOT view])
- Display a DOT file generated by Modest for the current file, updated in real-time (see section [DOT view])
- Process output to allow it to be interactively shown (see section [Analysis Results])
Usage
=====
This section provides an explanation of how to use some of the more complicated features of the Modest extension. For an explanation of the more common language features that are implemented by the extension refer to the [Visual Studio Code documentation](https://code.visualstudio.com/docs).
This section explains how to use some of the more complicated features of the Modest extension. For an explanation of the more common language features that are implemented by the extension refer to the [Visual Studio Code documentation](https://code.visualstudio.com/docs).
## Running tools
The sidebar, found by clicking the Modest Toolset logo in the bar on the left, is used to run tools from the Modest Toolset on your files. Figure [sidebar] shows the sidebar in action.
......@@ -71,13 +71,13 @@ The sidebar, found by clicking the Modest Toolset logo in the bar on the left, i
![Figure [sidebar]: The sidebar.](sidebar.png style="max-width:50%")
### Tool selection
Next to the run button there is a dropdown that is automatically populated with the available tools. Selecting a tool will change the options available in the expandable sections below the dropdown.
Next to the run button, there is a dropdown that is automatically populated with the available tools. Selecting a tool will change the options available in the expandable sections below the dropdown.
### Open constants and extra parameters
Below the tool selection there is an expandable section containing the constants in your file that do not have an assigned value. The values specified here will be passed to the tool using it's experiment parameter. Below the open constants section there is a section where additional parameters like intervals for sampling expressions may be provided. The open constants and extra parameters are saved for each file separately.
Below the tool selection, there is an expandable section containing the constants in your file that do not have an assigned value. The values specified here will be passed to the tool using its experiment parameter. Below the open constants section, there is a section where additional parameters like intervals for sampling expressions may be provided. The open constants and extra parameters are saved for each file separately.
### Parameters
Below the additional parameters section the tool-specific parameters are shown. The available parameters are automatically gathered from your Modest Toolset installation. The parameters are saved for each tool separately. Categories and individual will show revert buttons when their content is not equal to the default.
Below the additional parameters section, the tool-specific parameters are shown. The available parameters are automatically gathered from your Modest Toolset installation. The parameters are saved for each tool separately. Categories and individual will show revert buttons when their content is not equal to the default.
### Run progress
When a tool run is in progress a progress bar (Figure [progress_bar]) is shown in the bottom right of the screen. It shows the current state of the tool run and also provides a cancel button. The cancel button will cancel the tool run as quick as possible. While the progress bar disappears immediately, depending on the tool it may take a while before it finishes running. To see further tool run progress updates, even after clicking cancel, check out the Modest Extension section in the output window.
......@@ -85,7 +85,7 @@ When a tool run is in progress a progress bar (Figure [progress_bar]) is shown i
![Figure [progress_bar]: An example of a tool run that is in progress.](progress_bar.png)
### Tool problems
Tool runs can generate warnings and errors, these are shown in the problems window (Figure [problems]) and as highlights in the document. Individual tool problems can be dismissed by choosing the quick fix option or selecting the appropriate option in the right click menu. There are also quick fixes for dismissing all the tool problems in the file or simply all tool problems in general. The latter can also be done using the `Clear tool problems` button in the top right of the sidebar.
Tool runs can generate warnings and errors, these are shown in the problems window (Figure [problems]) and as highlights in the document. Individual tool problems can be dismissed by choosing the quick fix option or selecting the appropriate option in the right-click menu. There are also quick fixes for dismissing all the tool problems in the file or simply all tool problems in general. The latter can also be done using the `Clear tool problems` button in the top right of the sidebar.
![Figure [problems]: The problems window in action.](problems.png)
......@@ -102,10 +102,10 @@ You can copy and/or save the generated DOT/svg by choosing the option in the con
### Navigating the DOT view
By clicking and dragging the mouse you can pan around. To zoom the view in and out you can scroll up and down.
You can also zoom by clicking either of the zoom buttons on the top right of the window. If you're lost and can't find the graph (for example by changing one of the DOT options), press the Reset Location button on the top right to reset the view to the initial position.
You can also zoom in or out by clicking either of the zoom buttons on the top right of the window. If you're lost and can't find the graph (for example by changing one of the DOT options), press the Reset Location button on the top right to reset the view to the initial position.
### DOT Options
To open the DOT options (Figure [dot_options]), press the button with the cog in the top right of the DOT view. In the DOT view you'll see a minimise button to close the options again and a reset button to revert all the changed parameters.
To open the DOT options (Figure [dot_options]), press the button with the cog in the top right of the DOT view. In the DOT view, you'll see a minimise button to close the options again and a reset button to revert all the changed parameters.
You can change some aspects of the generated DOT by changing the parameters in the DOT options. Similar to the sidebar's options, these parameters are the same as the Toolset's. These options allow you to change things like hiding the entire behaviour in a node or flattening the model.
......@@ -132,12 +132,12 @@ By right-clicking on an item in the view you can:
![Figure [analysis_results]: An example of analysis results being shown in the Analysis Results View.](analysis_results.png)
### Plot View
Some analysis results values, such as CDFs, can be plotted. These plots can be displayed in a Plot View, by right clicking on an item and selecting the option 'Plot value'. At the moment, plots can only be opened in separate views. Plots can be saved by pressing the save button in the top bar of the window on the right side.
Some analysis results values, such as CDFs, can be plotted. These plots can be displayed in a Plot View, by right-clicking on an item and selecting the option 'Plot value'. At the moment, plots can only be opened in separate views. Plots can be saved by pressing the save button in the top bar of the window on the right side.
![Figure [plot_view]: A plot of the CDF of `QueueOverflowProbMax` is created by right clicking on the item in the Analysis Results View.](plot_view.png)
![Figure [plot_view]: A plot of the CDF of `QueueOverflowProbMax` is created by right-clicking on the item in the Analysis Results View.](plot_view.png)
## Refactoring
Refactoring options are accessed by selecting modest code, right clicking, and selecting "Refactor..." in the drop down menu (keyboard shortcut: `Ctrl+Shift+R`).
Refactoring options are accessed by selecting modest code, right-clicking, and selecting "Refactor..." in the dropdown menu (keyboard shortcut: `Ctrl+Shift+R`).
### Refactoring options
- You can surround your selection with an if, while, block -statement or surround it with parenthesis.
......@@ -146,7 +146,7 @@ Refactoring options are accessed by selecting modest code, right clicking, and s
There will be no refactoring options if your selection is empty, or if your selection is entirely within a comment.
## Renaming symbols
You can rename symbols by selecting a symbol, right clicking, and selecting "Rename Symbol" in the drop down menu (keyboard shortcut: `F2`).
You can rename symbols by selecting a symbol, right-clicking, and selecting "Rename Symbol" in the dropdown menu (keyboard shortcut: `F2`).
Once you enter a new name it will change all occurrences of the symbol selected.
![Figure [rename_symbols]: The rename symbols feature in action.](rename_symbol.png)
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment