Kotahi issueshttps://gitlab.coko.foundation/kotahi/kotahi/-/issues2024-03-20T05:19:18Zhttps://gitlab.coko.foundation/kotahi/kotahi/-/issues/1343Author Proofing Workflow2024-03-20T05:19:18ZRavindhar RangarajanAuthor Proofing Workflow**1. Introduction**
The purpose of this specification document is to outline the requirements and functionality of the Author Proofing Module for the Nvcleus Journal Publishing Platform. This module facilitates the author-proofing workfl...**1. Introduction**
The purpose of this specification document is to outline the requirements and functionality of the Author Proofing Module for the Nvcleus Journal Publishing Platform. This module facilitates the author-proofing workflow after the production process is complete. The Author Proofing Module will utilize the Wax Editor with limited functionality, supporting only suggesting mode and comments.
**2. Scope**
The Author Proofing Module will provide authors with a user-friendly interface to review and provide feedback on the finalized version of their published article. It will enable authors to suggest edits, make comments, and collaborate with the editorial team to ensure the accuracy and quality of the published work.
**3. Requirements**
3.1 Author assignment
Currently, Kotahi has the option only to assign editors and reviewers. We need the option to assign authors to the specific manuscript from the control window as shown below.
![Screenshot_4](/uploads/572713cca2c54038230a3f6b140f81ee/Screenshot_4.png)
If the manuscript has been submitted by an author, the respective author's name should be available by default under the Authors section.
**3.2 Author proofing stage**
Once the production process is completed, there will be a section under control options, where the journal manager or admin can move a submitted manuscript to the author-proofing stage as shown below. This stage will be enabled only when the production process is complete.
![Screenshot_5](/uploads/5a03df93191b9cf3e5768096239a803f/Screenshot_5.png)
**3.3 Wax Editor Integration**
The Author Proofing Module will utilize the Wax Editor, which supports only suggesting modes and comments. The following requirements should be considered:
**3.3.1 Suggesting Mode**
- The Wax Editor will be configured to allow authors to suggest edits to the text without directly modifying the published version.
- Authors can insert, delete, or modify text while clearly indicating the changes they propose.
- Suggested edits should be visually distinguishable from the original text which is already available in the wax editor.
**3.3.2 Comments**
- Authors and the editorial team should be able to add comments to specific sections of the article.
- Comments should provide a text input field for entering the comment text.
- Comments should be visible to all relevant parties and easily distinguishable from the main text.
- These are also already available in the Wax editor.
**3.4 Author Proofing Workflow**
The Author Proofing Module will follow a structured workflow to ensure efficient collaboration between authors and the editorial team. The workflow will include the following steps:
**3.4.1 Notification**
Authors will receive a notification when the production process is complete and their article is ready for proofreading.
The notification will contain instructions on accessing the Author Proofing Module and rules set by the publisher.
**3.4.2 Accessing the Module**
Authors will be able to access the Author Proofing Module through their Nvcleus account.
Upon logging in, authors will be presented with a list of their published articles that are ready for proofreading.
![proof_reading](/uploads/1a33e4884601ac0f8ed6acbaa9160dc3/proof_reading.jpg)
Clicking on the manuscript title will open the wax editor in suggesting mode.
**3.4.3 Reviewing the Article**
Authors can select an article from the list to enter the proofreading interface.
The article will be displayed in the Wax Editor with the finalized version.
Authors can navigate through the article, read the text, and make suggestions or comments as necessary.
Only the suggesting mode will be enabled and the author cannot have the option to change it to editing mode.
**3.4.5 Submitting Suggestions and Comments**
Author Proofing Form: Just like the reviewer form, we should have an author proofing form where the author can submit the comments and any supplementary files and complete the author proofing stage. Only this is done, the editorial team can take it up for review.
**3.4.5 Editorial Team Review**
The editorial team will receive notifications when authors submit their suggestions and comments.
The team can access the Author Proofing Module and view the author's feedback on the article.
The team can respond to suggestions and comments, provide clarifications, or request further revisions.
**4. Conclusion**
The Author Proofing Module for the Nvcleus Journal Publishing Platform will provide a robust workflow for authors to review and provide feedback on the finalized version of their articles. By leveraging the Wax Editor's suggesting mode and comment features, authors can suggest edits, make comments, and collaborate effectively with the editorial team. The module aims to enhance the overall quality and accuracy of published articles while ensuring a user-friendly experience for authors and the editorial team.