On Thu, Sep 20, 2012 at 3:31 PM, Andy Wokula <[email protected]> wrote: > Am 09.09.2012 16:17, schrieb Bram Moolenaar:> > >> Simon Ruderich wrote: >> >>> On Wed, Sep 05, 2012 at 02:27:43PM +0200, Bram Moolenaar wrote: >>>> >>>> By putting commands in backticks we can make the difference. I was >>>> wondering if this would cause problems somewhere, thus I changed a few >>>> places to use backticks. It seems to be OK, thus we could do this for >>>> all the help files. >>> >>> >>> While looking at the help files I found two problems I'm not sure >>> how to handle. >>> >>> Should examples like ":au group ..." also be put in backticks, >>> e.g. `:au group ...` (which is not colored at the moment) or only >>> commands, e.g ":autogroup" -> `:autogroup` - and stuff like ":au >>> group ..." stays in quotes. >> >> >> Every command a user would type should be in single quotes. But not >> option values, command output, etc. >> >>> Related to this is e.g. ":{range}!cmd" which is not a tag and >>> can't be followed with Ctrl-], should it be put in `..`? Same for >>> "caw" for which no help is available. >>> >>> In short, should all `..` point to tags, and what to do with the >>> commands which don't have a tag? >> >> >> No, the backticks are not for tags but for commands. We may need to >> change the way tags are extracted in help files so that using CTRL-] on >> the command inside backticks works. > > > Now `sequence` is for commands the user can type, or a sequence of > commands. I found that also many |:cmd| notations have been turned > into `:cmd`. Isn't this bad? Now CTRL-] on `sequence` sometimes > works (basic command) and sometimes not (sequence of commands, command > with arguments, etc). > > Wouldn't it be better to keep the |:cmd| notation when possible?
There has been several threads about `...` in help files. I'm confused myself too as to when `...` should be used. When to use them (or not use them) should be documented ":help help-writing" seems like the right place. Right now, `...` is undocumented, which is unusual for Vim. Regards -- Dominique -- You received this message from the "vim_dev" maillist. Do not top-post! Type your reply below the text you are replying to. For more information, visit http://www.vim.org/maillist.php
