Yegappan Lakshmanan is the maintainer of the Vim FAQ at

http://www.geocities.com/yegappan/vim_faq.txt

The HTML version is at

http://vimdoc.sourceforge.net/htmldoc/vimfaq.html

Yegappan has asked me for ideas on moving the FAQ to the Vim Tips wiki.
Please have a look at the FAQ and let me know what you think is the best way
to proceed. Following is one fairly obvious plan, to get discussion started.

The FAQ has around 700 lines in the TOC, and 7000 lines in the body. It
consists of 37 sections that vary from about 30 lines to 900 lines, with an
average of 200 lines.

Proposal: Put each section in its own tip page, using the convention of
naming each tip
    FAQ Title of section

Currently, each section is numbered. I propose removing that number.

 ---Example extract from FAQ---
 SECTION 1 - GENERAL INFORMATION
     1.1. What is Vim?
     1.2. Who wrote Vim?
 ...
 SECTION 2 - RESOURCES
     2.1. Where can I learn more about Vim?
     2.2. Is there a mailing list available?
 ---end---

We would make wiki pages with the following titles:

    FAQ Introduction and contents
    FAQ General information
    FAQ Resources

The "FAQ Introduction and contents" page would briefly state that this is
the Vim FAQ, moved to the wiki. Then it would list the section names as
clickable links to the other pages (just the 37 sections, not the
subsections). The wikitext might be as simple as:

    #[[FAQ General information]]
    #[[FAQ Resources]]

The "FAQ General information" page would be section 1 and would start with a
TOC for its section (list of its subsections). It would NOT mention "section
1" anywhere, so the list of subsections would start like this:

     1. What is Vim?
     2. Who wrote Vim?

The html version of the FAQ (URL above) has lots of links. I'm not sure how
achievable that would be, but it's clearly what we should have.

I envisage that some scripts would prepare the wiki pages from the text in
vim_faq.txt.

Please comment on the plan. I assume we want the FAQ? Any ideas for the
import procedure? There would probably be quite a bit of duplication between
existing tips and the FAQ. Presumably we would live with that.

One drawback is that people would no longer be able to download the complete
FAQ (I suppose the original would still be available, but I believe Yegappan
wants the community to maintain the FAQ in the future, and I think the only
changes would be on the wiki). Being able to download the complete FAQ is
probably not as important as it once was, so that limitation would be ok?

John

_______________________________________________
Vim-l mailing list
[email protected]
http://lists.wikia.com/mailman/listinfo/vim-l

Reply via email to