https://github.com/unfoldingword/epitelete-html
Epitelete taken a step forward to generate and parse Html.
https://github.com/unfoldingword/epitelete-html
epitelete javascript-library proskomma scripture-open-components
Last synced: about 2 months ago
JSON representation
Epitelete taken a step forward to generate and parse Html.
- Host: GitHub
- URL: https://github.com/unfoldingword/epitelete-html
- Owner: unfoldingWord
- License: mit
- Created: 2022-05-23T13:13:33.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-18T13:52:37.000Z (about 1 year ago)
- Last Synced: 2025-04-14T05:20:06.314Z (about 2 months ago)
- Topics: epitelete, javascript-library, proskomma, scripture-open-components
- Language: JavaScript
- Homepage:
- Size: 12.1 MB
- Stars: 0
- Watchers: 8
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# epitelete-html
Epitelete sub-class for HTML handling.
## Installation
```shell
npm install epitelete-html
```
## Usage
```js
import EpiteleteHtml from 'epitelete-html';
// Instantiate Proskomma and load some content into it
const epiPerfHtml= new EpiteleteHtml({proskomma: proskommaInstance, docSetId: "doc_set_id"});
const epiPerfHtml= new EpiteleteHtml({proskomma: proskommaInstance, docSetId: "doc_set_id", options: {historySize: 10}});
```
### Html handling
```js
const htmlContainer = await epiPerfHtml.readHtml(bookCode); // => Object { docSetId, mainSequenceId, headers, sequencesHtml };
const { sequencesHtml } = htmlContainer; //Object containing html sequences { [sequenceId] : ''}
//Make changes to sequences html and merge them back to htmlContainer
...
//write back the changed htmlContainer
await epiPerfHtml.writeHtml(bookCode, sequenceId, changedHtmlContainer);
...
// undo
await epiPerfHtml.undoHtml(bookCode);
...
// redo
await epiPerfHtml.redoHtml(bookCode);
```
### Inherited functionality
```js
epiPerfHtml.localBookCodes() // => Array of 3-character book codes cached in Epitelete
epiPerfHtml.bookHeaders() // => Object containing titles and other headers for each bookCode in Proskomma
epiPerfHtml.readPerf(bookCode) // => PERF for this bookCode, fetching from Proskomma if necessary
epiPerfHtml.clearPerf() // Deletes all local PERF data
```