On Thu, Apr 11, 2013 at 11:02 AM, Matt Wilkie <[email protected]> wrote:
> > It seems to me that "screencast style" would be much better for *all*
> tutorial descriptions
>
> That was my thought when I read this script. Previously I didn't know
> about incremental search at all (or managed to forget because I didn't
> understand it before)
>
OMG, the new screencast-script style is a revolution in documentation.
One of the most important pieces of advice in the Camtasia tutorials is,
"don't explain everything". This, combined with a minimalist (or cookbook)
style, actually makes documentation readable! In fact, this style will
often suffice even without screencasts.
Imo, it should be used *everywhere* in Leo's documentation. As part of the
"explaining what we already have" project, I plan to rewrite the docstrings
of the most important plugins to use this style.
Rev 5673 changes the apropos-find-commands to the following. It is a huge
improvement over the previous unreadable mess. It looks even better when
rendered. The rendered line-breaks are as shown, which is surprisingly
important. Note all the details that *aren't* shown: the corresponding key
bindings, alternative (and never used) commands, etc. etc.
Finding text
------------
**Ctrl-F** starts searching.
The cursor moves to the minibuffer.
To abandon a search, type **Ctrl-G**.
The Find Tab shows the present settings.
Underlined characters are keyboard hints:
**Alt-Ctrl-W** toggles the Whole Word checkbox, and so on.
Type the search string in the minibuffer.
Type the **Enter** key to start the search.
Once searching has begun:
**F3** searches again.
**F2** searches backwards.
Replacing text
--------------
Type **Ctrl-F** and enter the find string as before.
Type **Ctrl-R** instead of **Enter**.
Type the replacement string.
The **Enter** key starts the search.
When a match is found:
The **=** key makes the replacement.
The **-** key replaces and finds again.
The **F2** and **F3** keys work as before.
Incremental searching
---------------------
**Alt-S** starts an incremental search.
**Alt-R** starts a reverse incremental search.
Any characters you type extend the search.
**Backspace** retracts the search.
During an incremental search:
**Enter** or **Ctrl-G** stops the search.
**Alt-S** finds the search string again.
**Alt-R** does the same during a reverse search.
This should be enough to get everyone started with all these commands. I'd
say this is the most effective documentation I have ever written.
Edward
--
You received this message because you are subscribed to the Google Groups
"leo-editor" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/leo-editor?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.
