@jinntec/jinntap 1.31.0 → 1.33.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -11
- package/dist/index.es.js +12 -4
- package/dist/index.es.js.map +1 -1
- package/dist/jinn-tap.css +923 -34
- package/dist/jinn-tap.es.js +9334 -8210
- package/dist/jinn-tap.es.js.map +1 -1
- package/dist/jinn-toast.es.js +142 -40
- package/dist/jinn-toast.es.js.map +1 -1
- package/dist/storage.es.js +261 -0
- package/dist/storage.es.js.map +1 -0
- package/dist/{editor-styles.css → tei-editor-styles.css} +5 -1
- package/package.json +35 -21
package/README.md
CHANGED
|
@@ -1,11 +1,22 @@
|
|
|
1
1
|
# JinnTap
|
|
2
2
|
|
|
3
|
-

|
|
3
|
+

|
|
4
4
|
|
|
5
5
|
Edit TEI XML documents using a rich text editor. JinnTap preserves the structure of the XML in the editor. There's no need for complex transformation steps from TEI to HTML and back. The representation of the document in the editor corresponds directly with the XML. TEI elements are converted to HTML custom elements, preserving all attributes and structural features.
|
|
6
6
|
|
|
7
7
|
JinnTap comes as a web component. While it can be used standalone, it is usually meant to be embedded into a larger application context such as TEI Publisher 10, which will include JinnTap and does allow saving and reloading documents. TP 10 has not been released yet.
|
|
8
8
|
|
|
9
|
+
## Documentation
|
|
10
|
+
|
|
11
|
+
Full documentation — including a detailed [`tei-schema.json`](src/tei-schema.json) reference and a live editor — is published at **https://jinnelements.github.io/jinn-tap/**.
|
|
12
|
+
|
|
13
|
+
Work on the docs locally with:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm run docs:dev # Eleventy dev server with hot reload
|
|
17
|
+
npm run build:site # build library + docs site into dist/
|
|
18
|
+
```
|
|
19
|
+
|
|
9
20
|
## Installation
|
|
10
21
|
|
|
11
22
|
```bash
|
|
@@ -24,21 +35,18 @@ npm install @jinntec/jinntap
|
|
|
24
35
|
# Install dependencies
|
|
25
36
|
npm install
|
|
26
37
|
|
|
27
|
-
# Build the
|
|
38
|
+
# Build the library
|
|
28
39
|
npm run build
|
|
29
|
-
|
|
30
|
-
# Build the demo
|
|
31
|
-
npm run build:demo
|
|
32
40
|
```
|
|
33
41
|
|
|
34
|
-
###
|
|
42
|
+
### Local development
|
|
35
43
|
|
|
36
44
|
```bash
|
|
37
|
-
#
|
|
38
|
-
npm run dev
|
|
45
|
+
# Docs site with embedded TEI/JATS editors
|
|
46
|
+
npm run docs:dev
|
|
39
47
|
|
|
40
|
-
#
|
|
41
|
-
npm run
|
|
48
|
+
# Vite dev server for Cypress tests (serves test/*.html)
|
|
49
|
+
npm run dev
|
|
42
50
|
```
|
|
43
51
|
|
|
44
52
|
### Running Tests
|
|
@@ -64,7 +72,7 @@ npm run cypress:run
|
|
|
64
72
|
<!-- Import the general editor styles-->
|
|
65
73
|
<link rel="stylesheet" href="node_modules/@jinntec/jinntap/dist/jinn-tap.css" />
|
|
66
74
|
<!-- Import the styles for displaying TEI documents -->
|
|
67
|
-
<link rel="stylesheet" href="node_modules/@jinntec/jinntap/dist/editor-styles.css" />
|
|
75
|
+
<link rel="stylesheet" href="node_modules/@jinntec/jinntap/dist/tei-editor-styles.css" />
|
|
68
76
|
<script type="module" src="node_modules/@jinntec/jinntap/dist/jinn-tap.es.js"></script>
|
|
69
77
|
</head>
|
|
70
78
|
<body>
|
package/dist/index.es.js
CHANGED
|
@@ -1,7 +1,15 @@
|
|
|
1
|
-
import { JinnTap as
|
|
2
|
-
import { JinnToast as
|
|
1
|
+
import { JinnTap as o } from "./jinn-tap.es.js";
|
|
2
|
+
import { JinnToast as n, jinnToastConfirm as a } from "./jinn-toast.es.js";
|
|
3
|
+
import { DocumentStore as m, attachLocalStore as c, deduceDocumentName as T, extractTitleFromXml as l, isGenericTitle as f, truncateTitle as p } from "./storage.es.js";
|
|
3
4
|
export {
|
|
4
|
-
|
|
5
|
-
|
|
5
|
+
m as DocumentStore,
|
|
6
|
+
o as JinnTap,
|
|
7
|
+
n as JinnToast,
|
|
8
|
+
c as attachLocalStore,
|
|
9
|
+
T as deduceDocumentName,
|
|
10
|
+
l as extractTitleFromXml,
|
|
11
|
+
f as isGenericTitle,
|
|
12
|
+
a as jinnToastConfirm,
|
|
13
|
+
p as truncateTitle
|
|
6
14
|
};
|
|
7
15
|
//# sourceMappingURL=index.es.js.map
|
package/dist/index.es.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.es.js","sources":[],"sourcesContent":[],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.es.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;"}
|