Help with the docs [was Re: Curious about next version ...]

[Joerg Fischer]

Offer Kaye wrote:

>Probably morally wrong of me to ask other people to contribute time
>and effort to a project they won't get paid for, so I volunteer to
>help with the new docs, if a NEdit ever gets new life. At least I
>can help a little :)

Great. To give you a few ideas (where I have none), I think the
description of the filename_dialog() function isn't good. 

IMO an older problem is the whole section about the action routines
(Help -> Macro/Shell Extensions -> Action Routines). Problems I see
there are:

    - an unclear structure, "Actions Representing Menu Commands",
      then "Menu Action Routine Arguments", now "--Some notes on
      argument types above--" followed by "Window Preferences
      Actions" pluged in the middle of somewhere and finally
      "Keyboard-Only Actions". Adding to this is that the actions
      for copy, cut and paste, while clearly represented in the Edit
      menu, are listed under the "Keyboard-Only Actions".

    - The introduction says all actions can be called from both
      macros and translation table entries. This is true, but
      unfortunately there are some actions (grab_focus() is only one
      of them) that make only sense when bound to a key or even a
      mouse event. Calling them in macros doesn't give the possibly
      expected result.

    - Why are pure mouse actions like secondary_start() listed under
      the heading "Keyboard-Only Actions"?  

Hm, btw talking about it, what does "Keyboard-Only Actions" really
mean, considering that these are *not* actions that can only be
bound to key(board) events. And "Actions Representing Menu Commands"
are also bound to shortcuts, aren't they. So what's the difference
between uppercase() bound to Ctrl+6 but listed under "Actions
Repr..." and copy_clipboard() represented in the Edit menu as "Copy
Ctrl+C" but listed under "Keyboard-Only..."?

(Are you still volunteering?)

Cheers,
Jörg