add anchors to doc

This commit is contained in:
Basile Burg 2017-06-10 09:26:08 +02:00
parent c4bb6f62c2
commit 0114b947b3
No known key found for this signature in database
GPG Key ID: 1868039F415CB8CF
34 changed files with 354 additions and 25 deletions

View File

@ -1 +1,3 @@
theme: jekyll-theme-slate theme: jekyll-theme-slate
kramdown:
auto_ids: true

View File

@ -2,6 +2,10 @@
title: Build Coedit title: Build Coedit
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
### Build ### Build
#### Coedit #### Coedit
@ -44,3 +48,9 @@ You can also build it in CE using the project file _dastworx.ce_.
Additionally you'll have to build [the completion daemon **DCD**](https://github.com/BBasile/DCD#setup) and the [D linter **Dscanner**](https://github.com/Hackerpilot/Dscanner#building-and-installing). Additionally you'll have to build [the completion daemon **DCD**](https://github.com/BBasile/DCD#setup) and the [D linter **Dscanner**](https://github.com/Hackerpilot/Dscanner#building-and-installing).
See the products documentation for more information. See the products documentation for more information.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: D Completion Daemon title: D Completion Daemon
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
### D Completion Daemon ### D Completion Daemon
The D Completion Daemon (DCD) is used to accomplish IDE-grade features such as The D Completion Daemon (DCD) is used to accomplish IDE-grade features such as
@ -54,3 +58,9 @@ If the DCD server crashes while Coedit is running then both must be restarted.
- <kbd>F1</kbd>: Displays the phobos documentation for the symbol that has the focus. - <kbd>F1</kbd>: Displays the phobos documentation for the symbol that has the focus.
Documentation comments associated to a symbol are displayed when the cursor motion stops over a symbol. Documentation comments associated to a symbol are displayed when the cursor motion stops over a symbol.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: Projects title: Projects
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
### Projects ### Projects
Two project formats are supported. Two project formats are supported.
@ -49,3 +53,9 @@ It's possible to use the [custom tools](widgets_custom_tools) to call other buil
For example to call _make_, add a new tool with _make_ as _executable_ and sets the _workingDirectory_ to the folder that contains the makefile. For example to call _make_, add a new tool with _make_ as _executable_ and sets the _workingDirectory_ to the folder that contains the makefile.
To specify a special target, such as _release_, add _release_ in the parameters editor. To specify a special target, such as _release_, add _release_ in the parameters editor.
To get _make_ output in the messages, check _popUsesPipes_ in the tool options. To get _make_ output in the messages, check _popUsesPipes_ in the tool options.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: Runnable modules title: Runnable modules
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
### Runnable modules ### Runnable modules
#### Description #### Description
@ -81,3 +85,9 @@ Note that the action _Run file unittest_ is based on the same internal function
- **ifSaved**: The runnable file is not in the current project but it's been saved explicitly out of the temp folder that's automatically used by Coedit. - **ifSaved**: The runnable file is not in the current project but it's been saved explicitly out of the temp folder that's automatically used by Coedit.
- **ifNotSaved**: The runnable file is not part of the project and has never been saved explicitly. - **ifNotSaved**: The runnable file is not part of the project and has never been saved explicitly.
- **staticSwitches**: Defines a list of switches that are always passed to the compiler when a runnable is produced or when a module is tested. - **staticSwitches**: Defines a list of switches that are always passed to the compiler when a runnable is produced or when a module is tested.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: Symbolic strings title: Symbolic strings
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
### Symbolic strings ### Symbolic strings
The symbolic strings represent variables defined by the software. They are used by several widgets: The symbolic strings represent variables defined by the software. They are used by several widgets:
@ -55,3 +59,9 @@ The slices located before and after the symbols are passed in their original for
is expanded to: is expanded to:
`http://www.google.com/search?q="dlang.org"indexOf&btnI=Im+Feeling+Lucky` if **indexOf** is the current identifier. `http://www.google.com/search?q="dlang.org"indexOf&btnI=Im+Feeling+Lucky` if **indexOf** is the current identifier.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: index title: index
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
### Coedit documentation ### Coedit documentation
![](img/coedit_kde4_thumb.png) ![](img/coedit_kde4_thumb.png)
@ -78,3 +82,9 @@ _Description of each widget._
* [Search](widgets_search) * [Search](widgets_search)
* [Symbol list](widgets_symbol_list) * [Symbol list](widgets_symbol_list)
* [Todo list](widgets_todo_list) * [Todo list](widgets_todo_list)
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: Widgets - application options title: Widgets - application options
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
### File menu - reference ### File menu - reference
- **New empty file**: Adds a new, untyped, file to the source editor. - **New empty file**: Adds a new, untyped, file to the source editor.
@ -30,3 +34,9 @@ title: Widgets - application options
- **Verify with Dscanner**: verifies the current source with [Dscanner](https://github.com/Hackerpilot/Dscanner). Results are displayed in the [messages](widgets_messages). - **Verify with Dscanner**: verifies the current source with [Dscanner](https://github.com/Hackerpilot/Dscanner). Results are displayed in the [messages](widgets_messages).
- **View Halstead metrics**: Checks the halstead metrics in the source that has the focus and reports abnormal functions in the [messages](widgets_messages). [Description of the metric](options_code_metrics). - **View Halstead metrics**: Checks the halstead metrics in the source that has the focus and reports abnormal functions in the [messages](widgets_messages). [Description of the metric](options_code_metrics).
- **View in mini explorer**: expands the [mini explorer](widgets_mini_explorer) tree on the folder that contains the current file. - **View in mini explorer**: expands the [mini explorer](widgets_mini_explorer) tree on the folder that contains the current file.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: Widgets - application options title: Widgets - application options
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
#### Application #### Application
{% include xstyle.css %} {% include xstyle.css %}
@ -25,3 +29,9 @@ The page exposes unsorted options. In the future some of them might be moved to
- **reloadLastDocuments**: Sets if the sources, the project, and the group that were opened on exit are reloaded automatically. - **reloadLastDocuments**: Sets if the sources, the project, and the group that were opened on exit are reloaded automatically.
- **showBuildDuration**: Sets if the duration of a project build is measured. - **showBuildDuration**: Sets if the duration of a project build is measured.
- **splitterScrollSpeed**: Sets how fast the splitters are moved when the scroll wheel is used. - **splitterScrollSpeed**: Sets how fast the splitters are moved when the scroll wheel is used.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: Options - code metrics title: Options - code metrics
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
### Code metrics ### Code metrics
The quality of the D code is verifiable using code metrics. The quality of the D code is verifiable using code metrics.
@ -58,3 +62,9 @@ Default values can be modified in the option editor:
![](img/code_metrics.png) ![](img/code_metrics.png)
The maximal volume of a module is not verified, simply because it's possible to have huge modules with many small functions of high quality. The maximal volume of a module is not verified, simply because it's possible to have huge modules with many small functions of high quality.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: Options - compiler paths title: Options - compiler paths
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
### Compilers paths ### Compilers paths
The _Compilers paths_ category is used to define the paths to the compilers and to their respective versions of the standard library. The _Compilers paths_ category is used to define the paths to the compilers and to their respective versions of the standard library.
@ -26,3 +30,9 @@ In other options categories one of these compilers can be selected.
* Category _Application_, _nativeProjectCompiler_: defines the compiler used to compile a project that has the native format. * Category _Application_, _nativeProjectCompiler_: defines the compiler used to compile a project that has the native format.
* Category [_Runnable modules_](features_runnables), _compiler_: defines the compiler used to compile a _runnable module_ or a DUB script. * Category [_Runnable modules_](features_runnables), _compiler_: defines the compiler used to compile a _runnable module_ or a DUB script.
* Category [_DUB build_](options_dub_build), _compiler_: defines the compiler used to compile a project that has the DUB format. * Category [_DUB build_](options_dub_build), _compiler_: defines the compiler used to compile a project that has the DUB format.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: Options - DUB build title: Options - DUB build
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
#### DUB build #### DUB build
This category exposes the DUB options that are passed to the build tool each time it's used. This category exposes the DUB options that are passed to the build tool each time it's used.
@ -17,3 +21,9 @@ This category exposes the DUB options that are passed to the build tool each tim
- **parallel**: If checked, tries to build using several CPU. - **parallel**: If checked, tries to build using several CPU.
See also [the official DUB command line reference](http://code.dlang.org/docs/commandline) for more detailed descriptions. See also [the official DUB command line reference](http://code.dlang.org/docs/commandline) for more detailed descriptions.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: Options - DUB build title: Options - DUB build
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
#### Editor pages #### Editor pages
This category exposes the options of the page control that hosts the code editors. This category exposes the options of the page control that hosts the code editors.
@ -18,3 +22,9 @@ This category exposes the options of the page control that hosts the code editor
- **poFlatButtons**: Sets the tool bar buttons look. Normally controlled by the [application option **flatLook**](options_application). - **poFlatButtons**: Sets the tool bar buttons look. Normally controlled by the [application option **flatLook**](options_application).
- **poBottomHeader**: Sets if the toolbar is displayed at the bottom. - **poBottomHeader**: Sets if the toolbar is displayed at the bottom.
- **previousPage**: Sets the shortcut used to select the previous page. - **previousPage**: Sets the shortcut used to select the previous page.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: Options - shortcuts title: Options - shortcuts
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %} {% include xstyle.css %}
### Shortcuts editor ### Shortcuts editor
@ -18,3 +22,9 @@ Each item is editable.
![](img/options_shortcuts_edit.png) ![](img/options_shortcuts_edit.png)
After an assignation attempt and if the selected combination is already used the new shortcut is not validated and a warning is displayed. After an assignation attempt and if the selected combination is already used the new shortcut is not validated and a warning is displayed.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: Setup Coedit title: Setup Coedit
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
There are four ways to get the program: There are four ways to get the program:
* download and run the setup program build for each release. * download and run the setup program build for each release.
@ -59,3 +63,9 @@ Only the _x86-64_ _rpm_ is available (Fedora, openSuse, ...). After the installa
- verify the [compilers paths](options_compilers_paths). - verify the [compilers paths](options_compilers_paths).
- check the information [about the tools](widgets_about). - check the information [about the tools](widgets_about).
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: Usage in video title: Usage in video
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
### Debug a runnable ### Debug a runnable
This video shows how a [runnable module](features_runnables) can be debugged in the [GDB commander](widgets_gdb_commander) widget. This video shows how a [runnable module](features_runnables) can be debugged in the [GDB commander](widgets_gdb_commander) widget.
@ -29,3 +33,9 @@ Here the choice is applied to the compiler used to make a runnable but the same
{% raw %} {% raw %}
<div class="tumblr-post" data-href="https://embed.tumblr.com/embed/post/RfMjxAacl04tQydtQ8GmYA/161552390630" data-did="da39a3ee5e6b4b0d3255bfef95601890afd80709"><a href="https://abstractop.tumblr.com/post/161552390630">https://abstractop.tumblr.com/post/161552390630</a></div> <script async src="https://assets.tumblr.com/post.js"></script> <div class="tumblr-post" data-href="https://embed.tumblr.com/embed/post/RfMjxAacl04tQydtQ8GmYA/161552390630" data-did="da39a3ee5e6b4b0d3255bfef95601890afd80709"><a href="https://abstractop.tumblr.com/post/161552390630">https://abstractop.tumblr.com/post/161552390630</a></div> <script async src="https://assets.tumblr.com/post.js"></script>
{% endraw %} {% endraw %}
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: About box title: About box
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %} {% include xstyle.css %}
The _about box_ displays the software version and the information about the tools used in background. The _about box_ displays the software version and the information about the tools used in background.
@ -13,3 +17,9 @@ The status of each tool is indicated:
- <img src="{%include icurl%}bullet/bullet_green.png" class="tlbric"/>: The tool is well detected. - <img src="{%include icurl%}bullet/bullet_green.png" class="tlbric"/>: The tool is well detected.
- <img src="{%include icurl%}bullet/bullet_yellow.png" class="tlbric"/>: The tool cannot be found but it's not necessary. Expect some features not to work properly even if the software is still usable. - <img src="{%include icurl%}bullet/bullet_yellow.png" class="tlbric"/>: The tool cannot be found but it's not necessary. Expect some features not to work properly even if the software is still usable.
- <img src="{%include icurl%}bullet/bullet_red.png" class="tlbric"/>: The tool cannot be found but it's necessary. The software is not usable. This happens when the tool cannot be located using the PATH variable. - <img src="{%include icurl%}bullet/bullet_red.png" class="tlbric"/>: The tool cannot be found but it's necessary. The software is not usable. This happens when the tool cannot be located using the PATH variable.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -1,7 +1,9 @@
--- ---
title: Widgets - CE project editor title: Widgets - CE project editor
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %} {% include xstyle.css %}
### Coedit project editor ### Coedit project editor
@ -161,3 +163,9 @@ Unfiltered options, sub categories can be expanded or collapsed.
- **name**: The current configurations name. - **name**: The current configurations name.
- **isBaseConfiguration**: When checked, the current configuration defines the default options of a configuration which is set as overridden. - **isBaseConfiguration**: When checked, the current configuration defines the default options of a configuration which is set as overridden.
- **isOverriddenConfiguration**: When checked, the options of the current configuration are only handled if they don't match to the base configuration or if the base configuration is not set. This system avoids to edit using the synchro-mode. - **isOverriddenConfiguration**: When checked, the options of the current configuration are only handled if they don't match to the base configuration or if the base configuration is not set. This system avoids to edit using the synchro-mode.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: Widgets - custom tools title: Widgets - custom tools
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %} {% include xstyle.css %}
### Custom tools ### Custom tools
@ -45,3 +49,9 @@ A tool can be selected from the left side of the widget. If selected, a property
- **showWindow**: Defines how the tool window is displayed. Set to **swoHIDE** if the tool standard output is redirected. - **showWindow**: Defines how the tool window is displayed. Set to **swoHIDE** if the tool standard output is redirected.
- **toolAlias**: The friendly name associated to the tool. - **toolAlias**: The friendly name associated to the tool.
- **workingDirectory**: The directory in which the tool starts. Not to mismatch with its path. The field can contain [symbolic strings](features_symbolic_strings). - **workingDirectory**: The directory in which the tool starts. Not to mismatch with its path. The field can contain [symbolic strings](features_symbolic_strings).
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: Widgets - DFMT commander title: Widgets - DFMT commander
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %} {% include xstyle.css %}
### DFMT commander ### DFMT commander
@ -19,3 +23,9 @@ See the [official documentation](https://github.com/Hackerpilot/dfmt#configurati
The formatting is applied in memory and can be undone either from the widget or from the code editor. The formatting is applied in memory and can be undone either from the widget or from the code editor.
The changes are not physically applied until the file is explicitly saved. The changes are not physically applied until the file is explicitly saved.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: Widgets - DUB project editor title: Widgets - DUB project editor
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %} {% include xstyle.css %}
### DUB project editor ### DUB project editor
@ -29,3 +33,9 @@ There's two ways to add a property:
When the second method is used the property type is selected automatically, which is safer. When the second method is used the property type is selected automatically, which is safer.
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.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: Widgets - GDB commander title: Widgets - GDB commander
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %} {% include xstyle.css %}
### Editor ### Editor
@ -129,3 +133,9 @@ The shortcuts are editable in the [shortcut editor](options_shortcuts_editor), u
- **plusDdoc**: Sets if instead of `*`, `+` are used in the comment produced by the command _Insert DDoc Template_. - **plusDdoc**: Sets if instead of `*`, `+` are used in the comment produced by the command _Insert DDoc Template_.
- **resetFontSize**: When checked and if the font size is modified then the font size is resets in all the documents that are opened. The option can be disabled in order to keep the current zoom ratio. - **resetFontSize**: When checked and if the font size is modified then the font size is resets in all the documents that are opened. The option can be disabled in order to keep the current zoom ratio.
- **smartDdocNewLine**: Allow the auto insertion of a leading `*` or a `+` while writing documentation comments. - **smartDdocNewLine**: Allow the auto insertion of a leading `*` or a `+` while writing documentation comments.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: Widgets - GDB commander title: Widgets - GDB commander
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %} {% include xstyle.css %}
### GDB commander ### GDB commander
@ -96,3 +100,9 @@ The text following the symbol is written to the input stream, with an implicit n
- **showOutput**: Displays the target output in [the messages](widgets_messages). May be deactivated for a GUI program. - **showOutput**: Displays the target output in [the messages](widgets_messages). May be deactivated for a GUI program.
- **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). - **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).
- **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.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: Widgets - library manager title: Widgets - library manager
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %} {% include xstyle.css %}
### Library manager ### Library manager
@ -50,3 +54,9 @@ The text field is used to select the name of the package to install.
- <img src="{%include icurl%}other/tag_purple.png" class="tlbric"/>: By the default the master version of the package is installed. When the tag button is down Coedit rather installs the package from its latest tag. - <img src="{%include icurl%}other/tag_purple.png" class="tlbric"/>: By the default the master version of the package is installed. When the tag button is down Coedit rather installs the package from its latest tag.
- <img src="{%include icurl%}other/accept.png" class="tlbric"/>: Closes the dialog and start downloading before installing. - <img src="{%include icurl%}other/accept.png" class="tlbric"/>: Closes the dialog and start downloading before installing.
- <img src="{%include icurl%}other/cancel.png" class="tlbric"/>: Cancels and does nothing. - <img src="{%include icurl%}other/cancel.png" class="tlbric"/>: Cancels and does nothing.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: Widgets - messages title: Widgets - messages
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
### Messages ### Messages
#### Description #### Description
@ -40,3 +44,9 @@ This is a recommended setting because if a run-time error happens, it will be im
- **font**: Options for the font used in this widget: the size, the family, etc. - **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. - **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.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,9 @@
title: Widgets - mini explorer title: Widgets - mini explorer
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %} {% include xstyle.css %}
### Mini explorer ### Mini explorer
@ -28,3 +31,9 @@ A few options are available in the [option editor](widgets_options_editor).
- **contextExpands**: If checked then the tree auto expands to the folder that contains the source or the project file that's been selected. - **contextExpands**: If checked then the tree auto expands to the folder that contains the source or the project file that's been selected.
- **doubleClick**: Defines what happens when a file is double clicked. - **doubleClick**: Defines what happens when a file is double clicked.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: Widgets - options editor title: Widgets - options editor
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %} {% include xstyle.css %}
### Options editor ### Options editor
@ -24,3 +28,9 @@ The options are persistent and saved in a specific folder:
**`?:\Users\<your account>\AppData\Roaming\Coedit\`**. **`?:\Users\<your account>\AppData\Roaming\Coedit\`**.
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.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: Widgets - process input title: Widgets - process input
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %} {% include xstyle.css %}
### Process input ### Process input
@ -15,3 +19,9 @@ The process input widget is used to pass input to the processes that are execute
- <img src="{%include icurl%}other/cancel.png" class="tlbric"/>: Forces the process termination. - <img src="{%include icurl%}other/cancel.png" class="tlbric"/>: Forces the process termination.
The input text can contain [symbolic strings](features_symbolic_strings). The input text can contain [symbolic strings](features_symbolic_strings).
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: Widgets - Profile viewer title: Widgets - Profile viewer
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %} {% include xstyle.css %}
### Profile viewer ### Profile viewer
@ -21,3 +25,9 @@ The list displays all the results, which can be inspected more accurately after
- <img src="{%include icurl%}folder/folder.png" class="tlbric"/>: Propose to open the _trace.log_ from a dialog. - <img src="{%include icurl%}folder/folder.png" class="tlbric"/>: Propose to open the _trace.log_ from a dialog.
- <img src="{%include icurl%}arrow/arrow_update.png" class="tlbric"/>: Reloads the current _trace.log_ or tries to load it from the current directory. - <img src="{%include icurl%}arrow/arrow_update.png" class="tlbric"/>: Reloads the current _trace.log_ or tries to load it from the current directory.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: Widgets - project groups title: Widgets - project groups
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %} {% include xstyle.css %}
### Project groups ### Project groups
@ -49,3 +53,9 @@ The field at the bottom indicates the status of the FSP.
- **Compiles projects group in parallel**: Starts compiling the group. Wait points are ignored and each item is compiled in a new process. - **Compiles projects group in parallel**: Starts compiling the group. Wait points are ignored and each item is compiled in a new process.
- **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.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: Widgets - project inspector title: Widgets - project inspector
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %} {% include xstyle.css %}
### Project inspector ### Project inspector
@ -22,3 +26,9 @@ The toolbar buttons are only activated for CE projects.
- <img src="{%include icurl%}folder/folder_delete.png" class="tlbric"/> Removes from the project the sources files that stand in the same directory as the source selected in the tree. - <img src="{%include icurl%}folder/folder_delete.png" class="tlbric"/> Removes from the project the sources files that stand in the same directory as the source selected in the tree.
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.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: Widgets - search and replace title: Widgets - search and replace
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
The _find and replace_ widget allows to find and replace text patterns in the focused source editor. The _find and replace_ widget allows to find and replace text patterns in the focused source editor.
![](img/search.png) ![](img/search.png)
@ -26,3 +30,9 @@ Notes:
- To find the declaration of a symbol, <kbd>Ctrl</kbd> + <kbd>MB Left</kbd> or the [symbol list](widgets_symbol_list) are faster. - To find the declaration of a symbol, <kbd>Ctrl</kbd> + <kbd>MB Left</kbd> or the [symbol list](widgets_symbol_list) 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.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: Widgets - symbol list title: Widgets - symbol list
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
## Symbol list ## Symbol list
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).
@ -24,3 +28,9 @@ The way the widget refreshes the list can be tweaked in the context menu or in t
- **smartExpander**: If checked then the the tree follows the caret position. - **smartExpander**: If checked then the the tree follows the caret position.
- **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.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

View File

@ -2,6 +2,10 @@
title: Widgets - Todo list title: Widgets - Todo list
--- ---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %} {% include xstyle.css %}
### Todo list ### Todo list
@ -48,3 +52,9 @@ are valid _todos_.
- **autoRefresh**: Automatically refreshes the list when a document or a project is activated and following the rules described upper. - **autoRefresh**: Automatically refreshes the list when a document or a project is activated and following the rules described upper.
- **columns**: Selects which columns are visible. Despite of the settings a column is only displayed when at least one item uses the matching field. - **columns**: Selects which columns are visible. Despite of the settings a column is only displayed when at least one item uses the matching field.
- **singleClickSelect**: Defines how the mouse is used to go to the item declaration. - **singleClickSelect**: Defines how the mouse is used to go to the item declaration.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}