runtime(doc): tweak documentation style
closes: #18284 Signed-off-by: Hirohito Higashi <h.east.727@gmail.com> Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
committed by
Christian Brabandt
parent
e8bbdb90e4
commit
450d59145e
@ -1,27 +1,27 @@
|
||||
*ft_hare.txt* Support for the Hare programming language
|
||||
|
||||
==============================================================================
|
||||
CONTENTS *hare* *hare.vim*
|
||||
CONTENTS *hare* *hare.vim*
|
||||
|
||||
1. Introduction |ft-hare-intro|
|
||||
2. Filetype plugin |ft-hare-plugin|
|
||||
3. Haredoc filetype |ft-haredoc-plugin|
|
||||
4. Indentation settings |ft-hare-indent|
|
||||
5. Compiler support |compiler-hare|
|
||||
1. Introduction |ft-hare-intro|
|
||||
2. Filetype plugin |ft-hare-plugin|
|
||||
3. Haredoc filetype |ft-haredoc-plugin|
|
||||
4. Indentation settings |ft-hare-indent|
|
||||
5. Compiler support |compiler-hare|
|
||||
|
||||
==============================================================================
|
||||
INTRODUCTION *ft-hare-intro*
|
||||
INTRODUCTION *ft-hare-intro*
|
||||
|
||||
This plugin provides syntax highlighting, indentation, and other supporting
|
||||
functionality for the Hare programming language.
|
||||
|
||||
|
||||
FILETYPE PLUGIN *ft-hare-plugin*
|
||||
FILETYPE PLUGIN *ft-hare-plugin*
|
||||
|
||||
This plugin has a few different variables that can be defined inside your
|
||||
|vimrc| to tweak its behavior.
|
||||
|
||||
Additionally, support is provided for folding `{ }` blocks. To enable folding,
|
||||
Additionally, support is provided for folding `{ }` blocks. To enable folding,
|
||||
add the following to a file inside your |after-directory| (e.g.
|
||||
~/.vim/after/ftplugin/hare.vim): >
|
||||
|
||||
@ -30,7 +30,7 @@ add the following to a file inside your |after-directory| (e.g.
|
||||
Because block-based folding tends to create many small folds, consider setting
|
||||
a few related options, such as 'foldminlines' and 'foldnestmax'.
|
||||
|
||||
*g:hare_recommended_style*
|
||||
*g:hare_recommended_style*
|
||||
The following options are set by default, in accordance with Hare's official
|
||||
style guide: >
|
||||
|
||||
@ -44,29 +44,29 @@ To disable this behavior, add the following to your |vimrc|: >
|
||||
|
||||
let g:hare_recommended_style = 0
|
||||
<
|
||||
*g:hare_symbol_operators*
|
||||
*g:hare_symbol_operators*
|
||||
By default, symbolic operators do not receive any special highlighting (with
|
||||
`!`, `?`, and `::` being the only exceptions). To enable syntax highlighting
|
||||
for most other operators, add the following to your |vimrc|: >
|
||||
|
||||
let g:hare_symbol_operators = 1
|
||||
<
|
||||
*g:hare_space_error*
|
||||
*g:hare_space_error*
|
||||
By default, trailing whitespace and spaces followed by <Tab> characters will
|
||||
be highlighted as errors. This is automatically disabled in Insert mode. To
|
||||
be highlighted as errors. This is automatically disabled in Insert mode. To
|
||||
turn off this highlighting completely, add the following to your |vimrc|: >
|
||||
|
||||
let g:hare_space_error = 0
|
||||
|
||||
|
||||
HAREDOC FILETYPE *ft-haredoc-plugin*
|
||||
HAREDOC FILETYPE *ft-haredoc-plugin*
|
||||
|
||||
This plugin will automatically detect README files inside Hare modules, using
|
||||
a recursive directory search, and give them the "haredoc" filetype. Because
|
||||
a recursive directory search, and give them the "haredoc" filetype. Because
|
||||
this is such a common filename, this plugin only searches for Hare source
|
||||
files within the same directory by default.
|
||||
|
||||
*g:filetype_haredoc*
|
||||
*g:filetype_haredoc*
|
||||
The |g:filetype_haredoc| variable can be used to tweak the depth of this
|
||||
search, or bypass the detection of Hare documentation files altogether:
|
||||
|
||||
@ -80,13 +80,13 @@ The search depth may be any positive integer, but values higher than `2` are
|
||||
unlikely to provide a tangible benefit in most situations.
|
||||
|
||||
|
||||
INDENTATION SETTINGS *ft-hare-indent*
|
||||
INDENTATION SETTINGS *ft-hare-indent*
|
||||
|
||||
Unlike most other settings for this plugin, the indentation settings may also
|
||||
be set per-buffer, overriding any global configuration that exists. To do
|
||||
be set per-buffer, overriding any global configuration that exists. To do
|
||||
this, simply prefix the variable with |b:| instead of |g:|.
|
||||
|
||||
*g:hare_indent_match_switch*
|
||||
*g:hare_indent_match_switch*
|
||||
By default, continuation lines for "match" and "switch" conditions are
|
||||
indented only one level: >hare
|
||||
|
||||
@ -101,7 +101,7 @@ and "for" conditions, add the following line to your |vimrc|: >
|
||||
|
||||
let g:hare_indent_match_switch = 2
|
||||
<
|
||||
*g:hare_indent_case*
|
||||
*g:hare_indent_case*
|
||||
By default, continuation lines for cases in "match" and "switch" expressions
|
||||
are indented two levels, to visually distinguish them from the body of the
|
||||
case: >hare
|
||||
@ -114,21 +114,21 @@ If you prefer a different amount of indentation, you can adjust it using
|
||||
|g:hare_indent_case|. Valid values include `0`, `1`, and `2`.
|
||||
|
||||
|
||||
COMPILER SUPPORT *compiler-hare*
|
||||
COMPILER SUPPORT *compiler-hare*
|
||||
|
||||
If this plugin detects a Makefile in the current directory, it will assume you
|
||||
wish to use `make` for your build system, and will leave 'makeprg' untouched.
|
||||
Otherwise, `hare build` will be used.
|
||||
|
||||
*g:hare_makeprg_params*
|
||||
*g:hare_makeprg_params*
|
||||
When `hare build` is used, additional compiler options may be appended to
|
||||
'makeprg' with the |g:hare_makeprg_params| variable. It may also be set on a
|
||||
'makeprg' with the |g:hare_makeprg_params| variable. It may also be set on a
|
||||
per-buffer basis (using |b:| instead of |g:|), overriding any global
|
||||
configuration that exists. For example: >
|
||||
configuration that exists. For example: >
|
||||
|
||||
let b:hare_makeprg_params = '-lc -t o'
|
||||
|
||||
The global default is "-q", to suppress writing to stdout while building.
|
||||
|
||||
==============================================================================
|
||||
vim:ft=help:noet:ts=8:tw=78:norl:
|
||||
vim:tw=78:ts=8:noet:ft=help:norl:
|
||||
|
||||
Reference in New Issue
Block a user