Skip to content

Commit 9f7ff83

Browse files
balmasbalmas
authored
Merge pull request #137 from alpheios-project/incr-3.3.x
Incr 3.3.x
2 parents 98fe713 + ab68e5a commit 9f7ff83

File tree

13 files changed

+5666
-3890
lines changed

13 files changed

+5666
-3890
lines changed

.github/workflows/qa.yml renamed to .github/workflows/release.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
name: QA Build
1+
name: Release Build
22
on:
33
push:
4-
branches: [ qa ]
4+
branches: [ qa, ftqa, production ]
55

66
workflow_dispatch:
77

@@ -49,5 +49,5 @@ jobs:
4949
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
5050

5151
- name: publish
52-
run: npm publish --tag qa
52+
run: npm publish --tag ${{ steps.run_build.outputs.npmTag }}
5353

‎BUILD.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Alpheios Embedded Library Build Instructions
2+
3+
## Prerequisites:
4+
5+
* Node 14.1.0 or higher, npm 6.14.6 or higher
6+
7+
## Developer Build
8+
9+
```
10+
npm install && npm update
11+
npm run build
12+
npm run dev
13+
```
14+
15+
The last step runs a local web server on port 8888. Load the sample.html file
16+
at the root of the directory. Changes made to the code will be dynamically rebuilt.
17+
18+
19+
## QA Build
20+
21+
1. merge the `master` branch to the `qa` branch and push to GitHub
22+
2. GitHub Actions will execute the release.yml workflow to inject the build number,
23+
install the `qa` branch of the alpheios-components library, build the distribution
24+
files, tag a pre-release in GitHub and publish the alpheios-embedded package to
25+
npm tagged as `@qa`
26+
27+
28+
## Production Build and Version
29+
30+
1. merge the `qa` branch to the `production` branch (but don't push it)
31+
2. Edit version in the package.json.
32+
3. Commit and push the change to GitHub.
33+
4. GitHub Actions will execute the release.yml workflow to inject the build number,
34+
install the `production` branch of the alpheios-components library, build the distribution
35+
files, tag a pre-release in GitHub and publish the alpheios-embedded package to
36+
npm tagged as `@rc`
37+
5. When ready to release the code, manually tag the npm package as `@latest` using
38+
`npm --dist-tag` and remove the "Pre-release" flag from the Release in GitHub.
39+
6. Merge the version and any other code changes from `production` back to `master`

‎README.md‎

Lines changed: 1 addition & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -373,28 +373,4 @@ See our [FAQ pages](http://www.alpheios.net/pages/faq/)
373373

374374
## Developer Instructions
375375

376-
### Prerequisites to build the Alpheios Embedded Library from source:
377-
378-
* Node 13.7.0 or higher
379-
380-
### Install Dependencies
381-
382-
```
383-
npm install
384-
```
385-
386-
### Build
387-
388-
```
389-
npm run test
390-
npm run build
391-
```
392-
393-
### Develop
394-
395-
```
396-
npm run dev
397-
```
398-
399-
Runs a local web server on port 8888. Load the sample.html file at the root of the directory. Changes made to the
400-
code will be dynamically rebuilt.
376+
See [BUILD.md](BUILD.md)

‎demo/index-detect.html‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
<!-- Basic Development demo, using Components from the CDN -->
2+
<!DOCTYPE html>
3+
<html>
4+
<head>
5+
<meta charset="UTF-8">
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<title>Alpheios Embedded Library Developer Test Page</title>
8+
<link rel="stylesheet" href="../dist/style/style-components.css"/>
9+
<script src="https://cdn.auth0.com/js/lock/11.14.0/lock.js"></script>
10+
<script src="../dist/auth0/env-embed.js"></script>
11+
<style>
12+
.customenabled {
13+
color: green;
14+
}
15+
.customdisabled {
16+
color: red;
17+
}
18+
19+
</style>
20+
</head>
21+
22+
<body>
23+
<script type="text/javascript">
24+
document.addEventListener("DOMContentLoaded", function(event) {
25+
import ('../dist/alpheios-embedded.js').then(embedLib => {
26+
window.AlpheiosEmbed.importDependencies({ mode: 'development' }).then(Embedded => {
27+
new Embedded(
28+
{
29+
clientId: 'embed-lib-index-demo',
30+
authEnv: auth0Env,
31+
disabledSelector:".customignore",
32+
enabledClass: 'customenabled',
33+
disabledClass: 'customdisabled',
34+
popupInitialPos: {
35+
left: '150px',
36+
top: '150px'
37+
},
38+
toolbarInitialPos: {
39+
top: '5vh',
40+
right: '5vw'
41+
},
42+
}).activate();
43+
}).catch(e => {
44+
console.error(`Import of an embedded library dependencies failed: ${e}`)
45+
})
46+
}).catch(e => {
47+
console.error(`Import of an embedded library failed: ${e}`)
48+
})
49+
});
50+
</script>
51+
<h4>Greek</h4>
52+
<div class="alpheios-enabled" id="block1">
53+
<p>τά ταῖν ταῖν τοῦ</p>
54+
<p>εγώ εμένα ἐμαυτοῦ ταύταις</p>
55+
<p>ένα δύο τρία</p>
56+
<p>όμορφος νέος γλυκός</p>
57+
<p>συνεχής πλατύς οξύς</p>
58+
<p>ἄνδρα μοι ἔννεπε, μοῦσα, πολύτροπον</p>
59+
<p>πρόσφυμα ξηρή </p>
60+
<p>σκληρή ζώνη ινώδους συνδετικού ιστού που συνδέει συνήθως μύες με οστά</p>
61+
<p>A word with missing gender: ἥρωϊ</p>
62+
<p>Δαναὸς ἀφίκτωρ λεπτοψαμάθων</p>
63+
</div>
64+
65+
<h4>Latin</h4>
66+
<div class="alpheios-enabled" id="block2">
67+
<p>fero ferre tuli latus ferant missing-word</p>
68+
<p>sum sunt</p>
69+
<p>mare cupidinibus cepit differ</p>
70+
<p>a bene placito</p>
71+
<p>ab ovo usque ad mala</p>
72+
<p>caeli beatum videre</p>
73+
<p class="customignore">Ignore This</p>
74+
</div>
75+
76+
<h4>Arabic</h4>
77+
<div class="alpheios-enabled" id="block3" dir="rtl">
78+
1 اَلدٌّنيَا دَارُ مَمَرٍ لاَ دَارُ مَقَرٍ * سُلطَان بِلاَ عَدلٍ كَنَهرٍ
79+
</div>
80+
81+
<h4>Persian</h4>
82+
<div class="alpheios-enabled" id="block4" dir="rtl">
83+
آبادائیدن
84+
به نام خداوند جان و خرد
85+
کزین برتر اندیشه برنگذرد
86+
خداوند نام و خداوند جای
87+
خداوند روزی ده رهنمای
88+
خداوند کیوان و گردان سپهر
89+
فروزنده ماه و ناهید و مهر
90+
ز نام و نشان و گمان برترست
91+
نگارندهٔ بر شده پیکرست
92+
به بینندگان آفریننده را
93+
نبینی مرنجان دو بیننده را
94+
نیابد بدو نیز اندیشه راه
95+
که او برتر از نام و از جایگاه
96+
سخن هر چه زین گوهران بگذرد
97+
نیابد بدو راه جان و خرد
98+
</div>
99+
100+
<h4>Ge'ez</h4>
101+
<div class="alpheios-enabled" id="block5" dir="ltr">
102+
ይትባረክ፡ እግዚአብሔር፡ አምላከ፡ እስራኤል፡ አምላክ፡ ለኵሉ፡ መንፈስ፡ ወለኵሉ፡ ዘሥጋ፡ ወይቤሎ፡ እግዚአብሔር፡ ለእዝራ፡ አእምር፡ ወጠይቅ፡
103+
</div>
104+
105+
<h4>Traditional Chinese</h4>
106+
<div class="alpheios-enabled" id="block6" dir="ltr">
107+
天地玄黃，宇宙洪荒。日月盈昃，辰宿列張。寒來暑往，秋收冬藏。閏余成歲，律呂調陽。
108+
</div>
109+
110+
<h4>Simplified Chinese</h4>
111+
<div class="alpheios-enabled" id="block7" dir="ltr">
112+
天地玄黄，宇宙洪荒。日月盈昃，辰宿列张。寒来暑往，秋收冬藏。闰余成岁，律吕调阳。
113+
</div>
114+
115+
<h4>Chinese Test cases</h4>
116+
<div class="alpheios-enabled" dir="ltr">
117+
子曰學
118+
</div>
119+
</body>
120+
</html>

‎demo/index-paideia.html‎

Lines changed: 55 additions & 0 deletions
Large diffs are not rendered by default.

‎demo/index.html‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,14 @@
3131
disabledSelector:".customignore",
3232
enabledClass: 'customenabled',
3333
disabledClass: 'customdisabled',
34+
languageOptions: {
35+
lexiconsShort: {
36+
lat: [ 'https://github.com/alpheios-project/paidea-glossary' ]
37+
}
38+
},
39+
uiOptions: {
40+
hidePopupOnClickAway: true
41+
},
3442
popupInitialPos: {
3543
left: '150px',
3644
top: '150px'
@@ -59,6 +67,7 @@ <h4>Greek</h4>
5967
<p>πρόσφυμα ξηρή </p>
6068
<p>σκληρή ζώνη ινώδους συνδετικού ιστού που συνδέει συνήθως μύες με οστά</p>
6169
<p>A word with missing gender: ἥρωϊ</p>
70+
<p>Δαναὸς ἀφίκτωρ λεπτοψαμάθων</p>
6271
</div>
6372

6473
<h4>Latin</h4>

0 commit comments

Comments
 (0)