From 11bd2d15a880755fa8c58c39cf1de13ae0dd2b2a Mon Sep 17 00:00:00 2001 From: mitchell <70453897+orbitalquark@users.noreply.github.com> Date: Mon, 14 Sep 2020 00:08:28 -0400 Subject: More small documentation updates. --- README.md | 2 +- core/.buffer.luadoc | 5 ++--- core/.iconv.luadoc | 2 +- core/.view.luadoc | 7 +++---- core/file_io.lua | 2 +- core/init.lua | 4 ++-- docs/api.md | 16 ++++++++-------- docs/faq.md | 2 +- docs/index.html | 1 - modules/lua/ta_api | 4 ++-- modules/textadept/run.lua | 2 +- modules/textadept/snippets.lua | 2 +- scripts/fill_layout.lua | 2 +- src/Makefile | 12 ++++++------ 14 files changed, 30 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 42f4539f..95aebb68 100644 --- a/README.md +++ b/README.md @@ -136,4 +136,4 @@ submit patches either to the [mailing list][], or to me personally [donation]: https://gum.co/textadept [book]: https://orbitalquark.github.io/textadept/book.html [open source]: https://github.com/orbitalquark/textadept -[mailing list]: http://foicica.com/lists +[mailing list]: https://foicica.com/lists diff --git a/core/.buffer.luadoc b/core/.buffer.luadoc index 655c8820..7a70b5c4 100644 --- a/core/.buffer.luadoc +++ b/core/.buffer.luadoc @@ -8,9 +8,8 @@ -- to work with the global one. -- Many of these functions and fields are derived from buffer-specific -- functionality of the Scintilla editing component, and additional information --- can be found on the Scintilla website: --- [http://scintilla.org/ScintillaDoc.html]( --- http://scintilla.org/ScintillaDoc.html). +-- can be found on the +-- [Scintilla website](https://scintilla.org/ScintillaDoc.html). -- Note that with regard to Scintilla-specific functionality, this API is a -- _suggestion_, not a hard requirement. All of that functionality also exists -- in [`view`](), even if undocumented. diff --git a/core/.iconv.luadoc b/core/.iconv.luadoc index 189e83bc..addd7ebc 100644 --- a/core/.iconv.luadoc +++ b/core/.iconv.luadoc @@ -31,7 +31,7 @@ module('string') -- * Unicode: UTF-8, UCS-2, UCS-2BE, UCS-2LE, UCS-4, UCS-4BE, UCS-4LE, UTF-16, -- UTF-16BE, UTF-16LE, UTF-32, UTF-32BE, UTF-32LE, UTF-7, C99, JAVA. -- --- [GNU libiconv's encodings]: http://www.gnu.org/software/libiconv/ +-- [GNU libiconv's encodings]: https://www.gnu.org/software/libiconv/ -- @param text The text to convert. -- @param new The string encoding to convert to. -- @param old The string encoding to convert from. diff --git a/core/.view.luadoc b/core/.view.luadoc index 0cf59048..abd9dbd7 100644 --- a/core/.view.luadoc +++ b/core/.view.luadoc @@ -7,10 +7,9 @@ -- While you can work with individual view instances, it is often useful to work -- with just the global one. -- Many of these functions and fields are derived from view-specific --- functionality the Scintilla editing component, and additional information can --- be found on the Scintilla website: --- [http://scintilla.org/ScintillaDoc.html]( --- http://scintilla.org/ScintillaDoc.html) +-- functionality of the Scintilla editing component, and additional information +-- can be found on the +-- [Scintilla website](https://scintilla.org/ScintillaDoc.html). -- Note that with regard to Scintilla-specific functionality, this API is a -- _suggestion_, not a hard requirement. All of that functionality also exists -- in [`buffer`](), even if undocumented. diff --git a/core/file_io.lua b/core/file_io.lua index de90ec81..d45372ec 100644 --- a/core/file_io.lua +++ b/core/file_io.lua @@ -63,7 +63,7 @@ io.recent_files = {} -- * Unicode: UTF-8, UCS-2, UCS-2BE, UCS-2LE, UCS-4, UCS-4BE, UCS-4LE, UTF-16, -- UTF-16BE, UTF-16LE, UTF-32, UTF-32BE, UTF-32LE, UTF-7, C99, JAVA. -- --- [GNU iconv's encodings]: http://www.gnu.org/software/libiconv/ +-- [GNU iconv's encodings]: https://www.gnu.org/software/libiconv/ -- @usage io.encodings[#io.encodings + 1] = 'UTF-32' -- @class table -- @name encodings diff --git a/core/init.lua b/core/init.lua index ed2f66ba..4876e2cb 100644 --- a/core/init.lua +++ b/core/init.lua @@ -2,7 +2,7 @@ _RELEASE = 'Textadept 11.0 alpha 3' _COPYRIGHT = - 'Copyright © 2007-2020 Mitchell. See LICENSE.\nhttp://foicica.com/textadept' + 'Copyright © 2007-2020 Mitchell. See LICENSE.\nhttps://foicica.com/textadept' package.path = string.format('%s/core/?.lua;%s', _HOME, package.path) @@ -96,7 +96,7 @@ end) -- Whether or not Textadept is running in a terminal. -- Curses feature incompatibilities are listed in the [Appendix][]. -- --- [Appendix]: manual.html#curses-compatibility +-- [Appendix]: manual.html#terminal-version-compatibility module('_G')]] --[[ The tables below were defined in C. diff --git a/docs/api.md b/docs/api.md index b358cf10..e6ae4f29 100644 --- a/docs/api.md +++ b/docs/api.md @@ -51,7 +51,7 @@ Whether or not Textadept is running on BSD. Whether or not Textadept is running in a terminal. Curses feature incompatibilities are listed in the [Appendix][]. - [Appendix]: manual.html#curses-compatibility + [Appendix]: manual.html#terminal-version-compatibility #### `LINUX` (bool) @@ -632,8 +632,8 @@ to work with the global one. Many of these functions and fields are derived from buffer-specific functionality of the Scintilla editing component, and additional information can be found on the Scintilla website: -[http://scintilla.org/ScintillaDoc.html]( -http://scintilla.org/ScintillaDoc.html). +[https://scintilla.org/ScintillaDoc.html]( +https://scintilla.org/ScintillaDoc.html). Note that with regard to Scintilla-specific functionality, this API is a _suggestion_, not a hard requirement. All of that functionality also exists in [`view`](#view), even if undocumented. @@ -4492,7 +4492,7 @@ trying to open a file whose encoding is not recognized. Valid encodings are * Unicode: UTF-8, UCS-2, UCS-2BE, UCS-2LE, UCS-4, UCS-4BE, UCS-4LE, UTF-16, UTF-16BE, UTF-16LE, UTF-32, UTF-32BE, UTF-32LE, UTF-7, C99, JAVA. -[GNU iconv's encodings]: http://www.gnu.org/software/libiconv/ +[GNU iconv's encodings]: https://www.gnu.org/software/libiconv/ Usage: @@ -6420,7 +6420,7 @@ Valid encodings are [GNU libiconv's encodings][] and include: * Unicode: UTF-8, UCS-2, UCS-2BE, UCS-2LE, UCS-4, UCS-4BE, UCS-4LE, UTF-16, UTF-16BE, UTF-16LE, UTF-32, UTF-32BE, UTF-32LE, UTF-7, C99, JAVA. -[GNU libiconv's encodings]: http://www.gnu.org/software/libiconv/ +[GNU libiconv's encodings]: https://www.gnu.org/software/libiconv/ Parameters: @@ -7555,7 +7555,7 @@ A single unit of indentation based on the buffer's indentation settings A single set of line ending delimiters based on the buffer's end of line mode ([`buffer.eol_mode`](#buffer.eol_mode)). -[`io.popen()`]: http://www.lua.org/manual/5.3/manual.html#pdf-io.popen +[`io.popen()`]: https://www.lua.org/manual/5.3/manual.html#pdf-io.popen ### Fields defined by `textadept.snippets` @@ -8906,8 +8906,8 @@ with just the global one. Many of these functions and fields are derived from view-specific functionality the Scintilla editing component, and additional information can be found on the Scintilla website: -[http://scintilla.org/ScintillaDoc.html]( -http://scintilla.org/ScintillaDoc.html) +[https://scintilla.org/ScintillaDoc.html]( +https://scintilla.org/ScintillaDoc.html). Note that with regard to Scintilla-specific functionality, this API is a _suggestion_, not a hard requirement. All of that functionality also exists in [`buffer`](#buffer), even if undocumented. diff --git a/docs/faq.md b/docs/faq.md index 12b56ecb..70718c84 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -83,7 +83,7 @@ The LuaDoc describes [compile and run commands][] and you can configure them in your [preferences][]. [compile and run commands]: api.html#_M.Compile.and.Run -[preferences]: manual.html#...textadept +[preferences]: manual.html#textadept - - - diff --git a/docs/index.html b/docs/index.html index 0b519113..cf1ebdeb 100644 --- a/docs/index.html +++ b/docs/index.html @@ -72,7 +72,6 @@ Source
  • Other versions
    • -
  • PGP signatures

    • Nightly* Builds

    diff --git a/modules/lua/ta_api b/modules/lua/ta_api index 4b170a76..c4ef78b4 100644 --- a/modules/lua/ta_api +++ b/modules/lua/ta_api @@ -377,7 +377,7 @@ brace_highlight view.brace_highlight(view, pos1, pos2)\nHighlights the character brace_highlight_indicator view.brace_highlight_indicator(view, use_indicator, indicator)\nHighlights matching brace characters with indicator number *indicator*, in\nthe range of `1` to `32`, instead of the\n`view.STYLE_BRACELIGHT` style if *use_indicator* is `true`.\n@param view A view.\n@param use_indicator Whether or not to use an indicator.\n@param indicator The indicator number to use. brace_match buffer.brace_match(buffer, pos, max_re_style)\nReturns the position of the matching brace for the brace character at\nposition *pos*, taking nested braces into account, or `-1`.\nThe brace characters recognized are '(', ')', '[', ']', '{', '}', '<', and\n'>' and must have the same style.\n@param buffer A buffer.\n@param pos The position of the brace in *buffer* to match.\n@param max_re_style Must be `0`. Reserved for expansion.\n@return number brace_matches textadept.editing.brace_matches (table)\nTable of brace characters to highlight.\nThe ASCII values of brace characters are keys and are assigned non-`nil`\nvalues. The default brace characters are '(', ')', '[', ']', '{', and '}'. -buffer _G.buffer (module)\nA Textadept buffer object.\nConstants are documented in the fields they apply to.\nWhile you can work with individual buffer instances, it is really only useful\nto work with the global one.\nMany of these functions and fields are derived from buffer-specific\nfunctionality of the Scintilla editing component, and additional information\ncan be found on the Scintilla website:\nhttp://scintilla.org/ScintillaDoc.html.\nNote that with regard to Scintilla-specific functionality, this API is a\n_suggestion_, not a hard requirement. All of that functionality also exists\nin `view`, even if undocumented.\nAny buffer fields set on startup (e.g. in *~/.textadept/init.lua*) will be\nthe default, initial values for all buffers. +buffer _G.buffer (module)\nA Textadept buffer object.\nConstants are documented in the fields they apply to.\nWhile you can work with individual buffer instances, it is really only useful\nto work with the global one.\nMany of these functions and fields are derived from buffer-specific\nfunctionality of the Scintilla editing component, and additional information\ncan be found on the Scintilla website:\nhttps://scintilla.org/ScintillaDoc.html.\nNote that with regard to Scintilla-specific functionality, this API is a\n_suggestion_, not a hard requirement. All of that functionality also exists\nin `view`, even if undocumented.\nAny buffer fields set on startup (e.g. in *~/.textadept/init.lua*) will be\nthe default, initial values for all buffers. buffer _G.buffer (table)\nThe current buffer in the current view. buffer view.buffer (table)\nThe buffer the view currently contains. (Read-only) buffer_statusbar_text ui.buffer_statusbar_text (string, Write-only)\nThe text displayed in the buffer statusbar. @@ -960,7 +960,7 @@ vc_home_rect_extend buffer.vc_home_rect_extend(buffer)\nLike `buffer.vc_home()`, vc_home_wrap buffer.vc_home_wrap(buffer)\nMoves the caret to the first visible character on the current wrapped line\nor, if already there, to the beginning of the actual line.\n@param buffer A buffer. vc_home_wrap_extend buffer.vc_home_wrap_extend(buffer)\nLike `buffer.vc_home_wrap()`, but extends the selected text to the new\nposition.\n@param buffer A buffer. vertical_center_caret view.vertical_center_caret(view)\nCenters current line in the view.\n@param view A view. -view _G.view (module)\nA Textadept view object.\nConstants are documented in the fields they apply to.\nWhile you can work with individual view instances, it is often useful to work\nwith just the global one.\nMany of these functions and fields are derived from view-specific\nfunctionality the Scintilla editing component, and additional information can\nbe found on the Scintilla website:\nhttp://scintilla.org/ScintillaDoc.html\nNote that with regard to Scintilla-specific functionality, this API is a\n_suggestion_, not a hard requirement. All of that functionality also exists\nin `buffer`, even if undocumented.\nAny view fields set on startup (e.g. in *~/.textadept/init.lua*) will be the\ndefault, initial values for all views. +view _G.view (module)\nA Textadept view object.\nConstants are documented in the fields they apply to.\nWhile you can work with individual view instances, it is often useful to work\nwith just the global one.\nMany of these functions and fields are derived from view-specific\nfunctionality the Scintilla editing component, and additional information can\nbe found on the Scintilla website:\nhttps://scintilla.org/ScintillaDoc.html.\nNote that with regard to Scintilla-specific functionality, this API is a\n_suggestion_, not a hard requirement. All of that functionality also exists\nin `buffer`, even if undocumented.\nAny view fields set on startup (e.g. in *~/.textadept/init.lua*) will be the\ndefault, initial values for all views. view _G.view (table)\nThe current view. view_eol view.view_eol (bool)\nDisplay end of line characters.\nThe default value is `false`. view_ws view.view_ws (number)\nThe whitespace visibility mode.\n\n* `view.WS_INVISIBLE`\n Whitespace is invisible.\n* `view.WS_VISIBLEALWAYS`\n Display all space characters as dots and tab characters as arrows.\n* `view.WS_VISIBLEAFTERINDENT`\n Display only non-indentation spaces and tabs as dots and arrows.\n* `view.WS_VISIBLEONLYININDENT`\n Display only indentation spaces and tabs as dots and arrows.\n\nThe default value is `view.WS_INVISIBLE`. diff --git a/modules/textadept/run.lua b/modules/textadept/run.lua index ffccc7e7..89f68b56 100644 --- a/modules/textadept/run.lua +++ b/modules/textadept/run.lua @@ -5,7 +5,7 @@ local M = {} --[[ This comment is for LuaDoc. --- -- Compile and run source code files with Textadept. --- [Language modules](#_M.Compile.and.Run) may tweak the `compile_commands`, +-- [Language modules](#compile-and-run) may tweak the `compile_commands`, -- `run_commands`, and `error_patterns` tables for particular languages. -- The user may tweak `build_commands` for particular projects. -- @field run_in_background (bool) diff --git a/modules/textadept/snippets.lua b/modules/textadept/snippets.lua index c5be6a34..5fcb6a31 100644 --- a/modules/textadept/snippets.lua +++ b/modules/textadept/snippets.lua @@ -100,7 +100,7 @@ local M = {} -- A single set of line ending delimiters based on the buffer's end of line mode -- ([`buffer.eol_mode`]()). -- --- [`io.popen()`]: http://www.lua.org/manual/5.3/manual.html#pdf-io.popen +-- [`io.popen()`]: https://www.lua.org/manual/5.3/manual.html#pdf-io.popen -- -- @field INDIC_PLACEHOLDER (number) -- The snippet placeholder indicator number. diff --git a/scripts/fill_layout.lua b/scripts/fill_layout.lua index c0ecf890..a60584dc 100755 --- a/scripts/fill_layout.lua +++ b/scripts/fill_layout.lua @@ -8,7 +8,7 @@ local p = io.popen('markdown -f toc -T ' .. arg[1]) local html = p:read('*a'):match('^.-\n\n(.+)$') html = html:gsub('