runtime(doc): Whitespace updates
Use double sentence spacing and wrap lines at 'textwidth'. Code examples and tables were not wrapped unless this had already been done locally. closes: #18453 Signed-off-by: Doug Kearns <dougkearns@gmail.com> Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
Doug Kearns
committed by
Christian Brabandt
Christian Brabandt
parent
2a33b499a3
commit
c58f91c035
@ -130,7 +130,7 @@ CTRL-R {register} *i_CTRL-R*
|
||||
'.' the last inserted text
|
||||
*i_CTRL-R_-*
|
||||
'-' the last small (less than a line) delete
|
||||
register. This is repeatable using |.| since
|
||||
register. This is repeatable using |.| since
|
||||
it remembers the register to put instead of
|
||||
the literal text to insert.
|
||||
*i_CTRL-R_=*
|
||||
@ -167,12 +167,12 @@ CTRL-R CTRL-R {register} *i_CTRL-R_CTRL-R*
|
||||
CTRL-R CTRL-O {register} *i_CTRL-R_CTRL-O*
|
||||
Insert the contents of a register literally and don't
|
||||
auto-indent. Does the same as pasting with the mouse
|
||||
|<MiddleMouse>|. When the register is linewise this will
|
||||
|<MiddleMouse>|. When the register is linewise this will
|
||||
insert the text above the current line, like with `P`.
|
||||
The '.' register (last inserted text) is still inserted as
|
||||
typed.
|
||||
After this command, the '.' register contains the command
|
||||
typed and not the text. I.e., the literals "^R^O" and not the
|
||||
typed and not the text. I.e., the literals "^R^O" and not the
|
||||
text from the register.
|
||||
Does not replace characters in |Replace-mode|!
|
||||
|
||||
@ -182,7 +182,7 @@ CTRL-R CTRL-P {register} *i_CTRL-R_CTRL-P*
|
||||
The '.' register (last inserted text) is still inserted as
|
||||
typed.
|
||||
After this command, the '.' register contains the command
|
||||
typed and not the text. I.e., the literals "^R^P" and not the
|
||||
typed and not the text. I.e., the literals "^R^P" and not the
|
||||
text from the register.
|
||||
Does not replace characters in |Replace-mode|!
|
||||
|
||||
@ -559,10 +559,10 @@ extra spaces to get where you want to be.
|
||||
|
||||
*ins-smarttab*
|
||||
When the 'smarttab' option is on, the <Tab> key indents by 'shiftwidth' if the
|
||||
cursor is in leading whitespace. The <BS> key has the opposite effect. This
|
||||
behaves as if 'softtabstop' were set to the value of 'shiftwidth'. This option
|
||||
allows the user to set 'softtabstop' to a value other than 'shiftwidth' and
|
||||
still use the <Tab> key for indentation.
|
||||
cursor is in leading whitespace. The <BS> key has the opposite effect. This
|
||||
behaves as if 'softtabstop' were set to the value of 'shiftwidth'. This
|
||||
option allows the user to set 'softtabstop' to a value other than 'shiftwidth'
|
||||
and still use the <Tab> key for indentation.
|
||||
|
||||
==============================================================================
|
||||
5. Replace mode *Replace* *Replace-mode* *mode-replace*
|
||||
@ -663,7 +663,8 @@ not a valid CTRL-X mode command. Valid keys are the CTRL-X command itself,
|
||||
CTRL-N (next), and CTRL-P (previous).
|
||||
|
||||
By default, the possible completions are showed in a menu and the first
|
||||
completion is inserted into the text. This can be adjusted with 'completeopt'.
|
||||
completion is inserted into the text. This can be adjusted with
|
||||
'completeopt'.
|
||||
|
||||
To get the current completion information, |complete_info()| can be used.
|
||||
Also see the 'infercase' option if you want to adjust the case of the match.
|
||||
@ -889,7 +890,7 @@ Completing keywords with 'thesaurusfunc' *compl-thesaurusfunc*
|
||||
|
||||
If the 'thesaurusfunc' option is set, then the user specified function is
|
||||
invoked to get the list of completion matches and the 'thesaurus' option is
|
||||
not used. See |complete-functions| for an explanation of how the function is
|
||||
not used. See |complete-functions| for an explanation of how the function is
|
||||
invoked and what it should return.
|
||||
|
||||
Here is an example that uses the "aiksaurus" command (provided by Magnus
|
||||
@ -1139,8 +1140,8 @@ CTRL-X CTRL-Z Stop completion without changing the text.
|
||||
AUTOCOMPLETION *ins-autocompletion*
|
||||
|
||||
Vim can display a completion menu as you type, similar to using |i_CTRL-N|,
|
||||
but triggered automatically. See 'autocomplete'. The menu items are collected
|
||||
from the sources listed in the 'complete' option, in order.
|
||||
but triggered automatically. See 'autocomplete'. The menu items are
|
||||
collected from the sources listed in the 'complete' option, in order.
|
||||
|
||||
A decaying timeout keeps Vim responsive. Sources earlier in the 'complete'
|
||||
list get more time (higher priority), but all sources receive at least a small
|
||||
@ -1248,7 +1249,7 @@ items:
|
||||
items to be equal; when omitted zero is used, thus
|
||||
items that only differ in case are added
|
||||
equal when non-zero, always treat this item to be equal when
|
||||
comparing. Which means, "equal=1" disables filtering
|
||||
comparing. Which means, "equal=1" disables filtering
|
||||
of this item.
|
||||
dup when non-zero this match will be added even when an
|
||||
item with the same word is already present.
|
||||
@ -1264,7 +1265,7 @@ items:
|
||||
properties (with higher priority) like strikethrough
|
||||
to the completion items abbreviation
|
||||
kind_hlgroup an additional highlight group specifically for setting
|
||||
the highlight attributes of the completion kind. When
|
||||
the highlight attributes of the completion kind. When
|
||||
this field is present, it will override the
|
||||
|hl-PmenuKind| highlight group, allowing for the
|
||||
customization of ctermfg and guifg properties for the
|
||||
@ -1455,7 +1456,8 @@ any printable, non-white character:
|
||||
Add this character and reduce the number of matches.
|
||||
|
||||
In all three states these can be used:
|
||||
CTRL-Y Yes: Accept the currently selected match and stop completion.
|
||||
CTRL-Y Yes: Accept the currently selected match and stop
|
||||
completion.
|
||||
CTRL-E End completion, go back to what was there before selecting a
|
||||
match (what was typed or longest common string).
|
||||
<PageUp> Select a match several entries back, but don't insert it.
|
||||
@ -1559,7 +1561,7 @@ XHTML *ft-xhtml-omni*
|
||||
|
||||
CTRL-X CTRL-O provides completion of various elements of (X)HTML files. It is
|
||||
designed to support writing of XHTML 1.0 Strict files but will also work for
|
||||
other versions of HTML. Features:
|
||||
other versions of HTML. Features:
|
||||
|
||||
- after "<" complete tag name depending on context (no div suggestion inside
|
||||
of an a tag); '/>' indicates empty tags
|
||||
@ -1577,7 +1579,7 @@ other versions of HTML. Features:
|
||||
|
||||
Note: When used first time completion menu will be shown with little delay
|
||||
- this is time needed for loading of data file.
|
||||
Note: Completion may fail in badly formatted documents. In such case try to
|
||||
Note: Completion may fail in badly formatted documents. In such case try to
|
||||
run |:make| command to detect formatting problems.
|
||||
|
||||
|
||||
@ -1591,7 +1593,7 @@ When doing completion outside of any other tag you will have possibility to
|
||||
choose DOCTYPE and the appropriate data file will be loaded and used for all
|
||||
next completions.
|
||||
|
||||
More about format of data file in |xml-omni-datafile|. Some of the data files
|
||||
More about format of data file in |xml-omni-datafile|. Some of the data files
|
||||
may be found on the Vim website (|www|).
|
||||
|
||||
Note that b:html_omni_flavor may point to a file with any XML data. This
|
||||
@ -1620,8 +1622,8 @@ of external files).
|
||||
DOM compatibility
|
||||
|
||||
At the moment (beginning of 2006) there are two main browsers - MS Internet
|
||||
Explorer and Mozilla Firefox. These two applications are covering over 90% of
|
||||
market. Theoretically standards are created by W3C organisation
|
||||
Explorer and Mozilla Firefox. These two applications are covering over 90% of
|
||||
market. Theoretically standards are created by W3C organisation
|
||||
(http://www.w3c.org) but they are not always followed/implemented.
|
||||
|
||||
IE FF W3C Omni completion ~
|
||||
@ -1631,16 +1633,16 @@ market. Theoretically standards are created by W3C organisation
|
||||
- + - - ~
|
||||
|
||||
Regardless from state of implementation in browsers but if element is defined
|
||||
in standards, completion plugin will place element in suggestion list. When
|
||||
in standards, completion plugin will place element in suggestion list. When
|
||||
both major engines implemented element, even if this is not in standards it
|
||||
will be suggested. All other elements are not placed in suggestion list.
|
||||
will be suggested. All other elements are not placed in suggestion list.
|
||||
|
||||
|
||||
PHP *ft-php-omni*
|
||||
|
||||
Completion of PHP code requires a tags file for completion of data from
|
||||
external files and for class aware completion. You should use Universal/
|
||||
Exuberant ctags version 5.5.4 or newer. You can find it here:
|
||||
external files and for class aware completion. You should use Universal/
|
||||
Exuberant ctags version 5.5.4 or newer. You can find it here:
|
||||
|
||||
Universal Ctags: https://ctags.io
|
||||
Exuberant Ctags: http://ctags.sourceforge.net
|
||||
@ -1648,11 +1650,12 @@ Exuberant ctags version 5.5.4 or newer. You can find it here:
|
||||
Script completes:
|
||||
|
||||
- after $ variables name
|
||||
- if variable was declared as object add "->", if tags file is available show
|
||||
name of class
|
||||
- if variable was declared as object add "->", if tags file is available
|
||||
show name of class
|
||||
- after "->" complete only function and variable names specific for given
|
||||
class. To find class location and contents tags file is required. Because
|
||||
PHP isn't strongly typed language user can use @var tag to declare class: >
|
||||
class. To find class location and contents tags file is required.
|
||||
Because PHP isn't strongly typed language user can use @var tag to declare
|
||||
class: >
|
||||
|
||||
/* @var $myVar myClass */
|
||||
$myVar->
|
||||
@ -1670,11 +1673,11 @@ Script completes:
|
||||
|
||||
|
||||
Note: when doing completion first time Vim will load all necessary data into
|
||||
memory. It may take several seconds. After next use of completion delay
|
||||
memory. It may take several seconds. After next use of completion delay
|
||||
should not be noticeable.
|
||||
|
||||
Script detects if cursor is inside <?php ?> tags. If it is outside it will
|
||||
automatically switch to HTML/CSS/JavaScript completion. Note: contrary to
|
||||
Script detects if cursor is inside <?php ?> tags. If it is outside it will
|
||||
automatically switch to HTML/CSS/JavaScript completion. Note: contrary to
|
||||
original HTML files completion of tags (and only tags) isn't context aware.
|
||||
|
||||
|
||||
@ -1701,11 +1704,11 @@ The completions provided by CTRL-X CTRL-O are sensitive to the context:
|
||||
|
||||
Notes:
|
||||
- Vim will load/evaluate code in order to provide completions. This may
|
||||
cause some code execution, which may be a concern. This is no longer
|
||||
cause some code execution, which may be a concern. This is no longer
|
||||
enabled by default, to enable this feature add >
|
||||
let g:rubycomplete_buffer_loading = 1
|
||||
<- In context 1 above, Vim can parse the entire buffer to add a list of
|
||||
classes to the completion results. This feature is turned off by default,
|
||||
classes to the completion results. This feature is turned off by default,
|
||||
to enable it add >
|
||||
let g:rubycomplete_classes_in_global = 1
|
||||
< to your vimrc
|
||||
@ -1713,7 +1716,7 @@ Notes:
|
||||
- In context 3 above, Vim will attempt to determine the methods supported by
|
||||
the object.
|
||||
- Vim can detect and load the Rails environment for files within a rails
|
||||
project. The feature is disabled by default, to enable it add >
|
||||
project. The feature is disabled by default, to enable it add >
|
||||
let g:rubycomplete_rails = 1
|
||||
< to your vimrc
|
||||
|
||||
@ -1750,11 +1753,11 @@ a look at the PHP filetype to see how this works.
|
||||
If you edit a file called, index.php, run the following command: >
|
||||
syntax list
|
||||
|
||||
The first thing you will notice is that there are many different syntax groups.
|
||||
The PHP language can include elements from different languages like HTML,
|
||||
JavaScript and many more. The syntax plugin will only include syntax groups
|
||||
that begin with the filetype, "php", in this case. For example these syntax
|
||||
groups are included by default with the PHP: phpEnvVar, phpIntVar,
|
||||
The first thing you will notice is that there are many different syntax
|
||||
groups. The PHP language can include elements from different languages like
|
||||
HTML, JavaScript and many more. The syntax plugin will only include syntax
|
||||
groups that begin with the filetype, "php", in this case. For example these
|
||||
syntax groups are included by default with the PHP: phpEnvVar, phpIntVar,
|
||||
phpFunctions.
|
||||
|
||||
If you wish non-filetype syntax items to also be included, you can use a
|
||||
@ -1873,7 +1876,7 @@ be used in commands. It should be a unique name which will not create
|
||||
conflicts. For example, the name xhtml10s.vim means it is the data file for
|
||||
XHTML 1.0 Strict.
|
||||
|
||||
Each file contains a variable with a name like g:xmldata_xhtml10s . It is
|
||||
Each file contains a variable with a name like g:xmldata_xhtml10s . It is
|
||||
a compound from two parts:
|
||||
|
||||
1. "g:xmldata_" general prefix, constant for all data files
|
||||
@ -2090,7 +2093,7 @@ These two commands will keep on asking for lines, until you type a line
|
||||
containing only a ".". Watch out for lines starting with a backslash, see
|
||||
|line-continuation|.
|
||||
|
||||
Text typed after a "|" command separator is used first. So the following
|
||||
Text typed after a "|" command separator is used first. So the following
|
||||
command in ex mode: >
|
||||
:a|one
|
||||
two
|
||||
|
||||
Reference in New Issue
Block a user