@bci-av/af 0.0.0-stage → 0.1.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/NOTICE +39 -0
- package/README.md +26 -2
- package/dist/cjs/index.d.ts +13 -0
- package/dist/cjs/index.d.ts.map +1 -0
- package/dist/cjs/index.js +6572 -0
- package/dist/cjs/index.js.map +1 -0
- package/dist/cjs/package.json +1 -0
- package/dist/esm/index.d.ts +13 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +6568 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/package.json +1 -0
- package/package.json +51 -4
package/NOTICE
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# NOTICE
|
|
2
|
+
|
|
3
|
+
This repository packages two separately licensed things. Please keep them apart.
|
|
4
|
+
|
|
5
|
+
## The code — MIT
|
|
6
|
+
|
|
7
|
+
Everything in `bin/`, `scripts/`, the package sources, build configuration and
|
|
8
|
+
documentation is licensed MIT. See LICENSE.
|
|
9
|
+
|
|
10
|
+
## The Blissymbols — CC BY-SA 4.0, by BCI
|
|
11
|
+
|
|
12
|
+
The symbol artwork and all accompanying metadata (BCI-AV numbers, glosses in 19
|
|
13
|
+
languages, derivations, part-of-speech classifications) come from the **BCI
|
|
14
|
+
Authorized Vocabulary**, published by **Blissymbolics Communication
|
|
15
|
+
International (BCI)** and licensed under
|
|
16
|
+
**Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)**.
|
|
17
|
+
|
|
18
|
+
- Source: <https://www.blissymbolics.org/>
|
|
19
|
+
- Edition packaged here: see `EDITION` exported from `@bci-av/core`
|
|
20
|
+
- Licence text: <https://creativecommons.org/licenses/by-sa/4.0/>
|
|
21
|
+
|
|
22
|
+
### What this obliges you to do
|
|
23
|
+
|
|
24
|
+
If you ship these symbols in a product, CC BY-SA 4.0 requires that you:
|
|
25
|
+
|
|
26
|
+
1. **Attribute BCI.** Credit "Blissymbolics Communication International" and
|
|
27
|
+
link the licence. Crediting this package instead of BCI does not satisfy it.
|
|
28
|
+
2. **Share alike.** If you modify the symbols — redraw them, recolour them,
|
|
29
|
+
build new symbols from them — you must release those modifications under
|
|
30
|
+
CC BY-SA 4.0 as well.
|
|
31
|
+
3. **Indicate changes** if you made any.
|
|
32
|
+
|
|
33
|
+
Share-alike applies to the **symbols**, not to your application. Using them to
|
|
34
|
+
render a user interface does not make your code CC BY-SA. Editing the artwork
|
|
35
|
+
and redistributing it does.
|
|
36
|
+
|
|
37
|
+
Blissymbolics is a semantic graphical language, and BCI exists to standardise
|
|
38
|
+
it. If you are building something substantial with it, they are worth talking
|
|
39
|
+
to: <https://www.blissymbolics.org/>
|
package/README.md
CHANGED
|
@@ -1,3 +1,27 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @bci-av/af
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Afrikaans glosses for the BCI Authorized Vocabulary of Blissymbolics —
|
|
4
|
+
6,551 of 6,551 symbols
|
|
5
|
+
(100% coverage).
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm install @bci-av/af
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
```ts
|
|
12
|
+
import { getName, names } from '@bci-av/af';
|
|
13
|
+
|
|
14
|
+
getName('23536'); //=> "tuisteskepper, huiswerk"
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Keyed by **BCI-AV number**, which is stable across vocabulary editions —
|
|
18
|
+
unlike the slug ids, which follow their English gloss.
|
|
19
|
+
|
|
20
|
+
`@bci-av/core` carries all 19 languages, which is 2.6 MB of its registry.
|
|
21
|
+
This package exists so a single-language application does not ship the
|
|
22
|
+
other eighteen.
|
|
23
|
+
|
|
24
|
+
## Licensing
|
|
25
|
+
|
|
26
|
+
The glosses are **CC BY-SA 4.0** by Blissymbolics Communication
|
|
27
|
+
International. See [NOTICE](./NOTICE).
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/** Afrikaans glosses, keyed by BCI-AV number. */
|
|
2
|
+
export declare const names: Record<string, string>;
|
|
3
|
+
/** ISO 639-1 code for this package's language. */
|
|
4
|
+
export declare const language = "af";
|
|
5
|
+
/**
|
|
6
|
+
* Returns the Afrikaans gloss for a BCI-AV number, or undefined when BCI
|
|
7
|
+
* has not translated that symbol.
|
|
8
|
+
*
|
|
9
|
+
* BCI lists synonyms in one comma-separated string, so this returns the
|
|
10
|
+
* raw field; take the first part for display.
|
|
11
|
+
*/
|
|
12
|
+
export declare const getName: (bciAv: string) => string | undefined;
|
|
13
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAIA,iDAAiD;AACjD,eAAO,MAAM,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAw5MxC,CAAC;AAEF,kDAAkD;AAClD,eAAO,MAAM,QAAQ,OAAO,CAAC;AAE7B;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,UAAW,MAAM,KAAG,MAAM,GAAG,SAAgC,CAAC"}
|