Difference between revisions of "OFRPluginsDocumentation"
m (Typo) |
|||
| (20 intermediate revisions by one other user not shown) | |||
| Line 2: | Line 2: | ||
This is the user documentation for the objects for review plugin for OJS. The plugin is developed in the project "Functional extensions and value added services for OJS" [http://www.cedis.fu-berlin.de/ojs-de]. | This is the user documentation for the objects for review plugin for OJS. The plugin is developed in the project "Functional extensions and value added services for OJS" [http://www.cedis.fu-berlin.de/ojs-de]. | ||
| − | + | == Enable the plugin == | |
| − | The plugin can be found under Journal Management > System Plugins > Generic Plugins > Objects For Review Plugin. Then click on the link "Enable" | + | The plugin can be found under Journal Management > System Plugins > Generic Plugins > Objects For Review Plugin. Then click on the link "Enable". |
[[File:OJS_OFR_Plugin.png]] | [[File:OJS_OFR_Plugin.png]] | ||
| − | Image 1: Objects For Review Plugin | + | Image 1: Enable Objects For Review Plugin |
| + | |||
| + | == For editors == | ||
After the plugin is enabled, you will see the following Objects For Review part on the editor's page: | After the plugin is enabled, you will see the following Objects For Review part on the editor's page: | ||
| Line 18: | Line 20: | ||
Click on the link "Objects For Review" to set up, create and manage the objects for review. (Note that an active review object type must exists to be able to create an object for review.) | Click on the link "Objects For Review" to set up, create and manage the objects for review. (Note that an active review object type must exists to be able to create an object for review.) | ||
| − | === Review Object Types | + | === Review Object Types === |
| − | ==== Install | + | ==== Install ==== |
Choose one or several existing default review object types and languages and click on the button "Install" (s. Image 3). | Choose one or several existing default review object types and languages and click on the button "Install" (s. Image 3). | ||
| Line 27: | Line 29: | ||
Image 3: Review object types installation | Image 3: Review object types installation | ||
| − | ==== Update | + | ==== Update ==== |
| − | If an existing default review object type has been extended with additional metadata, translated into a new language or if | + | If an existing default review object type has been extended with additional metadata, translated into a new language or if its existing translation has been improved, you can update the review object type for that specific language. Select the desired review object types and languages and click on the button "Update" (s. Image 4). |
[[File:OJS_OFR_ROT_Update.png]] | [[File:OJS_OFR_ROT_Update.png]] | ||
Image 4: Review object types update | Image 4: Review object types update | ||
| − | ==== Edit | + | ==== Edit ==== |
| − | You can edit the title and description of a review object type, manage the metadata list, and preview the form for the creation of the objects for review: | + | You can edit the title and the description of a review object type, manage the metadata list, and preview the form for the creation of the objects for review: |
[[File:OJS_OFR_ROT_Edit.png]] | [[File:OJS_OFR_ROT_Edit.png]] | ||
Image 4: Edit review object type | Image 4: Edit review object type | ||
| − | ===== | + | ===== Metadata ===== |
| − | The | + | The position of the metadata can be changed (for the objects for review form). Further, you can choose which metadata are required and which should be displayed in the public object for review list. Press the button "Save" to record your changes. |
| − | If necessary, you can add new metadata (click on the link "Create Review Object Metadata"), and edit, delete as well as copy them to another review object type (choose the created metadata and the review object type from the list and press | + | If necessary, you can add new metadata (click on the link "Create Review Object Metadata"), and edit, delete as well as copy them to another review object type (choose the created metadata and the review object type from the list and press the button "Copy"). |
[[File:OJS_OFR_ROT_Metadata.png]] | [[File:OJS_OFR_ROT_Metadata.png]] | ||
Image 4: Review object type metadata | Image 4: Review object type metadata | ||
| − | ==== Activate | + | ==== Activate ==== |
When your review object type is perfectly finished and ready to be used, click on the link "Activate" to be able to crate objects for review of this type. | When your review object type is perfectly finished and ready to be used, click on the link "Activate" to be able to crate objects for review of this type. | ||
| Line 56: | Line 58: | ||
Image 5: Activate review object type | Image 5: Activate review object type | ||
| − | ==== Deactivate | + | ==== Deactivate ==== |
If you don't want the objects for review of a type to be created any more, deactivate the review object type by clicking on the link "Deactivate" | If you don't want the objects for review of a type to be created any more, deactivate the review object type by clicking on the link "Deactivate" | ||
| Line 63: | Line 65: | ||
Image 6: Deactivate review object type | Image 6: Deactivate review object type | ||
| + | ==== Delete ==== | ||
| − | === Objects For Review | + | Click on the link "Delete". This will also delete all objects for review of this type as well as their whole object history i.e. all the existing assignments for these object. |
| + | |||
| + | === Objects For Review === | ||
There are three menu elements for the objects for review management: Assignments, Objects For Review and Settings. | There are three menu elements for the objects for review management: Assignments, Objects For Review and Settings. | ||
| − | + | ==== Settings ==== | |
First define the mode your journal is working in: | First define the mode your journal is working in: | ||
1 - the available objects for review will be published under a new menu "Objects For Review" in the horizontal navigation, interested authors can request the objects for review and the editor will be able to manage the object reviewers. | 1 - the available objects for review will be published under a new menu "Objects For Review" in the horizontal navigation, interested authors can request the objects for review and the editor will be able to manage the object reviewers. | ||
| − | 2 - editor matches | + | 2 - editor matches the submissions to each object. |
Define the weeks the reviews are due after. | Define the weeks the reviews are due after. | ||
| Line 82: | Line 87: | ||
Image 7: Objects for review settings | Image 7: Objects for review settings | ||
| − | + | ==== Objects For Review ==== | |
Here you can see the list of the created objects for review. You can filter them by the editor or type, search for words in the title or abstract, and use the table column titles to sort the list as needed. | Here you can see the list of the created objects for review. You can filter them by the editor or type, search for words in the title or abstract, and use the table column titles to sort the list as needed. | ||
| Line 91: | Line 96: | ||
[[File:OJS_OFR_ObjectsForReview_2.png]] | [[File:OJS_OFR_ObjectsForReview_2.png]] | ||
| − | Image 8: Objects for review | + | Image 8: Objects for review mode 1 and mode 2 |
| − | ===== Create | + | ===== Create ===== |
Choose a review object type and press the button "Create". Fill in the required metadata fields, specify the language and if you have a copy of the object, eventually upload a cover page and write some additional information for the internal use only, specify the editor responsible for this object and define if the object is available for review i.e. can be reviewed. | Choose a review object type and press the button "Create". Fill in the required metadata fields, specify the language and if you have a copy of the object, eventually upload a cover page and write some additional information for the internal use only, specify the editor responsible for this object and define if the object is available for review i.e. can be reviewed. | ||
| − | ===== Delete | + | ===== Delete ===== |
Click on the link "Delete". This will also delete the whole object history i.e. all the existing assignments for this object. | Click on the link "Delete". This will also delete the whole object history i.e. all the existing assignments for this object. | ||
| − | ===== Assign | + | ===== Assign ===== |
Clicking on the link "Assign" (in mode 1) will lead to a list of the journal authors. You can then select the appropriate author from the list, and ask him/her for the object review. This assignment will then appear in the list of the assignments. | Clicking on the link "Assign" (in mode 1) will lead to a list of the journal authors. You can then select the appropriate author from the list, and ask him/her for the object review. This assignment will then appear in the list of the assignments. | ||
Note that an object can be assigned several times, to different authors, i.e. reviewed by different authors. | Note that an object can be assigned several times, to different authors, i.e. reviewed by different authors. | ||
| − | ===== Select an | + | Clicking on the link "Select" (in mode 2) will lead to a list of the journal articles. You can then select the appropriate article from the list, that contains the object review. This assignment will then appear in the list of the assignments. |
| + | Note that an object can be assigned several times, to different articles, i.e. reviewed by different authors in different articles. | ||
| + | |||
| + | ==== Assignments ==== | ||
| + | |||
| + | Here you can see the assignments lists. | ||
| + | If you are working in the mode 1, you can see all, requested, assigned, mailed and submitted assignments lists and manage the reviews. You can filter them by the editor or review object type, search for the words in the object title or abstract, and use the table column titles to sort the list as needed. | ||
| + | |||
| + | [[File:OJS_OFR_Assignments_2.png]] | ||
| + | Image 9: Objects for review assignments mode 2 | ||
| + | |||
| + | Else, if working in the mode 2 you can only see and manage the assigned submissions here: you can jump to the submission view page or, if necessary, you can change the assigned submission by clicking on the link "Select". | ||
| + | |||
| + | [[File:OJS_OFR_Assignments_1.png]] | ||
| + | Image 10: Objects for review assignments mode 1 | ||
| + | |||
| + | ===== Accept/Deny ===== | ||
| + | |||
| + | If an author requested an object for review, you can accept or deny the request by clicking on the appropriate link "Accept" i.e. "Deny". | ||
| + | |||
| + | ===== Mailed ===== | ||
| + | |||
| + | If you possess the physical copy of the object, you entered it so in the object form, and you mailed the copy to the author you can make the note and change the assignment status to "Mailed" by clicking on the link "Object Mailed". | ||
| + | |||
| + | ===== Remove ===== | ||
| + | |||
| + | You can remove an assignment by clicking on the link "Remove". | ||
| + | |||
| + | ===== Select submission ===== | ||
| + | |||
| + | You can select/assing a submission by clicking on the link "Select". If a submission is already assigned, you can jump to the submission view page by using the link "Edit" or, if necessary, change it by using the link "Select" again. | ||
| + | |||
| + | == For authors (mode 1) == | ||
| + | |||
| + | If working in mode 1 authors see the following Objects For Review part on their home page: | ||
| + | |||
| + | [[File:OJS_OFR_Author_menu.png]] | ||
| + | Image 11: Objects for review plugin menu for authors | ||
| + | |||
| + | There they see the their assignemnts lists: all, requested, assigned, mailed and submitted. The table column titles can be used to sort the list as needed. | ||
| + | |||
| + | [[File:OJS_OFR_Author_assignments.png]] | ||
| + | Image 12: Objects for review plugin menu for authors | ||
| + | |||
| + | === Review submission === | ||
| + | |||
| + | When submitting a review for an object, the author can choose the appropriate object from the list of the objects assigned to him/her in the submission step 5. | ||
| − | + | [[File:OJS_OFR_Author_step5.png]] | |
| + | Image 13: Review submission, step 5, determining the object | ||
Latest revision as of 14:26, 5 September 2013
Contents
Objects For Review Plugin for OJS
This is the user documentation for the objects for review plugin for OJS. The plugin is developed in the project "Functional extensions and value added services for OJS" [1].
Enable the plugin
The plugin can be found under Journal Management > System Plugins > Generic Plugins > Objects For Review Plugin. Then click on the link "Enable".
Image 1: Enable Objects For Review Plugin
For editors
After the plugin is enabled, you will see the following Objects For Review part on the editor's page:
Image 2: Objects for review plugin menu for editors
Click on the link "Review Object Types" to install or create new review object types, to update the installed, and/or to manage the existing ones.
Click on the link "Objects For Review" to set up, create and manage the objects for review. (Note that an active review object type must exists to be able to create an object for review.)
Review Object Types
Install
Choose one or several existing default review object types and languages and click on the button "Install" (s. Image 3).
Image 3: Review object types installation
Update
If an existing default review object type has been extended with additional metadata, translated into a new language or if its existing translation has been improved, you can update the review object type for that specific language. Select the desired review object types and languages and click on the button "Update" (s. Image 4).
Image 4: Review object types update
Edit
You can edit the title and the description of a review object type, manage the metadata list, and preview the form for the creation of the objects for review:
Image 4: Edit review object type
Metadata
The position of the metadata can be changed (for the objects for review form). Further, you can choose which metadata are required and which should be displayed in the public object for review list. Press the button "Save" to record your changes. If necessary, you can add new metadata (click on the link "Create Review Object Metadata"), and edit, delete as well as copy them to another review object type (choose the created metadata and the review object type from the list and press the button "Copy").
Image 4: Review object type metadata
Activate
When your review object type is perfectly finished and ready to be used, click on the link "Activate" to be able to crate objects for review of this type.
Image 5: Activate review object type
Deactivate
If you don't want the objects for review of a type to be created any more, deactivate the review object type by clicking on the link "Deactivate"
Image 6: Deactivate review object type
Delete
Click on the link "Delete". This will also delete all objects for review of this type as well as their whole object history i.e. all the existing assignments for these object.
Objects For Review
There are three menu elements for the objects for review management: Assignments, Objects For Review and Settings.
Settings
First define the mode your journal is working in: 1 - the available objects for review will be published under a new menu "Objects For Review" in the horizontal navigation, interested authors can request the objects for review and the editor will be able to manage the object reviewers. 2 - editor matches the submissions to each object.
Define the weeks the reviews are due after. If the automatic e-mail notifications should be send to the reviewers before or after the due date, define the days when the notifications should be sent.
Finally, add some more information that will be published along with the objects for review.
Image 7: Objects for review settings
Objects For Review
Here you can see the list of the created objects for review. You can filter them by the editor or type, search for words in the title or abstract, and use the table column titles to sort the list as needed. You can also delete an object and create a new one. Depending on the mode your journal is working in (s. Settings above), you will also be able to assign an object to a reviewer (in mode 1) or to select an article that contains the review of the object (in mode 2).
Image 8: Objects for review mode 1 and mode 2
Create
Choose a review object type and press the button "Create". Fill in the required metadata fields, specify the language and if you have a copy of the object, eventually upload a cover page and write some additional information for the internal use only, specify the editor responsible for this object and define if the object is available for review i.e. can be reviewed.
Delete
Click on the link "Delete". This will also delete the whole object history i.e. all the existing assignments for this object.
Assign
Clicking on the link "Assign" (in mode 1) will lead to a list of the journal authors. You can then select the appropriate author from the list, and ask him/her for the object review. This assignment will then appear in the list of the assignments. Note that an object can be assigned several times, to different authors, i.e. reviewed by different authors.
Clicking on the link "Select" (in mode 2) will lead to a list of the journal articles. You can then select the appropriate article from the list, that contains the object review. This assignment will then appear in the list of the assignments. Note that an object can be assigned several times, to different articles, i.e. reviewed by different authors in different articles.
Assignments
Here you can see the assignments lists. If you are working in the mode 1, you can see all, requested, assigned, mailed and submitted assignments lists and manage the reviews. You can filter them by the editor or review object type, search for the words in the object title or abstract, and use the table column titles to sort the list as needed.
Image 9: Objects for review assignments mode 2
Else, if working in the mode 2 you can only see and manage the assigned submissions here: you can jump to the submission view page or, if necessary, you can change the assigned submission by clicking on the link "Select".
Image 10: Objects for review assignments mode 1
Accept/Deny
If an author requested an object for review, you can accept or deny the request by clicking on the appropriate link "Accept" i.e. "Deny".
Mailed
If you possess the physical copy of the object, you entered it so in the object form, and you mailed the copy to the author you can make the note and change the assignment status to "Mailed" by clicking on the link "Object Mailed".
Remove
You can remove an assignment by clicking on the link "Remove".
Select submission
You can select/assing a submission by clicking on the link "Select". If a submission is already assigned, you can jump to the submission view page by using the link "Edit" or, if necessary, change it by using the link "Select" again.
For authors (mode 1)
If working in mode 1 authors see the following Objects For Review part on their home page:
Image 11: Objects for review plugin menu for authors
There they see the their assignemnts lists: all, requested, assigned, mailed and submitted. The table column titles can be used to sort the list as needed.
Image 12: Objects for review plugin menu for authors
Review submission
When submitting a review for an object, the author can choose the appropriate object from the list of the objects assigned to him/her in the submission step 5.
Image 13: Review submission, step 5, determining the object
