Re: How plugin writers write help document?

On 01/09/13 14:39, othree wrote:
> Hi All
>
> I have maintain several plugins.
>
> But some of them don't have Vim style document.
> I am wondering is there any support tool for write vim document.
> Or is there any good practice while writing Vim style document.
>
>
> Thanks.
>

Any script to be used with Vim (global plugin, filetype plugin, syntax
script, indent script, etc.) may (and IMHO should) have its own
documentation. Vim can be used to write the help.

A very short "help about writing help" is at ":help write-local-help"
(without quotes of course). There are things it doesn't explain: for
instance, "blue" (example) text starts (IIUC) at the first nonempty line
following a line ending in the character > and ends at the line
preceding the first empty line or line starting with < (whichever comes
first) after that. These > and < markers themselves are usually
highlighted as "invisible" (unless a non-default colorscheme makes them
visible).

To find about "good help writing practices" you should complement
reading the above-mentioned paragraph (which IMHO is a must) bu looking
at how the helpfiles distributed with Vim and with the third-party
plugins which have them are written.


Best regards,
Tony.
--
I always will remember -- I was in no mood to trifle;
'Twas a year ago November -- I got down my trusty rifle
I went out to shoot some deer And went out to stalk my prey --
On a morning bright and clear. What a haul I made that day!
I went and shot the maximum I tied them to my bumper and
The game laws would allow: I drove them home somehow,
Two game wardens, seven hunters, Two game wardens, seven hunters,
And a cow. And a cow.

The Law was very firm, it People ask me how I do it
Took away my permit-- And I say, "There's nothin' to it!
The worst punishment I ever endured. You just stand there lookin' cute,
It turns out there was a reason: And when something moves, you shoot."
Cows were out of season, and And there's ten stuffed heads
One of the hunters wasn't insured. In my trophy room right now:
Two game wardens, seven hunters,
And a pure-bred guernsey cow.
-- Tom Lehrer, "The Hunting Song"

--
--
You received this message from the "vim_use" 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

---
You received this message because you are subscribed to the Google Groups "vim_use" group.
To unsubscribe from this group and stop receiving emails from it, send an email to vim_use+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.