[Vim-l] Titles project

Santhalus santhalus at gmail.com
Thu Oct 4 09:04:06 UTC 2007


John Beckett wrote:
> Santhalus wrote:
>> Some quick suggestions below.
> 
> Thanks for your suggestions. Please review the following.
> 
> Also, think about the "Integrate" titles. Following are some
> examples, but there are more in the full list. Perhaps the first
> couple of the following should omit "gvim"?

I generally agree although this may often depend on the tip content.
Some tips are really created with special build in mind (console vim,
gvim, windows, linux, cygwin etc.) and ommitting this from tip title
would defeat it's purpose.
OTOH, we could use categories instead (as Sebastian suggested for
Windows - maybe create "Console Vim" and "GVim") but then not all
users search by categories.


Some thoughts on the title format:

I tried to keep the tip style "Do something [with something] [to do
something] [somehow]", hence the word "Use".

I think "Use" is OK with short titles and with long titles it's better
to think how reword the title anyway:
Perhaps:
819 Shortcut keys to minimize and restore gvim under Windows
--> 819 Minimize and restore gvim under Windows using shortcut keys
--> 819 Control gvim window under Windows using shortcut keys


I'm not sure about the "-ing" form. Do you want to change all titles
to "-ing" or have rules when to keep each?

IMO, the imperative form feels more tip-like, and the gerund would be
more in place in a tutorial/reference style. This may be also tip
dependent - some tips are not really tips but short tutorials. In that
case, it seems better to keep a short title and "-ing" form. Maybe we
could put them in a special "tutorial" namespace for better
distinction in future?


> 376 A totally useless tip...or is it ?
> 376 A totally useless tip
> --> 376 Build vim with your name included
> # Sebastian has suggested deleting this tip.
> # I will add {{delete}} if you don't object.
What about making it more general, like:
--> 376 Build Vim with custom features
--> 376 Build your custom version of Vim
I could not find a tip which would tell me how to do that (different
build options, tweaking feature.h etc.). I thought this tip could make
a good starting point, after some improvement.


> 
> 818 Vim/GVim as Diff tool for TortoiseCVS
> 818 Diff for TortoiseCVS
> ?? 818 Integrate with TortoiseCVS
> # Propose this again if you still believe the tip is about
> # integration. I thought maybe the point was that the tip
> # used Vim for a *diff* tool, which could be useful with
> # utilities other than TortoiseCVS.
To be precise this tip is more about TortoiseCVS than Vim - it is
about how to integrate TortoiseCVS with external diff tools, not
necessarily Vim.
What about:
--> 818 Integrate vim diff with TortoiseCVS

But then we could add another tip "Use vim as your diff tool"
explaining the use of vim diff feature.

> 
> 1228 Completion popup selection like other IDEs
> 1228 Completion popup selection
> NO 1228 Make completion popup work like in other IDEs
> # Can we debate this further please.
> # Several of the old titles refer to making Vim work like some
> # other system, but I don't see how that helps the reader.
> # You might call this tip "Improve completion popup selection"?
> # I proposed the simpler title (without "Improve") because the
> # tip should evolve to explaining the issue.
> # Propose this again if you still want it.
Many users are used to certain popular standards (Visual Studio,
Eclipse, Notepad) and often want to tweak vim to behave that way.
Mentioning other systems in a tip could help them track it.
But I agree that in this particular case it may not tell much. OTOH,
"Completion popup selection" is a little cryptic to me at first sight.
What about more general:
--> 1228 Improve completion popup menu.
--> 1228 Improve completion popup menu behaviour.
--> 1228 Tweak completion popup menu.
--> 1228 Improve completion behaviour.


I'm OK with your other comments.

Regards,
Santhalus





More information about the Vim-l mailing list