Updated RELEASE_NOTES.
[mp-5.x.git] / RELEASE_NOTES
blob76d810d89cbf6fa22631cae464bddb894451538b
1 Minimum Profit Release Notes
2 ============================
4 5.1.3
5 -----
7  * A new hexadecimal viewer.
8  * Improved file encoding autodetection by looking at the
9    UTF BOM marks.
10  * New configuration option `keep_eol', to keep the original
11    end of line sequence each document had.
12  * Fixed some clipboard issues and crashes.
13  * win32 executable has been renamed to `mp-5.exe'.
14  * Setting an empty encoding (to fall back to system defaults)
15    always work.
16  * The status line format string can also include the %e token
17    to show the encoding used by the document.
19 5.1.2
20 -----
22  * The `grep' action can now be recursive.
23  * New syntax color for special documentation blocks.
24  * Fix searching into empty selected blocks (this was bug #1269).
25  * New action `section_list', that shows a list of _sections_
26    in the current document to jump to. Sections are usually
27    function definitions and special marks in programming
28    languages.
29  * New action `seek_misspelled', to search the next
30    misspelled word. It has been assigned to keycode `f5'.
31  * New action `ignore_last_misspell', to add the last misspelled
32    word found by `seek_misspelled' to a whitelist so it won't
33    be found again.
34  * New action `seek_repeated_word', to search for words starting
35    or ending with the same number of letters up to a maximum
36    distance. It's controlled by the new configuration directives
37    `mp.config.rw_num_chars' and `mp.config.rw_max_dist'.
38    It has been assigned to keycode `f6' (this keycode was
39    previously assigned to `join_paragraph', which has no
40    keybinding now).
41  * The action `open_templates_file' has been fixed.
42  * Several GTK interface updates by fellow developer Sebastian Vöcking.
43  * New command line option `-d', to change the working directory.
44  * Several fixes to the win32 driver; word wrapping, combobox
45    drop-down sizes, underlined text.
46  * Avoid hanging if the external ispell program is broken.
47  * The `dump()' function now dumps its argument as MPSL code.
49 5.1.1
50 -----
52  * Internationalization works in all platforms (including KDE4,
53    were it was faulty, and win32, where it was non-existent since
54    the 3.x series).
55  * The status line format string can also include the %w token
56    to show the number of words in the current document or selection
57    (can be slow).
58  * Search and replace is now limited to the selected block, if any.
60 5.1.0
61 -----
63 Fixes to the KDE4 driver:
65  * Underlined text works.
66  * Text fields in forms now have history.
67  * If no xserver can be contacted, fall back to the curses interface.
69 5.1.0-rc1
70 ---------
72  * KDE4 support.
73  * Rectangular block copy/paste support.
74  * New syntax highlight for the Euphoria language.
76 5.0.3
77 -----
79  * New action `open_under_cursor', that picks the word in the
80    current document under the cursor, accepts it as a document
81    name and tries to open it. If it's in the format string:number,
82    is accepted as a file name and a line number. It's bound by
83    default to `ctrl-enter' (`alt-enter' under Curses).
84  * The `grep' action bevahaviour has changed; instead of in a form,
85    matches are shown in a read-only document that is only closed
86    explicitly. Each change can be moved to by using the new
87    `open_under_cursor' (`ctrl-enter' or `alt-enter') action shown above.
88  * In a similar way, the `build' action also shows its output in a
89    read-only document instead of a form that is not automatically closed,
90    making the browsing and editing of compilation errors more useful.
91  * Forms in the Curses driver have changed their look. All fields in a
92    form are shown simultaneously on screen. This is one step to close
93    bug #1249.
94  * A set of character encoding converters have been natively implemented,
95    improving those platforms where the 'iconv' library is not available
96    (i.e. Windows and old Unix systems). The available encodings can be
97    shown by executing
99         dump(EMBEDDED_ENCODINGS);
101 5.0.2
102 -----
104  * New option to mark end of line characters, with its associated
105    configuration directive (mp.config.mark_eol).
106  * The end of line string (mp.config.eol) is now system-dependent (so,
107    on win32, it's set by default to \r\n).
108  * Copy and paste on GTK has been fixed (this was bug #1205).
109  * Fixed some redrawing issues (bug #1236 and others).
110  * Ctrl-keys no longer fail on GTK (bug #1252).
111  * New document _Minimum Profit Action Reference_.
112  * New action `build', for building Makefile-based projects. See the
113    action reference for details.
115 5.0.1
116 -----
118  * Improved line edition in the Curses interface (full edition plus file
119    expansion using the `tab' key in open / save file prompts).
120  * Auto-indenting is temporarily disabled while pasting (bug #1250).
121  * New document _Minimum Profit Function Reference_ (contributed by Lee Page).
123 5.0.0
124 -----
126  * The search hit is highlighted.
127  * When invoked from the menu, the `record_macro' action dropped
128    the last key (bug #1245).
129  * A Curses configuration detection has been fixed that made
130    some things behave strangely, as the drop-down menu not
131    responding under some terminal configurations (bug #1247).
132  * The Curses menu no longer crashes if it doesn't fit on
133    the screen (bug #1195).
134  * The -f (execute script) command line argument really works
135    (bug #1240).
136  * New manual page (bug #1219) and README files (bug #1218).
137  * Updated documents, _MPSL Overview_ and _Minimum Profit Cookbook_.
138  * New documents, _Minimum Profit Data Model_ and
139    _Creating interactive dialog boxes_.
141 5.0.0-rc3
142 ---------
144  * New session support. All open documents and its current position
145    can be stored / retrieved with the new `save_session' and
146    `load_session' actions. Two new configuration flags has
147    been added: `mp.config.auto_sessions', to automatically load / save
148    sessions, and `mp.config.local_sessions', to save sessions in the
149    currently active directory instead of in the home directory.
150  * Multiple key sequences for invoking actions (ala Emacs) are
151    now possible. To create them, just assign a hash to a keycode
152    instead of an action. For example, to assign the key sequence
153    Ctrl-x Ctrl-f to `open' and Ctrl-x Ctrl-s to `save', you can use
155         mp.keycodes['ctrl-x'] = {
156                 'ctrl-f'        => 'open',
157                 'ctrl-s'        => 'save'
158         };
160  * In the curses version, confirmations now have default values
161    (shown in brackets), activated with the ENTER key.
162  * New action `close_all', that closes all documents.
164 5.0.0-rc2
165 ---------
167  * New `complete' action, that asks for completion on the current
168    word using any of the words found in the same document.
169  * New `redo' action, to revert undo operations.
170  * The global configuration file `/etc/mp.mpsl' is also executed.
171  * In the `replace' action, the substitution string can contain
172    the special character &, that will be replaced by the matched
173    string (as in the `sed' command line tool).
175 5.0.0-rc1
176 ---------
178  * New support for translating key sequences into MP keycodes, mainly
179    for redefining ANSI sequences not supported by current terminfo /
180    termcap. For example, if your terminal sends the ANSI sequence [6;5~
181    whenever you press Ctrl+page down, you can add to your config file
182    the following line:
184         mp.add_keyseq("[6;5~", 'ctrl-page-down');
186  * A new `system_command' action, to pipe from and to system commands
187    (Closed bug #1120).
188  * A new `word_count' action, to count the number of lines and words
189    in a document (or in the selected block).
190  * Incorrect word wrapping has been fixed (Closed bug #1137).
191  * Search and replace expand backslashed characters like \n and \t
192    (Closed bug #1214).
193  * New timer functionality has been added; a user function can be called
194    each time a specified period of milliseconds have elapsed. If, for
195    example, you want to print a string on standard output each two
196    seconds, you can run
198         mp.timer(2000, sub { print("Hi, world!\n"); });
200 5.0.0-pre1
201 ----------
203  * Password-protected files fully work.
204  * Moving to next / previous instance of character (bound to ctrl-page-down
205    and ctrl-page-up) works (Closed bug #1131).
206  * Files open MUCH faster.
207  * Selection can be done by pressing shift + any movement key (Closed bug #1182).
208  * Dialog boxes work under Windows 98 (Closed bugs #1196, #1197).
209  * Block selection can be done by dragging the mouse (Closed bugs #1200, #1201).
210  * New `grep' functionality (Closed bug #1116).
211  * New action `sync' (save all modified documents, closed bug #1206).
212  * New action `document_list' (show a box with all open documents, allowing
213    the selection of the active one; closed bug #1211).
214  * Translations ported from mp 3.x (closed bug #1169).
215  * Most syntax highlight definitions ported from mp 3.x (closed bug #1168).
217 4.99.12
218 -------
220  * The menu in the Curses interface has been (finally) implemented.
221  * Interfaces have changed internally; a new driver function, mp.drv.form()
222    serves as a dialog box generic generator, resulting in more useful queries
223    for data (for example, all data required for a `replace' operation is
224    queried in only one dialog box). The Curses implementation, though
225    functional, is still just a wrapper to the old interface functions
226    and fields are queried one-by-one (which is annoying). This is an example
227    of a call to mp.drv.form(); the r variable will contain an array of 5
228    elements (one per widget) containing the values, or NULL if user cancelled:
230         local r = mp.drv.form( [
231         
232                 /* a 'text' widget */
233                 { 'label'       => "Replace this:",
234                   'type'        => 'text',
235                   'history'     => 'search',
236                   'value'       => 'THIS' },
237         
238                 /* another one */
239                 { 'label'       => "With:",
240                   'type'        => 'text',
241                   'history'     => 'replace',
242                   'value'       => 'THAT' },
243         
244                 /* a 'password' widget */
245                 { 'label'       => 'Password:',
246                   'type'        => 'password' },
247         
248                 /* a 'checkbox' widget */
249                 { 'label'       => "Case sensitive:",
250                   'type'        => 'checkbox',
251                   'value'       => mp.config.case_sensitive_search },
252         
253                 /* a 'list' widget */
254                 { 'label'       => 'All C files:',
255                   'type'        => 'list',
256                   'list'        => glob('*.c'),
257                   'value'       => 10 }
258         ] );
260  * Password protecting files works (but they cannot be opened yet, so this
261    is far from useful, unless you use mp 3.x to open them).
262  * Case sensitivity in searches can be controlled with the new
263    config flag mp.config.case_sensitive_search.
264  * Replace (and global replace by use of the new config flag
265    `mp.config.global_replace') works.
267 4.99.11
268 -------
270  * Syntax highlight definition have changed (again, hopefully for the last
271    time). Definitions are now an array of attribute name / regexes in which
272    the order is significative.
273  * Template insertion works.
274  * Tag selection (open the file where a symbol is defined) works.
275  * Symbol completion (using tags) works.
276  * Closed bugs #1159, #1158, #1153, #1161.
278 4.99.10
279 -------
281  * A big advance in the Curses interface; alerts, confirmations, and open
282    file, save file, search and generic prompts are working. Still lacking
283    the selection lists (as the rest of interfaces) and the menu.
284  * Improved menus; if an invalid action is added to a menu, it's shown
285    followed by a ?; if a key is bound to that action, it's shown between
286    square brackets.
287  * For systems lacking iconv support (MS Windows), a crappy, ad-hoc utf-8
288    converter has been added. This means that hitting `escape' and typing
289    `encoding('utf-8');' makes reading and writing utf-8 encoded files
290    possible on every system.
291  * New action `join_paragraph', to join current paragraph all in one line.
292  * New action `word_wrap_paragraph', that re-word-wraps current paragraph.
293    Word wrapping must be set ('mp.config.word_wrap = number;') for this to
294    work.
296 4.99.9
297 ------
299  * The GTK and win32 drivers now include a native open/save file dialog.
300  * Interactive help (help for the word under the cursor, triggered by
301    pressing `f1') works.
302  * The menu in GTK and win32 works.
303  * New icon!
304  * Some bugs that caused random crashes has been fixed.
305  * New action `exec-doc', that executes the active open document as
306    MPSL code.
308 4.99.8
309 ------
311  * New configuration option `mp.config.tabs_as_spaces', to store tabs
312    as spaces.
313  * Each syntax highlight definition can contain an optional function
314    called detect() that receives the document as argument and can be used
315    to tailor special detection rules.
316  * A big part of the internal storage of colors and attributes have
317    been rewritten to make it more dynamic.
318  * Tag target for the word over the cursor is shown in the status line.
319  * Move word left works.
320  * Opening an already open file makes it the active one instead of
321    re-opening it.
322  * The `execute code' action has been remapped from `ctrl-f1' to escape.
323  * Spellchecking via ispell works (though it's SLOW!). Activate it by
324    hitting escape and typing:
326         mp.ispell(1);
328  * By default, files are now unlinked before (re)written. File permissions
329    and ownership are restored if available. This behaviour can be disabled
330    by setting `mp.config.unlink' to zero.
331  * The GTK driver drawing code has been optimized, so it's much more
332    responsive now.
334 4.99.7
335 ------
337  * The `modified' flag of documents is maintained, so now closing files
338    with pending modifications ask for confirmation. Also, the %m status
339    line directive works (marking modified files with an asterisk).
340  * Flex and bison are no longer needed to build.
341  * The `close window' button in GUIs (win32 and GTK) now generate the
342    special keycode `close-window'.
343  * The `exit' action now closes all open documents, asking for saving
344    confirmation on those modified.
345  * Temporary versions of the `open' ans `save' actions (using
346    mp.drv.readline() instead of an ad-hoc open file dialog) have
347    been implemented.
348  * The GUI interfaces now can have their font preferences configured
349    by using mp.config.font_face and mp.config.font_size.
350  * The actions `zoom-in' and `zoom-out' (font size rescaling, bound to
351    `f11/f12' and `ctrl-kp-minus/ctrl-kp-plus') have been implemented.
352  * New mouse-related actions; `move-to-mouse-position', `move-mouse-wheel-up'
353    and `move-mouse-wheel-down'.
355 4.99.6
356 ------
358 This is an EXPERIMENTAL version for evaluation purposes only. There are
359 many things that aren't implemented, others fail miserably and many more
360 do it incorrectly. Basically, what is known to work is:
362  * Basic text editing fully works. I've been using it for six months or so
363    to maintain itself, and there has not been a crash in three months,
364    more or less.
365  * Scripting works fine (90% of Minimum Profit 5.x itself is implemented
366    in MPSL, its internal scripting language).
367  * Undo works fine. It's bound to ctrl-z.
368  * Works cleanly in an UTF-8 environment.
370 I do development on the GTK version, so it's where it works best. The
371 curses version lacks many of the interface (alerts, confirmations,
372 asking for text, etc.), so it's barely usable. The win32 version seem
373 to work, but it needs to be manually installed and probably need some
374 tweaking.
376 What it doesn't work:
378  * The dialogs to open or save a file by its name aren't implemented.
379    There are workarounds for this: files can be opened from the command
380    line and save works correctly if the edited file has a name. Also,
381    files can be opened by hitting `ctrl-f1' (execute script code) and
382    typing:
384         mp.open("file-to-be-opened");
386  * There is no menu.
387  * No ispell support.
388  * No password protected files.
389  * No grep.
390  * No external commands (so no support for help, tags, etc.).
391  * Some movement commands as moving a word left, moving to matching
392    brackets, etc. are still not implemented.
393  * Only a few syntax highlight definitions are implemented.
394  * Many other things I cannot remember.
396 Documentation is still scarce: the more interesting bits are inside the
397 mpsl/doc directory. This is where the scripting language is documented,
398 with some basic overviews and implementation notes (there is even an
399 embryo of a PostScript quick reference guide).
401 Customizing can be done by writing MPSL commands in the ~/.mp.mpsl file,
402 which is read on startup.
404 I have not tried to optimize the internal engine, so it's probably some
405 magnitudes slower than the 3.x version.