git.iko.soy/typeable/pandoc
on master help sign in
doc/lua-filters.md: fix typos

Use American spelling.

commit4d564ce59751a9baee7149fdb9628418ee277b04 authorAlbert Krewinkel <albert@zeitkraut.de> dateMon 12 Oct 2020, 16:57 (6 years ago) parent34c75e0
1 file changed+24−20
doc/lua-filters.md+24−20
doc/lua-filters.md+24−20
@@ -32,7 +32,7 @@ Starting with version 2.0, pandoc makes it possible to write
3232filters in Lua without any external dependencies at all. A Lua
3333interpreter (version 5.3) and a Lua library for creating pandoc
3434filters is built into the pandoc executable. Pandoc data types
35−are marshalled to Lua directly, avoiding the overhead of writing
35+are marshaled to Lua directly, avoiding the overhead of writing
3636JSON to stdout and reading it from stdin.
3737
3838Here is an example of a Lua filter that converts strong emphasis
@@ -75,7 +75,7 @@ Python (`smallcaps.py`):
7575 `pandoc --lua-filter ./smallcaps.lua` 1.03s
7676
7777As you can see, the Lua filter avoids the substantial overhead
78−associated with marshalling to and from JSON over a pipe.
78+associated with marshaling to and from JSON over a pipe.
7979
8080# Lua filter structure
8181
@@ -292,7 +292,7 @@ use-case would be to load additional modules, or even to alter
292292default modules.
293293
294294The following snippet is an example of code that might be useful
295−when added to `init.lua`. The snippet adds all unicode-aware
295+when added to `init.lua`. The snippet adds all Unicode-aware
296296functions defined in the [`text` module](#module-text) to the
297297default `string` module, prefixed with the string `uc_`.
298298
@@ -307,21 +307,25 @@ colon syntax (`mystring:uc_upper()`).
307307
308308# Debugging Lua filters
309309
310−It is possible to use a debugging interface to halt execution and step through a
311−Lua filter line by line as it is run inside Pandoc. This is accomplished using
312−the remote-debugging interface of the package
313−[`mobdebug`](https://github.com/pkulchenko/MobDebug). Although mobdebug can be
314−run from the terminal, it is more useful run within the donation-ware Lua editor
315−and IDE, [Zerobrane](https://studio.zerobrane.com/). Zerobrane offers a REPL
316−console and UI to step-through and view all variables and state.
310+It is possible to use a debugging interface to halt execution and
311+step through a Lua filter line by line as it is run inside Pandoc.
312+This is accomplished using the remote-debugging interface of the
313+package [`mobdebug`](https://github.com/pkulchenko/MobDebug).
314+Although mobdebug can be run from the terminal, it is more useful
315+run within the donation-ware Lua editor and IDE,
316+[ZeroBrane](https://studio.zerobrane.com/). ZeroBrane offers a
317+REPL console and UI to step-through and view all variables and
318+state.
317319
318320If you already have Lua 5.3 installed, you can add
319−[`mobdebug`](https://luarocks.org/modules/paulclinger/mobdebug) and its
320−dependency [`luasocket`](https://luarocks.org/modules/luasocket/luasocket) using
321−[`luarocks`](https://luarocks.org), which should then be available on the path.
322−Zerobrane also includes both of these in its package, so if you don't want to
323−install Lua seperately, you should add/modify your `LUA_PATH` and `LUA_CPATH` to
324−include the correct locations; [see detailed instructions
321+[`mobdebug`](https://luarocks.org/modules/paulclinger/mobdebug)
322+and its dependency
323+[`luasocket`](https://luarocks.org/modules/luasocket/luasocket)
324+using [`luarocks`](https://luarocks.org), which should then be
325+available on the path. ZeroBrane also includes both of these in
326+its package, so if you don't want to install Lua separately, you
327+should add/modify your `LUA_PATH` and `LUA_CPATH` to include the
328+correct locations; [see detailed instructions
325329here](https://studio.zerobrane.com/doc-remote-debugging).
326330
327331# Examples
@@ -1765,7 +1769,7 @@ A list is any Lua table with integer indices. Indices start at
17651769one, so if `alist = {'value'}` then `alist[1] == 'value'`.
17661770
17671771Lists, when part of an element, or when generated during
1768−marshalling, are made instances of the `pandoc.List` type for
1772+marshaling, are made instances of the `pandoc.List` type for
17691773convenience. The `pandoc.List` type is defined in the
17701774[*pandoc.List*](#module-pandoc.list) module. See there for
17711775available methods.
@@ -2250,7 +2254,7 @@ format, and functions to filter and modify a subtree.
22502254
22512255[`Emph (content)`]{#pandoc.emph}
22522256
2253−: Creates an inline element representing emphasised text.
2257+: Creates an inline element representing emphasized text.
22542258
22552259 Parameters:
22562260
@@ -2453,7 +2457,7 @@ format, and functions to filter and modify a subtree.
24532457
24542458[`Strikeout (content)`]{#pandoc.strikeout}
24552459
2456−: Creates text which is striked out.
2460+: Creates text which is struck out.
24572461
24582462 Parameters:
24592463
@@ -2912,7 +2916,7 @@ Usage:
29122916
29132917`make_sections (number_sections, base_level, blocks)`
29142918
2915−Converst list of [Blocks](#type-block) into sections.
2919+Converts list of [Blocks](#type-block) into sections.
29162920`Div`s will be created beginning at each `Header`
29172921and containing following content until the next `Header`
29182922of comparable level. If `number_sections` is true,