mirror of https://gitlab.com/basile.b/dexed.git
doc
This commit is contained in:
Basile Burg
parent
bd3c3c3b90
commit
e11030f087
Binary file not shown.
|
After Width: | Height: | Size: 60 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 36 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 66 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 47 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 65 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 49 KiB |
|
|
@ -39,9 +39,11 @@ _Full description of Coedit options. May redirect to a specific widget page._
|
|||
* [Compiler paths](options_compilers_paths)
|
||||
* [DUB build](options_dub_build)
|
||||
* [Messages](widgets_messages)
|
||||
* [Mini explorer](widgets_mini_explorer)
|
||||
* [Runnable modules](features_runnables)
|
||||
* [Shortcuts editor](options_shortcuts_editor)
|
||||
* [Symbol list](widgets_symbol_list)
|
||||
* [Todo list](widgets_todo_list)
|
||||
|
||||
#### Widgets
|
||||
|
||||
|
|
@ -61,3 +63,4 @@ _Description of each widget._
|
|||
* [Process input](widgets_process_input)
|
||||
* [Search](widgets_search)
|
||||
* [Symbol list](widgets_symbol_list)
|
||||
* [Todo list](widgets_todo_list)
|
||||
|
|
|
|||
|
|
@ -12,17 +12,17 @@ These settings are important and should be verified after the installation.
|
|||
|
||||
Up to five D compilers can be defined.
|
||||
|
||||
* __DMD__: should be set to the stable DMD version. The paths are normally detected when _Coedit_ is launched for hte first time.
|
||||
* __DMD__: should be set to the stable DMD version. The paths are normally detected when _Coedit_ is launched for the first time.
|
||||
* __GDC__: should be set to the stable GDC version. The _runtime_ and _Phobos_ sources stand in the same folder so the third field can be left empty.
|
||||
* __LDC__: should be set to the stable LDC version. The _runtime_ and _Phobos_ sources stand in the same folder so the third field can be left empty.
|
||||
* __User1__: can be set to any compiler, for the example the development version of DMD.
|
||||
* __User2__: a second user-defined compiler.
|
||||
|
||||
The combo box at the top is used to select which are the paths passed to the completion daemon.
|
||||
When the completion daemon is launched by _Coedit_ the change is applied directly after the validation, otherwise it has to be restarted manually.
|
||||
The combo box at the top is used to select which are the paths passed to the [completion daemon](features_dcd).
|
||||
If the completion daemon is launched by _Coedit_ then the change is applied directly after the validation, otherwise it has to be restarted manually.
|
||||
|
||||
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 _Runnable modules_, _compiler_: defines the compiler used to compile a _runnable module_ or a DUB script.
|
||||
* Category _DUB build_, _compiler_: defines the compiler used to compile a project that has the DUB format.
|
||||
* 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.
|
||||
|
|
@ -1,3 +1,27 @@
|
|||
---
|
||||
title: Widgets - DUB project editor
|
||||
---
|
||||
|
||||
### DUB project editor
|
||||
|
||||
The DUB project editor allows to edit, add and remove properties of DUB project that has the [JSON format](http://code.dlang.org/package-format?lang=json).
|
||||
DUB project with the [SDL format](http://code.dlang.org/package-format?lang=sdl) are read only.
|
||||
|
||||
|
||||
|
||||
A property value can be modified in the field at the bottom. New values always require an extra validation.
|
||||
New properties can be added or removed:
|
||||
|
||||
* : Removes the selected property. Note that the effect is not reflected until the project is saved as a file (since Coedit does not communicate directly with DUB).
|
||||
* : Shows a small dialog that allows to add a new value, a new array or a new object.
|
||||
|
||||
|
||||
|
||||
There's two ways to add a property:
|
||||
|
||||
* Type the property name and select its JSON type.
|
||||
* Select a property name in the combo box.
|
||||
|
||||
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.
|
||||
After adding a property, its value still needs to be set at the bottom of the tree.
|
||||
|
|
@ -1,3 +1,28 @@
|
|||
---
|
||||
title: Widgets - process input
|
||||
---
|
||||
title: Widgets - mini explorer
|
||||
---
|
||||
|
||||
### Mini explorer
|
||||
|
||||
#### Description
|
||||
|
||||
The mini explorer provides basic file browsing within the IDE.
|
||||
|
||||
|
||||
|
||||
- : Adds the selected folder to the favorites.
|
||||
- : Removes the selected favorite folder.
|
||||
- : Open the selected folder or execute the selected file using the shell.
|
||||
- : If the selected file is a CE or a DUB project then opens it as a project otherwise opens it in a new code editor.
|
||||
- ***input field***: filter the files whose name contains the text typed.
|
||||
|
||||
The file list supports drag and drop.
|
||||
|
||||
#### Options
|
||||
|
||||
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.
|
||||
- **doubleClick**: Defines what happens when a file is double clicked.
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
---
|
||||
title: Widgets - Todo list
|
||||
---
|
||||
|
||||
### Todo list
|
||||
|
||||
#### Description
|
||||
|
||||
The _todo list_ widget displays the _todo comments_ located in the source files.
|
||||
|
||||
|
||||
|
||||
When no source file is opened but a project is, the widget displays the comments of the whole project.
|
||||
When a source file has the focus and if it is not part of the project then the widget only displays the items located in this file.
|
||||
Otherwise if a file has the focus and if it's part of the project then the whole project *todos* are displayed.
|
||||
|
||||
It's possible to jump to a particular item in its file with a double click.
|
||||
The items cannot be edited in the widget.
|
||||
|
||||
- : Refreshes the list manually .
|
||||
- : Jump to the item declaration.
|
||||
|
||||
#### Format
|
||||
|
||||
The _todo comments_ must follow this format:
|
||||
> TODO|FIXME|NOTE -cCategory -aAssignee -pPriority -sStatus : what
|
||||
|
||||
The fields (-a -c -p -s) are optional but the _what_ is mandatory.
|
||||
|
||||
For example
|
||||
|
||||
```D
|
||||
// TODO: something.
|
||||
// TODO-cfixes: something to fix.
|
||||
// TODO-cfixes-aMrFreeze: something that MrFreezae has to fix.
|
||||
// NOTE: a reminder.
|
||||
```
|
||||
|
||||
are valid _todos_.
|
||||
|
||||
#### Options
|
||||
|
||||
|
||||
|
||||
- **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.
|
||||
- **singleClickSelect**: Defines how the mouse is used to go to the item declaration.
|
||||
|
|
@ -504,73 +504,6 @@ Unfiltered options, sub categories can be expanded or collapsed.
|
|||
|
||||
|
||||
|
||||
## DUB project editor
|
||||
|
||||
The DUB project editor is widget is divided in two panels:
|
||||
|
||||
#### Inspector
|
||||
|
||||
|
||||
|
||||
The first panel displays the source list and the combination of _each build type_ with each _build configuration_. A source can be opened in a new editor by a double click.
|
||||
Selecting a configuration defines which _buildType_ type and which _configuration_ will be build by DUB when clicking _compile_ in the _project_ menu.
|
||||
Note that it's possible to specify which compiler DUB uses in the application options _dubCompiler_.
|
||||
|
||||
#### Editor
|
||||
|
||||
The second panel displays the tree of the project properties. The can be modified in the field at the bottom.
|
||||
|
||||
|
||||
|
||||
New properties can be added or removed:
|
||||
|
||||
* : removes the selected property. Note that the effect is not reflected until the project is saved as a file (since Coedit does not communicate directly with DUB).
|
||||
* : shows a small dialog that allows to add a new value, a new array or a new object. This requires to master the [DUB JSON format](http://code.dlang.org/package-format?lang=json). In the dialog, the value of the text field is only used when an object or a value is added. It matches to the _key_, not the value itself.
|
||||
|
||||
|
||||
|
||||
## Todo list
|
||||
|
||||
The _todo list_ widget displays the _todo comments_ located in the source files.
|
||||
|
||||
|
||||
|
||||
When no source file is opened but a project is, the widget displays the comments of the whole project.
|
||||
When a source file has the focus but is not part of the project the widget only displays the items located in this file.
|
||||
Otherwise if a file has the focus and if it's part of the project then the whole project *todos* are displayed.
|
||||
|
||||
By default the list is refreshed automatically but it can be advisable to disable this option
|
||||
if the project contain a huge SLOC count. This can be deactivated in the context menu or in the [options editor][lnk_widg_opts]:
|
||||
|
||||
|
||||
|
||||
It's possible to jump to a particular item in its file with a double click.
|
||||
The items cannot be edited in the widget.
|
||||
|
||||
- : refreshes the list manually .
|
||||
- : jump to the item declaration.
|
||||
|
||||
The _todo comments_ must follow this format:
|
||||
> TODO -cCategory -aAssignee -pPriority -sStatus : what
|
||||
|
||||
The fields (-a -c -p -s) are optional but the _what_ is mandatory.
|
||||
The format is more detailed in the [tool source code](https://github.com/BBasile/Coedit/blob/master/cetodo/cetodo.d#L7).
|
||||
The tool itself can be build with Coedit.
|
||||
|
||||
## Mini explorer widget
|
||||
|
||||
The mini explorer provides basic file browsing within the IDE.
|
||||
|
||||
|
||||
|
||||
- : adds the selected folder to the favorites.
|
||||
- : removes the selected favorite folder.
|
||||
- : lets the shell open the selected folder or execute the selected file.
|
||||
- : if the selected file is a native or a DUB project then opens it as a project otherwise opens it in a new code editor.
|
||||
- ***input field***: filter the files whose name contains the text typed.
|
||||
|
||||
The favorite folders are persistent. The file list supports drag and drop. A few options are available in the [option editor][lnk_widg_opts].
|
||||
|
||||
# Detailed and illustrated tutorials
|
||||
|
||||
## New project flow
|
||||
|
|
|
|||
Loading…
Reference in New Issue