diff --git a/docs/img/dfmt_commander.png b/docs/img/dfmt_commander.png new file mode 100644 index 00000000..59aee0a0 Binary files /dev/null and b/docs/img/dfmt_commander.png differ diff --git a/docs/img/project_inspector.png b/docs/img/project_inspector.png new file mode 100644 index 00000000..8b37e404 Binary files /dev/null and b/docs/img/project_inspector.png differ diff --git a/docs/index.md b/docs/index.md index fe102b8b..b10be4e6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -21,6 +21,7 @@ title: index #### Widgets +* [DFMT commander](widgets_dfmt_commander) * [DUB project editor](widgets_dub_project_editor) * [CE project editor](widgets_ce_project_editor) * [Custom tools](widgets_custom_tools) diff --git a/docs/widgets_dfmt_commander.md b/docs/widgets_dfmt_commander.md new file mode 100644 index 00000000..03a7d07f --- /dev/null +++ b/docs/widgets_dfmt_commander.md @@ -0,0 +1,19 @@ +--- +title: Widgets - DFMT commander +--- + +### DFMT commander + +The _Dfmt commander_ widget is a simple but complete interface for the D source code formater [Dfmt](https://github.com/Hackerpilot/dfmt). +The background tool has to be build and installed in one of the _PATH_ known by the operating system. + +![](img/dfmt_commander.png) + +A property inspector allows to tweak the format. +See the [official documentation](https://github.com/Hackerpilot/dfmt#configuration) to learn more about the options. + +- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/other/accept.png): apply the formatting. The editor state is backed up before each formatting. +- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/other/cancel.png): 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. \ No newline at end of file diff --git a/docs/widgets_project_inspector.md b/docs/widgets_project_inspector.md index b891a2d0..50f6d9a3 100644 --- a/docs/widgets_project_inspector.md +++ b/docs/widgets_project_inspector.md @@ -1,3 +1,21 @@ --- title: Widgets - project inspector --- + +### Project inspector + +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). + +![](img/project_inspector.png) + +The toolbar buttons are only activated for CE projects. + +- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/file/document_add.png): 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. +- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/file/document_delete.png): Removes the selected source (selected in the widget tree, not in the editor) from the project. +- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/folder/folder_add.png): Adds a folder of D source to the project from a dialog. The procedure is recursive. + +Note that instead of using the dialogs to add files, it's also possible to drop items from a file explorer. \ No newline at end of file diff --git a/wiki/wiki.txt b/wiki/wiki.txt index 522206a5..01b112c0 100644 --- a/wiki/wiki.txt +++ b/wiki/wiki.txt @@ -383,18 +383,6 @@ All of them can be easily build in Coedit and setup in the [_libman_](lnk_widg_l The library entries are saved in the user folder [(see options)][lnk_widg_opts] as _libraryManager.txt_. -## Project inspector widget - -The project inspector widget is mostly designed to manipulate the project source files. It can also be used to select a compiler configuration. - -![](https://raw.githubusercontent.com/BBasile/CoeditWikiData/master/projectinspector1.png) - -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/file/document_add.png): 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. -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/file/document_delete.png): removes the selected source (_selected_ in the widget tree, not in the editor) from the project. -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/folder/folder_add.png): adds a folder of D source to the project from a dialog. The procedure is recursive. - -Note that instead of using the dialogs to add files, it's also possible to drop items from a file explorer. - ## Project configuration widget The project configuration widget is a powerful editor for the compiler options. By design it uses an "_Object Inspector_" GUI element. @@ -588,20 +576,6 @@ New properties can be added or removed: ![](https://raw.githubusercontent.com/BBasile/CoeditWikiData/master/dub_edit2.png) -## Dfmt Commander - -The _Dfmt commander_ widget is a simple but complete interface for the D source code formater [Dfmt](https://github.com/Hackerpilot/dfmt). The background tool has to be build and installed in one of the _PATH_ known by the operating system. - -![](https://raw.githubusercontent.com/BBasile/CoeditWikiData/master/dfmt1.png) - -A property inspector allows to tweak the format. See the [official documentation](https://github.com/Hackerpilot/dfmt#configuration) to learn more about the options. - -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/other/accept.png): apply the formatting. The editor state is backed up before each formatting. -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/other/cancel.png): restore the previous backup. - -The formatting is applied in memory and is undo-able either from the widget or from the code editor. The changes are not physically applied until the file is explicitly saved. -Formatting options are saved between each session in the [Coedit data folder][lnk_widg_opts]. - ## Todo list The _todo list_ widget displays the _todo comments_ located in the source files.