sponsor Vim development Vim logo Vim Book Ad

Preamble : Automatically folds long licensing and copyright preambles that head sources.

 script karma  Rating 6/5, Downloaded by 215    Comments, bugs, improvements  Vim wiki

created by
Mel Davis
 
script type
utility
 
description
This plugin will automatically fold long preambles, such as GPL copyright
notices, located at the head of source files.  You may find it helpful if,
like me, you use syntax folding infrequently.

Very often, I read third-party library sources and examples, such as Nokia's
Qt library, various GNU utilities, and many others.  I want to see the
functions and read the comments but not the 50 lines of licensing and
copyright notices that head every file. Because these are third-party
sources, I do not want to modify the files to include Vim fold markers.

WHAT IT DOES:

This plugin does not use fold markers and does not modify files.
It adds the fold by changing the foldmethod to "manual" and inserting a
manual fold.

If the foldmethod is 'syntax', the plugin will do nothing except try to
close the fold on line 1, if one exists.  No fold is created and the
foldmethod is not changed.

The preamble has to start at the top of the file, but may be preceded by
empty lines.  It will consist of leading blank lines followed by lines
with comments starting in column one. The preamble will stop at the first line
not having a comment in the first column.  

Note: If the preamble uses 'c' style comments without a border of characters
in column 1 the preamble will not be recognized.

 
install details
The vimball archive contains 2 files:  
    autoload/Preamble.vim
    doc/Preamble.txt

Install using the Vimball plugin by typing:
    vim Preamble.vba
       :so %
       :q

For automatic folding, add a line to your .vimrc file, such as:
    call Preamble#Enable('cpp,java')

For more info on usage and options, type:   :help preamble
 

rate this script Life Changing Helpful Unfulfilling 
script versions (upload new version)

Click on the package to download.

package script version date Vim version user release notes
Preamble.vba 0.1 2010-01-06 7.0 Mel Davis Initial upload
ip used for rating: 50.19.169.37

If you have questions or remarks about this site, visit the vimonline development pages. Please use this site responsibly.
Questions about Vim should go to the maillist. Help Bram help Uganda.
   
SourceForge.net Logo