diff --git a/docs/img/options_terminal.png b/docs/img/options_terminal.png new file mode 100644 index 00000000..7ab65a4b Binary files /dev/null and b/docs/img/options_terminal.png differ diff --git a/docs/img/widgets_terminal.png b/docs/img/widgets_terminal.png new file mode 100644 index 00000000..7cb00f2c Binary files /dev/null and b/docs/img/widgets_terminal.png differ diff --git a/docs/index.md b/docs/index.md index 78d3fc52..097359c4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,7 +10,7 @@ title: index ![](img/coedit_kde4_thumb.png) -This documentation is based on version 3.6.6. +This documentation is based on version 3.6.7. Screenshots can be outdated but descriptions are up to date. #### First steps @@ -60,6 +60,7 @@ _Full description of Coedit options. May redirect to a specific widget page._ * [Shortcuts editor](options_shortcuts_editor) * [Static macros](widgets_editor) * [Symbol list](widgets_symbol_list) +* [Terminal](widgets_terminal) * [Todo list](widgets_todo_list) #### Widgets @@ -83,6 +84,7 @@ _Description of each widget._ * [Process input](widgets_process_input) * [Search](widgets_search) * [Symbol list](widgets_symbol_list) +* [Terminal](widgets_terminal) * [Todo list](widgets_todo_list) {% raw %} diff --git a/docs/widgets_terminal.md b/docs/widgets_terminal.md new file mode 100644 index 00000000..4192f412 --- /dev/null +++ b/docs/widgets_terminal.md @@ -0,0 +1,45 @@ +--- +title: Widgets - Terminal +--- + +{% raw %} + +{% endraw %} + +{% include xstyle.css %} + +### Todo list + +#### Description + +The _Terminal_ widget is a terminal emulator integrated in the IDE. It's only available for the linux version. + +![](img/widgets_terminal.png) + +The terminal requires [libvte](https://github.com/GNOME/vte) to be setup. +This library should be available by default in the package manager of most mainstream distribution, especially those using a GNOME desktop, +since _libvte_ is often used by the system terminal emulator of these distributions. + +For now it's mostly usable with hardcoded shortcuts: and the mouse is only used to set the focus or select text (SHIFT+LeftMB to set the selection start and a second time to set the end). +Commonly used keys are: +- HOME, END, CTRL+, CTRL+: navigation. +- CTRL+INS, CTRL+SHIFT+INS: copy, paste. +- , : commands history. + +#### Options + +![](img/options_terminal.png) + +- **backgroundColor**: The background color. +- **followEditors**: When checked the current directory is automatically set to the folder containing a document when it gains the focus. +- **followProjects**: When checked the current directory is automatically set to the folder containing a project when it gains the focus. +- **font**: Allows to customize the font name and its size. The color is not handled here. +- **foregroundCOlor**: The font color. +- **scrollbackLines**: The max count of previous lines that are stored. +- **selectedColor**: The bacground when some text is selected. Selected text color is then simply inverted. + +{% raw %} + +{% endraw %}