aboutsummaryrefslogtreecommitdiff
path: root/modules
diff options
context:
space:
mode:
Diffstat (limited to 'modules')
-rw-r--r--modules/textadept/keys.lua9
-rw-r--r--modules/textadept/menu.lua1
-rw-r--r--modules/textadept/mime_types.lua39
-rw-r--r--modules/textadept/snippets.lua27
4 files changed, 12 insertions, 64 deletions
diff --git a/modules/textadept/keys.lua b/modules/textadept/keys.lua
index df088b44..1b79e9ae 100644
--- a/modules/textadept/keys.lua
+++ b/modules/textadept/keys.lua
@@ -106,15 +106,6 @@ module('_m.textadept.keys', package.seeall)
-- Therefore, any module containing key commands should be loaded after all
-- other modules, whose functions are being referenced, have been loaded.
--
--- ## Configuration
---
--- It is not recommended to edit Textadept's `modules/textadept/keys.lua`.
--- Instead you can modify `_G.keys` from within your `~/.textadept/init.lua` or
--- from a file `require`d by your `init.lua`.
-
--- Windows and Linux key commands are listed in the first block.
--- Mac OSX key commands are listed in the second block.
---
-- ## Events
--
-- The following is a list of all key events generated in
diff --git a/modules/textadept/menu.lua b/modules/textadept/menu.lua
index f94aad56..85835cfe 100644
--- a/modules/textadept/menu.lua
+++ b/modules/textadept/menu.lua
@@ -11,7 +11,6 @@ local gui = _G.gui
module('_m.textadept.menu', package.seeall)
-- Markdown:
---
-- ## Events
--
-- The following is a list of all menu events generated in
diff --git a/modules/textadept/mime_types.lua b/modules/textadept/mime_types.lua
index e6023995..b71fb514 100644
--- a/modules/textadept/mime_types.lua
+++ b/modules/textadept/mime_types.lua
@@ -10,45 +10,6 @@ module('_m.textadept.mime_types', package.seeall)
-- Markdown:
-- ## Overview
--
--- Files can be recognized and associated with programming language lexers in
--- three ways:
---
--- * By file extension.
--- * By keywords in the file's shebang (`#!/path/to/exe`) line.
--- * By a pattern that matches the file's first line.
---
--- If a lexer is not associated with a file you open, first make sure the lexer
--- exists in `lexers/`. If it does not, you will need to write one. Consult the
--- [lexer][lexer] module for a tutorial.
---
--- [lexer]: ../modules/lexer.html
---
--- ## Configuration Files
---
--- Built-in mime-types are located in `modules/textadept/mime_types.conf`. You
--- can override or add to them in your `~/.textadept/mime_types.conf`.
---
--- #### Detection by File Extension
---
--- file_ext lexer
---
--- Note: `file_ext` should not start with a `.` (period).
---
--- #### Detection by Shebang Keywords
---
--- #shebang_word lexer
---
--- Examples of `shebang_word`'s are `lua`, `ruby`, `python`.
---
--- #### Detection by Pattern
---
--- /pattern lexer
---
--- Only the last space, the one separating the pattern from the lexer, is
--- significant. No spaces in the pattern need to be escaped.
---
--- ## Extras
---
-- This module adds an extra function to `buffer`:
--
-- * **buffer:set\_lexer** (language)<br />
diff --git a/modules/textadept/snippets.lua b/modules/textadept/snippets.lua
index 95a80558..bcfc209c 100644
--- a/modules/textadept/snippets.lua
+++ b/modules/textadept/snippets.lua
@@ -7,15 +7,6 @@ local L = _G.locale.localize
module('_m.textadept.snippets', package.seeall)
-- Markdown:
--- ## Settings
---
--- * `MARK_SNIPPET`: The unique integer mark used to identify the line that
--- marks the end of a snippet.
--- * `MARK_SNIPPET_COLOR`: The [Scintilla color][scintilla_color] used for the
--- line that marks the end of the snippet.
---
--- [scintilla_color]: http://scintilla.org/ScintillaDoc.html#colour
---
-- ## Overview
--
-- Snippets are basically pieces of text inserted into a document, but can
@@ -37,6 +28,15 @@ module('_m.textadept.snippets', package.seeall)
-- Snippet text should contain spaces instead of tabs since Textadept
-- automatically converts spaces to tabs depending on the current settings.
--
+-- ## Settings
+--
+-- * `MARK_SNIPPET`: The unique integer mark used to identify the line that
+-- marks the end of a snippet.
+-- * `MARK_SNIPPET_COLOR`: The [Scintilla color][scintilla_color] used for the
+-- line that marks the end of the snippet.
+--
+-- [scintilla_color]: http://scintilla.org/ScintillaDoc.html#colour
+--
-- ## Snippet Precedence
--
-- When searching for a snippet to expand in the `snippets` table, snippets in
@@ -99,12 +99,9 @@ module('_m.textadept.snippets', package.seeall)
-- %num(pattern|replacement)
--
-- These act like mirrors, but transform the text that would be inserted using
--- a given [Lua pattern][lua_pattern] and replacement. Like in placeholders,
--- `replacement` can contain Lua code executed at run-time as well as the
--- standard Lua capture sequences: `%n` where 1 <= `n` <= 9.
---
--- [lua_pattern]: http://www.lua.org/manual/5.1/manual.html#5.4.1
---
+-- a given [Lua pattern](../manual/14_Appendix.html#lua_patterns) and
+-- replacement. Like in placeholders, `replacement` can contain Lua code
+-- executed at run-time as well as the standard Lua capture (`%n`) sequences.
-- Any `|`'s after the first one do not need to be escaped.
--
-- ## Example