Skip to content

Commit

Permalink
Removed last vestiges of "annotations-tool" terminology
Browse files Browse the repository at this point in the history
At least I hope so ...
  • Loading branch information
JulianKniephoff committed Jan 26, 2018
1 parent 675ee99 commit a25d1c2
Show file tree
Hide file tree
Showing 63 changed files with 589 additions and 591 deletions.
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -6,13 +6,13 @@ The software devides currently into two parts:

* The frontend component, containing the annotation webapp.
* The Opencast Backend modules, that need to be integrated into an Opencast installation. A recent version of the i
frontend is already included in the entwine-annotations-tool module.
frontend is already included in the annotation-tool module.

## [Installation](documentation/opencast-installation.md)
The instruction on how to install the Annotation tool in Opencast 2.3+ [can be found here](documentation/opencast-installation.md)

## [Building the Frontend](documentation/build-frontend.md)
Instructions on how to build the frontend webapp [can be found here](documentation/build-frontend.md).
Instructions on how to build the frontend webapp [can be found here](documentation/build-frontend.md).

_This is NOT needed to install the Annotation Tool in Opencast!_

Expand Down
8 changes: 4 additions & 4 deletions documentation/News.md
Expand Up @@ -33,9 +33,9 @@ Related to the tickets [#394](https://github.com/entwinemedia/annotations/issues
* Off-screen rendering for the list.
* Limit the redraw frequency for the timeline.

For load testing, the method `tracksToImport` can now be implemented in the [configuration file](https://github.com/entwinemedia/annotations/blob/develop/js/annotations-tool-configuration.js) to load a large set of tracks. See the [load test configuration file](https://github.com/entwinemedia/annotations/blob/develop/tests/js/annotations-tool-configuration-loading.js) as example.
For load testing, the method `tracksToImport` can now be implemented in the [configuration file](https://github.com/entwinemedia/annotations/blob/develop/js/annotation-tool-configuration.js) to load a large set of tracks. See the [load test configuration file](https://github.com/entwinemedia/annotations/blob/develop/tests/js/annotation-tool-configuration-loading.js) as example.

###12.11.2013
###12.11.2013
Some tests have been done with the updates from the 4th november and they resulted with the following work:

* [#307](https://github.com/entwinemedia/annotations/issues/#307) - Moving annotations between public/private tracks and changing track visibility status in timeline did not always update the list view. This is now fixed.
Expand All @@ -44,12 +44,12 @@ Some tests have been done with the updates from the 4th november and they result
* [#382](https://github.com/entwinemedia/annotations/issues/#382) - Automatically select new track.
* [#383](https://github.com/entwinemedia/annotations/issues/#383) - Switching Public/Private visibility on track was relative slow due to synchronisation of all annotations. Now just the track is synchronised with the backend for this operation.

###05.11.2013
###05.11.2013
Some design related issues have been fixed:
* [#280](https://github.com/entwinemedia/annotations/issues/#280) - Fix responsive design issue that was happening during tab switching.
* [#275](https://github.com/entwinemedia/annotations/issues/#275) - Change eye icon for the track visibility status (public/private).

###04.11.2013
###04.11.2013
Small update with the fixes for the following bugs:
* [#271](https://github.com/entwinemedia/annotations/issues/#271) - Small modifications done on the print design. The labels captions are no more split and the color.
* [#280](https://github.com/entwinemedia/annotations/issues/#280) - Add responsive design for the categories edit-modus.
Expand Down
4 changes: 2 additions & 2 deletions documentation/Test-the-tool-with-an-annotations-preset.md
Expand Up @@ -4,7 +4,7 @@ To use it, first the tests folder should access through a web server. You can us

If you need to install Grunt, follow [the starting tutorial](http://gruntjs.com/getting-started).

The set of track is loaded only the first time following the [`tracksToImport`](https://github.com/entwinemedia/annotations/blob/t/ANNOT-83/tests/js/annotations-tool-configuration-loading.js#L141) function define in the [configuration file](https://github.com/entwinemedia/annotations/blob/t/ANNOT-83/tests/js/annotations-tool-configuration-loading.js) for the test page. To reset the tracks, use the url parameter `?reset=true`. You can edit this function to get the number of tracks and annotations that you want. The function has to return the track and annotations in the following format:
The set of track is loaded only the first time following the [`tracksToImport`](https://github.com/entwinemedia/annotations/blob/t/ANNOT-83/tests/js/annotation-tool-configuration-loading.js#L141) function define in the [configuration file](https://github.com/entwinemedia/annotations/blob/t/ANNOT-83/tests/js/annotation-tool-configuration-loading.js) for the test page. To reset the tracks, use the url parameter `?reset=true`. You can edit this function to get the number of tracks and annotations that you want. The function has to return the track and annotations in the following format:

[
// Array containing the generated tracks
Expand All @@ -29,4 +29,4 @@ The set of track is loaded only the first time following the [`tracksToImport`](
// Add more track here
]

A test page for the story ANNOT-83 is available at http://entwinemedia.github.io/annotations/ANNOT-83/tests/loading.html
A test page for the story ANNOT-83 is available at http://entwinemedia.github.io/annotations/ANNOT-83/tests/loading.html
2 changes: 1 addition & 1 deletion documentation/build-frontend.md
Expand Up @@ -47,7 +47,7 @@ You will find the webapp in `/opt/annotation/annotation-tool/frontend/`.
cd /opt/annotation/annotation-tool/frontend/
grunt integration

The files in `/opt/annotation/annotation-tool/opencast-backend/entwine-annotations-tool/src/main/resources/ui/` should
The files in `/opt/annotation/annotation-tool/opencast-backend/annotation-tool/src/main/resources/ui/` should
have been updated. Use the [installation guide for Opencast](opencast-installation.md) to update Opencast with the new frontend.

## Building __dev__
Expand Down
2 changes: 1 addition & 1 deletion frontend/.jshintrc
Expand Up @@ -24,7 +24,7 @@
"FileReader" : true,
"console" : true,
"window" : true,
"annotationsTool" : true,
"annotationTool" : true,
"localStorage" : true,
"Backbone" : true,
"$" : true,
Expand Down
10 changes: 5 additions & 5 deletions frontend/Gruntfile.js
Expand Up @@ -34,30 +34,30 @@ module.exports = function (grunt) {
integration: {
sources : '',
target : '../opencast-backend/annotation-tool/src/main/resources/ui/',
config : 'build/profiles/integration/annotations-tool-configuration.js'
config : 'build/profiles/integration/annotation-tool-configuration.js'
},

local: {
sources: '<source src=\"/resources/aav1.mp4\" type=\"video/mp4\" />\n \
<source src=\"/resources/aav1.webm\" type=\"video/webm\" />\n \
<source src=\"/resources/aav1.ogv\" type=\"video/ogg\" /> ',
target : '<%= webServerDir %>',
config : 'build/profiles/local/annotations-tool-configuration.js'
config : 'build/profiles/local/annotation-tool-configuration.js'
},

build: {
sources: '<source src=\"/resources/Annotations_Video.mp4\" type=\"video/mp4\" />\n \
<source src=\"/resources/Annotations_Video.webm\" type=\"video/webm\" />\n \
<source src=\"/resources/Annotations_Video.theora.ogv\" type=\"video/ogg\" /> ',
target : '<%= buildDir %>',
config : 'build/profiles/local/annotations-tool-configuration.js'
config : 'build/profiles/local/annotation-tool-configuration.js'
},

demo: {
sources: '<source src=\"/annotation/resources/sinteltrailer.mp4\" type=\"video/mp4\" />\n \
<source src=\"/annotation/resources/sinteltrailer.ogv\" type=\"video/ogg\" /> ',
target : '/var/www/html/annotation/',
config : 'build/profiles/local/annotations-tool-configuration.js'
config : 'build/profiles/local/annotation-tool-configuration.js'
}
},

Expand Down Expand Up @@ -269,7 +269,7 @@ module.exports = function (grunt) {
// ... the configuration
'config': {
src: '<%= currentProfile.config %>',
dest: '<%= currentProfile.target %>/js/annotations-tool-configuration.js'
dest: '<%= currentProfile.target %>/js/annotation-tool-configuration.js'
},
// ... the translations
'locales': {
Expand Down
6 changes: 3 additions & 3 deletions frontend/build/config/INDEX_DOC.md
@@ -1,13 +1,13 @@
# Javascript documentation for the annotations tool
<br/>
## Main namespace
The only exported namespace is [`annotationsTool`](annotationsTool.html). Extend this one to extend the tool API.
The only exported namespace is [`annotationTool`](annotationTool.html). Extend this one to extend the tool API.

## Tool configuration
The tool can be configured through this [`configuration file`](module-annotations-tool-configuration.html#Configuration).
The tool can be configured through this [`configuration file`](module-annotation-tool-configuration.html#Configuration).

## More informations
on https://github.com/entwinemedia/annotations/wiki

## Bugs, problems in the code or docs?
Fill a ticket on https://github.com/entwinemedia/annotations/issues/new
Fill a ticket on https://github.com/entwinemedia/annotations/issues/new

0 comments on commit a25d1c2

Please sign in to comment.