(expand on the idea of a SIMPLE problem statement)
Line 6:
Line 6:
While the scripts in this tip may be very useful, nobody who isn't familiar with the subject matter will know what they do or why. This tip may need:
While the scripts in this tip may be very useful, nobody who isn't familiar with the subject matter will know what they do or why. This tip may need:
−
*a problem statement telling what the problem is that is solved by this tip
+
*a problem statement explaining—inlayman's terms—what the problem is that is solved by this tip
*a "do it yourself" example showing how to do it manually without a complicated script, and telling why this may not be sufficient
*a "do it yourself" example showing how to do it manually without a complicated script, and telling why this may not be sufficient
*explanations of how the script works at a basic level
*explanations of how the script works at a basic level
Latest revision as of 02:45, October 7, 2011
This template is for tips that have too much script and not enough explanation. While it is nice to be able to provide a buffet of useful tidbits that people can just grab and use (indeed, this was a big part of the "old" Vim Tips database on vim.org), on the wiki we strive to also be a learning resource.
More explaining please!
While the scripts in this tip may be very useful, nobody who isn't familiar with the subject matter will know what they do or why. This tip may need:
a problem statement explaining—in layman's terms—what the problem is that is solved by this tip
a "do it yourself" example showing how to do it manually without a complicated script, and telling why this may not be sufficient
explanations of how the script works at a basic level
comments in the script itself for the complicated bits
