README.md

   1 ta-parkour is a structured editing plugin for the [Textadept editor](https://github.com/orbitalquark/textadept),
   2 based on the [parkour library](https://repo.or.cz/lisp-parkour.git).
   3
   4 # Configuration
   5
   6 In `~/.textadept/init.lua`:
   7
   8     local pk = require'ta-parkour'
   9
  10     -- optional (example values):
  11     pk.auto_square_brackets = true
  12     pk.lispwords.scheme.lambda = 0
  13     pk.repl_fifo = os.getenv('HOME')..'/.repl_fifo'
  14     pk.emacs = true
  15     pk.compat = true
  16
  17 ## `auto_square_brackets`
  18
  19 Rewrites any delimiter to a square bracket at certain locations.
  20 Has effect only on Scheme; for Clojure and Fennel this behaviour is always on.
  21 Works both when inserting and wrapping.
  22 The locations are not configurable ATM, but are grouped by language in the code - see, for example, the [Fennel config](parkour/cfg-fennel.lua#l24).
  23
  24 ## `lispwords`_`.dialect.word`_
  25
  26 The plugin comes with a set of indentation rules for each supported file type,
  27 but they are incomplete and sometimes will be wrong (due to multiple possible dialects under a single file type).
  28 The `lispwords` table allows customizing those rules by setting the desired number of distinguished arguments
  29 a function/macro has. (`0` is like `defun` in Emacs.)
  30 As an example, see the built-in indent numbers [for Scheme](parkour/cfg-scheme.lua#l11).
  31
  32 ## `repl_fifo`
  33
  34 This option can be set to the path of a named pipe from which a REPL (or anything, really) can read input.
  35 Inserting a newline at the end of the last line of a paragraph will send the paragraph to this pipe.
  36 Since REPL commands fit the criteria for paragraph (a top-level S-expression), they get sent as well.
  37
  38 ## `emacs`
  39
  40 The plugin comes with two key themes - [emacs](keytheme/emacs.lua) and [CUA](keytheme/CUA.lua).
  41 `CUA` is always enabled.
  42 Setting this option to true will enable the `emacs` key theme, too. (A few CUA and built-in key bindings will be overridden.)
  43
  44 ## `compat`
  45
  46 Setting this option to true will swap some of the motions in the native key theme with ones more resembling the built-in CUA motions.
  47 See [CUA-compat](keytheme/CUA-compat.lua).
  48
  49 __Note:__ menu mnemonics conflicting with `Alt+` shortcuts of an active key theme will be disabled in the current buffer.
  50 __Note:__ The linked key themes are the only "documentation" on the available keyboard shortcuts ATM.