diff --git a/docs/features_runnables.md b/docs/features_runnables.md new file mode 100644 index 00000000..8d1c8b69 --- /dev/null +++ b/docs/features_runnables.md @@ -0,0 +1 @@ + diff --git a/docs/img/messages1.png b/docs/img/messages1.png new file mode 100644 index 00000000..d3f149c5 Binary files /dev/null and b/docs/img/messages1.png differ diff --git a/docs/img/messages2.png b/docs/img/messages2.png new file mode 100644 index 00000000..c9ba79cf Binary files /dev/null and b/docs/img/messages2.png differ diff --git a/docs/img/messages3.png b/docs/img/messages3.png new file mode 100644 index 00000000..43a9d8a6 Binary files /dev/null and b/docs/img/messages3.png differ diff --git a/docs/img/options_application.png b/docs/img/options_application.png new file mode 100644 index 00000000..7e073c41 Binary files /dev/null and b/docs/img/options_application.png differ diff --git a/docs/img/options_messages.png b/docs/img/options_messages.png new file mode 100644 index 00000000..d7cb2fcc Binary files /dev/null and b/docs/img/options_messages.png differ diff --git a/docs/img/options_symbol_list.png b/docs/img/options_symbol_list.png new file mode 100644 index 00000000..a4862ca9 Binary files /dev/null and b/docs/img/options_symbol_list.png differ diff --git a/docs/img/symbol_list.png b/docs/img/symbol_list.png new file mode 100644 index 00000000..8cf6e8eb Binary files /dev/null and b/docs/img/symbol_list.png differ diff --git a/docs/index.md b/docs/index.md index e2b5ecab..12f0c908 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,19 @@ ### Coedit documentation -#### Options +#### Features + +* [Runnable modules](features_runnables) + +#### Options categories * [Code metrics](options_code_metrics) -* [Compiler paths](options_compilers_paths.html) \ No newline at end of file +* [Compiler paths](options_compilers_paths) +* [Messages](widgets_messages) +* [Symbol list](widgets_symbol_list) + +#### Widgets + +* [Messages](widgets_messages) +* [Options editor](widgets_options_editor) +* [Search](widgets_search) +* [Symbol list](widgets_symbol_list) \ No newline at end of file diff --git a/docs/widgets_messages b/docs/widgets_messages new file mode 100644 index 00000000..7d0103c7 --- /dev/null +++ b/docs/widgets_messages @@ -0,0 +1,33 @@ +## Messages + +The widget displays a stream of information about the current file or about the current project. +The messages can be filtered according to their context: + +- __All__: no filter. +- __Editor__: filter the messages related to the editor that has the focus (compilation, standard output of the module when executed as a [_runnable_](features_runnables)). +- __Project__: filter the messages related to the current project (DMD or DUB messages, pre/post compilation process output, project execution). +- __Application__: filter the messages emitted by CE (applications warnings, application exceptions). +- __Misc__: miscellaneous messages (messages emitted by the widgets, by the custom tools when their output is redirected, [find all](widgets_search) results, etc). + +![](img/messages1.png) +![](img/messages2.png) +![](img/messages3.png) + +When a message is double clicked, it is parsed in order to extract a *position* and a *file name*. +If the operation succeeds then the *file* will be opened at a *position*. +For now *DMD*, [*Dscanner*](https://www.github.com/Hackerpilot/Dscanner) and DUB messages are well parsed. +The messages emitted by the custom tools may also be clickable if they follow a the format: **`()`**. + +The context menu contains a few useful actions, such as *copy messages*, *save message(s) to file*. +By default only the last 500 messages are displayed, regardless of the categories. +This value and several other options can be changed in the [options editor][widgets_options]: + +![](img/options_messages.png) + +- autoSelect: defines if the widget change dynamically the message categories. +This is a recommended setting because if a run-time error happens, it will be immediately displayed. +- colors: allows to associate a message kind to a particular color. +- fast display: if set, the new messages are displayed fast but by block. When not set the same amount of message takes longer to be displayed but the operation is smoother. +- font: options for the font used in this widget: the size, the family, etc. +- maxMessageCount: allows to limit the maximum number of messages kept in the list. +- singleMessageClick: allows to open the file that the message parser has found by a single click. \ No newline at end of file diff --git a/docs/widgets_options_editor.md b/docs/widgets_options_editor.md new file mode 100644 index 00000000..4ac7d653 --- /dev/null +++ b/docs/widgets_options_editor.md @@ -0,0 +1,17 @@ +### Options editor + +The _Options editor_ is a special, non-dockable, widget that allows the other widgets to expose their options. +The list at the left displays the categories. A category often matches to a single widget but not only (for example the shortcuts). + +![](img/options_application.png) + +The options are applied in real time but are reversible until the green checker icon is clicked. + +- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/other/accept.png): validates the modifications made to the current category, after what they can't be canceled anymore. +- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/other/cancel.png): cancels and restores the previous state of the current category. + +The options are persistent and saved in a distinct folder: +- Linux: **`/home//.config/Coedit/`**. +- Windows: **`?:\Users\\AppData\Roaming\Coedit\`**. + +Each widget and software component save their own files with a self-explanatory name so it's easy to find and modify the file that matches a particular setting. \ No newline at end of file diff --git a/docs/widgets_search.md b/docs/widgets_search.md new file mode 100644 index 00000000..8d1c8b69 --- /dev/null +++ b/docs/widgets_search.md @@ -0,0 +1 @@ + diff --git a/docs/widgets_symbol_list.md b/docs/widgets_symbol_list.md new file mode 100644 index 00000000..5508caff --- /dev/null +++ b/docs/widgets_symbol_list.md @@ -0,0 +1,12 @@ +## Symbol list + +This list displays the symbols declared in the D module that has the focus (imports, classes, variables, etc). +The widget is a GUI front-end for one the [_dastworx_][https://github.com/BBasile/Coedit/tree/master/dastworx] feature. + +It can be used to quickly find and go to the declaration of a symbol but also as a basic linter since the syntactic errors are displayed (almost immediately if the option _refresh on change_ is checked). + +![](img/symbol_list.png) + +The way the widget refreshes the list can be tweaked in the context menu or in the [options editor](widgets_options_editor). + +![](img/options_symbol_list.png) \ No newline at end of file