-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
475d9b6
commit e80e25d
Showing
13 changed files
with
241 additions
and
228 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,17 @@ | ||
## Videowiki Proofread web component | ||
`<vw-proofread></vw-proofread>` | ||
## COMET Video Proofread web component | ||
`<vd-proofread></vd-proofread>` | ||
|
||
This web component is part of www.videowiki.org and used for the proofreading stage | ||
This web component is part of comet.anuvaad.org and used for the proofreading stage | ||
|
||
### Usage: | ||
##### Include the following script in you page | ||
`<script src="https://videowiki-microapps.s3-eu-west-1.amazonaws.com/vw-proofread/v1.0.0.js" async />` | ||
|
||
Use the web component `vw-proofread` anywhere on the page with the following properties | ||
Use the web component `vd-proofread` anywhere on the page with the following properties | ||
|
||
`<vw-proofread apiKey="" apiRoot="" videoId="" backRoute="" finishRedirectRoute="" </vw-proofread>` | ||
`<vd-proofread apiKey="" apiRoot="" videoId="" backRoute="" finishRedirectRoute="" </vd-proofread>` | ||
` | ||
### Properties | ||
- apiKey: Obtain an API key for your organization from the dashboard on www.videowiki.org | ||
- apiRoot: The API to which the component will communicate, for integration with videowiki's original API use https://api.videowiki.org/api | ||
- apiKey: Obtain an API key for your organization from the dashboard on comet.anuvaad.org | ||
- apiRoot: The API to which the component will communicate, for integration with COMET's original API use https://comet.anuvaad.org.org/api | ||
- videoId: the `_id` field of the video that is to be proofread | ||
- backRoute: the location/route to which the component should redirect when the user press "Back to videos" button. | ||
- finishRedirectRoute: The location/route to which the component should redirect when the user press "Save and complete" button. |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.