diff --git a/docs/features_dcd.md b/docs/features_dcd.md index 1b842b4f..f52be41f 100644 --- a/docs/features_dcd.md +++ b/docs/features_dcd.md @@ -23,7 +23,7 @@ _DCD_ is a third part software, it's bundled in the archives distributed for eac However, _DCD_ may have to be build manually, for example if a new version is released while _Coedit_ development is paused for a while. Visit the product [homepage](https://github.com/Hackerpilot/DCD) for more information. Note that since version 2 update 5, Coedit uses an experimental features that's not merged in the official repository. -If you wish to test it you must build [this clone](https://github.com/BBasile/DCD/tree/reboot-localusage), after checking out the right feature branch. +If you wish to test it you must build [this fork](https://github.com/BBasile/DCD/tree/reboot-localusage), after checking out the right feature branch. Once DCD build or extracted from the release archive, copy the two programs (_dcd-client_ and _dcd-server_) to the folder where the Coedit executable stands. They can be put elsewhere, as long as the target directory is a known operating system PATH. diff --git a/docs/index.md b/docs/index.md index 1cc14474..60f89c0b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,15 +4,37 @@ title: index ### Coedit documentation +#### First steps + +_Install and configure Coedit._ + +* [Build]() +* [Download]() + #### Features +_General features or concepts that are not wrapped in a widget_ + * [Completion deamon](features_dcd.md) * [Projects](features_projects) * [Runnable modules](features_runnables) * [Symbolic strings](features_symbolic_strings) +#### Menu reference + +_Description of each entry in the main menu. May redirect to a specific widget page._ + +* [File]() +* [Debugger]() +* [Edit]() +* [Project]() +* [Project groups]() +* [Run]() + #### Options categories +_Full description of Coedit options. May redirect to a specific widget page._ + * [Code metrics](options_code_metrics) * [Compiler paths](options_compilers_paths) * [DUB build](options_dub_build) @@ -23,6 +45,8 @@ title: index #### Widgets +_Description of each widget._ + * [DFMT commander](widgets_dfmt_commander) * [DUB project editor](widgets_dub_project_editor) * [CE project editor](widgets_ce_project_editor) diff --git a/docs/widgets_symbol_list.md b/docs/widgets_symbol_list.md index 1ca3e3f7..8f24bee8 100644 --- a/docs/widgets_symbol_list.md +++ b/docs/widgets_symbol_list.md @@ -13,4 +13,14 @@ It can be used to quickly find and go to the declaration of a symbol but also as The way the widget refreshes the list can be tweaked in the context menu or in the [options editor](widgets_options_editor). -![](img/options_symbol_list.png) \ No newline at end of file +![](img/options_symbol_list.png) + +- **autoExpandsErrors**: If checked then the warnings and the errors are always expanded. +- **autoRefresh**: If checked then the symbols are refreshed after _autoRefreshDelay_ milliseconds following the last keystroke. +- **autoRefreshDelay**: Sets the duration before auto refreshing happens. +- **refreshOnChange**: Sets if the list is refreshed when the document is saved. +- **refreshOnFocus**: Sets if the list is refreshed when a document is selected or opened. +- **showChildCategories**: When not checked, only the top level symbols are displayed. +- **smartExpander**: If checked then the the tree follows the caret position. +- **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. \ No newline at end of file