[Vim-l] Ideal Tip and links to Help

John Beckett johnb.beckett at gmail.com
Sat Jun 16 02:32:36 UTC 2007


Some tips have a link to online Help, for example:
http://vim.wikia.com/wiki/VimTip398

---begin extract---
Refs: 

 {{help|register}}
 {{help|recording}}
---end---

Let's take VimTip398 and make it our short-term "ideal" format.
Ignore the content, just fix the layout as a model.

When editing I suggest no blank line after "Refs:".
Is that ok?

Is it "Refs:" or "See:" or "Reference:" or ...?
Or "==References=="?

Is there a way to handle help links including punctuation?
For example, how could you make the following work?

 {{help|*}}
 {{help|#}}
 {{help|g*}}
 {{help|g&#}}
 {{help|<S-LeftMouse>}}
 {{help|<S-RightMouse>}}

See following for where these would be useful:
http://vim.wikia.com/wiki/VimTip5

What about import comments?
<!-- parsed by vimtips.py in 0.480768  seconds-->

Yes, you only see this when editing, but I like things clean,
or at least I'd like a reason keep it. So, I propose deleting
the "parsed by" comments when editing.

John



More information about the Vim-l mailing list