# The Indico Editorial Module for JACoW Thomas Baron - JACoW TM December 2021 --- ## Important Disclaimer :::danger This presentation describes the Indico editing workflow as it is **in December 2021**. There are already [**changes planned**](https://codimd.web.cern.ch/s/7bB12pwI0#) in the workflow and feature set. The full description of the editorial workflow is available at https://codimd.web.cern.ch/s/E5Z-iKlTZ# and will be **updated as things progress**. ::: --- ## Overview of the Indico Document Assessment Workflows :arrow_right: ---- ### Two Assessment Workflows - Indico supports two main document assessment workflows - Paper Peer Review - Mostly for reviewing scientific content of the papers - Also includes a layout review option - Editing - Generic editing workflow for conference documents - Papers - Slides - Posters ---- ### Integration with the Paper Peer Review ![](https://codimd.web.cern.ch/uploads/upload_1aaf4f7109dc6bb4163d8385cd58629a.png =500x) ---- ### Main differences between Paper Peer Review and Editing Modules - The `Paper Peer Review` module allows: - Several reviewers per paper - A `Judge` role which makes the final decision - The review to be established according to various questions defined as Rating/Boolean/Text - No direct interaction between the reviewer and the author - Review of papers ---- ### Main differences between Paper Peer Review and Editing Modules - The `Editing` module allows - A single editor per paper - A direct interaction between editor and author - The editor makes the final decision - The possibility for the editor to make changes to the files or request changes directly to the author. - Review of papers, slides and/or posters ---- ### The Editing Workflow Can be applied to Papers, Slides or Posters ![](https://codimd.web.cern.ch/uploads/upload_7ea26ab5983b33dbb38c19b965a5b39c.png) --- ## Setting up the Editing Workflow on Indico :gear: ---- ### Activation of the Editing Workflow ![](https://codimd.web.cern.ch/uploads/upload_614d12d5f2843a9dceed54bbdbfbf9fe.png) ![](https://codimd.web.cern.ch/uploads/upload_97b6b40a8f43d605e5e4ca80eee1bc72.png) ---- ### Activating the Editing Workflow(s) ![](https://codimd.web.cern.ch/uploads/upload_96de5cc095fccd845259e3f5a90b0297.png) ---- ### Activating the Editing Workflow(s) ![](https://codimd.web.cern.ch/uploads/upload_5d4eb9e8592d8ed740b797a4e345b432.png) ---- ### Configuring the File Types - File Types make sure authors submit the appropriate files in the appropriate format - Different File Types can be defined for Papers, Slides and Posters ![](https://codimd.web.cern.ch/uploads/upload_e3120979183da208488c40f88156bb6f.png) ---- ### Configuring the File Types ![](https://codimd.web.cern.ch/uploads/upload_213dab43457a12a2acb38e5b832af386.png =400x) ---- ### Configuring the Ready for review Conditions - define minimum requirements for a file to be considered ready for editing - type of the received files, combined with AND and OR operators ![](https://codimd.web.cern.ch/uploads/upload_554562be534ab3cd598e6d48ff050a33.png) ---- ### Configuring the Ready for review Conditions ![](https://codimd.web.cern.ch/uploads/upload_ad70d9fca641535d5b587571de0971ca.png) ---- ### Activation of the JACoW Microservice ![](https://codimd.web.cern.ch/uploads/upload_86e3ac9bda940b653935bd398dcb076e.png) ---- ### Activation of the JACoW Microservice ![](https://codimd.web.cern.ch/uploads/upload_c259802dca0e9a3e96c7434bf809baba.png =600x) *https://test-openreferee-jacow.web.cern.ch* ---- ### The JACoW Microservice - Customizes the default Indico editing module to JACoW needs ---- ### The JACoW Microservice Automatic creation of standard JACoW editing tags: ![](https://codimd.web.cern.ch/uploads/upload_606a3bd4d4043e784380a5aa729dbec1.png =500x) ---- ### The JACoW Microservice Automatic creation of standard JACoW file types: | Papers | Slides | Posters | | -------- | -------- | -------- | | ![](https://codimd.web.cern.ch/uploads/upload_c3cbcdff61ab31df1b79e1a8f8017669.png =200x) | ![](https://codimd.web.cern.ch/uploads/upload_b327a79beb0e874aa63de71feb4b1d2f.png =200x) | ![](https://codimd.web.cern.ch/uploads/upload_2c4afbbffd9ba67d51b6dca5fe88b082.png =200x) | ---- ### The JACoW Microservice - Introduction of the final QA state - Automated distilling of the submitted PDFs ---- ### Setting up the Editing Team - The team that will edit the submitted files for your conference - You can create different teams for Papers, Slides and Posters - Can include users and roles ![](https://codimd.web.cern.ch/uploads/upload_dba196bccbc569e192fc0a68d44d5943.png) ---- ### Setting up the Editing Team ![](https://codimd.web.cern.ch/uploads/upload_eb2a573fa81a844063fca3095da352e1.png) ---- ### Assigning Editors to Editables There are two ways to assign an editor to an editable - Self-assignment by the editor - Assignment by the manager ![](https://codimd.web.cern.ch/uploads/upload_ad3f66e375ba29fdc36df61dc5702f87.png) ---- ### Assigning Editors to Editables ![](https://codimd.web.cern.ch/uploads/upload_2416a83c208b330ac1994c824c6dbe44.png) ---- ### Opening the Submission of Files Files can be submitted by Authors only when the submission of files is open. ![](https://codimd.web.cern.ch/uploads/upload_ddc77bce33d9355851ddf4bc900e8a95.png) You can close the submission at any time ![](https://codimd.web.cern.ch/uploads/upload_227535040845cf03703e5de35473b7bb.png) ---- ### Starting the Editing Process Editables can be assigned to editors only when the Editing is started. Start the editing process by clicking on the Start now button. ![](https://codimd.web.cern.ch/uploads/upload_6c29a4330051919b898f2ab9a7a53221.png) You can then close it at any time by clicking on the "Close now" button. ![](https://codimd.web.cern.ch/uploads/upload_6a38adb556bb3efeb8ba1ed28161d72e.png) --- ## The Editor's Perspective :pencil2: ---- ### Accessing the Editor's Features ![](https://codimd.web.cern.ch/uploads/upload_c71a6b250194194ea1a00385c817e343.png =700x) ---- ### Accessing the Editor's Features - cont. ![](https://codimd.web.cern.ch/uploads/upload_35c4ed7609d3279f1e4a622c45fc5a38.png =700x) ---- ### Getting a Paper Assignment ![](https://codimd.web.cern.ch/uploads/upload_b443a0f2dd3dbb3816adb50526af3a58.png =700x) ---- ### Checking List of Assignments ![](https://codimd.web.cern.ch/uploads/upload_0582dc88124f35b73758e786acf21d42.png =700x) ---- ### Editing a Document ![](https://codimd.web.cern.ch/uploads/upload_52ed5a1b595be3344def541c4aeb7b65.png =700x) ---- ### Editing a Document - Commenting - Any editor - Open to the author or not ![](https://codimd.web.cern.ch/uploads/upload_c13e3fefaba9d4a19e41a749c85268b7.png =500x) ---- ### Editing a Document - Judging - Only by the assigned editor ![](https://codimd.web.cern.ch/uploads/upload_0f26912f6287ec4ca8f008e1b967f107.png) - 4 choices - Accept - Reject - Make Changes - Request Changes ---- ### Editing a Document - Accept (Green Dot) - When the current revision is ready for publishing ![](https://codimd.web.cern.ch/uploads/upload_ce35895ab434632fffc193091b1314ed.png =500x) ---- ### Editing a Document - Reject - When there is no more hope that the document is ever published ![](https://codimd.web.cern.ch/uploads/upload_b5b098d119bc785c18825187ef3e6b47.png =500x) ---- ### Editing a Document - Make Changes (Yellow Dot) - When you have edited the file to a new version you think is good enough - This triggers approval by the author ![](https://codimd.web.cern.ch/uploads/upload_2a924b7cfea89cca302e2ffa7b251603.png =400x) ---- ### Editing a Document - Make Changes - bypassing author's confirmation - When you have edited the file to a new version you think is good enough - The changes do not require the author's confirmation ![](https://codimd.web.cern.ch/uploads/upload_7d2137f9ce237f22f3cfd5e98657f499.png =400x) ---- ### Editing a Document - Request Changes (Red Dot) - When you cannot edit the file to a good version, the last resort is to ask the author to do the modification ![](https://codimd.web.cern.ch/uploads/upload_97e1f838359d136ec9700e7888caf794.png =500x) ---- ### Undoing the Last Action ![](https://codimd.web.cern.ch/uploads/upload_71c77432d2e42e0da55b71a9c6354b25.png) --- ## The Author's Perspective :female-student: ---- ### Submitting a Document ![](https://codimd.web.cern.ch/uploads/upload_247dd93f0be2e81066c86d65473f5d14.png =700x) ---- ### Submitting a Document ![](https://codimd.web.cern.ch/uploads/upload_15aead66ab3673bd52867197785203cb.png =700x) ---- ### Initial File Upload ![](https://codimd.web.cern.ch/uploads/upload_ba9479a1d2029045f9476ffd4b124dde.png =700x) ---- ### Editing Timeline ![](https://codimd.web.cern.ch/uploads/upload_899ee3688cecd1521405a327f11fe7c3.png =600x) ---- ### Commenting to Editors - You can send comments to editors ![](https://codimd.web.cern.ch/uploads/upload_bd1062366fc767fd850e7a6e9cdf3781.png =500x) - To which they can answer (you also receive an email) ![](https://codimd.web.cern.ch/uploads/upload_f26f27d2141af7046987d0886f53a54d.png =500x) ---- ### Uploading a New Version of the Files - File Revision is normally not permitted when editing has started - At some point, if the editors cannot obtain a publishable file by themselves, they may ask you to upload a new version yourself ![](https://codimd.web.cern.ch/uploads/upload_9accfdb51b17a937c327c78b9adcf36d.png =500x) ---- ### Approving new Edited Files - The Editor may upload a new version of the document and ask you to validate it ![](https://codimd.web.cern.ch/uploads/upload_8514247483ba8884d29306c7e6f008f4.png =700x) --- ## Publishing :newspaper: ---- ### Final QA - Once the document is accepted, final QA starts - Only people with the Scientific Secretary role can perform the final QA ![](https://codimd.web.cern.ch/uploads/upload_e781b7cdcc0a81529b37ab93f383f6aa.png =700x) ---- ### Final QA Decision - If accepted, the document is ready for publishing. - If rejected, the status of the document is moved back to "Assigned" --- ## Thanks for your Attention! More details at https://codimd.web.cern.ch/s/E5Z-iKlTZ# The JACoW Indico server is at https://indico.jacow.org/ The general Indico documentation is at https://indico.docs.cern.ch/
{"type":"slide","slideOptions":{"theme":"cern2"}}