This short video explains the Editing process in Indico:
Just like the Peer Reviewing module, the Editing module provides a paper workflow whereby authors submit papers which are subsequently reviewed and/or corrected. Specifically, the module allows you to
- submit papers, posters and slides for a review,
- set up an editing team and assign editors to editables,
- review and judge editables and
- publish accepted materials.
If you're not sure which module to use, check the introduction for a higher level description of the Peer Reviewing and Editing modules.
Here is a flowchart showing an overview of the editing workflow:
The following sections explain how to use the Editing module from the point of view of organizers, authors and paper reviewers.
Configuring the Editing module as a manager/organizer
Enabling the module
In order to start using the Editing module, you need to first enable it. From the event management page, click on the Editing tab in the left menu, under Workflows. Click Enable module to enable the Editing module.
The module can be disabled at any time from the Features tab under Advanced options.
Once the module is enabled, you will see new tabs appear in the conference's menu when switching to the display area.
Granting access to the Editing module
By default, event managers can access the management area of the Editing module. In addition, anyone with the Editing manager permission can also manage the module. This permission can be set on the Protection page of the event.
Configuring editable types
As previously alluded to, unlike the Peer Reviewing module, the Editing module allows you to submit not just papers but also slides and posters. These are referred to as editable types and you can configure which ones are enabled. Authors will not be able to submit a material for that particular type unless it is enabled. By the default, only the paper editable type is enabled.
To enable more editable types, first navigate to the Editing page in the management area. Then, click on Toggle editables types:
Now you can toggle the individual editable types:
Once finished, click Save to save the changes.
Note that the settings for each editable type are separate. You can open them by clicking on Manage next to the editable type you want to edit:
You will see this settings page:
The subtitle tells you what editable type you are currently editing. In this case, we are editing settings for papers.
In the following sections, we explain the various settings found on this page.
Managing file types
From the same settings menu above, you can manage allowed file types by clicking on Configure next to File types:
By default, PDF is added as the default file type.
This means that by default, authors can only submit PDF files for this editable type. If you want to allow other file types, such as a CSV file with additional data, click on Add new a file type at the bottom of the page.
This opens a dialog window with several options:
The Filename template is an optional file name pattern. You can use this to make sure that the submitted file names conform to the specified pattern. For example, all CSV files ending with '_data' and all PDF files ending with '_paper'. You can also optionally specify allowed file extensions, e.g. '.csv' for CSV files and '.pdf' for PDF files. At the bottom of the dialog, there are a few more options you can toggle.
- File required - whether this file is required when submitting the given editable (paper, poster or slides).
- Multiple files - allows uploading multiple files for the same editable type, such as multiple PDF files.
- Publishable - controls whether the files of this type should be published in the corresponding contribution. This is useful in case some files should only be visible to the editors.
Once done, click on Submit to create a new file type. If you need to edit the file type later, you can do so by clicking on the edit icon next to it. Deleting a file type is possible as long as no file of that type has been uploaded and the file is not referenced in reviewing conditions (explained in the following section).
Setting up 'Ready for review' conditions
In case you have complex submission requirements based on file types, you can benefit from setting up reviewing conditions. An example where reviewing conditions are useful would be a conference requiring authors to submit either a PDF or a Word document with a CSV file attached. Since you want the authors to be able to choose between PDF and Word, you cannot make either of the file types required. However, you still want that at least one of them submitted. Reviewing conditions allow you to easily express complex conditions such as this one.
Note that these conditions will not outright prevent authors from uploading incomplete submissions, but rather the timeline of the editable will display a warning until the reviewing conditions are met.
To add a new condition, click on Configure next to Ready for review conditions in the management page of your chosen editable type.
On the next page, click on Create new file type condition.
Use the dropdown to select the file types you have defined previously. If you select more than one file type, the chosen combination of file types will be required. For example, if you select PDF and CSV, authors will be required to upload at least one file of each type.
When you've selected your first condition, click on the tick icon to confirm:
To finish our example, we will add a second condition for a Word document and a CSV file. The final state should look like this:
These example conditions mean that authors must submit a CSV file together with either a PDF or a Word document. If the conditions are not met, authors and editors alike will see a warning on the timeline of the editable:
Setting up the editing team
The Editing module lets you set up an editing team. This feature is similar to the reviewing teams in the Peer Reviewing module. Only users added to the editing team can view the list of editables and review them. Unlike the Peer Reviewing module, there is no separation between reviewers and judges - editors have the role of both.
The editing team is separate for each editable type, meaning that for example the paper editing team is different from the editing team for posters or slides.
To add an editor to the editing team, click on Manage team next to Editing team:
Here, add your users and click Submit. You can use the same procedure to remove editors as well.
Having set up the editing team, you can now easily contact all editors via email should you need to. Click on Contact, select the recipients and click on Send emails which will open a dialog window where you can type the email.
The Editing module also lets you keep the editors private. This means that authors will not be able to see the identity of the editors reviewing and commenting on their submissions.
Editors are visible by default. To hide them, toggle Keep editing team members anonymous next to Editing team:
Opening submission & editing
Once you are done configuring the Editing module, you can open submissions and editing. This will allow authors to submit editables and reviewers to review them. Each editable type (papers, slides and posters) can be opened and closed independently. Both submissions and reviewing can be opened from the management page of the editable type by clicking on Start now:
To close submissions or reviewing, simply click on Close now.
Editors may only review editables that have been assigned to them by editing managers. To assign editors to papers, click on List in the Editor assignment section of your chosen editable type.
Here, you will see the list of all contributions. Contributions where an editable of the current type (visible in the page subtitle) has been submitted will be active, with the status saying Ready for review.
The EDITOR column shows the currently assigned editor.
To assign an editor to an editable, select a contribution and click on Assign in the top menu. You can also assign an editable to yourself by clicking on Assign to myself. To unassign a paper, select a contribution and click Unassign. Note that unassigning an editor will not remove their review from the editable.
This list of editables can also be used to quickly download materials from multiple editables using Download files. By selecting multiple contributions, you can download all of their files in one zip archive.
To simplify the assignment process, you can use the filtering options in the top menu. It is possible to filter by the assigned editor, contribution keywords, program code and the status of the editable. Searching by a string or an ID is supported as well.
The possible statuses of an editable are:
- Not submitted
- Read for review
- Needs submitter changes
- Needs submitter confirmation
When no editable has been submitted yet, the status is Not submitted. After submission, an editable becomes Ready for review. At this point, an editor can be assigned and the reviewing process starts. If an editable is accepted or rejected, the Editing process is finished. Accepted editables are automatically published in the contribution. The exact files which are published depend on whether the file type was set as publishable in the file type settings.
If an editor judges a paper as Needs submitter changes, the author will be able to submit a new version for further review. An editor can also submit a new version themselves - the status becomes Needs submitter approval as the original author must approve the new version. Once approved, the editable is automatically accepted. If the author rejects the changes, they will be able to submit a new version themselves instead.
Normally, only editing managers can assign papers to editors, however there is an option to allow editors to self-assign papers. The option can be found on the management page for the given editable type in the Editor assignment section - Allow editors to self-assign editables.
The Editing module establishes new roles that Indico users may have. Here, we provide a list of what permissions are required in order to perform the most common actions related to the Editing module.
|Submit a an editable||Abstract or contribution submitters|
|Access the editable list||Editors, editing managers and event managers|
|Judge/review an editable||Editors, editing managers and event managers (must be assigned)|
|Assign editables and manage settings||Editing managers and event managers|
Editing as an author
Authors can submit materials (papers, slides and posters) from the contribution page by selecting the editable type and uploading the relevant files. To submit an editable, first click on My contributions in the sidebar under My conference.
Here, click on the contribution for which you want to submit material and scroll down to the Editing section. If the section is not visible, then most likely submissions have not been opened yet. With the submissions open, you should have an option to submit:
If multiple editable types have been enabled, you must first select the type of material you wish to submit from the dropdown:
In the dialog window that opens, upload all the required files and confirm by clicking Submit. If multiple file types are allowed, the dialog will display one box for each. The required file extensions are written in the top left corner of each box under the name of the file type. If a file of a specific type is required, there will be a red asterisk icon in the top right corner of the box.
Once submitted, you can track progress of your submission from the contribution page by clicking on Go to timeline.
The timeline is where you will find all updates regarding your submission in chronological order. As an author, you can add comments to your submission and upload additional files.
If you see a warning about unmet reviewing conditions, it means that, depending on the files you have already submitted, extra files may be required as defined by the conference organizers, and you might be asked to provide them.
At this point, an editor will be assigned to your submission. They can either comment on the submission or leave a review. A review comes with a proposed action. An editor might either accept or reject your submission. They can also ask for corrections, in which case the author should upload a new, corrected version. Lastly, an editor can also submit a corrected version themselves. The author can then either accept the new version, which will automatically mark the submission as accepted, or reject it. If the editor's version is rejected, the author can submit a new version themselves.
If the Peer Reviewing module is enabled
If the Peer Reviewing module is enabled, you can also submit a paper from the peer reviewing timeline once the paper has been accepted in the Peer Reviewing module. To submit the paper in the Editing module, click on Submit for editing and select the files you want to submit.
Editing as an editor
Editors can find all papers to review in the Editing section of the conference. You will see different subsections (Papers, Slides, Posters) depending on whether you are a member of an editing team for that particular editable type.
Clicking on one of the links will take you to the list of editables for the chosen type:
You can always see which editable type you are working with based on the title in the top left of the page. It will say either Paper Editing, Slides Editing or Poster Editing.
The left sidebar contains links to other related modules - Peer Reviewing and Call for Abstracts, provided they have been enabled for the conference. Clicking on Display will take you back to the conference page.
On the right, you will see a list of all contributions. Contributions that already have an editable submitted will be active. Clicking on the contribution name will bring you to the editable timeline. As an editor, you can leave comments on any editable, but you can only review editables that have been assigned to you by the editing managers. Each editable only has one editor assigned to it. The editor is listed in the EDITOR column of the editable list. Each editable also has a status (column STATUS) indicating the state of the editable. Contributions without an editable have the status Not submitted while contributions with an editable submitted are Ready for review.
To quickly find out which editables are assigned to you, you can use the filter functionality. Click on Filter in the top right, click on Editor and select your name from the list. Instead of filtering, you can also search contributions by name or by an ID as well.
Once you have a found an editable assigned to you, click on the name to open the editable timeline:
In the timeline, you can download the uploaded files by clicking on Download zip. It is also possible to download the files individually by clicking on the file names. Once the editor has reviewed the files, they can judge the editable. There are four actions an editor can propose:
- Accept - The editable is accepted as-is, no further changes are possible unless the review is reset by the editor. The status of the editable is Accepted.
- Reject - The editable is rejected. No further changes possible unless reset. The status of the editable is Rejected.
- Request changes - The author will have an option to submit a corrected version, which will need to be reviewed. The status of the editable is Needs submitter changes.
- Make changes - An editor can upload a corrected version themselves. The changes must then be approved by the original author. The status of the editable is Needs submitter confirmation.
It is always possible to reset a judgment by clicking on the revert icon:
If an editing manager has enabled the option to self-assign editables, there will be a button above the list of editables saying either Get next paper, Get next slides or Get next poster depending on which editable type you are currently viewing. Clicking on the button brings up a dialog window with the list of editables. You can use this list to search and assign editables to yourself.
It is also possible to assign and unassign yourself from an editable in the editable timeline by clicking either Assign myself or Unassign: