From 2fa6697071afddc0f73a25b3ef35008d51e50974 Mon Sep 17 00:00:00 2001 From: Bailey Ling Date: Sat, 21 Sep 2013 15:35:53 -0400 Subject: [PATCH] add documentation about predefined parts. resolves #267. --- doc/airline.txt | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/doc/airline.txt b/doc/airline.txt index 6660183..743bae8 100644 --- a/doc/airline.txt +++ b/doc/airline.txt @@ -393,6 +393,21 @@ same `foo` part. Note: Look at the source code and tests for the full API. +------------------------------------- *airline-predefined-parts* +Before is a list of parts that are predefined by vim-airline. + +* `mode` displays the current mode +* `iminsert` displays the current insert method +* `paste` displays the paste indicator +* `filetype` displays the file type +* `readonly` displays the read only indicator +* `file` displays the filename and modified indicator +* `ffenc` displays the file format and encoding + +And the following are defined for their respective extensions: + +`hunks`, `branch`, `tagbar`, `syntastic`, `whitespace` + ------------------------------------- *airline-sections* Once a part is defined, you can use helper functions to generate the statuslines for each section. For example, to use the part above, we could