f6559e5 · typeable/pandoc

git.iko.soy/typeable/pandoc

on master help sign in

Lua filter docs: render field names as code

f6559e5Albert Krewinkel8 years ago

doc/lua-filter-types-and-objects.md+131−131

compare with master

unifiedsplit

@@ -4,10 +4,10 @@

5## Pandoc

7−blocks

7+`blocks`

8: document content ([list] of [blocks])

10−meta

10+`meta`

11: document meta information ([Meta] object)

@@ -28,7 +28,7 @@ A list of blocks usable as meta value ([list] of [blocks])

29Fields:

31−tag, t

31+`tag`, `t`

32: the literal `MetaBlocks` (string)

34### MetaBool

@@ -41,7 +41,7 @@ List of inlines used in metadata ([list] of [inline]s)

42Fields:

44−tag, t

44+`tag`, `t`

45: the literal `MetaInlines` (string)

47### MetaList

@@ -50,7 +50,7 @@ A list of other [meta value]s. ([list])

51Fields:

53−tag, t

53+`tag`, `t`

54: the literal `MetaList` (string)

56### MetaMap

@@ -59,7 +59,7 @@ A string-indexed map of meta-values. (table)

60Fields:

62−tag, t

62+`tag`, `t`

63: the literal `MetaMap` (string)

65*Note*: The fields will be shadowed if the map contains a field

@@ -79,96 +79,96 @@ A block quote element

79content:

80: block content ([list] of [blocks])

82−tag, t

82+`tag`, `t`

83: the literal `BlockQuote` (string)

85### BulletList

87A bullet list

89−content

89+`content`

90: list of items ([list] of [blocks])

92−tag, t

92+`tag`, `t`

93: the literal `BulletList` (string)

95### CodeBlock

97Block of code.

99−text

99+`text`

100: code string (string)

101

102−attr

102+`attr`

103: element attributes (Attr)

104

105−identifier

105+`identifier`

106: alias for `attr.identifier` (string)

107

108−classes

108+`classes`

109: alias for `attr.classes` ([list] of strings)

110

111−attributes

111+`attributes`

112: alias for `attr.attributes` ([attributes])

113

114−tag, t

114+`tag`, `t`

115: the literal `CodeBlock` (string)

116

117### DefinitionList

118

119Definition list, containing terms and their explanation.

120

121−content

121+`content`

122: list of items

123

124−tag, t

124+`tag`, `t`

125: the literal `DefinitionList` (string)

126

127### Div

128

129Generic block container with attributes

130

131−content

131+`content`

132: block content ([list] of [blocks])

133

134−attr

134+`attr`

135: element attributes (Attr)

136

137−identifier

137+`identifier`

138: alias for `attr.identifier` (string)

139

140−classes

140+`classes`

141: alias for `attr.classes` ([list] of strings)

142

143−attributes

143+`attributes`

144: alias for `attr.attributes` ([attributes])

145

146−tag, t

146+`tag`, `t`

147: the literal `Div` (string)

148

149### Header

150

151Creates a header element.

152

153−level

153+`level`

154: header level (integer)

155

156−content

156+`content`

157: inline content ([list] of [inlines])

158

159−attr

159+`attr`

160: element attributes (Attr)

161

162−identifier

162+`identifier`

163: alias for `attr.identifier` (string)

164

165−classes

165+`classes`

166: alias for `attr.classes` ([list] of strings)

167

168−attributes

168+`attributes`

169: alias for `attr.attributes` ([attributes])

170

171−tag, t

171+`tag`, `t`

172: the literal `Header` (string)

173

174

@@ -176,7 +176,7 @@ tag, t

176

177A horizontal rule.

178

179−tag, t

179+`tag`, `t`

180: the literal `HorizontalRule` (string)

181

182### LineBlock

@@ -184,10 +184,10 @@ tag, t

184A line block, i.e. a list of lines, each separated from the next

185by a newline.

186

187−content

187+`content`

188: inline content

189

190−tag, t

190+`tag`, `t`

191: the literal `LineBlock` (string)

192

193### Null

@@ -195,7 +195,7 @@ tag, t

195A null element; this element never produces any output in the

196target format.

197

198−tag, t

198+`tag`, `t`

199: the literal `Null` (string)

200

201### OrderedList

@@ -204,55 +204,55 @@ An ordered list.

204

205Parameters:

206

207−items

207+`items`

208: list items ([list] of [blocks])

209

210−listAttributes

210+`listAttributes`

211: list parameters (ListAttributes)

212

213−start

213+`start`

214: alias for `listAttributes.start` (integer)

215

216−style

216+`style`

217: alias for `listAttributes.style` (string)

218

219−delimiter

