epidoc-viewer-core

Exports a react component for converting epidoc to Leiden:

LeidenViewer - a react component that will display rendered Leiden when passed epidoc.

Relies on the convert function of epidoc-viewer-core

The LeidenViewer uses the convert function under the covers, but you can also use the convert function directly without react.

Usage

npm install @isicily/epidoc-viewer-react

OR

yarn add @isicily/epidoc-viewer-react

import {LeidenViewer} from ‘@isicily/epidoc-viewer-core’

then use it somewhere...

		tei={tei} 
		showInterpreted={false} 
		overridingRules={someRules} 
/>```
  
Where:

- ‘tei’ is the epidoc to be transformed to Leiden.
- ‘showInterpreted’ is a boolean 
	- true shows interpreted, false shows diplomatic
- ‘overridingRules’ is a list of rules to add to the core set, or to override in the core set.  

The rules passed in overridingRules must be an object like so:

```javascript
const yourRules = {
    'w': node => {
        if (node.getAttribute('part') === 'I') {
            const exChild = node.querySelector('ex')
            if (exChild) {
                exChild.append('-')
            }
        } 
    },
    'ex': node => {
        const cert = node.getAttribute('cert')
        node.prepend('('); 
        if (cert === 'low') node.append('?')
        node.append(')')
    },
    'abbr': node => {
        if (node.parentNode.nodeName !== 'expan') node.append('(- - -)')
    }
}

Only include rules for those tags you wish to add or override. You can see the default rules in these three files:

Interpreted

Diplomatic

Shared

The shared rules are used in both the diplomatic and interpreted modes.

Updating this repo in NPM

In project directory:

npm run build
npm version patch -m "Upgrade to %s"
git push
npm publish --access public