/plugins/SuperAbbrevs/tags/stable_002/SuperAbbrevs.html

# · HTML · 61 lines · 60 code · 1 blank · 0 comment · 0 complexity · 3f3dfa6aed1bac1df50706fcd5e164da MD5 · raw file 

    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <html>
    3. 

  3. 	<head>
    4. 

  4. 		<title>SuperAbbrevs</title>
    5. 

  5. 		<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
    6. 

  6. 	</head>
    7. 

  7. 	<body>
    8. 

  8. 		<h1>SuperAbbrevs</h1>
    9. 

  9. 		<p>Author: <i>Sune Simonsen</i></p>
    10. 

  10. 		<p><i>This will soon be updated</i></p>
    11. 

  11. 		<p>
    12. 

  12. 			This plugin gives you eclipse style code templates. You can define a 
    13. 

  13. 			template wich contains variables. You assosiate the template with a 
    14. 

  14. 			abbreviation, if you have the caret placed after the abbreviation and 
    15. 

  15. 			execute the command:</p>
    16. 

  16. 		<p>
    17. 

  17. 			<i>Plugins-&#062; SuperAbbrevs -&#062; Expand Abbreviation</i>
    18. 

  18. 		</p>
    19. 

  19. 		<p>
    20. 

  20. 			it will be expanded. You can then use the 
    21. 

  21. 			<i>SHIFT-TAB</i> and <i>TAB</i> keys, to jump back and forth between 
    22. 

  22. 			the variables.
    23. 

  23. 		</p> 	
    24. 

  24. 		<h2>Template syntax</h2>
    25. 

  25. 		<p>This is best explained with an example.</p>
    26. 

  26. 		<pre>
    27. 

  27. 	Iterator ${2:iter} = ${1:list}.iterator();
    28. 

  28. 	while ($2.hasNext()){
    29. 

  29. 		${3:Type} ${4:element} = ($3)$2.next();
    30. 

  30. 		$end
    31. 

  31. 	}
    32. 

  32. 		</pre>
    33. 

  33. 		<p>
    34. 

  34. 			The above example, shows a java template, with the variables 
    35. 

  35. 			<i>$1</i>, <i>$2</i>, <i>$3</i> and <i>$4</i>. Variable <i>$1</i>'s 
    36. 

  36. 			default value is list, and <i>$2</i>'s default value is iter, and so on.
    37. 

  37. 			When this template is inserted the following code will be inserted, and 
    38. 

  38. 			the <i>list</i> will be selected.
    39. 

  39. 		</p>
    40. 

  40. 		<pre>
    41. 

  41. 	Iterator iter = list.iterator();
    42. 

  42. 	while (iter.hasNext()){
    43. 

  43. 		Type element = (Type)iter.next();
    44. 

  44. 		
    45. 

  45. 	}
    46. 

  46. 		</pre>
    47. 

  47. 		<p>
    48. 

  48. 			There are to types of variables, a variable that defines the default 
    49. 

  49. 			value of the variable, and a plain variable. Each has a tab index, if 
    50. 

  50. 			the variable should have a default value, it should be define in the 
    51. 

  51. 			first occurrence of the variable. Like index 2 has defined it's 
    52. 

  52. 			default value to <i>iter</i> (<i>${2:iter}</i>). When you have defined 
    53. 

  53. 			the default value you can just use the variable index <i>$2</i> to 
    54. 

  54. 			referrer to the variable. The template also has to contain a <i>$end</i>
    55. 

  55. 			variable, that represent the last entry, if you write in the <i>$end</i>
    56. 

  56. 			variable the template will be disabled and you go back to normal mode.</p>
    57. 

  57. 		<p>
    58. 

  58. 			I suggest that you bind <i>Expand abbreviation</i> to a key.
    59. 

  59. 		</p>
    60. 

  60. 	</body>
    61. 

  61. </html>
    62.