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. --- README.md | 33 +- core/._M.luadoc | 16 +- core/init.lua | 2 +- core/keys.lua | 10 +- core/ui.lua | 2 +- docs/_layouts/default.html | 16 +- docs/api.md | 11585 +++++++++++++++++++++++++++++++++++++++ docs/book.md | 50 + docs/changelog.md | 2593 +-------- docs/faq.md | 6 +- docs/images/quickref_small.png | Bin 0 -> 25195 bytes docs/index.html | 82 +- docs/manual.md | 105 +- docs/markdowndoc.lua | 13 +- docs/media.md | 74 - docs/quickref_excerpt.pdf | Bin 0 -> 344672 bytes docs/style.css | 8 +- modules/lua/ta_api | 153 +- modules/lua/ta_tags | 158 +- modules/textadept/keys.lua | 2 +- modules/textadept/snippets.lua | 20 +- scripts/fill_layout.lua | 4 + src/Makefile | 34 +- 23 files changed, 12010 insertions(+), 2956 deletions(-) create mode 100644 docs/api.md create mode 100644 docs/book.md create mode 100644 docs/images/quickref_small.png delete mode 100644 docs/media.md create mode 100644 docs/quickref_excerpt.pdf diff --git a/README.md b/README.md index f339cd4f..42f4539f 100644 --- a/README.md +++ b/README.md @@ -37,23 +37,24 @@ implementation of curses like [ncurses][](w). ## Download -Download Textadept from the project's [download page][] by selecting the -appropriate package for your platform. You can also download a separate set of -modules that provide extra features and functionality to the core application. +Textadept releases can be found [here][1]. Select the appropriate package for +your platform. A comprehensive list of changes between releases can be found +[here][2]. You can also download a separate set of modules that provide extra +features and functionality to the core application. -[download page]: https://foicica.com/textadept/download +[1]: https://github.com/orbitalquark/textadept/releases +[2]: https://orbitalquark.github.io/textadept/changelog.html ## Installation and Usage -Textadept comes with a comprehensive user manual in its *docs/* directory. This -manual is also available [online][1]. It covers all of Textadept's main -features, including installation, usage, configuration, theming, scripting, and -compilation. +Textadept comes with a comprehensive [user manual][] in its *docs/* directory. +It covers all of Textadept's main features, including installation, usage, +configuration, theming, scripting, and compilation. Since nearly every aspect of Textadept can be scripted using Lua, the editor's -API is heavily documented. This documentation is also located in *docs/* and -available [online][2]. It serves as the ultimate resource when it comes to -scripting the application. +API is heavily documented. This [API documentation][] is also located in +*docs/*. It serves as the ultimate resource when it comes to scripting the +application. A more structured scripting resource is [Textadept Quick Reference][], which contains a wealth of knowledge on how to script and configure Textadept. It @@ -61,9 +62,9 @@ groups the editor's rich API into a series of tasks in a convenient and easy-to-use manner. This book serves as the perfect complement to Textadept's Manual and exhaustive API documentation. -[1]: https://foicica.com/textadept/manual.html -[2]: https://foicica.com/textadept/api.html -[Textadept Quick Reference]: https://foicica.com/textadept/media.html#Book +[user manual]: https://orbitalquark.github.io/textadept/manual.html +[API documentation]: https://orbitalquark.github.io/textadept/api.html +[Textadept Quick Reference]: https://orbitalquark.github.io/textadept/book.html ## Compile @@ -121,7 +122,7 @@ For more information on compiling Textadept, please see the [manual][]. [mingw-w64]: https://mingw-w64.org/ [OSX cross toolchain]: https://github.com/tpoechtrager/osxcross [Clang]: https://clang.llvm.org/ -[manual]: https://foicica.com/textadept/manual.html#Compiling +[manual]: https://orbitalquark.github.io/textadept/manual.html#compiling ## Contribute @@ -133,6 +134,6 @@ submit patches either to the [mailing list][], or to me personally (mitchell.att.foicica.com). [donation]: https://gum.co/textadept -[book]: https://foicica.com/textadept/media.html#Book +[book]: https://orbitalquark.github.io/textadept/book.html [open source]: https://github.com/orbitalquark/textadept [mailing list]: http://foicica.com/lists 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. diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 84fb9667..59af59e0 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -12,22 +12,22 @@