219+`delimiter`

220: alias for `listAttributes.delimiter` (string)

221

222−tag, t

222+`tag`, `t`

223: the literal `OrderedList` (string)

224

225### Para

226

227A paragraph

228

229−content

229+`content`

230: inline content ([list] of [inlines])

231

232−tag, t

232+`tag`, `t`

233: the literal `Para` (string)

234

235### Plain

236

237Plain text, not a paragraph

238

239−content

239+`content`

240: inline content ([list] of [inlines])

241

242−tag, t

242+`tag`, `t`

243: the literal `Plain` (string)

244

245### RawBlock

246

247Raw content of a specified format.

248

249−format

249+`format`

250: format of content (string)

251

252−text

252+`text`

253: raw content (string)

254

255−tag, t

255+`tag`, `t`

256: the literal `RawBlock` (string)

257

258### Table

@@ -268,13 +268,13 @@ aligns:

268widths:

269: column widths

270

271−headers

271+`headers`

272: header row

273

274rows:

275: table rows

276

277−tag, t

277+`tag`, `t`

278: the literal `Table` (string)

279

280## Inline

@@ -282,235 +282,235 @@ tag, t

282### Cite

283Citation

284

285−content

285+`content`

286: ([list] of [inlines])

287

288−citations

288+`citations`

289: citation entries ([list] of [citations])

290

291−tag, t

291+`tag`, `t`

292: the literal `Cite` (string)

293

294### Code

295Inline code

296

297−text

297+`text`

298: code string (string)

299

300−attr

300+`attr`

301: attributes ([Attr])

302

303−identifier

303+`identifier`

304: alias for `attr.identifier` (string)

305

306−classes

306+`classes`

307: alias for `attr.classes` ([list] of strings)

308

309−attributes

309+`attributes`

310: alias for `attr.attributes` ([attributes])

311

312−tag, t

312+`tag`, `t`

313: the literal `Code` (string)

314

315### Emph

316Emphasized text

317

318−content

318+`content`

319: inline content ([list] of [inlines])

320

321−tag, t

321+`tag`, `t`

322: the literal `Emph` (string)

323

324### Image

325Image: alt text (list of inlines), target

326

327−attr

327+`attr`

328: attributes ([Attr])

329

330−caption

330+`caption`

331: text used to describe the image ([list] of [inlines])

332

333−src

333+`src`

334: path to the image file (string)

335

336−title

336+`title`

337: brief image description

338

339−identifier

339+`identifier`

340: alias for `attr.identifier` (string)

341

342−classes

342+`classes`

343: alias for `attr.classes` ([list] of strings)

344

345−attributes

345+`attributes`

346: alias for `attr.attributes` ([attributes])

347

348−tag, t

348+`tag`, `t`

349: the literal `Image` (string)

350

351### LineBreak

352Hard line break

353

354−tag, t

354+`tag`, `t`

355: the literal `LineBreak` (string)

356

357### Link

358Hyperlink: alt text (list of inlines), target

359

360−attr

360+`attr`

361: attributes ([Attr])

362

363−content

363+`content`

364: text for this link ([list] of [inlines])

365

366−target

366+`target`

367: the link target (string)

368

369−identifier

369+`identifier`

370: alias for `attr.identifier` (string)

371

372−classes

372+`classes`

373: alias for `attr.classes` ([list] of strings)

374

375−attributes

375+`attributes`

376: alias for `attr.attributes` ([attributes])

377

378−tag, t

378+`tag`, `t`

379: the literal `Link` (string)

380

381### Math

382TeX math (literal)

383

384−mathype

384+`mathype`

385: specifier determining whether the math content should be

386 shown inline (`InlineMath`) or on a separate line

387 (`DisplayMath`) (string)

388

389−text

389+`text`

390: math content (string)

391

392−tag, t

392+`tag`, `t`

393: the literal `Math` (string)

394

395### Note

396Footnote or endnote

397

398−content

398+`content`

399: ([list] of [blocks])

400

401−tag, t

401+`tag`, `t`

402: the literal `Note` (string)

403

404### Quoted

405Quoted text

406

407−quotetype

407+`quotetype`

408: type of quotes to be used; one of `SingleQuote` or

409 `DoubleQuote` (string)

410

411−content

411+`content`

412: quoted text ([list] of [inlines])

413

414−tag, t

414+`tag`, `t`

415: the literal `Quoted` (string)

416

417### RawInline

418Raw inline

419

420−format

420+`format`

421: the format of the content (string)

422

423−text

423+`text`

424: raw content (string)

425

426−tag, t

426+`tag`, `t`

427: the literal `RawInline` (string)

428

429### SmallCaps

