https://github.com/trialanderrororg/reoff-rejour
Plugin for `reoff` that transforms an `ooxast` syntax tree into a `jats` syntax tree, i.e.
https://github.com/trialanderrororg/reoff-rejour
abstract docx jast jats-xml ooxast ooxml syntax tree unified word
Last synced: 4 months ago
JSON representation
Plugin for `reoff` that transforms an `ooxast` syntax tree into a `jats` syntax tree, i.e.
- Host: GitHub
- URL: https://github.com/trialanderrororg/reoff-rejour
- Owner: TrialAndErrorOrg
- Created: 2023-02-28T21:57:32.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-14T22:14:06.000Z (over 2 years ago)
- Last Synced: 2025-01-01T04:52:46.620Z (9 months ago)
- Topics: abstract, docx, jast, jats-xml, ooxast, ooxml, syntax, tree, unified, word
- Language: TypeScript
- Size: 26.4 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/funding.yml
Awesome Lists containing this project
README
> **Note**
> This repository is automatically generated from the [main parser monorepo](https://github.com/TrialAndErrorOrg/parsers). Please submit any issues or pull requests there.
# reoff-rejour
[](https://badge.fury.io/js/reoff-rejour) [](https://www.npmjs.com/package/reoff-rejour)
Plugin for `reoff` that transforms an `ooxast` syntax tree into a `jats` syntax tree, i.e. converting `.docx` to `JATS XML`.
## Contents
* [reoff-rejour](#reoff-rejour)
* [Contents](#contents)
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [Syntax tree](#syntax-tree)
* [Types](#types)
* [Compatibility](#compatibility)
* [Security](#security)
* [Related](#related)
* [Contribute](#contribute)
* [License](#license)
## What is this?
## When should I use this?
## Install
This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c). In Node.js (version 12.20+, 14.14+, 16.0+, 18.0+), install as
```bash
pnpm add reoff-rejour
# or with yarn
# yarn add reoff-rejour
# or with npm
# npm install reoff-rejour
```
## Use
## API
***
### `default()`
Plugin to bridge or mutate to jast.
If a destination is given, runs the destination with the new mdast
tree (bridge-mode).
Without destination, returns the mdast tree: further plugins run on that
tree (mutate-mode).
This is done so that you can use this plugin as either the plugin before the stringify plugin, or the plugin before another mutate plugin
#### Signature
```ts
default(this: Processor, ...settings: [Processor, Options?]): void | Transformer;
```
#### Parameters
| Name | Type |
| :------ | :------ |
| `this` | `Processor`<`void`, `Root`, `void`, `void`> |
| `...settings` | [`Processor`, `Options?`] |
#### Returns
`void` | `Transformer`<`Root`, `Root`>
Defined in: node\_modules/.pnpm/unified\@10.1.2/node\_modules/unified/index.d.ts:531
Plugin to bridge or mutate to jast.
If a destination is given, runs the destination with the new mdast
tree (bridge-mode).
Without destination, returns the mdast tree: further plugins run on that
tree (mutate-mode).
This is done so that you can use this plugin as either the plugin before the stringify plugin, or the plugin before another mutate plugin
#### Signature
```ts
default(this: Processor, ...settings: [Options?] | void[]): void | Transformer;
```
#### Parameters
| Name | Type |
| :------ | :------ |
| `this` | `Processor`<`void`, `Root`, `void`, `void`> |
| `...settings` | [`Options?`] | `void`[] |
#### Returns
`void` | `Transformer`<`Root`, `Root`>
Defined in: node\_modules/.pnpm/unified\@10.1.2/node\_modules/unified/index.d.ts:531
## Syntax tree
## Types
## Compatibility
## Security
## Related
## Contribute
## License
[GPL-3.0-or-later](LICENSE) © Thomas F. K. Jorna
[unified]: https://unifiedjs.com
[unifiedgh]: https://github.com/unifiedjs/unified
[xast-from-xml]: https://github.com/syntax-tree/xast-util-from-xml
[rehype]: https://github.com/rehypejs/rehype
[rejour]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/rejour
[rejour-parse]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/rejour/rejour-parse
[rejour-stringify]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/rejour/rejour-stringify
[rejour-move-abstract]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/rejour/rejour-move-abstract
[rejour-meta]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/rejour/rejour-meta
[rejour-relatex]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/rejour/rejour-relatex
[relatex]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/relatex
[reoff-rejour]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/relatex/reoff-rejour
[jast]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/rejour/jast
[jast-util-to-texast]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/rejour/jast-util-to-texast
[jastscript]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/rejour/jastscript
[texast]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/relatex/texast
[texast-util-to-latex]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/relatex/texast-util-to-latex
[hast]: https://github.com/syntax-tree/hast
[xast]: https://github.com/syntax-tree/xast
[mdast]: https://github.com/syntax-tree/mdast
[mdast-markdown]: https://github.com/syntax-tree/mdast-util-to-markdown
[latex-utensils]: https://github.com/tamuratak/latex-utensils
[latexjs]: https://github.com/latexjs/latexjs
[reoff]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/reoff
[reoff-parse]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/reoff/reoff-parse
[reoff-rejour]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/reoff/reoff-rejour
[ooxast]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/ooxast/ooxast
[ooxast]: https://github.com/TrialAndErrorOrg/parsers/tree/main/libs/ooxast/ooxast-util-to-jast