https://github.com/acdh-oeaw/acdh-noske-search

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (9.3%) to scientific vocabulary

Last synced: 9 months ago · JSON representation

Repository

Basic Info

Host: GitHub
Owner: acdh-oeaw
License: mit
Language: TypeScript
Default Branch: main
Homepage: https://www.npmjs.com/package/acdh-noske-search
Size: 348 KB

Statistics

Stars: 1
Watchers: 7
Forks: 0
Open Issues: 4
Releases: 0

Created about 2 years ago · Last pushed over 1 year ago

Metadata Files

Readme License

ACDH Noske Search UI

This is a simple search UI for the ACDH Noske project. The search client is build with Hey-Api OpenAPI client generator and using acdh-oeaw/noske-ubi9@yaml.

Installation

bash npm i acdh-noske-search

You can also include the Package via CDN:

```html ```

Usage

```typescript import { NoskeSearch } from 'acdh-noske-search'; const search = new NoskeSearch({container: "noske-search"}: Options);

search.search({ client: { base: "https://", corpname: "your coprus name", attrs: "word,id", structs: "doc,docTitle,head,p,imprimatur,list", refs: "doc.id,doc.corpus,docTitle.id,p.id,head.id,imprimatur.id,list.id", }, hits: { id: "hitsbox", css: { table: "table-auto", } }, pagination: { id: "noske-pagination", }, searchInput: { id: "noske-input", }, stats: { id: "noske-stats", }, }: Search); ```

Add the following HTML to your page:

the noske-search div is the container for the search interface. The Container ID is passed to the NoskeSearch constructor and defaults to noske-search.
the hitsbox div is the container for the search results. The Container ID is passed to the search method. The ID is required and has not default value.
the noske-pagination div is the container for the pagination. The Container ID is passed to the search method. The ID is required and has not default value.
the noske-stats div is the container for the search statistics. The Container ID is passed to the search method. The ID is required and has not default value.

html <!doctype html> <html lang="en"> <head> <meta charset="UTF-8" /> <title>NoSke Search Interface</title> </head> <body> <div id="noske-search"></div> <div id="hitsbox"></div> <div> <div id="noske-pagination-test"></div> <div id="noske-stats"></div> </div> </body> </html>

Types

The NoskeSearch class is a generic class and can be used with custom types. The following types are available: /dist/index.d.ts

typescript type Options = { container?: string; }; type Search = { client: Client; hits: Hits; pagination: Pagination; searchInput: SearchInput; stats: Stats; config: Config; }; type Config = { results?: string; customUrl?: string; urlparam?: string | boolean; }; type Client = { base: string; corpname: string; viewmode?: "kwic" | "sen" | undefined; attrs?: string; format?: "json" | "xml" | "csv" | "tsv" | "txt" | "xls" | undefined; structs?: string; kwicrightctx?: string; kwicleftctx?: string; refs?: string; pagesize?: number; fromp?: number; }; type SearchInput = { id: string; placeholder?: string; css?: { div?: string; select?: string; input?: string; }; }; type Pagination = { id: string; css?: { div?: string; select?: string; }; }; type Hits = { id: string; css?: { div?: string; table?: string; thead?: string; trHead?: string; th?: string; tbody?: string; trBody?: string; td?: string; kwic?: string; left?: string; right?: string; }; }; type Stats = { id: string; label?: string; css?: { div?: string; label?: string; }; };

Owner

Name: Austrian Centre for Digital Humanities & Cultural Heritage
Login: acdh-oeaw
Kind: organization
Email: acdh@oeaw.ac.at
Location: Vienna, Austria

Website: https://www.oeaw.ac.at/acdh
Repositories: 476
Profile: https://github.com/acdh-oeaw

GitHub Events

Total

Push event: 3
Pull request event: 2
Create event: 1

Last Year

Push event: 3
Pull request event: 2
Create event: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time

Total issues: 7
Total pull requests: 3
Average time to close issues: 11 days
Average time to close pull requests: less than a minute
Total issue authors: 2
Total pull request authors: 1
Average comments per issue: 0.43
Average comments per pull request: 0.0
Merged pull requests: 3
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 2
Pull requests: 3
Average time to close issues: 5 days
Average time to close pull requests: less than a minute
Issue authors: 1
Pull request authors: 1
Average comments per issue: 1.0
Average comments per pull request: 0.0
Merged pull requests: 3
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

linxOD (4)
cfhaak (3)

Pull Request Authors

linxOD (4)

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- npm 37 last-month

Total dependent packages: 1
Total dependent repositories: 0
Total versions: 23
Total maintainers: 1

npmjs.org: acdh-noske-search

Search Interface for Noske

Homepage: https://github.com/acdh-oeaw/acdh-noske-search#readme
License: MIT
Latest release: 0.2.2
published over 1 year ago

Versions: 23
Dependent Packages: 1
Dependent Repositories: 0
Downloads: 37 Last month

Rankings

Dependent repos count: 29.8%

Average: 36.2%

Dependent packages count: 42.6%

Maintainers (1)

linxod