diff options
| author |   mitchell <70453897+667e-11@users.noreply.github.com> | 2012-03-07 09:28:43 -0500 |
|---|---|---|
| committer | mitchell <70453897+667e-11@users.noreply.github.com> | 2012-03-07 09:28:43 -0500 |
| commit | 96c85498c019e381d0aeed2e33e626563563ea8c (patch) | |
| tree | a44a3ff017cc7c5de3e4845434324c7798689d24 /modules/textadept/snippets.lua | |
| parent | 6c5bda943d87c629e3fbeaa9178d5fdcb96134c5 (diff) | |
| download | textadept-96c85498c019e381d0aeed2e33e626563563ea8c.tar.gz textadept-96c85498c019e381d0aeed2e33e626563563ea8c.zip | |
Documentation overhaul with Discount (Markdown implementation).
The standard LuaDoc template is no longer used. Instead, the new
`scripts/markdowndoc.lua` has the template for LuaDoc and `scripts/update_doc`
has the template for the Manual.
Also added README, CHANGELOG, and THANKS files.
Diffstat (limited to 'modules/textadept/snippets.lua')
| -rw-r--r-- | modules/textadept/snippets.lua | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/modules/textadept/snippets.lua b/modules/textadept/snippets.lua index a99a51b8..60b9402d 100644 --- a/modules/textadept/snippets.lua +++ b/modules/textadept/snippets.lua @@ -36,7 +36,7 @@ module('_M.textadept.snippets')]] -- -- A snippet to insert may contain any of the following: -- --- #### Plain Text +-- ### Plain Text -- -- Any plain text characters may be used with the exception of `%` followed -- immediately by a digit (`0`-`9`), `(`, `)`, `>`, or `]` character. These are @@ -45,7 +45,7 @@ module('_M.textadept.snippets')]] -- another `%` to the first `%`. For example, `%%>` in the snippet inserts a -- literal `%>` into the document. -- --- #### Placeholders +-- ### Placeholders -- -- Textadept's snippets provide a number of different placeholders. The simplest -- ones are of the form @@ -82,17 +82,17 @@ module('_M.textadept.snippets')]] -- variable (containing the current selection in the buffer). After execution, -- the placeholder contains the return value of the code that was run. -- --- Shell code is executed using Lua's [`io.popen()`][io_popen] which reads from --- the process' standard output (STDOUT). After execution, the placeholder will +-- Shell code is executed using Lua's [`io.popen()`][] which reads from the +-- process' standard output (STDOUT). After execution, the placeholder will -- contain the STDOUT of the process. -- --- [io_popen]: http://www.lua.org/manual/5.1/manual.html#pdf-io.popen +-- [`io.popen()`]: http://www.lua.org/manual/5.2/manual.html#pdf-io.popen -- -- These kinds of placeholders can be used to transform mirrored text. For -- example, `%2<([[%1]]):gsub('^.', function(c) return c:upper() end)>` will -- capitalize a mirrored `%1` placeholder. -- --- ##### Important Note +-- #### Important Note -- -- It is very important that any `%`, `(`, `)`, `>`, or `]` characters -- **within** placeholders be escaped with a `%` as necessary. Otherwise, |