Skip to content
Snippets Groups Projects

Updated README.txt to README.md

1 file
+ 105
0
Compare changes
  • Side-by-side
  • Inline
+ 105
0
CONTENTS OF THIS FILE
# Image Annotator [Annotorious] Module
---------------------
* Introduction
## Contents Of This File
* Requirements
* Installation
* Configuration
* Maintainers
 
- Introduction
 
- Requirements
 
- Installation
 
- Configuration
 
- Maintainers
INTRODUCTION
------------
Image Annotator module allows users to create annotations on node images.
## Introduction
Users can highlight a particular portion of a node's image
- Image Annotator module allows users to create annotations on node images.
by drawing a rectangle over the image and adding a note to it.
Adding, deleting, updating and viewing of these annotations can easily
- Users can highlight a particular portion of a node's image
be controlled by permission configuration.
by drawing a rectangle over the image and adding a note to it.
It also supports multi-valued image fields.
- Adding, deleting, updating and viewing of these annotations can easily
 
be controlled by permission configuration.
 
- It also supports multi-valued image fields.
REQUIREMENTS
------------
This module requires the following modules:
## Requirements
* Image (Core)
* Node (Core)
This module requires the Annotorious library:
- This module requires the following modules:
https://github.com/annotorious/annotorious
- Image (Core)
 
- Node (Core)
Manual installation:
- This module requires the Annotorious library:
* Download the library from:
https://github.com/annotorious/annotorious
 
 
- Manual installation:
 
- Download the library from:
https://github.com/annotorious/annotorious/releases/tag/v0.6.4
https://github.com/annotorious/annotorious/releases/tag/v0.6.4
* Extract it in your 'libraries' folder, file paths should be:
- Extract it in your '`libraries`' folder, file paths should be:
- DRUPAL_ROOT/libraries/annotorious/annotorious.min.js
- `DRUPAL_ROOT/libraries/annotorious/annotorious.min.js`
- DRUPAL_ROOT/libraries/annotorious/css/annotorious.css
- `DRUPAL_ROOT/libraries/annotorious/css/annotorious.css`
- DRUPAL_ROOT/libraries/annotorious/css/theme-dark/annotorious-dark.css
- `DRUPAL_ROOT/libraries/annotorious/css/theme-dark/annotorious-dark.css`
Composer installation:
**Composer installation:**
1: Ensure that you have the `oomphinc/composer-installers-extender` package
1: Ensure that you have the `oomphinc/composer-installers-extender` package
installed.
installed.
2: Add an "installer-types" section in the "extra" of your project composer.json
file, make sure you have "bower-asset" and "npm-asset" listed.
2: Add an "`installer-types`" section in the "`extra`" of your project composer.json
 
file, make sure you have "`bower-asset`" and "`npm-asset`" listed.
 
```
For example:
For example:
"installer-types": [
"installer-types": [
"bower-asset",
"bower-asset",
"npm-asset"
"npm-asset"
],
],
3: In the "installer-paths" section in the "extra" of your project composer.json
```
 
3: In the "`installer-paths`" section in the "`extra`" of your project composer.json
file, ensure you have the types drupal-library, bower-asset, and npm-asset.
file, ensure you have the types drupal-library, bower-asset, and npm-asset.
 
```
For example:
For example:
"web/libraries/{$name}": [
"web/libraries/{$name}": [
"type:drupal-library",
"type:drupal-library",
"type:bower-asset",
"type:bower-asset",
"type:npm-asset"
"type:npm-asset"
],
],
 
```
4: Add https://asset-packagist.org defined in your Composer repositories.
4: Add https://asset-packagist.org defined in your Composer repositories.
 
```
For example:
For example:
"repositories": {
"repositories": {
"asset-packagist": {
"asset-packagist": {
"type": "composer",
"type": "composer",
"url": "https://asset-packagist.org"
"url": "https://asset-packagist.org"
},
},
...
```
5: Run 'composer require npm-asset/annotorious:0.6.4'.
 
5: Run '`composer require npm-asset/annotorious:0.6.4`'.
INSTALLATION
## Installation
------------
* Install as you would normally install a contributed drupal module. See:
- Install as you would normally install a contributed drupal module. See:
https://drupal.org/documentation/install/modules-themes/modules-8
[Installing Modules](https://www.drupal.org/docs/extending-drupal/installing-modules)
for further information.
for further information.
CONFIGURATION
## Configuration
-------------
* Enable the Image Annotator module on your site.
- Enable the Image Annotator module on your site.
* Go to the configuration pages (admin/config/img_annotator) and choose
- Go to the configuration pages (`admin/config/img_annotator`) and choose
your settings.
- your settings.
* Go on a node's page with an image field with annotations enabled.
- Go on a node's page with an image field with annotations enabled.
* If you have the appropriate permissions you will be able to draw annotations.
- If you have the appropriate permissions you will be able to draw annotations.
MAINTAINERS
## Maintainers
-----------
Current maintainers:
Current maintainers:
* Florent Torregrosa (Grimreaper) - https://www.drupal.org/user/2388214
- Florent Torregrosa (Grimreaper) - https://www.drupal.org/user/2388214
Previous maintainers:
Previous maintainers:
* abhaysaraf - https://www.drupal.org/user/2723079
- abhaysaraf - https://www.drupal.org/user/2723079
This project has been sponsored by:
This project has been sponsored by:
* Smile - https://www.drupal.org/smile
- [Smile](https://www.drupal.org/smile)
Sponsored maintenance.
Sponsored maintenance.
Loading