11e9940 · typeable/pandoc

git.iko.soy/typeable/pandoc

docs: capitalize Lua where it refers to the programming language name

This follows the advise on the Lua website (https://www.lua.org/about.html#name): > […] "Lua" is a name, the name of the Earth's moon and the name of the > language. Like most names, it should be written in lower case with an > initial capital, that is, "Lua".

commit11e99409cec24749df5dabeb4dca96c084ddbc75 authorAlbert Krewinkel <albert@zeitkraut.de> dateSun 12 Jan 2020, 11:22 (7 years ago) parent6fd3d54

3 files changed+32−32

compare with master

unifiedsplit

MANUAL.txt+15−15 README.md+2−2 doc/lua-filters.md+15−15

MANUAL.txt+15−15

@@ -325,7 +325,7 @@ header when requesting a document from a URL:

325325 - `tei` ([TEI Simple])

326326 - `xwiki` ([XWiki markup])

327327 - `zimwiki` ([ZimWiki markup])

328− - the path of a custom lua writer, see [Custom writers] below

328+ - the path of a custom Lua writer, see [Custom writers] below

329329 :::

330330

331331 Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed

@@ -574,22 +574,22 @@ header when requesting a document from a URL:

574574

575575 3. `$PATH` (executable only)

576576

577− Filters and lua-filters are applied in the order specified

577+ Filters and Lua-filters are applied in the order specified

578578 on the command line.

579579

580580`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*

581581

582582: Transform the document in a similar fashion as JSON filters (see

583− `--filter`), but use pandoc's build-in lua filtering system. The given

584− lua script is expected to return a list of lua filters which will be

585− applied in order. Each lua filter must contain element-transforming

583+ `--filter`), but use pandoc's build-in Lua filtering system. The given

584+ Lua script is expected to return a list of Lua filters which will be

585+ applied in order. Each Lua filter must contain element-transforming

586586 functions indexed by the name of the AST element on which the filter

587587 function should be applied.

588588

589− The `pandoc` lua module provides helper functions for element

590− creation. It is always loaded into the script's lua environment.

589+ The `pandoc` Lua module provides helper functions for element

590+ creation. It is always loaded into the script's Lua environment.

591591

592− The following is an example lua script for macro-expansion:

592+ The following is an example Lua script for macro-expansion:

593593

594594 function expand_hello_world(inline)

595595 if inline.c == '{{helloworld}}' then

@@ -601,7 +601,7 @@ header when requesting a document from a URL:

601601

602602 return {{Str = expand_hello_world}}

603603

604− In order of preference, pandoc will look for lua filters in

604+ In order of preference, pandoc will look for Lua filters in

605605

606606 1. a specified full or relative path (executable or

607607 non-executable)

@@ -1477,7 +1477,7 @@ include-after-body: []

14771477include-in-header: []

14781478resource-path: ["."]

14791479

1480−# filters will be assumed to be lua filters if they have

1480+# filters will be assumed to be Lua filters if they have

14811481# the .lua extension, and json filters otherwise. But

14821482# the filter type can also be specified explicitly, as shown:

14831483filters:

@@ -5829,15 +5829,15 @@ same styles in your input and output files.

58295829

58305830# Custom writers

58315831

5832−Pandoc can be extended with custom writers written in [lua]. (Pandoc

5833−includes a lua interpreter, so lua need not be installed separately.)

5832+Pandoc can be extended with custom writers written in [Lua]. (Pandoc

5833+includes a Lua interpreter, so Lua need not be installed separately.)

58345834

5835−To use a custom writer, simply specify the path to the lua script

5835+To use a custom writer, simply specify the path to the Lua script

58365836in place of the output format. For example:

58375837

58385838 pandoc -t data/sample.lua

58395839

5840−Creating a custom writer requires writing a lua function for each

5840+Creating a custom writer requires writing a Lua function for each

58415841possible element in a pandoc document. To get a documented example

58425842which you can modify according to your needs, do

58435843

@@ -5850,7 +5850,7 @@ default template with the name

58505850`default.NAME_OF_CUSTOM_WRITER.lua` to the `templates`

58515851subdirectory of your user data directory (see [Templates]).

58525852

5853−[lua]: http://www.lua.org

5853+[Lua]: http://www.lua.org

58545854

58555855# A note on security

58565856

README.md+2−2

@@ -169,7 +169,7 @@ It can convert *to*

169169 markup](https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/))

170170 - `zimwiki` ([ZimWiki

171171 markup](http://zim-wiki.org/manual/Help/Wiki_Syntax.html))

172− - the path of a custom lua writer, see [Custom

172+ - the path of a custom Lua writer, see [Custom

173173 writers](https://pandoc.org/MANUAL.html#custom-writers) below

174174

175175</div>

@@ -188,7 +188,7 @@ convert this native representation into a target format. Thus, adding an

188188input or output format requires only adding a reader or writer. Users

189189can also run custom pandoc filters to modify the intermediate AST (see

190190the documentation for [filters](https://pandoc.org/filters.html) and

191−[lua filters](https://pandoc.org/lua-filters.html)).

191+[Lua filters](https://pandoc.org/lua-filters.html)).

192192

193193Because pandoc’s intermediate representation of a document is less

194194expressive than many of the formats it converts between, one should not

doc/lua-filters.md+15−15

@@ -29,13 +29,13 @@ used by anyone who has a certain version of the pandoc

2929executable.

3030

3131Starting with version 2.0, pandoc makes it possible to write

32−filters in lua without any external dependencies at all. A lua

33−interpreter (version 5.3) and a lua library for creating pandoc

32+filters in Lua without any external dependencies at all. A Lua

33+interpreter (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 marshalled to Lua directly, avoiding the overhead of writing

3636JSON to stdout and reading it from stdin.

3737

38−Here is an example of a lua filter that converts strong emphasis

38+Here is an example of a Lua filter that converts strong emphasis

3939to small caps:

4040

4141``` lua

@@ -74,7 +74,7 @@ Python (`smallcaps.py`):

7474 `pandoc --filter ./smallcaps.py` 1.40s

7575 `pandoc --lua-filter ./smallcaps.lua` 1.03s

7676

77−As you can see, the lua filter avoids the substantial overhead

77+As you can see, the Lua filter avoids the substantial overhead

7878associated with marshalling to and from JSON over a pipe.

7979

8080# Lua filter structure

@@ -91,10 +91,10 @@ then it would be applied like this:

9191

9292The `--lua-filter` option may be supplied multiple times. Pandoc

9393applies all filters (including JSON filters specified via

94−`--filter` and lua filters specified via `--lua-filter`) in the

94+`--filter` and Lua filters specified via `--lua-filter`) in the

