Friday, May 28, 2010

Re: Formatting help files

Pablo Giménez wrote:
> Hi.
> I have some help files along with my scripts and I wanto give them a better
> formatting.
> So far the text layout is not too bad, but I am wondering is there is
> anyway to make some letter to appear as bold or italic, like when you write
> a wiki.
> Is this possible with vim help files format????

Pablo,
You might have a look at the following plugin:

Txtfmt (The Vim Highlighter)
http://www.vim.org/scripts/script.php?script_id=2208

Txtfmt can be used either as a standalone filetype, or in conjunction
with other filetypes (e.g., Vim "help"), to beautify your documents with
word processor style highlighting. Txtfmt allows you to create arbitrary
regions involving any combination of bold, underline, italic, etc..., as
well as both foreground and background colors. The following site
contains screenshots. (Note that there are multiple tabs in addition to
"Home": the "ywchaos", "Jnl and Txtfmt" and "ywtxt" tabs show Txtfmt
regions supplementing the statically-defined regions of other
wiki/journal filetypes.)

http://www.txtfmt.webs.com/

To use Txtfmt within a Vim help file, you would need to set the filetype
to help.txtfmt. One way to do this would be with the following modeline:

vim:ft=help.txtfmt

If you decide to give it a try, there's a "Quick-Start Tutorial" on the
download page that explains how to add the highlighting regions. Let me
know if anything is unclear...

Sincerely,
Brett Stahlman

> thanks
>

--
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

No comments:

Post a Comment