From 8af6d322ef3523f2813d6b3dbd7bebaf9e3e1090 Mon Sep 17 00:00:00 2001 From: marty Date: Tue, 11 Aug 2009 21:09:30 +1200 Subject: [PATCH] update the intro in the doc --- doc/syntastic.txt | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/doc/syntastic.txt b/doc/syntastic.txt index 59d503e0..d61b0b03 100644 --- a/doc/syntastic.txt +++ b/doc/syntastic.txt @@ -34,16 +34,32 @@ CONTENTS *syntastic-contents* 1. Intro *syntastic-intro* Syntastic is a syntax checking plugin that runs buffers through external syntax -checkers as they are saved and opened. If syntax errors are detected, -the user is notified and is happy because they didn't have to compile their -code or execute their script to find them. +checkers as they are saved and opened. If syntax errors are detected, the user +is notified and is happy because they didn't have to compile their code or +execute their script to find them. + +Syntastic comes in two parts: the syntax checker plugins, and the core script +(i.e. syntastic.vim). The syntax checker plugins are defined on a per-filetype +basis where each one wraps up an external syntax checking program. The core +script delegates off to these plugins and uses their output to provide the +syntastic functionality. Currently, syntax checking plugins exist for eruby, +haml, html, javascript, php, python, ruby and sass. + +If your language is not supported then see |syntastic-syntax-checkers| for +details on how to implement a syntax checking plugin, and be sure to send me a +patch ;-) + +This plugin is currently only recommended for *nix users. It is functional on +Windows, but since the syntax checking plugins shell out, the command window +briefly appears whenever one is executed. + ============================================================================== 2. Functionality provided *syntastic-functionality* By default, the script does nothing. The following functionality is provided -and must be enabled/activated as indicated (see the sections below for more in -depth descriptions): +and must be enabled/activated as indicated (see the sections below for more +in-depth descriptions): * A statusline flag appears when syntax errors are detected * |signs| are placed beside lines with syntax errors, where a different sign is used for errors and warnings.