git.iko.soy/typeable/pandoc
on master help sign in
Lua filter docs: document fields of inline objects
2e63e2fAlbert Krewinkel
doc/lua-filter-types-and-objects.md+96−14
compare with master
unifiedsplit
@@ -270,19 +270,32 @@ content
270tag, t
270tag, t
271: the literal `Emph` (string)
271: the literal `Emph` (string)
272
272
273−<!-- TODO -->
274−
275### Image
273### Image
276Image: alt text (list of inlines), target
274Image: alt text (list of inlines), target
277
275
278−tag, t
276+attr
279−: the literal `Image` (string)
277+: attributes ([Attr])
280
278
281−### Link
279+caption
282−Hyperlink: alt text (list of inlines), target
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])
283
296
284tag, t
297tag, t
285−: the literal `Link` (string)
298+: the literal `Image` (string)
286
299
287### LineBreak
300### LineBreak
288Hard line break
301Hard line break
@@ -290,20 +303,62 @@ Hard line break
290tag, t
303tag, t
291: the literal `LineBreak` (string)
304: the literal `LineBreak` (string)
292
305
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+
293### Math
330### Math
294TeX math (literal)
331TeX math (literal)
295
332
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+
296tag, t
341tag, t
297: the literal `Math` (string)
342: the literal `Math` (string)
298
343
299### Note
344### Note
300Footnote or endnote
345Footnote or endnote
301
346
347+content
348+: ([list] of [blocks])
349+
302tag, t
350tag, t
303: the literal `Note` (string)
351: the literal `Note` (string)
304
352
305### Quoted
353### 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])
307
362
308tag, t
363tag, t
309: the literal `Quoted` (string)
364: the literal `Quoted` (string)
@@ -311,11 +366,20 @@ tag, t
311### RawInline
366### RawInline
312Raw inline
367Raw inline
313
368
369+format
370+: the format of the content (string)
371+
372+text
373+: raw content (string)
374+
314tag, t
375tag, t
315: the literal `RawInline` (string)
376: the literal `RawInline` (string)
316
377
317### SmallCaps
378### SmallCaps
318−Small caps text (list of inlines)
379+Small caps text
380+
381+content
382+: ([list] of [inlines])
319
383
320tag, t
384tag, t
321: the literal `SmallCaps` (string)
385: the literal `SmallCaps` (string)
@@ -338,6 +402,9 @@ Generic inline container with attributes
338attr
402attr
339: attributes ([Attr])
403: attributes ([Attr])
340
404
405+content
406+: wrapped content ([list] of [inlines])
407+
341identifier
408identifier
342: alias for `attr.identifier` (string)
409: alias for `attr.identifier` (string)
343
410
@@ -351,31 +418,46 @@ tag, t
351: the literal `Span` (string)
418: the literal `Span` (string)
352
419
353### Str
420### Str
354−Text (string)
421+Text
422+
423+text
424+: content (string)
355
425
356tag, t
426tag, t
357: the literal `Str` (string)
427: the literal `Str` (string)
358
428
359### Strikeout
429### Strikeout
360−Strikeout text (list of inlines)
430+Strikeout text
431+
432+content
433+: inline content ([list] of [inlines])
361
434
362tag, t
435tag, t
363: the literal `Strikeout` (string)
436: the literal `Strikeout` (string)
364
437
365### Strong
438### Strong
366−Strongly emphasized text (list of inlines)
439+Strongly emphasized text
440+
441+content
442+: inline content ([list] of [inlines])
367
443
368tag, t
444tag, t
369: the literal `Strong` (string)
445: the literal `Strong` (string)
370
446
371### Subscript
447### Subscript
372−Subscripted text (list of inlines)
448+Subscripted text
449+
450+content
451+: inline content ([list] of [inlines])
373
452
374tag, t
453tag, t
375: the literal `Subscript` (string)
454: the literal `Subscript` (string)
376
455
377### Superscript
456### Superscript
378−Superscripted text (list of inlines)
457+Superscripted text
458+
459+content
460+: inline content ([list] of [inlines])
379
461
380tag, t
462tag, t
381: the literal `Superscript` (string)
463: the literal `Superscript` (string)