9595order they appear on the command line.

9696

97−Pandoc expects each lua file to return a list of filters. The

97+Pandoc expects each Lua file to return a list of filters. The

9898filters in that list are called sequentially, each on the result

9999of the previous filter. If there is no value returned by the

100100filter script, then pandoc will try to generate a single filter

@@ -104,7 +104,7 @@ those of pandoc elements (e.g., `Str`, `Para`, `Meta`, or

104104

105105For each filter, the document is traversed and each element

106106subjected to the filter. Elements for which the filter contains

107−an entry (i.e. a function of the same name) are passed to lua

107+an entry (i.e. a function of the same name) are passed to Lua

108108element filtering function. In other words, filter entries will

109109be called for each corresponding element in the document,

110110getting the respective element as input.

@@ -208,7 +208,7 @@ variables.

208208

209209# Pandoc Module

210210

211−The `pandoc` lua module is loaded into the filter's lua

211+The `pandoc` Lua module is loaded into the filter's Lua

212212environment and provides a set of functions and constants to

213213make creation and manipulation of elements easier. The global

214214variable `pandoc` is bound to the module and should generally

@@ -222,15 +222,15 @@ functionalities.

222222

223223Element creator functions like `Str`, `Para`, and `Pandoc` are

224224designed to allow easy creation of new elements that are simple

225−to use and can be read back from the lua environment.

226−Internally, pandoc uses these functions to create the lua

225+to use and can be read back from the Lua environment.

226+Internally, pandoc uses these functions to create the Lua

227227objects which are passed to element filter functions. This means

228228that elements created via this module will behave exactly as

229229those elements accessible through the filter function parameter.

230230

231231## Exposed pandoc functionality

232232

233−Some pandoc functions have been made available in lua:

233+Some pandoc functions have been made available in Lua:

234234

235235- [`walk_block`](#pandoc.walk_block) and

236236 [`walk_inline`](#pandoc.walk_inline) allow filters to be applied

@@ -269,7 +269,7 @@ colon syntax (`mystring:uc_upper()`).

269269# Examples

270270

271271The following filters are presented as examples. A repository of

272−useful lua filters (which may also serve as good examples) is

272+useful Lua filters (which may also serve as good examples) is

273273available at <https://github.com/pandoc/lua-filters>.

274274

275275## Macro substitution

@@ -2478,7 +2478,7 @@ Parameters:

24782478: the block element

24792479

24802480`filter`:

2481−: a lua filter (table of functions) to be applied within the

2481+: a Lua filter (table of functions) to be applied within the

24822482 block element

24832483

24842484Returns: the transformed block element

@@ -2495,7 +2495,7 @@ Parameters:

24952495: the inline element

24962496

24972497`filter`:

2498−: a lua filter (table of functions) to be applied within the

2498+: a Lua filter (table of functions) to be applied within the

24992499 inline element

25002500

25012501Returns: the transformed inline element