diff options
author | 2012-03-07 09:28:43 -0500 | |
---|---|---|
committer | 2012-03-07 09:28:43 -0500 | |
commit | 96c85498c019e381d0aeed2e33e626563563ea8c (patch) | |
tree | a44a3ff017cc7c5de3e4845434324c7798689d24 /core/file_io.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 'core/file_io.lua')
-rw-r--r-- | core/file_io.lua | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/core/file_io.lua b/core/file_io.lua index 8ff6d5be..1d31f1e6 100644 --- a/core/file_io.lua +++ b/core/file_io.lua @@ -6,13 +6,14 @@ module('io')]] -- Markdown: --- ## Converting Filenames to and from UTF-8 +-- ## Working with UTF-8 -- -- If your filesystem does not use UTF-8 encoded filenames, conversions to and --- from that encoding will be necessary. When opening and saving files through --- dialogs, Textadept takes care of these conversions for you, but if you need --- to do them manually, use [`string.iconv()`][string_iconv] along with --- `_CHARSET`, your filesystem's detected encoding. +-- from that encoding are necessary since all of Textadept's internal strings +-- are UTF-8 encoded. When opening and saving files through dialogs, these +-- conversions are performed autmatically, but if you need to do them manually, +-- use [`string.iconv()`][] along with `_CHARSET`, your filesystem's detected +-- encoding. -- -- Example: -- @@ -23,26 +24,26 @@ module('io')]] -- f:close() -- end) -- --- [string_iconv]: ../modules/string.html#iconv +-- [`string.iconv()`]: string.html#iconv -- -- ## File Events -- -- * `_G.events.FILE_OPENED` -- Called when a file is opened in a new buffer. -- Arguments: --- * `filename`: The filename encoded in UTF-8. +-- * `filename`: The filename encoded in UTF-8. -- * `_G.events.FILE_BEFORE_SAVE` -- Called right before a file is saved to disk. -- Arguments: --- * `filename`: The filename encoded in UTF-8. +-- * `filename`: The filename encoded in UTF-8. -- * `_G.events.FILE_AFTER_SAVE` -- Called right after a file is saved to disk. -- Arguments: --- * `filename`: The filename encoded in UTF-8. +-- * `filename`: The filename encoded in UTF-8. -- * `_G.events.FILE_SAVED_AS` -- Called when a file is saved under a different filename. -- Arguments: --- * `filename`: The filename encoded in UTF-8. +-- * `filename`: The filename encoded in UTF-8. -- Events. local events, events_connect = events, events.connect |