reoff-markup-to-style v0.3.0

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

reoff-markup-to-style

Plugin for reoff that is able to change the styles of paragraphs based on the markup of the underlying text

Contents

• reoff-markup-to-style
  • Contents
  • What is this?
  • When should I use this?
  • Install
  • Use
  • API
    • default()
      • Example
      • Signature
      • Parameters
      • Returns
    • Options
      • Example
  • Syntax tree
  • Security
  • Related
  • Contribute
  • License

What is this?

A plugin for reoff for finding paragraphs that have a certain markup in a docx document and changing their style to a different style.

When should I use this?

If you want to change the style of paragraphs based on the markup of the underlying text.

If you want to change the style of paragraphs based on the markup of the underlying text, but are handling the [ooxast][ooxast] syntax tree yourself, use ooxast-util-markup-to-style

Install

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

pnpm add reoff-markup-to-style
# or with yarn
# yarn add reoff-markup-to-style
# or with npm
# npm install reoff-markup-to-style

Use

API

default()

reoff plugin for inferring paragraph styles from the markup of the underlying text.

By default, this plugin will infer the following styles:

• w:b -> Heading 1
• w:i -> Heading 2

This plugin can be configured to infer other styles as well.

Example

const options: Options = [
// find all paragraphs that are bold and larger than 24pt and make it a Title
 {
  markup: (rPr) => rPr['w:b'] && rPr['w:sz'] && rPr['w:sz']['w:val'] > 24,
  style: 'Title',
 },
// find all paragraphs that are strikethrough text and make it a Comment
 {
  markup: 'w:strike',
  style: 'Comment',
 },
]

Signature

default(options: Options = ...): ReturnType<Plugin<[Options?] | void[], Root, Root>>;

Parameters

Returns

ReturnType<Plugin<Options? | void[], Root, Root>>

A reoff plugin.

Defined in: reoff/reoff-markup-to-style/src/lib/reoff-markup-to-style.ts:35

Options

Option[]

Example

const options: Options = [
// find all paragraphs that are bold and larger than 24pt and make it a Title
 {
  markup: (rPr) => rPr['w:b'] && rPr['w:sz'] && rPr['w:sz']['w:val'] > 24,
  style: 'Title',
 },
// find all paragraphs that are strikethrough text and make it a Comment
 {
  markup: 'w:strike',
  style: 'Comment',
 },
]

Defined in: ooxast/ooxast-util-markup-to-style/src/lib/ooxast-util-markup-to-style.ts:80

Syntax tree

Uses the [ooxast][ooxast] syntax tree.

Security

Related

• ooxast-util-markup-to-style

Contribute

License

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