From 96c85498c019e381d0aeed2e33e626563563ea8c Mon Sep 17 00:00:00 2001 From: mitchell <70453897+667e-11@users.noreply.github.com> Date: Wed, 7 Mar 2012 09:28:43 -0500 Subject: 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. --- doc/manual/10_Advanced.md | 38 ++++++++++++++++++++++---------------- 1 file changed, 22 insertions(+), 16 deletions(-) (limited to 'doc/manual/10_Advanced.md') diff --git a/doc/manual/10_Advanced.md b/doc/manual/10_Advanced.md index db5cc5a3..d81687aa 100644 --- a/doc/manual/10_Advanced.md +++ b/doc/manual/10_Advanced.md @@ -6,16 +6,18 @@ Access to the Lua state is available through the command entry. Press `Ctrl+E` (`⌘E` on Mac OSX) to access it. It is useful for debugging, inspecting, and entering buffer or view commands. If you try to cause instability in Textadept's Lua state, you might very well succeed so be careful. For more information, see -the [scripting](11_Scripting.html) page. +the [scripting][] page. Abbreviated commands for the `buffer`, `view` and `gui` are available. So `buffer:append_text('foo')` can be shortened to `append_text('foo')`. `print()` -redirects to [`gui.print()`](../modules/gui.html#print). Use `_G.print()` for -Lua's `print()`. +redirects to [`gui.print()`][]. Use `_G.print()` for Lua's `print()`. ![Command Entry](images/commandentry.png) -#### Tab Completion +[scripting]: 11_Scripting.html +[`gui.print()`]: ../api/gui.html#print + +### Tab Completion Tab-completion for functions, variables, tables, etc. is available. Press the `Tab` (`⇥`) key to display a list of available completions. Use the arrow keys @@ -23,21 +25,24 @@ to make a selection and press `Enter` (`↩`) to insert it. ![Command Completion](images/commandentrycompletion.png) -#### Extending +### Extending You can extend the command entry to do more than enter Lua commands. An -example of this is [incremental -search](../modules/gui.find.html#find_incremental). See -`modules/textadept/find.lua` for the implementation. +example of this is [incremental search][]. See `modules/textadept/find.lua` for +the implementation. + +[incremental search]: ../api/gui.find.html#find_incremental ## Command Selection -If you did not disable the menu in your [preferences](9_Preferences.html), then -pressing `Ctrl+Shift+E` (`⌘⇧E` on Mac OSX) brings up the command selection -dialog. Typing part of any command filters the list with spaces being wildcards. -This is an easy way to run commands without navigating the menus, using the -mouse, or remembering key commands. It is also useful for looking up particular -key commands quickly. +If you did not disable the menu in your [preferences][], then pressing +`Ctrl+Shift+E` (`⌘⇧E` on Mac OSX) brings up the command selection dialog. Typing +part of any command filters the list with spaces being wildcards. This is an +easy way to run commands without navigating the menus, using the mouse, or +remembering key commands. It is also useful for looking up particular key +commands quickly. + +[preferences]: 9_Preferences.html#User.Init ## Shell Commands and Filtering Text @@ -69,10 +74,11 @@ not notice any difference for working with files containing ASCII text since UTF-8 is compatible with it. Textadept can also detect ISO-8859-1 and MacRoman, the primary encodings used on Windows and Mac OSX respectively. Files with more exotic encodings may not be detected properly, if at all. You can change the -list of encodings Textadept tries to detect via -[`io.try_encodings`](../modules/io.html#try_encodings). +list of encodings Textadept tries to detect via [`io.try_encodings`][]. It is recommended to use UTF-8 encoded files because UTF-8 is very well supported by other text editors and operating systems. You can change the file's encoding via the `Buffer -> Encoding` menu. Textadept saves new files as UTF-8 by default. + +[`io.try_encodings`]: ../api/io.html#try_encodings -- cgit v1.2.3