Merge pull request #73 from kana/add-filetype-example

Add example to define text objects for a filetype

Author: kana

README.md

@@ -34,15 +34,15 @@ call textobj#user#plugin('datetime', {
 
 ### Simple text objects surrounded by a pair of patterns
 
-Define `aP` to select a PHP code with `<?php` and `?>`, and
-define `iP` to select a PHP code without `<?php` and `?>`:
+Define `aA` to select text from `<<` to the matching `>>`, and
+define `iA` to select text inside `<<` and `>>`:
 
 ```vim
-call textobj#user#plugin('php', {
-\ 'code': {
-\ 'pattern': ['<?php\>', '?>'],
-\ 'select-a': 'aP',
-\ 'select-i': 'iP',
+call textobj#user#plugin('braces', {
+\ 'angle': {
+\ 'pattern': ['<<', '>>'],
+\ 'select-a': 'aA',
+\ 'select-i': 'iA',
 \ },
 \ })
 ```
@@ -85,6 +85,33 @@ endfunction
 ```
 
 
+### Text objects for a specific filetype
+
+Define `a(` to select text from `\left(` to the matching `\right)`, and
+define `i(` to select text inside `\left(` to the matching `\right)`,
+but *only for tex files*:
+
+```vim
+call textobj#user#plugin('tex', {
+\ 'paren-math': {
+\ 'pattern': ['\\left(', '\\right)'],
+\ 'select-a': [],
+\ 'select-i': [],
+\ },
+\ })
+
+augroup tex_textobjs
+ autocmd!
+ autocmd FileType tex call textobj#user#map('tex', {
+ \ 'paren-math': {
+ \ 'select-a': '<buffer> a(',
+ \ 'select-i': '<buffer> i(',
+ \ },
+ \ })
+augroup END
+```
+
+
 
 
 ## Further reading

doc/textobj-user.txt

@@ -61,14 +61,14 @@ or use functions to define complex ones. For example...
 \ })
 <
 *textobj-user-example-between*
-(b) Define "aP" to select a PHP code with "<?php" and "?>", and
- define "iP" to select a PHP code without "<?php" and "?>":
+(b) Define "aA" to select text from "<<" to the matching ">>", and
+ define "iA" to select text inside "<<" and ">>":
 >
-call textobj#user#plugin('php', {
-\ 'code': {
-\ 'pattern': ['<?php\>', '?>'],
-\ 'select-a': 'aP',
-\ 'select-i': 'iP',
+call textobj#user#plugin('braces', {
+\ 'angle': {
+\ 'pattern': ['<<', '>>'],
+\ 'select-a': 'aA',
+\ 'select-i': 'iA',
 \ },
 \ })
 <
@@ -105,6 +105,29 @@ or use functions to define complex ones. For example...
  \ : 0
 endfunction
 <
+*textobj-user-example-filetype*
+(d) Define "a(" to select text from "\left(" to the matching "\right)", and
+ define "i(" to select text inside "\left(" to the matching "\right)",
+ but only for tex files:
+>
+call textobj#user#plugin('tex', {
+\ 'paren-math': {
+\ 'pattern': ['\\left(', '\\right)'],
+\ 'select-a': [],
+\ 'select-i': [],
+\ },
+\ })
+
+augroup tex_textobjs
+ autocmd!
+ autocmd FileType tex call textobj#user#map('tex', {
+ \ 'paren-math': {
+ \ 'select-a': '<buffer> a(',
+ \ 'select-i': '<buffer> i(',
+ \ },
+ \ })
+augroup END
+<
 
 You can define your own text objects like the above examples.
 See also |textobj-user-reference| for more details.