update docs

This commit is contained in:
Basile Burg 2020-03-04 21:20:56 +01:00
parent 54836a0667
commit 16fe29b778
28 changed files with 49 additions and 78 deletions

View File

@ -1,6 +1,6 @@
Dexed, the _D Extended EDitor_, is an IDE for the [D programming language](https://dlang.org), its compilers, tools and libraries. Dexed, the _D Extended EDitor_, is an IDE for the [D programming language](https://dlang.org), its compilers, tools and libraries.
[![](https://basile.b.gitlab.io/dexed/img/coedit_kde4_thumb.png)](https://basile.b.gitlab.io/dexed/img/coedit_kde4.png) ![](https://basile.b.gitlab.io/dexed/img/coedit_kde4_thumb.png)
## Overview ## Overview
@ -28,7 +28,7 @@ Dexed, the _D Extended EDitor_, is an IDE for the [D programming language](https
- :scroll: licensed under the terms of the Boost software license. - :scroll: licensed under the terms of the Boost software license.
- :dollar: Development can be supported with [Paypal donations](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=AQDJVC39PJF7J). - :dollar: Development can be supported with [Paypal donations](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=AQDJVC39PJF7J).
## Download version 3.7.10 ## Download version 3.7.11
***coming soon...*** ***coming soon...***

View File

@ -1,11 +1,11 @@
--- ---
title: index title: Dexed Manual
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script> header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
--- ---
![](img/coedit_kde4_thumb.png) ![](img/coedit_kde4_thumb.png)
This documentation is based on version 3.7.5. This documentation is based on Dexed version 3.7.10.
Screenshots can be outdated but descriptions are up to date. Screenshots can be outdated but descriptions are up to date.
## First steps ## First steps
@ -49,7 +49,6 @@ _Full description of Dexed options. May redirect to a specific widget page._
* [Profile viewer](widgets_profile_viewer.html) * [Profile viewer](widgets_profile_viewer.html)
* [Runnable modules](features_runnables.html) * [Runnable modules](features_runnables.html)
* [Shortcuts editor](options_shortcuts_editor.html) * [Shortcuts editor](options_shortcuts_editor.html)
* [Static macros](widgets_editor.html)
* [Symbol list](widgets_symbol_list.html) * [Symbol list](widgets_symbol_list.html)
* [Terminal](widgets_terminal.html) * [Terminal](widgets_terminal.html)
* [Todo list](widgets_todo_list.html) * [Todo list](widgets_todo_list.html)

View File

@ -1,5 +1,5 @@
--- ---
title: File menu title: File Menu
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script> header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Widgets - application options title: Widgets - Common Application Options
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script> header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Options - code metrics title: Options - Code Metrics
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script> header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Options - compiler paths title: Options - Compiler Paths
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script> header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Options - DUB build title: Options - DUB Build
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script> header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Options - Editor pages title: Options - Editor Pages
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script> header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Options - shortcuts title: Options - Shortcuts
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script> header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Setup dexed title: Setup
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script> header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
--- ---
@ -19,9 +19,9 @@ For each platform Dexed can be setup using a setup program or by extracting the
## Linux dependencies ## Linux dependencies
The software is based on the GTK2 toolkit. The official build of the software is based on the GTK2 toolkit.
The runtime libraries must be setup (libgtk2, libglib, libgdk-pixbuf2, etc; they usually comes together, libc). The runtime libraries must be setup (libgtk2, libglib, libgdk-pixbuf2, etc; they usually comes together, libc).
You must also setup some theme engines (such as Adwaita, Clearlooks, Nimbus, Industrial, etc). To enhance the appearence, you can also setup some theme engines (such as Adwaita, Clearlooks, Nimbus, Industrial, etc).
Windows interface is based on native win32 controls. Windows interface is based on native win32 controls.

View File

@ -1,5 +1,5 @@
--- ---
title: About box title: Widgets - About Box
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script> header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Widgets - custom tools title: Widgets - Custom Tools
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script> header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
--- ---

View File

@ -1,15 +1,13 @@
--- ---
title: Widgets - DEXED project editor title: Widgets - DEXED Project Editor
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script> header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
--- ---
The widget is used to edit the properties of a project that has the DEXED format (_*.dprj_ extension)
The widget is used to edit the properties of a project that has the DEXED format (*.dprj extension)
It's no recommended to use this format anymore. It's no recommended to use this format anymore.
![](img/ce_project_editor.png) ![](img/ce_project_editor.png)
The format is modeled based on the DMD command line interface but it can be compiled with LDC or GDC too, The format is modeled based on the DMD command line interface but it can be compiled with LDC or GDC too,
using the bridges that convert DMD options to LDC (LDMD) or to GDC (GDMD), which is done automatically when they are [set to compile CE the projects](options_application.html). using the bridges that convert DMD options to LDC (LDMD) or to GDC (GDMD), which is done automatically when they are [set to compile CE the projects](options_application.html).
@ -150,7 +148,7 @@ This is possible when the post compilation process _executable_ is set to the [s
They define the options applied when running the project output (e.g: menu **"project"**, **"compile and run"**). They define the options applied when running the project output (e.g: menu **"project"**, **"compile and run"**).
The _executable_ field is not present because it relies on the project parameters (**-of** for a CE project and the combination of _targetPath_ with _targetName_ for a DUB project). The _executable_ field is not present because it relies on the project parameters (**-of** for a CE project and the combination of _targetPath_ with _targetName_ for a DUB project).
If the output is piped then the [process input widget][lnk_widg_procinp] can be used to pass the input to the program being executed. If the output is piped then the [process input widget](widgets_process_input.html) can be used to pass the input to the program being executed.
These options are defined per-configuration. These options are defined per-configuration.
These options are not compatible with the system of _base_ & _overridden_ configuration. These options are not compatible with the system of _base_ & _overridden_ configuration.

View File

@ -1,5 +1,5 @@
--- ---
title: Widgets - DFMT commander title: Widgets - DFMT Commander
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script> header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Widgets - DUB project editor title: Widgets - DUB Project Editor
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script> header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
--- ---
@ -27,6 +27,4 @@ When the second method is used the property type is selected automatically, whic
The property name is not always required. For example when when an array item is added the content of the field is ignored. The property name is not always required. For example when when an array item is added the content of the field is ignored.
After adding a property, its value still needs to be set at the bottom of the tree. After adding a property, its value still needs to be set at the bottom of the tree.
<script> <script>anchors.add();</script>
anchors.add();
</script>

View File

@ -1,5 +1,5 @@
--- ---
title: Widgets - GDB commander title: Widgets - GDB Commander
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script> header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
--- ---
@ -98,6 +98,4 @@ The text following the symbol is written to the input stream, with an implicit n
- **showRawMiOutput**: For the custom commands or for debugging the widget. When checked the GDB output (after JSON-ization) is displayed in [the messages](widgets_messages.html). - **showRawMiOutput**: For the custom commands or for debugging the widget. When checked the GDB output (after JSON-ization) is displayed in [the messages](widgets_messages.html).
- **stopAllThreadsOnBreak**: Sets if all the threads of the target are stopped when the execution breaks. Not applied until next debugging cession. - **stopAllThreadsOnBreak**: Sets if all the threads of the target are stopped when the execution breaks. Not applied until next debugging cession.
<script> <script>anchors.add();</script>
anchors.add();
</script>

View File

@ -1,5 +1,5 @@
--- ---
title: Widgets - library manager title: Widgets - Library Manager
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script> header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
--- ---
@ -46,6 +46,4 @@ The text field is used to select the name of the package to install.
- ![](icons/other/accept.png): Closes the dialog and start downloading before installing. - ![](icons/other/accept.png): Closes the dialog and start downloading before installing.
- ![](icons/other/cancel.png): Cancels and does nothing. - ![](icons/other/cancel.png): Cancels and does nothing.
<script> <script>anchors.add();</script>
anchors.add();
</script>

View File

@ -1,5 +1,5 @@
--- ---
title: Widgets - messages title: Widgets - Messages
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script> header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
--- ---
## Description ## Description
@ -19,7 +19,7 @@ The messages can be filtered according to their context:
When a message is double clicked, it is parsed in order to extract a *position* and a *file name*. 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*. 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. For now *DMD*, [*Dscanner*](https://www.github.com/dlang-community/D-Scanner) and DUB messages are well parsed.
The messages emitted by the custom tools may also be clickable if they follow a the format: **`<relative|absolute filename>(<line[:column]>)<message body>`**. The messages emitted by the custom tools may also be clickable if they follow a the format: **`<relative|absolute filename>(<line[:column]>)<message body>`**.
The context menu contains a few useful actions, such as *copy messages*, *save message(s) to file*. The context menu contains a few useful actions, such as *copy messages*, *save message(s) to file*.
@ -40,6 +40,4 @@ This is a recommended setting because if a run-time error happens, it will be im
- **maxMessageCount**: Allows to limit the maximum number of messages kept in the list. - **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. - **singleMessageClick**: Allows to open the file that the message parser has found by a single click.
<script> <script>anchors.add();</script>
anchors.add();
</script>

View File

@ -1,5 +1,5 @@
--- ---
title: Widgets - mini explorer title: Widgets - Mini Explorer
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script> header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
--- ---
@ -29,6 +29,4 @@ A few options are available in the [option editor](widgets_options_editor.html).
- **doubleClick**: Defines what happens when a file is double clicked. - **doubleClick**: Defines what happens when a file is double clicked.
- **showHidden**: Sets if hidden folders and files are displayed. - **showHidden**: Sets if hidden folders and files are displayed.
<script> <script>anchors.add();</script>
anchors.add();
</script>

View File

@ -1,5 +1,5 @@
--- ---
title: Widgets - options editor title: Widgets - Options Editor
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script> header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
--- ---
@ -22,6 +22,4 @@ The options are persistent and saved in a specific folder:
Each software component saves its own file with a self-explanatory name so it's easy to find and modify the file that matches a particular setting. Each software component saves its own file with a self-explanatory name so it's easy to find and modify the file that matches a particular setting.
<script> <script>anchors.add();</script>
anchors.add();
</script>

View File

@ -1,9 +1,9 @@
--- ---
title: Widgets - process input title: Widgets - Process Input
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script> header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
--- ---
The process input widget is used to pass input to the processes that are executed within Coedit. The process input widget is used to pass input to the processes that are executed within Dexed.
![](img/process_input.png) ![](img/process_input.png)
@ -13,6 +13,4 @@ The process input widget is used to pass input to the processes that are execute
The input text can contain [symbolic strings](features_symbolic_strings.html). The input text can contain [symbolic strings](features_symbolic_strings.html).
<script> <script>anchors.add();</script>
anchors.add();
</script>

View File

@ -1,5 +1,5 @@
--- ---
title: Widgets - Profile viewer title: Widgets - Profile Viewer
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script> header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
--- ---
@ -28,6 +28,4 @@ The list displays all the results, which can be inspected more accurately after
- **hideStandardLibraryCalls**: When checked, all the functions starting with `std.` are excluded. - **hideStandardLibraryCalls**: When checked, all the functions starting with `std.` are excluded.
- **otherExclusion**: Allows to define other sub-strings masks. - **otherExclusion**: Allows to define other sub-strings masks.
<script> <script>anchors.add();</script>
anchors.add();
</script>

View File

@ -1,5 +1,5 @@
--- ---
title: Widgets - project groups title: Widgets - Project Groups
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script> header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
--- ---
@ -47,6 +47,4 @@ The field at the bottom indicates the status of the FSP.
- **Compiles projects group sequentially**: Starts compiling the group. Wait points are ignored and items are compiled one by one. - **Compiles projects group sequentially**: Starts compiling the group. Wait points are ignored and items are compiled one by one.
- **Compiles projects group using wait points**: Starts compiling the group. Wait points are respected. - **Compiles projects group using wait points**: Starts compiling the group. Wait points are respected.
<script> <script>anchors.add();</script>
anchors.add();
</script>

View File

@ -1,5 +1,5 @@
--- ---
title: Widgets - project inspector title: Widgets - Project Inspector
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script> header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
--- ---
@ -7,7 +7,7 @@ The project inspector is used to
- select the project configuration. - select the project configuration.
- open sources in an new editor. - open sources in an new editor.
- add or remove source if the active project has the [CE format](features_projects.html). - add or remove source if the active project has the [Dexed format](features_projects.html).
![](img/project_inspector.png) ![](img/project_inspector.png)
@ -25,6 +25,4 @@ The following toolbar buttons are only visible for CE projects:
Note that instead of using the dialogs to add files, it's also possible to drop items from a file explorer. Note that instead of using the dialogs to add files, it's also possible to drop items from a file explorer.
<script> <script>anchors.add();</script>
anchors.add();
</script>

View File

@ -1,5 +1,5 @@
--- ---
title: Widgets - search and replace title: Widgets - Search and Replace
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script> header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
--- ---
@ -29,6 +29,4 @@ Notes:
- To find the declaration of a symbol, <kbd>Ctrl</kbd> + <kbd>MB Left</kbd> or the [symbol list](widgets_symbol_list.html) are faster. - To find the declaration of a symbol, <kbd>Ctrl</kbd> + <kbd>MB Left</kbd> or the [symbol list](widgets_symbol_list.html) are faster.
- To rename a variable or a type, local identifier renaming (<kbd>Ctrl</kbd> + <kbd>F2</kbd>) can be more accurate than _Replace all_ since the action uses the semantic. - To rename a variable or a type, local identifier renaming (<kbd>Ctrl</kbd> + <kbd>F2</kbd>) can be more accurate than _Replace all_ since the action uses the semantic.
<script> <script>anchors.add();</script>
anchors.add();
</script>

View File

@ -4,7 +4,7 @@ header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4
--- ---
This list displays the symbols declared in the D module that has the focus (imports, classes, variables, etc). 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/Basile-z/dexed/tree/master/dastworx) feature. The widget is a GUI front-end for one the [_dastworx_](https://gitlab.com/basile.b/dexed/-/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). 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).
@ -24,6 +24,4 @@ The way the widget refreshes the list can be tweaked in the context menu or in t
- **smartFilter**: Change the behavior of the list when the symbols are filtered. - **smartFilter**: Change the behavior of the list when the symbols are filtered.
- **sortSymbols**: If checked then the symbols are sorted alphabetically instead of following the declaration order. - **sortSymbols**: If checked then the symbols are sorted alphabetically instead of following the declaration order.
<script> <script>anchors.add();</script>
anchors.add();
</script>

View File

@ -32,6 +32,4 @@ Commonly used keys are:
- **scrollbackLines**: The max count of previous lines that are stored. - **scrollbackLines**: The max count of previous lines that are stored.
- **selectedColor**: The bacground when some text is selected. Selected text color is then simply inverted. - **selectedColor**: The bacground when some text is selected. Selected text color is then simply inverted.
<script> <script>anchors.add();</script>
anchors.add();
</script>

View File

@ -1,5 +1,5 @@
--- ---
title: Widgets - Todo list title: Widgets - Todo List
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script> header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
--- ---