ld/yasnippet
1
0
Fork 0
mirror of https://github.com/joaotavora/yasnippet.git synced 2025-10-13 13:13:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

Replace text -> yas-text in documentation

Browse Source 
* doc/snippet-development.org: replace text -> yas-text
This commit is contained in:
Noam Postavsky 2014-06-17 19:21:22 -04:00
parent 763f5faa14
commit f98c527a38
1 changed files with 17 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
doc/snippet-development.org
View File

@ -283,12 +283,13 @@ the field and others mirrors.
** Mirrors with <<transformations>> ** Mirrors with <<transformations>>
If the value of an =${n:=-construct starts with and contains =$(=, then If the value of an =${n:=-construct starts with and contains =$(=,
it is interpreted as a mirror for field =n= with a transformation. The then it is interpreted as a mirror for field =n= with a
mirror's text content is calculated according to this transformation, transformation. The mirror's text content is calculated according to
which is Emacs-lisp code that gets evaluated in an environment where the this transformation, which is Emacs-lisp code that gets evaluated in
variable =text= (or [[sym:yas-text][=yas-text=]]) is bound to the text content (string) an environment where the variable [[sym:yas-text][=yas-text=]] is bound to the text
contained in the field =n=.Here's an example for Objective-C: content (string) contained in the field =n=. Here's an example for
Objective-C:
#+BEGIN_SRC snippet #+BEGIN_SRC snippet
- (${1:id})${2:foo} - (${1:id})${2:foo}
@ -296,7 +297,7 @@ contained in the field =n=.Here's an example for Objective-C:
return $2; return $2;
} }
- (void)set${2:$(capitalize text)}:($1)aValue - (void)set${2:$(capitalize yas-text)}:($1)aValue
{ {
[$2 autorelease]; [$2 autorelease];
$2 = [aValue retain]; $2 = [aValue retain];
@ -304,12 +305,13 @@ contained in the field =n=.Here's an example for Objective-C:
$0 $0
#+END_SRC #+END_SRC
Look at =${2:$(capitalize text)}=, it is a mirror with transformation Look at =${2:$(capitalize yas-text)}=, it is a mirror with
instead of a field. The actual field is at the first line: =${2:foo}=. transformation instead of a field. The actual field is at the first
When you type text in =${2:foo}=, the transformation will be evaluated line: =${2:foo}=. When you type text in =${2:foo}=, the transformation
and the result will be placed there as the transformed text. So in this will be evaluated and the result will be placed there as the
example, if you type "baz" in the field, the transformed text will be transformed text. So in this example, if you type "baz" in the field,
"Baz". This example is also available in the screencast. the transformed text will be "Baz". This example is also available in
the screencast.
Another example is for =rst-mode=. In reStructuredText, the document Another example is for =rst-mode=. In reStructuredText, the document
title can be some text surrounded by "===" below and above. The "===" title can be some text surrounded by "===" below and above. The "==="
@ -332,9 +334,9 @@ is a valid title but
is not. Here's an snippet for rst title: is not. Here's an snippet for rst title:
#+BEGIN_SRC snippet #+BEGIN_SRC snippet
${1:$(make-string (string-width text) ?\=)} ${1:$(make-string (string-width yas-text) ?\=)}
${1:Title} ${1:Title}
${1:$(make-string (string-width text) ?\=)} ${1:$(make-string (string-width yas-text) ?\=)}
$0 $0
#+END_SRC #+END_SRC