git.iko.soy/typeable/pandoc
on master help sign in
Lua filter docs: document fields of inline objects
commit2e63e2f2bc76407a0c8610154e8127d5fa4b3279 authorAlbert Krewinkel <albert@zeitkraut.de> dateThu 11 Oct 2018, 20:50 (8 years ago) parentf5c64c3
1 file changed+96−14
doc/lua-filter-types-and-objects.md+96−14
doc/lua-filter-types-and-objects.md+96−14
@@ -270,19 +270,32 @@ content
270270tag, t
271271: the literal `Emph` (string)
272272
273−<!-- TODO -->
274−
275273### Image
276274Image: alt text (list of inlines), target
277275
278−tag, t
279−: the literal `Image` (string)
276+attr
277+: attributes ([Attr])
280278
281−### Link
282−Hyperlink: alt text (list of inlines), target
279+caption
280+: text used to describe the image ([list] of [inlines])
281+
282+src
283+: path to the image file (string)
284+
285+title
286+: brief image description
287+
288+identifier
289+: alias for `attr.identifier` (string)
290+
291+classes
292+: alias for `attr.classes` ([list] of strings)
293+
294+attributes
295+: alias for `attr.attributes` ([attributes])
283296
284297tag, t
285−: the literal `Link` (string)
298+: the literal `Image` (string)
286299
287300### LineBreak
288301Hard line break
@@ -290,20 +303,62 @@ Hard line break
290303tag, t
291304: the literal `LineBreak` (string)
292305
306+### Link
307+Hyperlink: alt text (list of inlines), target
308+
309+attr
310+: attributes ([Attr])
311+
312+content
313+: text for this link ([list] of [inlines])
314+
315+target
316+: the link target (string)
317+
318+identifier
319+: alias for `attr.identifier` (string)
320+
321+classes
322+: alias for `attr.classes` ([list] of strings)
323+
324+attributes
325+: alias for `attr.attributes` ([attributes])
326+
327+tag, t
328+: the literal `Link` (string)
329+
293330### Math
294331TeX math (literal)
295332
333+mathype
334+: specifier determining whether the math content should be
335+ shown inline (`InlineMath`) or on a separate line
336+ (`DisplayMath`) (string)
337+
338+text
339+: math content (string)
340+
296341tag, t
297342: the literal `Math` (string)
298343
299344### Note
300345Footnote or endnote
301346
347+content
348+: ([list] of [blocks])
349+
302350tag, t
303351: the literal `Note` (string)
304352
305353### Quoted
306−Quoted text (list of inlines)
354+Quoted text
355+
356+quotetype
357+: type of quotes to be used; one of `SingleQuote` or
358+ `DoubleQuote` (string)
359+
360+content
361+: quoted text ([list] of [inlines])
307362
308363tag, t
309364: the literal `Quoted` (string)
@@ -311,11 +366,20 @@ tag, t
311366### RawInline
312367Raw inline
313368
369+format
370+: the format of the content (string)
371+
372+text
373+: raw content (string)
374+
314375tag, t
315376: the literal `RawInline` (string)
316377
317378### SmallCaps
318−Small caps text (list of inlines)
379+Small caps text
380+
381+content
382+: ([list] of [inlines])
319383
320384tag, t
321385: the literal `SmallCaps` (string)
@@ -338,6 +402,9 @@ Generic inline container with attributes
338402attr
339403: attributes ([Attr])
340404
405+content
406+: wrapped content ([list] of [inlines])
407+
341408identifier
342409: alias for `attr.identifier` (string)
343410
@@ -351,31 +418,46 @@ tag, t
351418: the literal `Span` (string)
352419
353420### Str
354−Text (string)
421+Text
422+
423+text
424+: content (string)
355425
356426tag, t
357427: the literal `Str` (string)
358428
359429### Strikeout
360−Strikeout text (list of inlines)
430+Strikeout text
431+
432+content
433+: inline content ([list] of [inlines])
361434
362435tag, t
363436: the literal `Strikeout` (string)
364437
365438### Strong
366−Strongly emphasized text (list of inlines)
439+Strongly emphasized text
440+
441+content
442+: inline content ([list] of [inlines])
367443
368444tag, t
369445: the literal `Strong` (string)
370446
371447### Subscript
372−Subscripted text (list of inlines)
448+Subscripted text
449+
450+content
451+: inline content ([list] of [inlines])
373452
374453tag, t
375454: the literal `Subscript` (string)
376455
377456### Superscript
378−Superscripted text (list of inlines)
457+Superscripted text
458+
459+content
460+: inline content ([list] of [inlines])
379461
380462tag, t
381463: the literal `Superscript` (string)