mirror of https://gitlab.com/basile.b/dexed.git
doc, fix toolbar icons in list
This commit is contained in:
Basile Burg
parent
271bc44501
commit
03e14c5cc7
|
|
@ -2,6 +2,8 @@
|
|||
title: Widgets - custom tools
|
||||
---
|
||||
|
||||
{% include xstyle.css %}
|
||||
|
||||
### Custom tools
|
||||
|
||||
This widget allows to define a set of third party applications that can be launched from Coedit.
|
||||
|
|
@ -20,11 +22,11 @@ A few examples:
|
|||
|
||||
Toolbar:
|
||||
|
||||
- : Adds a new tool.
|
||||
- : Removes selected tool.
|
||||
-  **/**  : Changes the position of the selected tool.
|
||||
- : Executes the tool that's selected, according to the options it's associated to. This also works by double-clicking the tool aliases.
|
||||
- : Clones the tool that's selected.
|
||||
- <img src="{%include icurl%}window/application_add.png" class="tlbric"/>: Adds a new tool.
|
||||
- <img src="{%include icurl%}window/application_delete.png" class="tlbric"/>: Removes selected tool.
|
||||
- <img src="{%include icurl%}arrow/arrow_up.png" class="tlbric"/> **/** <img src="{%include icurl%}arrow/arrow_down.png" class="tlbric"/>: Changes the position of the selected tool.
|
||||
- <img src="{%include icurl%}window/application_flash.png" class="tlbric"/>: Executes the tool that's selected, according to the options it's associated to. This also works by double-clicking the tool aliases.
|
||||
- <img src="{%include icurl%}window/application_double.png" class="tlbric"/>: Clones the tool that's selected.
|
||||
|
||||
A tool can be selected from the left side of the widget. If selected, a property inspector displays the options that can be edited:
|
||||
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Widgets - DFMT commander
|
||||
---
|
||||
|
||||
{% include xstyle.css %}
|
||||
|
||||
### DFMT commander
|
||||
|
||||
The _Dfmt commander_ widget is a simple but complete interface for the D source code formater [Dfmt](https://github.com/Hackerpilot/dfmt).
|
||||
|
|
@ -12,8 +14,8 @@ The background tool has to be build and installed in one of the _PATH_ known by
|
|||
A property inspector allows to tweak the format.
|
||||
See the [official documentation](https://github.com/Hackerpilot/dfmt#configuration) to learn more about the options.
|
||||
|
||||
- : apply the formatting. The editor state is backed up before each formatting.
|
||||
- : restore the previous backup.
|
||||
- <img src="{%include icurl%}other/accept.png" class="tlbric"/>: apply the formatting. The editor state is backed up before each formatting.
|
||||
- <img src="{%include icurl%}other/cancel.png" class="tlbric"/>: restore the previous backup.
|
||||
|
||||
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.
|
||||
|
|
@ -2,6 +2,8 @@
|
|||
title: Widgets - DUB project editor
|
||||
---
|
||||
|
||||
{% include xstyle.css %}
|
||||
|
||||
### DUB project editor
|
||||
|
||||
The DUB project editor allows to edit, add and remove properties of DUB projects that has the [JSON format](http://code.dlang.org/package-format?lang=json).
|
||||
|
|
@ -12,8 +14,8 @@ DUB projects with the [SDL format](http://code.dlang.org/package-format?lang=sdl
|
|||
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.
|
||||
- <img src="{%include icurl%}other/textfield_delete.png" class="tlbric"/>: 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).
|
||||
- <img src="{%include icurl%}other/textfield_add.png" class="tlbric"/>: Shows a small dialog that allows to add a new value, a new array or a new object.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Widgets - library manager
|
||||
---
|
||||
|
||||
{% include xstyle.css %}
|
||||
|
||||
### Library manager
|
||||
|
||||
#### Description
|
||||
|
|
@ -22,19 +24,19 @@ This features is only used for the CE project format and the [runnables](feature
|
|||
|
||||
#### Toolbar
|
||||
|
||||
- : Adds a library item, by default its fields are initialized with _n/a_.
|
||||
- : Removes the selected item.
|
||||
-  **/** : Changes selected entry position.
|
||||
- : If the current project is a static library then the _libman_ will use its parameters to create an entry. This avoids to browse in the dialogs. Note that sometimes the sources root folder has to be adjusted.
|
||||
- : If the selected item defines a _project_ then closes current project and opens the one matching to the entry.
|
||||
- : Allows to fetch the master version of a [DUB registry item](http://code.dlang.org/). See the last section.
|
||||
- : enable or disable the selected entry. This is mainly useful to test new DMD versions since the libraries often have to be recompiled from a version to another.
|
||||
- : edit the item alias.
|
||||
- : select the library file. In some rare case, this field can be omitted (for example if the library file is set in the _sc.ini_).
|
||||
- <img src="{%include icurl%}book/book_add.png" class="tlbric"/>: Adds a library item, by default its fields are initialized with _n/a_.
|
||||
- <img src="{%include icurl%}book/book_delete.png" class="tlbric"/>: Removes the selected item.
|
||||
- <img src="{%include icurl%}arrow/arrow_up.png" class="tlbric"/> **/** <img src="{%include icurl%}arrow/arrow_down.png" class="tlbric"/> Changes selected entry position.
|
||||
- <img src="{%include icurl%}book/book_link.png): If the current project is a static library then the _libman_ will use its parameters to create an entry. This avoids to browse in the dialogs. Note that sometimes the sources root folder has to be adjusted.
|
||||
- <img src="{%include icurl%}book/book_open.png" class="tlbric"/>: If the selected item defines a _project_ then closes current project and opens the one matching to the entry.
|
||||
- <img src="{%include icurl%}other/dub.png" class="tlbric"/>: Allows to fetch the master version of a [DUB registry item](http://code.dlang.org/). See the last section.
|
||||
- <img src="{%include icurl%}book/book.png" class="tlbric"/>: enable or disable the selected entry. This is mainly useful to test new DMD versions since the libraries often have to be recompiled from a version to another.
|
||||
- <img src="{%include icurl%}book/book_edit.png" class="tlbric"/>: edit the item alias.
|
||||
- <img src="{%include icurl%}folder/folder_brick.png" class="tlbric"/>: select the library file. In some rare case, this field can be omitted (for example if the library file is set in the _sc.ini_).
|
||||
This can be skipped if the library is only a small orphan _d_ source that's not been compiled as a static library or if the entry is only used for the [DCD](features_dcd) completion.
|
||||
- : select a folder that contains several libraries files or several orphans modules.
|
||||
- : select the sources root folder. (the one commonly named 'import').
|
||||
- : set the project file that matches to the selected item.
|
||||
- <img src="{%include icurl%}other/bricks.png" class="tlbric"/>: select a folder that contains several libraries files or several orphans modules.
|
||||
- <img src="{%include icurl%}folder/folder_add.png" class="tlbric"/>: select the sources root folder. (the one commonly named 'import').
|
||||
- <img src="{%include icurl%}other/script_bricks.png" class="tlbric"/>: set the project file that matches to the selected item.
|
||||
|
||||
#### Register online DUB packages
|
||||
|
||||
|
|
@ -44,7 +46,7 @@ When the toolbar button that displays DUB logo is clicked, a dialog is displayed
|
|||
|
||||
The text field is used to select the name of the package to install.
|
||||
|
||||
- : Update the list of the online packages.
|
||||
- : 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.
|
||||
- : Closes the dialog and start downloading before installing.
|
||||
- : Cancels and does nothing.
|
||||
- <img src="{%include icurl%}arrow/arrow_update.png" class="tlbric"/>: Update the list of the online packages.
|
||||
- <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/cancel.png" class="tlbric"/>: Cancels and does nothing.
|
||||
|
|
@ -2,6 +2,8 @@
|
|||
title: Widgets - mini explorer
|
||||
---
|
||||
|
||||
{% include xstyle.css %}
|
||||
|
||||
### Mini explorer
|
||||
|
||||
#### Description
|
||||
|
|
@ -10,10 +12,10 @@ 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.
|
||||
- <img src="{%include icurl%}folder/folder_add.png" class="tlbric"/>: Adds the selected folder to the favorites.
|
||||
- <img src="{%include icurl%}folder/folder_delete.png" class="tlbric"/>: Removes the selected favorite folder.
|
||||
- <img src="{%include icurl%}other/flash.png" class="tlbric"/>: Open the selected folder or execute the selected file using the shell.
|
||||
- <img src="{%include icurl%}other/pencil.png" class="tlbric"/>: 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.
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Widgets - options editor
|
||||
---
|
||||
|
||||
{% include xstyle.css %}
|
||||
|
||||
### Options editor
|
||||
|
||||
The _Options editor_ is a special, non-dockable, widget that allows the other widgets to expose their options.
|
||||
|
|
@ -11,8 +13,8 @@ The list at the left displays the categories. A category often matches to a sing
|
|||
|
||||
The options are applied in real time but are reversible until the green checker icon is clicked.
|
||||
|
||||
- : validates the modifications made to the current category, after what they can't be canceled anymore.
|
||||
- : cancels and restores the previous state of the current category.
|
||||
- <img src="{%include icurl%}other/accept.png" class="tlbric"/>: Validates the modifications made to the current category, after what they can't be canceled anymore.
|
||||
- <img src="{%include icurl%}other/cancel.png" class="tlbric"/>: Cancels and restores the previous state of the current category.
|
||||
|
||||
The options are persistent and saved in a distinct folder:
|
||||
|
||||
|
|
|
|||
|
|
@ -1 +1,7 @@
|
|||
|
||||
---
|
||||
title: Widgets - project groups
|
||||
---
|
||||
|
||||
{% include xstyle.css %}
|
||||
|
||||
### Project groups
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Widgets - project inspector
|
||||
---
|
||||
|
||||
{% include xstyle.css %}
|
||||
|
||||
### Project inspector
|
||||
|
||||
The project inspector is used to
|
||||
|
|
@ -14,9 +16,9 @@ The project inspector is used to
|
|||
|
||||
The toolbar buttons are only activated for CE projects.
|
||||
|
||||
|  | Adds a D source to the project from a dialog. The new source is not directly opened in the editor. To add a file that is already edited, rather use **"Add file to project"** from the **File** menu. |
|
||||
|  | Removes from the project the source that's selected in the tree. |
|
||||
|  | Adds a folder of D source to the project from a dialog. The procedure is recursive. |
|
||||
|  | Removes from the project the sources files that stand in the same directory as the source selected in the tree. |
|
||||
- <img src="{%include icurl%}file/document_add.png" class="tlbric"/>: Adds a D source to the project from a dialog. The new source is not directly opened in the editor. To add a file that is already edited, rather use **"Add file to project"** from the **File** menu.
|
||||
- <img src="{%include icurl%}file/document_delete.png" class="tlbric"/>: Removes from the project the source that's selected in the tree.
|
||||
- <img src="{%include icurl%}folder/folder_add.png" class="tlbric"/> Adds a folder of D source to the project from a dialog. The procedure is recursive.
|
||||
- <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.
|
||||
|
|
@ -2,6 +2,8 @@
|
|||
title: Widgets - Todo list
|
||||
---
|
||||
|
||||
{% include xstyle.css %}
|
||||
|
||||
### Todo list
|
||||
|
||||
#### Description
|
||||
|
|
@ -17,8 +19,8 @@ Otherwise if a file has the focus and if it's part of the project then the whole
|
|||
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.
|
||||
- <img src="{%include icurl%}arrow/arrow_update.png" class="tlbric"/>: Refreshes the list manually.
|
||||
- <img src="{%include icurl%}arrow/arrow_pen.png" class="tlbric"/>: Jump to the item declaration.
|
||||
|
||||
#### Format
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue