|
| 1 | +.. container:: document |
| 2 | + |
| 3 | + `RIDE (Robot Framework |
| 4 | + IDE) <https://github.com/robotframework/RIDE/>`__ v2.1a3 is a new |
| 5 | + release with important enhancements and bug fixes. The reference for |
| 6 | + valid arguments is `Robot Framework <https://robotframework.org/>`__ |
| 7 | + installed version, which is at this moment 7.0.1rc1. However, |
| 8 | + internal library code is originally based on version 3.1.2, but |
| 9 | + adapted for new versions. |
| 10 | + |
| 11 | + - This version supports Python 3.8 up to 3.12. |
| 12 | + - There are some changes, or known issues: |
| 13 | + |
| 14 | + - ❌ - Removed support for Python 3.6 and 3.7 |
| 15 | + - ✔ - Added support for Setup in keywords, since Robot Framework |
| 16 | + version 7.0. |
| 17 | + - ✔ - Added support for new VAR marker, since Robot Framework |
| 18 | + version 7.0. |
| 19 | + - ✔ - Added to Grid Editor changing Zoom In/Out with **Ctrl-Mouse |
| 20 | + Wheel** and setting at Preferences. |
| 21 | + - ✔ - Fixed plugin Run Anything (Macros) not showing output and |
| 22 | + broken actions. |
| 23 | + - ✔ - Added actions on columns of Grid Editor: Double-Click or |
| 24 | + Right Mouse Click, allows to edit the column name for Data |
| 25 | + Driven or Templated; Left Mouse Click, selects the column |
| 26 | + cells. |
| 27 | + - ✔ - Added command line option, **--settingspath**, to select a |
| 28 | + different configuration. |
| 29 | + - ✔ - Added different settings file, according the actual Python |
| 30 | + executable, if not the original installed. |
| 31 | + - ✔ - Added a selector for Tasks and Language to the New Project |
| 32 | + dialog. |
| 33 | + - ✔ - Added UI localization prepared for all the languages from |
| 34 | + installed Robot Framework version 6.1, or higher. Major |
| 35 | + translations are: Dutch, Portuguese and Brazilian Portuguese. |
| 36 | + Still missing translation of some elements. |
| 37 | + - ✔ - Added support for language configured test suites, with |
| 38 | + languages from installed Robot Framework version 6.1, or |
| 39 | + higher. |
| 40 | + - ✔ - On Text Editor, pressing **Ctrl** when the caret/cursor is |
| 41 | + near a Keyword will show a detachable window with the |
| 42 | + documentation, at Mouse Pointer position. |
| 43 | + - ✔ - RIDE tray icon now shows a context menu with options Show, |
| 44 | + Hide and Close. |
| 45 | + - ✔ - Highlighting and navigation of selected Project Explorer |
| 46 | + items, in Text Editor. |
| 47 | + - ✔ - When editing in Grid Editor with content assistance, the |
| 48 | + selected content can be edited by escaping the list of |
| 49 | + suggestions with keys ARROW_LEFT or ARROW_RIGHT. |
| 50 | + - ✔ - Newlines in Grid Editor can be made visible with the |
| 51 | + **filter newlines** set to False. |
| 52 | + - 🐞 - On Text Editor when Saving the selection of tests in Test |
| 53 | + Suites (Tree) is cleared. |
| 54 | + - 🐞 - Problems with COPY/PASTE in Text Editor have been reported |
| 55 | + when using wxPython 4.2.0, but not with version 4.2.1, which we |
| 56 | + now *recommend*. |
| 57 | + - 🐞 - Some argument types detection (and colorization) is not |
| 58 | + correct in Grid Editor. |
| 59 | + - 🐞 - RIDE **DOES NOT KEEP** Test Suites formatting or |
| 60 | + structure, causing differences in files when used on other IDE |
| 61 | + or Editors. |
| 62 | + |
| 63 | + **New Features and Fixes Highlights** |
| 64 | + |
| 65 | + - Added support for Setup in keywords, since Robot Framework version |
| 66 | + 7.0. |
| 67 | + - Fixed multiline variables in Variables section. In Text Editor |
| 68 | + they are separated by ... continuation marker. In Grid Editor use |
| 69 | + \| (pipe) to separate lines. |
| 70 | + - Added support for new VAR marker, since Robot Framework version |
| 71 | + 7.0. |
| 72 | + - Added configurable style of the tabs in notebook pages, Edit, |
| 73 | + Text, Run, etc. Parameter **notebook theme** takes values from 0 |
| 74 | + to 5. See wxPython, demo for agw.aui for details. |
| 75 | + - Added UI localization and support for Japanese configured test |
| 76 | + suites, valid for Robot Framework version 7.0.1 or higher. |
| 77 | + - Fixed keywords Find Usages in Grid Editor not finding certain |
| 78 | + values when using Gherkin. |
| 79 | + - Improved selection of items from Tree in Text Editor. Now finds |
| 80 | + more items and selects whole line. |
| 81 | + - Changed output in plugin Run Anything (Macros) to allow Zoom |
| 82 | + In/Out, and Copy content. |
| 83 | + - Added to Grid Editor changing Zoom In/Out with **Ctrl-Mouse |
| 84 | + Wheel** and setting at Preferences. |
| 85 | + - Fixed plugin Run Anything (Macros) not showing output and broken |
| 86 | + actions. |
| 87 | + - Added actions on columns of Grid Editor: Double-Click or Right |
| 88 | + Mouse Click, allows to edit the column name for Data Driven or |
| 89 | + Templated; Left Mouse Click, selects the column cells. |
| 90 | + - Added command line option, **--settingspath**, to select a |
| 91 | + different configuration. |
| 92 | + - Added different settings file, according the actual Python |
| 93 | + executable, if not the original installed. |
| 94 | + - Fixed headers and blank spacing in Templated tests. |
| 95 | + - Added context option **Open Containing Folder** to test suites |
| 96 | + directories in Project Explorer. |
| 97 | + - Added a setting for a specific file manager by editing the |
| 98 | + settings.cfg file. Add the string parameter **file manager** in |
| 99 | + the section **[General]** |
| 100 | + - Added minimal support to have comment lines in Import settings. |
| 101 | + These are not supposed to be edited in Editor, and new lines are |
| 102 | + added at Text Editor. |
| 103 | + - Fixed removal of continuation marker in steps |
| 104 | + - Fixed wrong continuation of long chains of keywords in Setups, |
| 105 | + Teardowns or Documentation. |
| 106 | + - Added a selector for Tasks and Language to the New Project dialog. |
| 107 | + Still some problems: Tasks type changes to Tests, localized |
| 108 | + sections only stay translated after Apply in Text Editor. |
| 109 | + - Added UI localization prepared for all the languages from |
| 110 | + installed Robot Framework version 6.1, or higher. Language is |
| 111 | + selected from Tools->Preferences->General. |
| 112 | + - Removed support for HTML file format (obsolete since Robot |
| 113 | + Framework 3.2) |
| 114 | + - Added support for language configured test suites. Fields are |
| 115 | + shown in the language of the files in Grid Editor. Tooltips are |
| 116 | + always shown in English. Colorization for language configured |
| 117 | + files is working in Text Editor. |
| 118 | + - Fixed New User Keyword dialog not allowing empty Arguments field |
| 119 | + - Fixed escaped spaces showing in Text Editor on commented cells |
| 120 | + - Improved keywords documentation search, by adding current dir to |
| 121 | + search |
| 122 | + - Improved Move up/down, **Alt-UpArrow**/**Alt-DownArrow** in Text |
| 123 | + Editor, to have proper indentation and selection |
| 124 | + - Added auto update check when development version is installed |
| 125 | + - Added menu option **Help->Check for Upgrade** which allows to |
| 126 | + force update check and install development version |
| 127 | + - Added **Upgrade Now** action to update dialog. |
| 128 | + - Added **Test Tags** field (new, since Robot Framework 6.0) to Test |
| 129 | + Suites settings. This field will replace **Default** and **Force |
| 130 | + Tags** settings, after Robot Framework 7.0 |
| 131 | + - Improved **RIDE Log** and **Parser Log** windows to allow Zoom |
| 132 | + In/Out with **Ctrl-Mouse Wheel** |
| 133 | + - Hide continuation markers in Project Tree |
| 134 | + - Improved content assistance in Text Editor by allowing to filter |
| 135 | + list as we type |
| 136 | + - Fixed resource files disappearing from Project tree on Windows |
| 137 | + - Fixed missing indication of link for User Keyword, when pressing |
| 138 | + **Ctrl** in Grid Editor |
| 139 | + - Added content help pop-up on Text Editor by pressing **Ctrl** for |
| 140 | + text at cursor position or selected autocomplete list item |
| 141 | + - Added Exclude option in context nenu for Test files, previously |
| 142 | + was only possible for Test Suites folders |
| 143 | + - Added exclusion of monitoring filesystem changes for files and |
| 144 | + directories excluded in Preferences |
| 145 | + - Fixed exception when finding GREY color for excluded files and |
| 146 | + directories in Project Tree |
| 147 | + - Added support for JSON variables, by using the installed Robot |
| 148 | + Framework import method |
| 149 | + - Colorization of Grid Editor cells after the continuation marker |
| 150 | + **...** and correct parsing of those lines |
| 151 | + - Colorization of Grid Editor cells when contents is list or |
| 152 | + dictionary variables |
| 153 | + - Added indication of matching brackets, **()**, **{}**, **[]**, in |
| 154 | + Text Editor |
| 155 | + - Fixed non synchronized expanding/collapse of Settings panel in |
| 156 | + Grid Editor, on Linux |
| 157 | + - Fixed not working the deletion of cells commented with **#** in |
| 158 | + Grid Editor with **Ctrl-Shift-D** |
| 159 | + - Fixed empty line being always added to the Variables section in |
| 160 | + Text Editor |
| 161 | + - Improved project file system changes and reloading |
| 162 | + - Added context menu to RIDE tray icon. Options Show, Hide and Close |
| 163 | + - Added synchronization with Project Explorer to navigate to |
| 164 | + selected item, Test Case, Keyword, Variable, in Text Editor |
| 165 | + - Control commands (**FOR**, **IF**, **TRY**, etc) will only be |
| 166 | + colorized as valid keywords when typed in all caps in Grid Editor |
| 167 | + - Newlines in Grid Editor can be made visible with the **filter |
| 168 | + newlines** set to False, by editing *settings.cfg* |
| 169 | + - Improve auto-suggestions of keywords in Grid Editor by allowing to |
| 170 | + close suggestions list with keys ARROW_LEFT or ARROW_RIGHT |
| 171 | + - Improve Text Editor auto-suggestions by using: selected text, text |
| 172 | + at left or at right of cursor |
| 173 | + |
| 174 | + We hope to implement or complete features and make fixes on next |
| 175 | + major version 2.1 (in the end of 2023). |
| 176 | + |
| 177 | + **The minimal wxPython version is, 4.0.7, and RIDE supports the |
| 178 | + current version, 4.2.1.** |
| 179 | + |
| 180 | + *Linux users are advised to install first wxPython from .whl package |
| 181 | + at* |
| 182 | + `wxPython.org <https://extras.wxpython.org/wxPython4/extras/linux/gtk3/>`__, |
| 183 | + or by using the system package manager. |
| 184 | + |
| 185 | + The |
| 186 | + `CHANGELOG.adoc <https://github.com/robotframework/RIDE/blob/master/CHANGELOG.adoc>`__ |
| 187 | + lists the changes done on the different versions. |
| 188 | + |
| 189 | + All issues targeted for RIDE v2.1 can be found from the `issue |
| 190 | + tracker |
| 191 | + milestone <https://github.com/robotframework/RIDE/issues?q=milestone%3Av2.1>`__. |
| 192 | + |
| 193 | + Questions and comments related to the release can be sent to the |
| 194 | + `robotframework-users <https://groups.google.com/group/robotframework-users>`__ |
| 195 | + mailing list or to the channel #ride on `Robot Framework |
| 196 | + Slack <https://robotframework-slack-invite.herokuapp.com>`__, and |
| 197 | + possible bugs submitted to the `issue |
| 198 | + tracker <https://github.com/robotframework/RIDE/issues>`__. You |
| 199 | + should see `Robot Framework |
| 200 | + Forum <https://forum.robotframework.org/c/tools/ride/>`__ if your |
| 201 | + problem is already known. |
| 202 | + |
| 203 | + To install with `pip <https://pypi.org/project/pip/>`__ installed, |
| 204 | + just run |
| 205 | + |
| 206 | + .. code:: literal-block |
| 207 | +
|
| 208 | + pip install --upgrade --pre robotframework-ride==v2.1a3 |
| 209 | +
|
| 210 | + to install exactly this release, which is the same as using |
| 211 | + |
| 212 | + .. code:: literal-block |
| 213 | +
|
| 214 | + pip install --upgrade --pre robotframework-ride |
| 215 | +
|
| 216 | + Alternatively you can download the source distribution from |
| 217 | + `PyPI <https://pypi.python.org/pypi/robotframework-ride>`__ and |
| 218 | + install it manually. For more details and other installation |
| 219 | + approaches, see the `installation |
| 220 | + instructions <https://github.com/robotframework/RIDE/wiki/Installation-Instructions>`__. |
| 221 | + If you want to help in the development of RIDE, by reporting issues |
| 222 | + in current development version, you can install with: |
| 223 | + |
| 224 | + .. code:: literal-block |
| 225 | +
|
| 226 | + pip install -U https://github.com/robotframework/RIDE/archive/master.zip |
| 227 | +
|
| 228 | + Important document for helping with development is the |
| 229 | + `CONTRIBUTING.adoc <https://github.com/robotframework/RIDE/blob/master/CONTRIBUTING.adoc>`__. |
| 230 | + |
| 231 | + See the `FAQ <https://github.com/robotframework/RIDE/wiki/F.A.Q.>`__ |
| 232 | + for important info about : FOR changes and other known issues and |
| 233 | + workarounds. |
| 234 | + |
| 235 | + A possible way to start RIDE is: |
| 236 | + |
| 237 | + .. code:: literal-block |
| 238 | +
|
| 239 | + python -m robotide.__init__ |
| 240 | +
|
| 241 | + You can then go to Tools>Create RIDE Desktop Shortcut, or run the |
| 242 | + shortcut creation script with: |
| 243 | + |
| 244 | + .. code:: literal-block |
| 245 | +
|
| 246 | + python -m robotide.postinstall -install |
| 247 | +
|
| 248 | + RIDE v2.1a3 was released on 22/July/2024. |
0 commit comments