From 16fe29b7787cc50e9214dfd144d4ce66458545e9 Mon Sep 17 00:00:00 2001 From: Basile Burg Date: Wed, 4 Mar 2020 21:20:56 +0100 Subject: [PATCH] update docs --- README.md | 4 ++-- docs/index.md | 5 ++--- docs/menu_file.md | 2 +- docs/options_application.md | 2 +- docs/options_code_metrics.md | 2 +- docs/options_compilers_paths.md | 2 +- docs/options_dub_build.md | 2 +- docs/options_editor_pages.md | 2 +- docs/options_shortcuts_editor.md | 2 +- docs/setup.md | 6 +++--- docs/widgets_about.md | 2 +- docs/widgets_custom_tools.md | 2 +- docs/widgets_dexed_project_editor.md | 8 +++----- docs/widgets_dfmt_commander.md | 2 +- docs/widgets_dub_project_editor.md | 6 ++---- docs/widgets_gdb_commander.md | 6 ++---- docs/widgets_library_manager.md | 6 ++---- docs/widgets_messages.md | 8 +++----- docs/widgets_mini_explorer.md | 6 ++---- docs/widgets_options_editor.md | 6 ++---- docs/widgets_process_input.md | 8 +++----- docs/widgets_profile_viewer.md | 6 ++---- docs/widgets_project_groups.md | 6 ++---- docs/widgets_project_inspector.md | 8 +++----- docs/widgets_search.md | 6 ++---- docs/widgets_symbol_list.md | 6 ++---- docs/widgets_terminal.md | 4 +--- docs/widgets_todo_list.md | 2 +- 28 files changed, 49 insertions(+), 78 deletions(-) diff --git a/README.md b/README.md index f05ed563..4a0798aa 100644 --- a/README.md +++ b/README.md @@ -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. -[![](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 @@ -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. - :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...*** diff --git a/docs/index.md b/docs/index.md index 67c91c35..c8111615 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,11 +1,11 @@ --- -title: index +title: Dexed Manual header-includes: --- ![](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. ## First steps @@ -49,7 +49,6 @@ _Full description of Dexed options. May redirect to a specific widget page._ * [Profile viewer](widgets_profile_viewer.html) * [Runnable modules](features_runnables.html) * [Shortcuts editor](options_shortcuts_editor.html) -* [Static macros](widgets_editor.html) * [Symbol list](widgets_symbol_list.html) * [Terminal](widgets_terminal.html) * [Todo list](widgets_todo_list.html) diff --git a/docs/menu_file.md b/docs/menu_file.md index 090a9096..ed82e2ae 100644 --- a/docs/menu_file.md +++ b/docs/menu_file.md @@ -1,5 +1,5 @@ --- -title: File menu +title: File Menu header-includes: --- diff --git a/docs/options_application.md b/docs/options_application.md index 04dcc9fb..e1d5b6ec 100644 --- a/docs/options_application.md +++ b/docs/options_application.md @@ -1,5 +1,5 @@ --- -title: Widgets - application options +title: Widgets - Common Application Options header-includes: --- diff --git a/docs/options_code_metrics.md b/docs/options_code_metrics.md index e52de466..c89fa0f5 100644 --- a/docs/options_code_metrics.md +++ b/docs/options_code_metrics.md @@ -1,5 +1,5 @@ --- -title: Options - code metrics +title: Options - Code Metrics header-includes: --- diff --git a/docs/options_compilers_paths.md b/docs/options_compilers_paths.md index 2ef30e9f..492107f9 100644 --- a/docs/options_compilers_paths.md +++ b/docs/options_compilers_paths.md @@ -1,5 +1,5 @@ --- -title: Options - compiler paths +title: Options - Compiler Paths header-includes: --- diff --git a/docs/options_dub_build.md b/docs/options_dub_build.md index 5678b469..1eaef1d5 100644 --- a/docs/options_dub_build.md +++ b/docs/options_dub_build.md @@ -1,5 +1,5 @@ --- -title: Options - DUB build +title: Options - DUB Build header-includes: --- diff --git a/docs/options_editor_pages.md b/docs/options_editor_pages.md index 384be02c..06860da6 100644 --- a/docs/options_editor_pages.md +++ b/docs/options_editor_pages.md @@ -1,5 +1,5 @@ --- -title: Options - Editor pages +title: Options - Editor Pages header-includes: --- diff --git a/docs/options_shortcuts_editor.md b/docs/options_shortcuts_editor.md index a04e3273..a72a9602 100644 --- a/docs/options_shortcuts_editor.md +++ b/docs/options_shortcuts_editor.md @@ -1,5 +1,5 @@ --- -title: Options - shortcuts +title: Options - Shortcuts header-includes: --- diff --git a/docs/setup.md b/docs/setup.md index a93a01bb..9c3108f2 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -1,5 +1,5 @@ --- -title: Setup dexed +title: Setup header-includes: --- @@ -19,9 +19,9 @@ For each platform Dexed can be setup using a setup program or by extracting the ## 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). -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. diff --git a/docs/widgets_about.md b/docs/widgets_about.md index 3e7cf8bc..1e4a37b4 100644 --- a/docs/widgets_about.md +++ b/docs/widgets_about.md @@ -1,5 +1,5 @@ --- -title: About box +title: Widgets - About Box header-includes: --- diff --git a/docs/widgets_custom_tools.md b/docs/widgets_custom_tools.md index 9c5c49a8..7434e8f3 100644 --- a/docs/widgets_custom_tools.md +++ b/docs/widgets_custom_tools.md @@ -1,5 +1,5 @@ --- -title: Widgets - custom tools +title: Widgets - Custom Tools header-includes: --- diff --git a/docs/widgets_dexed_project_editor.md b/docs/widgets_dexed_project_editor.md index 6c9bbdf8..bac46aa8 100644 --- a/docs/widgets_dexed_project_editor.md +++ b/docs/widgets_dexed_project_editor.md @@ -1,15 +1,13 @@ --- -title: Widgets - DEXED project editor +title: Widgets - DEXED Project Editor header-includes: --- - -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. ![](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, 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"**). 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 not compatible with the system of _base_ & _overridden_ configuration. diff --git a/docs/widgets_dfmt_commander.md b/docs/widgets_dfmt_commander.md index 79058882..b3db4921 100644 --- a/docs/widgets_dfmt_commander.md +++ b/docs/widgets_dfmt_commander.md @@ -1,5 +1,5 @@ --- -title: Widgets - DFMT commander +title: Widgets - DFMT Commander header-includes: --- diff --git a/docs/widgets_dub_project_editor.md b/docs/widgets_dub_project_editor.md index b9be8e07..2dcd25a7 100644 --- a/docs/widgets_dub_project_editor.md +++ b/docs/widgets_dub_project_editor.md @@ -1,5 +1,5 @@ --- -title: Widgets - DUB project editor +title: Widgets - DUB Project Editor header-includes: --- @@ -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. After adding a property, its value still needs to be set at the bottom of the tree. - + diff --git a/docs/widgets_gdb_commander.md b/docs/widgets_gdb_commander.md index d9c5d479..14eafbd8 100644 --- a/docs/widgets_gdb_commander.md +++ b/docs/widgets_gdb_commander.md @@ -1,5 +1,5 @@ --- -title: Widgets - GDB commander +title: Widgets - GDB Commander header-includes: --- @@ -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). - **stopAllThreadsOnBreak**: Sets if all the threads of the target are stopped when the execution breaks. Not applied until next debugging cession. - + diff --git a/docs/widgets_library_manager.md b/docs/widgets_library_manager.md index 3c736ca3..05211ade 100644 --- a/docs/widgets_library_manager.md +++ b/docs/widgets_library_manager.md @@ -1,5 +1,5 @@ --- -title: Widgets - library manager +title: Widgets - Library Manager header-includes: --- @@ -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/cancel.png): Cancels and does nothing. - + diff --git a/docs/widgets_messages.md b/docs/widgets_messages.md index fe87ecc9..0398731b 100644 --- a/docs/widgets_messages.md +++ b/docs/widgets_messages.md @@ -1,5 +1,5 @@ --- -title: Widgets - messages +title: Widgets - Messages header-includes: --- ## 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*. 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: **`()`**. 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. - **singleMessageClick**: Allows to open the file that the message parser has found by a single click. - + diff --git a/docs/widgets_mini_explorer.md b/docs/widgets_mini_explorer.md index 07238958..b9d2cb2e 100644 --- a/docs/widgets_mini_explorer.md +++ b/docs/widgets_mini_explorer.md @@ -1,5 +1,5 @@ --- -title: Widgets - mini explorer +title: Widgets - Mini Explorer header-includes: --- @@ -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. - **showHidden**: Sets if hidden folders and files are displayed. - + diff --git a/docs/widgets_options_editor.md b/docs/widgets_options_editor.md index eaf34181..338261ce 100644 --- a/docs/widgets_options_editor.md +++ b/docs/widgets_options_editor.md @@ -1,5 +1,5 @@ --- -title: Widgets - options editor +title: Widgets - Options Editor header-includes: --- @@ -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. - + diff --git a/docs/widgets_process_input.md b/docs/widgets_process_input.md index 0e201338..cca6ebc4 100644 --- a/docs/widgets_process_input.md +++ b/docs/widgets_process_input.md @@ -1,9 +1,9 @@ --- -title: Widgets - process input +title: Widgets - Process Input header-includes: --- -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) @@ -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). - + diff --git a/docs/widgets_profile_viewer.md b/docs/widgets_profile_viewer.md index 23a3a0c5..d0d157ef 100644 --- a/docs/widgets_profile_viewer.md +++ b/docs/widgets_profile_viewer.md @@ -1,5 +1,5 @@ --- -title: Widgets - Profile viewer +title: Widgets - Profile Viewer header-includes: --- @@ -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. - **otherExclusion**: Allows to define other sub-strings masks. - + diff --git a/docs/widgets_project_groups.md b/docs/widgets_project_groups.md index 36173216..cf6529fa 100644 --- a/docs/widgets_project_groups.md +++ b/docs/widgets_project_groups.md @@ -1,5 +1,5 @@ --- -title: Widgets - project groups +title: Widgets - Project Groups header-includes: --- @@ -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 using wait points**: Starts compiling the group. Wait points are respected. - + diff --git a/docs/widgets_project_inspector.md b/docs/widgets_project_inspector.md index ac9ae9b8..cfeb0882 100644 --- a/docs/widgets_project_inspector.md +++ b/docs/widgets_project_inspector.md @@ -1,5 +1,5 @@ --- -title: Widgets - project inspector +title: Widgets - Project Inspector header-includes: --- @@ -7,7 +7,7 @@ The project inspector is used to - select the project configuration. - 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) @@ -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. - + diff --git a/docs/widgets_search.md b/docs/widgets_search.md index febd4da7..11bfaadb 100644 --- a/docs/widgets_search.md +++ b/docs/widgets_search.md @@ -1,5 +1,5 @@ --- -title: Widgets - search and replace +title: Widgets - Search and Replace header-includes: --- @@ -29,6 +29,4 @@ Notes: - To find the declaration of a symbol, Ctrl + MB Left or the [symbol list](widgets_symbol_list.html) are faster. - To rename a variable or a type, local identifier renaming (Ctrl + F2) can be more accurate than _Replace all_ since the action uses the semantic. - + diff --git a/docs/widgets_symbol_list.md b/docs/widgets_symbol_list.md index 52cf166e..851f7671 100644 --- a/docs/widgets_symbol_list.md +++ b/docs/widgets_symbol_list.md @@ -4,7 +4,7 @@ header-includes: ---