From 03e14c5cc77ea2081eaf0b2c34d7a122d7b9919d Mon Sep 17 00:00:00 2001 From: Basile Burg Date: Wed, 4 Jan 2017 07:21:02 +0100 Subject: [PATCH] doc, fix toolbar icons in list --- docs/widgets_custom_tools.md | 12 ++++++----- docs/widgets_dfmt_commander.md | 6 ++++-- docs/widgets_dub_project_editor.md | 6 ++++-- docs/widgets_library_manager.md | 34 ++++++++++++++++-------------- docs/widgets_mini_explorer.md | 10 +++++---- docs/widgets_options_editor.md | 6 ++++-- docs/widgets_project_groups.md | 8 ++++++- docs/widgets_project_inspector.md | 10 +++++---- docs/widgets_todo_list.md | 6 ++++-- 9 files changed, 60 insertions(+), 38 deletions(-) diff --git a/docs/widgets_custom_tools.md b/docs/widgets_custom_tools.md index 016762f7..74adf6ff 100644 --- a/docs/widgets_custom_tools.md +++ b/docs/widgets_custom_tools.md @@ -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: -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/window/application_add.png): Adds a new tool. -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/window/application_delete.png): Removes selected tool. -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/arrow/arrow_up.png) **/** ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/arrow/arrow_down.png) : Changes the position of the selected tool. -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/window/application_flash.png): Executes the tool that's selected, according to the options it's associated to. This also works by double-clicking the tool aliases. -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/window/application_double.png): Clones the tool that's selected. +- : 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. A tool can be selected from the left side of the widget. If selected, a property inspector displays the options that can be edited: diff --git a/docs/widgets_dfmt_commander.md b/docs/widgets_dfmt_commander.md index 03a7d07f..56477fd8 100644 --- a/docs/widgets_dfmt_commander.md +++ b/docs/widgets_dfmt_commander.md @@ -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. -- ![](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. +- : apply the formatting. The editor state is backed up before each formatting. +- : 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_dub_project_editor.md b/docs/widgets_dub_project_editor.md index bb10bdf6..1afc7ad2 100644 --- a/docs/widgets_dub_project_editor.md +++ b/docs/widgets_dub_project_editor.md @@ -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: -* ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/other/textfield_delete.png): 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). -* ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/other/textfield_add.png): Shows a small dialog that allows to add a new value, a new array or a new object. +- : 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/dub_add_property.png) diff --git a/docs/widgets_library_manager.md b/docs/widgets_library_manager.md index 00986d71..cc951671 100644 --- a/docs/widgets_library_manager.md +++ b/docs/widgets_library_manager.md @@ -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 -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/book/book_add.png): Adds a library item, by default its fields are initialized with _n/a_. -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/book/book_delete.png): Removes the selected item. -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/arrow/arrow_up.png) **/** ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/arrow/arrow_down.png): Changes selected entry position. -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/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. -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/book/book_open.png): If the selected item defines a _project_ then closes current project and opens the one matching to the entry. -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/other/dub.png): Allows to fetch the master version of a [DUB registry item](http://code.dlang.org/). See the last section. -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/book/book.png): 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. -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/book/book_edit.png): edit the item alias. -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/folder/folder_brick.png): 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_). +- : Adds a library item, by default its fields are initialized with _n/a_. +- : Removes the selected item. +- **/** Changes selected entry position. +- : 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_). 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. -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/other/bricks.png): select a folder that contains several libraries files or several orphans modules. -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/folder/folder_add.png): select the sources root folder. (the one commonly named 'import'). -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/other/script_bricks.png): set the project file that matches to the selected item. +- : 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. #### 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. -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/arrow/arrow_update.png): Update the list of the online packages. -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/other/tag_purple.png): 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. -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/other/accept.png): Closes the dialog and start downloading before installing. -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/other/cancel.png): Cancels and does nothing. \ No newline at end of file +- : 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. \ No newline at end of file diff --git a/docs/widgets_mini_explorer.md b/docs/widgets_mini_explorer.md index 48579e53..179938fc 100644 --- a/docs/widgets_mini_explorer.md +++ b/docs/widgets_mini_explorer.md @@ -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. ![](img/mini_explorer.png) -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/folder/folder_add.png): Adds the selected folder to the favorites. -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/folder/folder_delete.png): Removes the selected favorite folder. -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/other/flash.png): Open the selected folder or execute the selected file using the shell. -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/other/pencil.png): 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. +- : 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. diff --git a/docs/widgets_options_editor.md b/docs/widgets_options_editor.md index e824cf56..b7882096 100644 --- a/docs/widgets_options_editor.md +++ b/docs/widgets_options_editor.md @@ -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. -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/other/accept.png): validates the modifications made to the current category, after what they can't be canceled anymore. -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/other/cancel.png): cancels and restores the previous state of the current category. +- : 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. The options are persistent and saved in a distinct folder: diff --git a/docs/widgets_project_groups.md b/docs/widgets_project_groups.md index 8d1c8b69..6e3560c8 100644 --- a/docs/widgets_project_groups.md +++ b/docs/widgets_project_groups.md @@ -1 +1,7 @@ - +--- +title: Widgets - project groups +--- + +{% include xstyle.css %} + +### Project groups diff --git a/docs/widgets_project_inspector.md b/docs/widgets_project_inspector.md index e5262083..71089fdf 100644 --- a/docs/widgets_project_inspector.md +++ b/docs/widgets_project_inspector.md @@ -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. -| ![](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 from the project the source that's selected in the tree. | -| ![](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. | -| ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/folder/folder_delete.png) | Removes from the project the sources files that stand in the same directory as the source selected in the tree. | +- : 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. 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/docs/widgets_todo_list.md b/docs/widgets_todo_list.md index 6fbd072c..5b217506 100644 --- a/docs/widgets_todo_list.md +++ b/docs/widgets_todo_list.md @@ -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. -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/arrow/arrow_update.png): Refreshes the list manually . -- ![](https://raw.githubusercontent.com/BBasile/Coedit/master/icons/arrow/arrow_pen.png): Jump to the item declaration. +- : Refreshes the list manually. +- : Jump to the item declaration. #### Format