From c436febaf7f7b7605bf61777931e97831d956d83 Mon Sep 17 00:00:00 2001 From: mitchell <70453897+orbitalquark@users.noreply.github.com> Date: Sun, 13 Sep 2020 18:20:00 -0400 Subject: Lots of documentation updates. Updated header id generation, anchors, links, and header levels. Added dedicated book page and support data. Removed extra module autocompletion and documentation from Lua module. Removed GPG signing and verification, as everything is built and distributed on GitHub. Removed all release links prior to 10.8 since there is no point in uploading the relevant files to GitHub. --- core/._M.luadoc | 16 ++++++++-------- core/init.lua | 2 +- core/keys.lua | 10 +++++----- core/ui.lua | 2 +- 4 files changed, 15 insertions(+), 15 deletions(-) (limited to 'core') diff --git a/core/._M.luadoc b/core/._M.luadoc index d637da3c..fb7d3e7b 100644 --- a/core/._M.luadoc +++ b/core/._M.luadoc @@ -1,4 +1,4 @@ --- Copyright 2007-2018 Mitchell mitchell.att.foicica.com. See LICENSE. +-- Copyright 2007-2020 Mitchell mitchell.att.foicica.com. See LICENSE. -- This is a DUMMY FILE used for making LuaDoc for built-in functions in the -- global _M table. @@ -25,7 +25,7 @@ -- -- Examples of these features are described in the sections below. -- --- ## Block Comment +-- ### Block Comment -- -- Many languages have different syntaxes for single line comments and -- multi-line comments in source code. Textadept's block comment feature only @@ -36,7 +36,7 @@ -- -- textadept.editing.comment_string.ansi_c = '//' -- change from /* ... */ -- --- ## Compile and Run +-- ### Compile and Run -- -- Textadept knows most of the commands that compile and/or run code in source -- files. However, it does not know all of them, and the ones that it does know @@ -57,7 +57,7 @@ -- if not patterns.lua then patterns.lua = {} end -- patterns.lua[#patterns.lua + 1] = '^luac?: (.-):(%d+): (.+)$' -- --- ## Buffer Properties +-- ### Buffer Properties -- -- By default, Textadept uses 2 spaces for indentation. Some languages have -- different indentation guidelines, however. As described in the manual, use @@ -71,7 +71,7 @@ -- view.view_ws = view.WS_VISIBLEALWAYS -- end -- --- ## Autocompletion and Documentation +-- ### Autocompletion and Documentation -- -- Textadept has the capability to autocomplete symbols for programming -- languages and display API documentation. In order for these to work for a @@ -80,7 +80,7 @@ -- included language modules have examples of autocompleters and API -- documentation, as well as most of its officially supported language modules. -- --- ## Snippets +-- ### Snippets -- -- [Snippets](#textadept.snippets) for common language constructs are useful. -- Some snippets for common Lua control structures look like this: @@ -92,7 +92,7 @@ -- forp = "for %1(k), %2(v) in pairs(%3(table)) do\n\t%0\nend", -- } -- --- ## Commands +-- ### Commands -- -- Additional editing features for the language can be useful. For example, a -- C++ module might have a feature to add a ';' to the end of the current line @@ -118,7 +118,7 @@ -- ... -- } -- --- ## Menus +-- ### Menus -- -- It may be useful to add language-specific menu options to the top-level menu -- and/or right-click context menu in order to access module features without diff --git a/core/init.lua b/core/init.lua index 37f94af3..ed2f66ba 100644 --- a/core/init.lua +++ b/core/init.lua @@ -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#curses-compatibility module('_G')]] --[[ The tables below were defined in C. diff --git a/core/keys.lua b/core/keys.lua index 8d03c284..b20244a6 100644 --- a/core/keys.lua +++ b/core/keys.lua @@ -6,7 +6,7 @@ local M = {} --- -- Manages key bindings in Textadept. -- --- ## Overview +-- ### Overview -- -- Define key bindings in the global `keys` table in key-value pairs. Each pair -- consists of either a string key sequence and its associated command, a string @@ -24,7 +24,7 @@ local M = {} -- autocompletion, but fall back to word autocompletion if the first command -- fails.) -- --- ## Key Sequences +-- ### Key Sequences -- -- Key sequences are strings built from an ordered combination of modifier keys -- and the key's inserted character. Modifier keys are "Control", "Shift", and @@ -53,7 +53,7 @@ local M = {} -- *core/keys.lua* causes Textadept to print key sequences to standard out -- (stdout) for inspection. -- --- ## Commands +-- ### Commands -- -- A command bound to a key sequence is simply a Lua function. For example: -- @@ -63,7 +63,7 @@ local M = {} -- -- Textadept handles [`buffer`]() references properly in static contexts. -- --- ## Modes +-- ### Modes -- -- Modes are groups of key bindings such that when a key [mode](#keys.mode) is -- active, Textadept ignores all key bindings defined outside the mode until the @@ -89,7 +89,7 @@ local M = {} -- **Warning**: When creating a mode, be sure to define a way to exit the mode, -- otherwise you will probably have to restart Textadept. -- --- ## Key Chains +-- ### Key Chains -- -- Key chains are a powerful concept. They allow you to assign multiple key -- bindings to one key sequence. By default, the `Esc` key cancels a key chain, diff --git a/core/ui.lua b/core/ui.lua index 438d7494..30187098 100644 --- a/core/ui.lua +++ b/core/ui.lua @@ -540,7 +540,7 @@ The functions below are Lua C functions. -- Table arguments containing strings are allowed and expanded in place. This is -- useful for filtered list dialogs with many items. -- --- [gtdialog]: http://foicica.com/gtdialog/manual.html#Usage +-- [gtdialog]: https://orbitalquark.github.io/gtdialog/manual.html -- @param kind The kind of gtdialog. -- @param ... Parameters to the gtdialog. -- @return string gtdialog result. -- cgit v1.2.3