Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
I
img_annotator
Manage
Activity
Members
Labels
Plan
Wiki
Custom issue tracker
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Model registry
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
project
img_annotator
Merge requests
!4
Updated README.txt to README.md
Code
Review changes
Check out branch
Download
Patches
Plain diff
Open
Updated README.txt to README.md
issue/img_annotator-3322426:3322426-replace-readme.txt-with
into
8.x-1.x
Overview
0
Commits
2
Pipelines
0
Changes
1
Open
Pracheth S P
requested to merge
issue/img_annotator-3322426:3322426-replace-readme.txt-with
into
8.x-1.x
2 years ago
Overview
0
Commits
2
Pipelines
0
Changes
1
Expand
Updated README.txt to README.md as per Drupal markdown practices. Please review the same.
0
0
Merge request reports
Compare
8.x-1.x
version 1
ba9da5fb
2 years ago
8.x-1.x (base)
and
latest version
latest version
ae80aea2
2 commits,
2 years ago
version 1
ba9da5fb
1 commit,
2 years ago
1 file
+
105
−
0
Side-by-side
Compare changes
Side-by-side
Inline
Show whitespace changes
Show one file at a time
README.
txt
→
README.
md
+
105
−
0
Options
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/doc
umentation/install/modules-themes/
modules
-8
[
Installing Modules
](
https://
www.
drupal.org/doc
s/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