430Small caps text

431

432−content

432+`content`

433: ([list] of [inlines])

434

435−tag, t

435+`tag`, `t`

436: the literal `SmallCaps` (string)

437

438### SoftBreak

439Soft line break

440

441−tag, t

441+`tag`, `t`

442: the literal `SoftBreak` (string)

443

444### Space

445Inter-word space

446

447−tag, t

447+`tag`, `t`

448: the literal `Space` (string)

449

450### Span

451Generic inline container with attributes

452

453−attr

453+`attr`

454: attributes ([Attr])

455

456−content

456+`content`

457: wrapped content ([list] of [inlines])

458

459−identifier

459+`identifier`

460: alias for `attr.identifier` (string)

461

462−classes

462+`classes`

463: alias for `attr.classes` ([list] of strings)

464

465−attributes

465+`attributes`

466: alias for `attr.attributes` ([attributes])

467

468−tag, t

468+`tag`, `t`

469: the literal `Span` (string)

470

471### Str

472Text

473

474−text

474+`text`

475: content (string)

476

477−tag, t

477+`tag`, `t`

478: the literal `Str` (string)

479

480### Strikeout

481Strikeout text

482

483−content

483+`content`

484: inline content ([list] of [inlines])

485

486−tag, t

486+`tag`, `t`

487: the literal `Strikeout` (string)

488

489### Strong

490Strongly emphasized text

491

492−content

492+`content`

493: inline content ([list] of [inlines])

494

495−tag, t

495+`tag`, `t`

496: the literal `Strong` (string)

497

498### Subscript

499Subscripted text

500

501−content

501+`content`

502: inline content ([list] of [inlines])

503

504−tag, t

504+`tag`, `t`

505: the literal `Subscript` (string)

506

507### Superscript

508Superscripted text

509

510−content

510+`content`

511: inline content ([list] of [inlines])

512

513−tag, t

513+`tag`, `t`

514: the literal `Superscript` (string)

515

516## Attributes

@@ -522,37 +522,37 @@ indices to the list table.

522

523Single citation entry

524

525−id

525+`id`

526: citation identifier, e.g., a bibtex key (string)

527

528−mode

528+`mode`

529: citation mode, one of `AuthorInText`, `SuppressAuthor`, or

530 `NormalCitation` (string)

531

532−prefix

532+`prefix`

533: citation prefix ([list] of [inlines])

534

535−suffix

535+`suffix`

536: citation suffix ([list] of [inlines])

537

538−note_num

538+`note_num`

539: note number (integer)

540

541−hash

541+`hash`

542: hash (integer)

543

544## ListAttributes

545List attributes

546

547−start

547+`start`

548: number of the first list item (integer)

549

550−style

550+`style`

551: style used for list numbers; possible values are `DefaultStyle`,

552 `Example`, `Decimal`, `LowerRoman`, `UpperRoman`,

553 `LowerAlpha`, and `UpperAlpha` (string)

554

555−delimiter

555+`delimiter`

556: delimiter of list numbers; one of `DefaultDelim`, `Period`,

557 `OneParen`, and `TwoParens` (string)

558

@@ -568,57 +568,57 @@ document contents.

568

569**Objects of this type are read-only.***

570

571−level

571+`level`

572: header level (integer)

573

574−numbering

574+`numbering`

575: section numbering ([list] of integers)

576

577−attr

577+`attr`

578: header attributes ([attributes])

579

580−label

580+`label`

581: header content ([list] of [inlines])

582

583−contents

583+`contents`

584: list of contents in this section ([list] of hierarchical elements)

585

586−t, tag

586+`tag`, `t`

587: constant `Sec` (string)

588

589## ReaderOptions

590

591Pandoc reader options

592

593−abbreviations

593+`abbreviations`

594: set of known abbreviations (set of strings)

595

596−columns

596+`columns`

597: number of columns in terminal (integer)

598

599−default_image_extension

599+`default_image_extension`

600: default extension for images (string)

601

602−extensions

602+`extensions`

603: string representation of the syntax extensions bit field

604 (string)

605

606−indented_code_classes

606+`indented_code_classes`

607: default classes for indented code blocks (list of strings)

608

609−standalone

609+`standalone`

610: whether the input was a standalone document with header

611 (boolean)

612

613−strip_comments

613+`strip_comments`

614: HTML comments are stripped instead of parsed as raw HTML

615 (boolean)

616

617−tab_stop

617+`tab_stop`

618: width (i.e. equivalent number of spaces) of tab stops

619 (integer)

620

621−track_changes

621+`track_changes`

622: track changes setting for docx; one of `AcceptChanges`,

623 `RejectChanges`, and `AllChanges` (string)

624