ooxast-util-citations
TypeScript icon, indicating that this package has built-in type declarations

0.5.0 • Public • Published

Note This repository is automatically generated from the main parser monorepo. Please submit any issues or pull requests there.

ooxast-util-visit-citations

npm version npm downloads

ooxast util to visit in text office citations.

Contents

What is this?

When should I use this?

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, 16.0+, 18.0+), install as

pnpm add ooxast-util-citations
# or with yarn
# yarn add ooxast-util-citations
# or with npm
# npm install ooxast-util-citations

Use

API


constructCitation()

Construct a citation for Mendeley or Zotero.

Signature

constructCitation(
  curr: Citation,
  type: string,
  index: number,
  bibliography?: Data[]): object;

Parameters

Name Type Description
curr Citation The citation to construct
type string The type of citation to construct
index number The index of the citation
bibliography? Data[] The bibliography to use

Returns

object

The constructed citation and instruction

| Member | Type | | :--------- | :------------------------------------------------ | --------------------------------------------- | | citation | MendeleyCitation | ZoteroCitation | | instr | string |

Defined in: lib/ooxast-util-citations.ts:197


findCitations()

Signature

findCitations(tree: Node<Data>, vfile?: VFile, options?: Options): Root;

Parameters

Name Type
tree Node<Data>
vfile? VFile
options? Options

Returns

Root

Defined in: lib/ooxast-util-citations.ts:28


citationTypesWithSuffixedForm

Const string[]

Defined in: lib/ooxast-util-citations.ts:21


Citation

Properties

citationId

string

Defined in: lib/types.ts:6

citationItems

CitationItem[]

Defined in: lib/types.ts:7

originalText?

string

Defined in: lib/types.ts:9

properties

Properties

Defined in: lib/types.ts:8


CitationItem

Properties

id

string

Defined in: lib/types.ts:18

infix?

string

Defined in: lib/types.ts:22

itemData

Data

Defined in: lib/types.ts:19

label?

string

Defined in: lib/types.ts:23

locator?

string

Defined in: lib/types.ts:24

prefix?

string

Defined in: lib/types.ts:20

suffix?

string

Defined in: lib/types.ts:21


Mendeley

Properties

formattedCitation

string

Defined in: lib/types.ts:52

plainTextFormattedCitation

string

Defined in: lib/types.ts:53

previouslyFormattedCitation

string

Defined in: lib/types.ts:54


MendeleyCitation

Properties

citationId

string

Defined in: lib/types.ts:40

citationItems

MendeleyCitationItem[]

Defined in: lib/types.ts:41

mendeley

Mendeley

Defined in: lib/types.ts:42

properties

MendeleyProperties

Defined in: lib/types.ts:43

schema

string

Defined in: lib/types.ts:44


MendeleyCitationItem

Properties

id

string

Defined in: lib/types.ts:58

itemData

Data

Defined in: lib/types.ts:59

uris

string[]

Defined in: lib/types.ts:60


MendeleyProperties

Properties

noteIndex

number

Defined in: lib/types.ts:48


Options

Properties

bibliography?

Data[]

Defined in: lib/ooxast-util-citations.ts:23

log?

boolean

Defined in: lib/ooxast-util-citations.ts:24

type?

"endnote" | "citavi" | "mendeley" | "word" | "zotero"

Defined in: lib/ooxast-util-citations.ts:25


Properties

Properties

mode?

string

Defined in: lib/types.ts:14

noteIndex

number

Defined in: lib/types.ts:13


ZoteroCitation

Properties

citationID

string

Defined in: lib/types.ts:28

citationItems

MendeleyCitationItem[]

Defined in: lib/types.ts:29

properties

ZoteroProperties

Defined in: lib/types.ts:30

schema

string

Defined in: lib/types.ts:31


ZoteroProperties

Properties

formattedCitation

string

Defined in: lib/types.ts:36

noteIndex

number

Defined in: lib/types.ts:35

plainCitation

string

Defined in: lib/types.ts:37


CiteOutput

(string | Citation)[]

Defined in: lib/types.ts:3

Syntax tree

Types

Compatibility

Security

Related

Contribute

License

GPL-3.0-or-later © Thomas F. K. Jorna

Readme

Keywords

Package Sidebar

Install

npm i ooxast-util-citations

Weekly Downloads

5

Version

0.5.0

License

GPL-3.0-or-later

Unpacked Size

42.2 kB

Total Files

19

Last publish

Collaborators

  • tefkah