Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gbv/ng-daia
AngularJS module to facilitate access to availability information via DAIA
https://github.com/gbv/ng-daia
Last synced: 3 months ago
JSON representation
AngularJS module to facilitate access to availability information via DAIA
- Host: GitHub
- URL: https://github.com/gbv/ng-daia
- Owner: gbv
- Created: 2014-02-24T08:32:04.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2016-02-08T13:27:54.000Z (almost 9 years ago)
- Last Synced: 2024-10-01T17:09:11.849Z (3 months ago)
- Language: JavaScript
- Homepage: http://gbv.github.io/ng-daia/
- Size: 622 KB
- Stars: 2
- Watchers: 20
- Forks: 2
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# ng-daia
> [AngularJS](http://angularjs.org/) module to access [DAIA](http://purl.org/NET/DAIA) services
[](https://www.npmjs.com/package/ng-daia)
[](https://travis-ci.org/gbv/ng-daia)
[](https://coveralls.io/r/gbv/ng-daia?branch=master)
[](https://github.com/gbv/ng-daia/issues)
**ng-daia** is an [AngularJS](http://angularjs.org/) module to facilitate
access [Document Availability Information API (DAIA)](http://purl.org/NET/DAIA)
display DAIA responses.
## Install
### npm
```bash
npm install ng-daia --save
```
### bower
```bash
bower install ng-daia --save
```
## Usage
See for documentation and usage examples!
### Getting started
The [demo](demo) () illustrates display of
availability information with directives and filters provided by module
ng-daia}. Please have a look at the documentation of each directive/filter.
The following minimal example might help to include ng-daia into your website:
```.html
angular.module('myApp', ['ngDAIA']);
```
### Customization
The default templates, included in `ng-daia.js`, can be styled with CSS,
translated with angular-translate, and replaced with the `template-url`
parameter:
* [template/daia-response.html](https://github.com/gbv/ng-daia/blob/master/src/templates/daia-response.html)
* [template/daia-availability.html](https://github.com/gbv/ng-daia/blob/master/src/templates/daia-availability.html)
* [template/daia-item.html](https://github.com/gbv/ng-daia/blob/master/src/templates/daia-item.html)
* [template/daia-simple.html](https://github.com/gbv/ng-daia/blob/master/src/templates/daia-simple.html)
The following CSS classes are used:
* `daia-response`: the whole response
* `daia-result`: the whole result
* `daia-document`: each copy of the result
* `daia-label`: style of descriptions
* `availability`: overall style for display of availability
* `service-label`: style for availability labels
* `availability-available`: style for display of available services
* `availability-unavailable`: style for display of unavailable services
* `availability-expected`: style for display of unavailable services with expected availability
* `availability-limitation`: style for limitations (in brackets after the corresponding availability status)
* `returning`: overall style for message concerning 'expected' date and link for preordering
* `returning-expected`: style for message concerning 'expected' date
* `access`: style for display of possible access-link
* `simple-openaccess`: style for simple availability "openaccess"
* `simple-loan`: style for simple availability "loan"
* `simple-presentation`: style for simple availability "presentation"
The default templates are fully prepared for internationalization (i18n) with
[angular-translate](https://angular-translate.github.io/docs/#/guide/02_getting-started).
To use the translations module, first include the following in your html:
```.html
```
There are several ways to manage translations with angular-translate. You might want to add them directly into your `myApp` module, or the translations can be put into their own json files and retrieved by your app, which will require an additional package:
```.html
```
You then have to extend the app module to enable loading the translations (the filenames would in this case have the format "lang-en.json", etc.):
```.javascript
angular.module('myApp', ['ngDAIA', 'pascalprecht.translate']).config(['$translateProvider', function ($translateProvider) {
$translateProvider.useStaticFilesLoader({
prefix: '../src/translations/lang-',
suffix: '.json'
});
$translateProvider.registerAvailableLanguageKeys(['en', 'de'], {
'en_US':'en','en_UK':'en','de_DE':'de','de_AT':'de','de_CH':'de',
})
$translateProvider.fallbackLanguage('en');
$translateProvider.determinePreferredLanguage();
}]);
```
As well as exporting the translation tables, this example shows the support for automatic language-detection. The default templates are using the following translation terms:
#### daia-response terms
* `unknown`
* `available`
* `unavailable`
* `presentation`
* `loan`
* `interloan`
* `none`
* `expected`
* `openaccess`
#### labels and other text
* `INSTITUTION` : reference label to holding institution
* `DOCUMENT` : reference label for searched document
* `CATALOG_ENTRY` : reference label for document link
* `DEPARTMENT` : label for specific part of the institution
* `SIGNATURE` : label for alternative id (like shelf mark for physical medium)
* `NO_RECORDS`: message shown when no items can be displayed
* `AVAILABILITY` : label used before `unknown` if no items can be displayed
* `EXPECTED_BACK` : message
* `RESERVATION` : displayed link text for reservation link
* `ACCESS` : label displayed if a direct document link exists
* `STATUS` : label text for `daia-simple` output
### Demo
The [demo](demo) (see [demo
directory](https://github.com/gbv/ng-daia/tree/master/demo) of source code
repository) contains a more detailed sample application that makes use of
`ng-daia` as well as angular-translate. The demo should be run from a server
(e.g. localhost).
## Contributing
See [`CONTRIBUTING.md`](#/api/contributing) for development documentation.
Contributions and [feedback](https://github.com/gbv/ng-daia/issues) is
appreciated!
## Contributors
* Jakob Voß
* Moritz Horn
## License
Code licensed under the [AGPL](http://www.gnu.org/licenses/agpl-3.0.html).
Documentation licensed under [CC BY 3.0](http://creativecommons.org/licenses/by/3.0/).
DAIA icons (included in `daia.css`) are based on
[PICOL](http://picol.org/) icons, CC-BY Melih Bilgil.