diff --git a/content/support/accounts-and-roles/account-management.md b/content/support/accounts-and-roles/account-management.md index c0dbfef8..0e42f170 100644 --- a/content/support/accounts-and-roles/account-management.md +++ b/content/support/accounts-and-roles/account-management.md @@ -1,58 +1,68 @@ title: Managing user accounts # Managing user accounts -The **Users and Roles** section of the manager has various controls for -different permission levels. +The **Users and roles** section of the Manager dashboard has various controls for managing users and permissions. Who can manage what will depend on their role and permissions associated with it. -Editors have control of: -- User accounts at the journal level. -- Account roles in the journal. -- Account activation. +**Editors** and **Journal managers** can: -Staff have additional controls for: -- Viewing all accounts for the Janeway installation, including their journal roles and activation status. -- Merging user accounts. -Both of these are only available at the press level. +- Manage user accounts at the journal level. +- Assign and remove roles for users on the journal. +- View and update account activation status. + +**Staff** have additional controls for: + +- Viewing all accounts for the press (Janeway installation), including their journal roles and activation status. +- Merging duplicate user accounts. + +These additional controls are only available at the press level. ## Journal users -If you are an editor or staff member, you can manage user accounts for a -journal via the **Journal Users** page. +If you are an editor, journal manager or staff member, you can manage user accounts for a journal via the **Journal users** page. + +![The Journal Users page.](../images/journal-users.png) -![The Journal Users page.](../images/journal_users.png) +From this page you can: -You can search by various fields, including name, email, ORCID, -institution, and biography. You can filter by role and whether an account -is active. +- Search by name, email address, ORCID, institution, or biography. +- Filter users by role and account activation status. +- Add or remove journal roles. +- Edit user account details. +- Create new user accounts where required. -You can also add and remove roles, edit accounts, and, if needed create -accounts. +Each user's assignment history (for example, editorial or review activity) is also available from this view. -Each user's assignment history is also available from this view. +This page cannot be used to delete accounts, only deactivate them. Accounts can only be deleting using through the **Admin area** . +Click **Edit** next to a user to open the **Edit user** interface, where you can update a user’s account details. -TBC -- information about how editing an account won't affect metadata on articles that have already been accepted: to do that you'll need to edit the frozen author record on the article metadata page. +Some changes are restricted by permission level. For more information, see the **Permissions** page. -## Merge users (Press manager only) +>[!IMPORTANT] +> Editing a user account does **not** change author metadata on articles that have already been accepted. +> To update author details on an accepted article, you must edit the *frozen author record* on the article’s metadata page. -The press manager interface enables staff members to merge two accounts to eliminate duplicates. All associated objects, such as tasks, articles, roles, and files, will be moved from the source account to the destination account. The account profile remains unchanged, meaning any profile information in the source account will be lost. +## Merge users (staff only) +When users have multiple accounts (often due to different email addresses having been used), it may be helpful to merge accounts. Users with staff permission can merge two user accounts to remove duplicates, using the **Press manager interface**. When searching for users to merge, note that the user account in the left column (source account) will be merged into the user account in the right column (destination account). -![A press manager is merging Andy Byers' account into Katheryn Janeway's account.](../images/merge-users.gif) +>[!WARNING] +>An account merge **cannot** be undone. Only merge account when you are certain they can be merged. -> [!WARNING] -> When searching for users to merge, note that the user account in the left column will be merged into the user account in the right column. +When accounts are merged: +- All associated items (including articles, tasks, roles and files) are transferred from the source account to the destination account. +- The destination account profile is retained. +- Any profile information from the source account is permanently lost. + \ No newline at end of file diff --git a/content/support/accounts-and-roles/accounts-and-roles-index-placeholder.md b/content/support/accounts-and-roles/accounts-and-roles-index-placeholder.md index 013bcdd5..ec89eab2 100644 --- a/content/support/accounts-and-roles/accounts-and-roles-index-placeholder.md +++ b/content/support/accounts-and-roles/accounts-and-roles-index-placeholder.md @@ -1,2 +1,24 @@ -title: Accounts and Roles -# Accounts and Roles +title: Accounts and roles +# Accounts and roles + +This section explains how user accounts and permissions work in Janeway, including how roles are assigned and managed. Read the following pages for more information: + + + +- Managing user accounts +- Roles and permissions +- Activating accounts +- ORCID login +- Single sign-on (SSO) + +## New accounts + +Account creation VS self-registration + +## Single sign-on (SSO) login + +Janeway supports single sign-on (SSO), allowing users to log in using their institutional credentials without creating a separate Janeway account. + +SSO must be configured by your system administrator. If you are interested in enabling SSO for your journal or press, contact your system administrator for further information. + + \ No newline at end of file diff --git a/content/support/accounts-and-roles/activating-accounts-placeholder.md b/content/support/accounts-and-roles/activating-accounts-placeholder.md deleted file mode 100644 index fb7c7537..00000000 --- a/content/support/accounts-and-roles/activating-accounts-placeholder.md +++ /dev/null @@ -1,16 +0,0 @@ -title: Activating accounts -# Activating accounts - -**WIP** -This section will explain how to find out if an account has been activated and, if not, how to activate it. -Inactive accounts are a common cause of login issues. - -## Inactive users -The inactive users page is accessible to staff only and lists all users who have not yet activated their accounts. You are cautioned only to activate accounts for which you've confirmed ownership with the user. - -- Users who have not yet activated their account cannot log in to Janeway. - -## Authenticated users -It presents a list of users who are currently logged into your Janeway installation. This page is only accessible to users with 'Staff' permission. - - diff --git a/content/support/accounts-and-roles/activating-accounts.md b/content/support/accounts-and-roles/activating-accounts.md new file mode 100644 index 00000000..e83cc5ab --- /dev/null +++ b/content/support/accounts-and-roles/activating-accounts.md @@ -0,0 +1,52 @@ +title: Activating accounts +# Activating accounts + +This page explains how to check whether a user account has been activated and how to activate inactive accounts. As users must activate their account before they can log in to Janeway, inactive accounts are a common cause of login issues. + +## Inactive users +There are two places from which to check and manage the activation status of accounts: + +- **Journal users** +- **Inactive users**. + +Both are found under **Users & roles** on the Manager dashboard. The **Journal users** page is available to editors and journal managers, where as the **Inactive users** page is accessible to staff only. + +To view inactive users: + +1. Open **Journal users**. +2. Use the filter on the left-hand side. +3. Set **Status** to **Inactive**. +4. Click **Apply**. + +This will list all inactive users on the journal. You can also search by name or email address. + +The **Inactive users** page lists all inactive users across the press who have not yet activated their accounts. + +## Activating accounts +Once you have identified an inactive account through either **Journal users** or **Inactive users**: +1. Click **Edit** next to the user to open the account page. +2. Under **Is active**, select **Yes**. +3. Save your changes. + +![Account activation toggle.](../images/activate-account.png) + +The user will now be able to login into the journal. + +### Troubleshooting + +-Resending activation emails + Only from admin? + +Account activation should not trigger an email (check). + +Users usually activate through a link sent to them. + +/Does ORCID require activation? +/Do author accounts automatically activate upon submission? +/Do reviewer accounts with one-click review? -> check Mauro's suggested solution for the issue encountered. +/Why can accounts be inactive? -> NEarly always because not activated. Rarely manually deactivated. + +## Authenticated users +The **Authenticated users** page shows a list of users currently logged in to your Janeway installation. + +This page is only accessible to users with staff permission. \ No newline at end of file diff --git a/content/support/accounts-and-roles/janeway-roles-and-permissions.md b/content/support/accounts-and-roles/janeway-roles-and-permissions.md index 9ca2295e..60ce9546 100644 --- a/content/support/accounts-and-roles/janeway-roles-and-permissions.md +++ b/content/support/accounts-and-roles/janeway-roles-and-permissions.md @@ -1,18 +1,26 @@ -title: Roles and Permissions on Janeway -# Roles and Permissions on Janeway +title: Roles and permissions on Janeway +# Roles and permissions on Janeway -**WIP** -Needs some further work, checks and dev input on a few bits. Need to check out the granular permissions still. +This page explains the different roles available in Janeway and how permissions are managed. -## Janeway roles -- Author - - When someone registers with the journal or submits an article, they are given this role. + + +## Janeway roles + +Janeway has a variety of roles available that can be assigned to users, some of which will affect the permissions of the user. Roles do not exclude each other, e.g. having one role will not prevent you another one. + +- Author + Assigned automatically when a user registers with a journal or submits an article. This can be considered the 'base role'. - Reviewer -- Editor - - Handles processing of articles and assignment of tasks -- Journal Manager - - Has a similar level of permission to the editor role but can be given extra access (see below) -- Section Editor +- Editor + Editors handle processing of articles and assignment of tasks. An editor has access to the journal workflow, manager dashboard and journal settings, certain plugins and is able to do general journal management. + An editor does not have access to the admin area, press level settings and certain plugins. +- Journal manager + Journal managers have a similar level of permission to the editor role, but can be given additional access (see below). +- Section editor + Section editors have access only to the workflow elements of articles assigned to them. They cannot access any articles not assigned to them, journal settings or plugins. This role is well-suited for (guest) editors who only need to handle specific articles within the journal. - Copyeditor - Typesetter - Proofreader @@ -20,58 +28,66 @@ Needs some further work, checks and dev input on a few bits. Need to check out t - This is not a role as such, but it is used to indicate whether a user is signed up for article publication notifications. For more information, see Email notifications > [!NOTE] -> Whilst the Production Manager and Proofing Manager are still assignable in Janeway, they have been deprecated in 1.4 and are no longer in use. +> Whilst the Production manager and Proofing manager are still assignable in Janeway, they have been deprecated in 1.4 and are no longer in use. ## Permissions -In addition to the roles and their respective permissions, separate permission levels can be assigned. Editors also have specific permissions associated with their roles. - -### Editor permission +In addition to the roles and their respective permissions, separate permission levels can be assigned for certain settings for journal managers and editors. Editors also have specific permissions associated with their roles. -Editors have permissions that allow: +### Editor permission -- Managing roles within their journal. -- Viewing and editing the account activation status of journal users. -- Editing basic account information on behalf of journal users. -- Viewing a user's history (review/editorial/proofing etc. assignments). +Editors can: +- Manage roles within their journal. +- View and edit account activation status for journal users. +- Edit basic account information on behalf of users. +- View a user’s assignment history (editorial, review, proofing, etc.). - The user history page also displays emails sent directly to the user - excluding 'automated' emails such as reminders, notifications and invitations. ### Staff permission -The ‘Staff’ permission should only be given to Journal Managers/Publishers and can only be assigned by other users with the Admin and/or Superuser permission. Staff have additional controls for: +Staff permission should only be assigned to press-level users (for example, publishers or system administrators). It can only be granted by another user with staff permission. -- The same controls as editors, but for all the journals belonging to the press. -- Merging duplicate user accounts (available at the press level). +Staff users can: +- Perform all editor-level actions across all journals in the press. +- Merge duplicate user accounts at press level. +- Use all installed plugins. +- View additional manager pages (for example: inactive users, authenticated users). +- View the **All articles** page. +- Access the **Admin area**. ### Superusers permission -- ‘Superuser’ will assign a user all roles across the system. +‘Superuser’ will assign a user all roles across the system. -### Admin permission -- ‘Admin’ grants access to Janeway's admin data layer. - -## Granular Manager Permissions - -In version 1.5, we introduced more granular manager permissions. Initially, these roles were centred around journal manager and editor roles. We are introducing a new setting group, "Permission", and within this group, we will be adding new permission controllers starting with: +## Granular manager permissions + +Janeway allows more granular permissions for journal managers and editors, using the **Permissions** setting group. This can be used on the configuration of licences and sections as following: - Licenses - - Controls whether users can access the licenses control pages based on their roles, defaulting to Editor and Journal Manager. + Permissions control whether users can access the licenses control pages based on their roles, defaulting to Editor and Journal Manager. - Sections - - Controls whether a user can access the sections control pages based on their roles, defaults to Editor and Journal Manager. + Permissions control whether a user can access the sections control pages based on their roles, defaults to Editor and Journal Manager. + +### Editing granular permissions (staff only - advanced) -Currently, there is no interface for updating the roles that can access these pages and the setting is JSON stored in the database. +>[!NOTE] +>The following sections contain information on configuring granular permissions. This requires more advanced technical knowledge, though you are unlikely to need this (often). + +There is no interface for updating the roles that can access these pages and the setting is JSON stored in the database. If you are not comfortable or able editing this, contact your system administrator. > [!WARNING] -> You should only edit the Permission settings if you are sure about the change you are making. +> Only modify granular permissions if you are confident in the change you are making. By default, both settings read `["editor", "journal-manager"]`. If, for example, you wanted to stop editors from editing licenses, you could change it to read `["journal-manager"]`. Once saved, only users with the journal manager role will be able to access the licenses pages. -### Granular settings permissions +### Granular settings permissions (staff only - advanced) -In version 1.5, we introduced permissions for granular settings. Staff can now determine which roles can edit any given setting object. This is done via the Django Admin panel (Core \> Settings), using the `editable_by` field. Staff can alter the roles that are allowed to see and edit a setting. +Users with staff permission can control which roles can view and edit individual settings via the **Admin area** (Core \> Settings), using the `editable_by` field. -> [!NOTE] -> If a setting is also displayed on a settings group page (for example, the General or Submission settings page) and a user does not have the appropriate permission to edit that setting, it will be filtered out of the form and not be visible. +If a setting is displayed on a settings group page (for example, the **General** or **Submission settings** page) and a user does not have the appropriate permission to edit that setting, it will be hidden from the form. As with the manager permissions changes, the default to settings permission maintains the status quo, and by default, all settings are editable by editors and journal managers. +By default, setting permissions are only editable by editors and journals. When upgrading to a Janeway version with the granular permissions, no changes will be made to the default. + +If you wish to make these changes and are not confident using the Admin interface, contact your system administrator. \ No newline at end of file diff --git a/content/support/accounts-and-roles/orcid-login-placeholder.md b/content/support/accounts-and-roles/orcid-login-placeholder.md index f35ab653..7474ebca 100644 --- a/content/support/accounts-and-roles/orcid-login-placeholder.md +++ b/content/support/accounts-and-roles/orcid-login-placeholder.md @@ -1,22 +1,24 @@ title: ORCID login # ORCID login -**WIP** +*Coming soon* Janeway supports ORCID login. - How to register - How to login - + + +*If you don't have ORCID, you will need one. missing hyperlink Start with: ### Linking ORCID to an existing account - -## Technical information +--> +## Technical information ### Enable ORCID login To enable ORIC login, you need to add the following to your settings file: diff --git a/content/support/analytics/google-analytics-placeholder.md b/content/support/analytics/google-analytics-placeholder.md index 2d6f6644..83aec3f7 100644 --- a/content/support/analytics/google-analytics-placeholder.md +++ b/content/support/analytics/google-analytics-placeholder.md @@ -1,18 +1,17 @@ title: Google analytics # Google analytics - -**WIP** + *Coming soon* +Allows you to measure activity on your web pages. - About Google analytics -- If no Google analytics, where to get. Link to GA page. -- GA 3 vs 4 +- Link to GA page - If issues, send email to support. Found through either general settings -> scroll down -![" "](../../support/images/general-settings-google.png) +!["Google analytics settings"](../../support/images/general-settings-google.png) Or through all settings: -![" "](../../support/images/all-settings-google.png) +!["Google analytics settings shown on the All settings page"](../../support/images/all-settings-google.png) diff --git a/content/support/analytics/janeway-statistics-and-index-placeholder.md b/content/support/analytics/janeway-statistics-and-index-placeholder.md index db06f810..44d000e3 100644 --- a/content/support/analytics/janeway-statistics-and-index-placeholder.md +++ b/content/support/analytics/janeway-statistics-and-index-placeholder.md @@ -1,22 +1,36 @@ title: Janeway analytics # Janeway analytics +*Coming soon* + + diff --git a/content/support/reporting.md b/content/support/analytics/reporting.md similarity index 97% rename from content/support/reporting.md rename to content/support/analytics/reporting.md index 2cff0321..93d14a37 100644 --- a/content/support/reporting.md +++ b/content/support/analytics/reporting.md @@ -1,86 +1,86 @@ -Title: Reporting - -## Reporting plugin - -The reporting plugin produces a range of reports for analytics within the Janeway publishing platform. These reports include: - -- Press report -- Journal usage by month -- Article metrics -- Geographical spread -- Peer review report -- Article citations -- Article authors -- Journal citations -- Book citations -- Crossref DOI URLs -- License report -- Workflow report -- Experimental reports - -## Press Report -This report summarises the overall performance of the press, including analytics around the number of publications and usage data across journals. - -This report uses the dates specified in the filter when retrieving data. - -> [!TIP] -> If you wish to review statistics over a year, we recommend setting the end date not on 31/12 but on 01/01 of the year following. - -The first three columns (Submissions, Published Submissions and Rejected Submissions) use the submission date as their data point. - -## Journal usage by month -This report shows usages (views and downloads) grouped by month per journal. - -## Article metrics -This report provides view and download metrics grouped by article for a given journal. You select the journal on the reporting plugin page. - -## Geographical spread -This report provides views and downloads grouped by country. -The data provided in this report is approximate and not suited for in-depth analytics. - -The numbers may not perfectly add up to numbers found in other reports. This is due to the fact that not all visits will have country data available (users may hide this data when visiting websites). - -## Peer review report -This report shows reviews and their time to completion. It also displays submissions, accepted submissions, rejected submissions and completed review assignment in the period specified in the filter. The date on which a review was requested will determine inclusion in the table. - -## Article citations -This report shows article citations. It can either show citations per year or of all time. -For a citation to be countable, the citing article needs to have a DOI deposited with Crossref. - -> [!TIP] -> We recommend also depositing citations and producing XML to improve article citation accuracy. - -## Article authors -This report lists articles by author published in the period specified in the filter. It displays their name, email and affiliation, as well as the article ID and title, and the date published. - -> [!NOTE] -> Author records are frozen upon article submission. This information is not updated over time. - -## Journal citations -Similar to the article citations report, this report shows journal citation totals, based on Crossref data. You will also be able to see the citing journal for each article citation by clicking through using the links in the right column. - -## Book citations -This report shows total book citations using Crossref data. - -## Crossref DOI URLs -This report can be used to generate TSV files that can be shared with Crossref to perform bulk updates. You can either use it to update URLs linked to DOIs stored in Janeway or to update full-text URLs for updating Crossref Similarity Check. - -## License report -This report shows the number of article using specific licenses in the period specified in the date filter. The date filter for this report uses the date an article was published. - -## Workflow report -This report provides average times for: -- Submission to acceptance -- Acceptance to publication -- Submission to publication - -Data is presented in a series of averages followed by a table of data. The date filter uses the date an article was published to determine inclusion into the report. - - - - - - - - - +Title: Reporting + +## Reporting plugin + +The reporting plugin produces a range of reports for analytics within the Janeway publishing platform. These reports include: + +- Press report +- Journal usage by month +- Article metrics +- Geographical spread +- Peer review report +- Article citations +- Article authors +- Journal citations +- Book citations +- Crossref DOI URLs +- License report +- Workflow report +- Experimental reports + +## Press Report +This report summarises the overall performance of the press, including analytics around the number of publications and usage data across journals. + +This report uses the dates specified in the filter when retrieving data. + +> [!TIP] +> If you wish to review statistics over a year, we recommend setting the end date not on 31/12 but on 01/01 of the year following. + +The first three columns (Submissions, Published Submissions and Rejected Submissions) use the submission date as their data point. + +## Journal usage by month +This report shows usages (views and downloads) grouped by month per journal. + +## Article metrics +This report provides view and download metrics grouped by article for a given journal. You select the journal on the reporting plugin page. + +## Geographical spread +This report provides views and downloads grouped by country. +The data provided in this report is approximate and not suited for in-depth analytics. + +The numbers may not perfectly add up to numbers found in other reports. This is due to the fact that not all visits will have country data available (users may hide this data when visiting websites). + +## Peer review report +This report shows reviews and their time to completion. It also displays submissions, accepted submissions, rejected submissions and completed review assignment in the period specified in the filter. The date on which a review was requested will determine inclusion in the table. + +## Article citations +This report shows article citations. It can either show citations per year or of all time. +For a citation to be countable, the citing article needs to have a DOI deposited with Crossref. + +> [!TIP] +> We recommend also depositing citations and producing XML to improve article citation accuracy. + +## Article authors +This report lists articles by author published in the period specified in the filter. It displays their name, email and affiliation, as well as the article ID and title, and the date published. + +> [!NOTE] +> Author records are frozen upon article submission. This information is not updated over time. + +## Journal citations +Similar to the article citations report, this report shows journal citation totals, based on Crossref data. You will also be able to see the citing journal for each article citation by clicking through using the links in the right column. + +## Book citations +This report shows total book citations using Crossref data. + +## Crossref DOI URLs +This report can be used to generate TSV files that can be shared with Crossref to perform bulk updates. You can either use it to update URLs linked to DOIs stored in Janeway or to update full-text URLs for updating Crossref Similarity Check. + +## License report +This report shows the number of article using specific licenses in the period specified in the date filter. The date filter for this report uses the date an article was published. + +## Workflow report +This report provides average times for: +- Submission to acceptance +- Acceptance to publication +- Submission to publication + +Data is presented in a series of averages followed by a table of data. The date filter uses the date an article was published to determine inclusion into the report. + + + + + + + + + diff --git a/content/support/article-management/article-galleys-placeholder.md b/content/support/article-management/article-galleys-placeholder.md index b8d7b3d2..60a88608 100644 --- a/content/support/article-management/article-galleys-placeholder.md +++ b/content/support/article-management/article-galleys-placeholder.md @@ -1,9 +1,9 @@ title: Article galleys # Article galleys -**WIP** +*More updates coming soon* - this needs more info as galleys-related problems are more common than I'd like + - What is a galley - PDF / HTML / XML @@ -13,9 +13,6 @@ title: Article galleys - Preview galleys - What you wont see on a galley preview - /////// - - Like the Production page, the article archive allows you to upload new and replace old Galley files. @@ -24,7 +21,7 @@ Like the Production page, the article archive allows you to upload new and repla > Editing a galley will change how it is displayed. If making changes to a published piece, it is recommended to add a Publisher Note alongside it. > [!TIP] -> The Edit Galleys link will take you to the Production page. +> The **Edit galleys** link will take you to the Production page. diff --git a/content/support/article-management/article-images-placeholder.md b/content/support/article-management/article-images-placeholder.md index 4879bbcb..141dc031 100644 --- a/content/support/article-management/article-images-placeholder.md +++ b/content/support/article-management/article-images-placeholder.md @@ -25,6 +25,4 @@ Articles have three images that are used for display: ## Article images manager The article images manager is an interface for editing all of the images for a given article. -See also: image guidelines - - +See also: image guidelines \ No newline at end of file diff --git a/content/support/article-management/article-metadata-placeholder.md b/content/support/article-management/article-metadata-placeholder.md index f852fb32..ecabd56f 100644 --- a/content/support/article-management/article-metadata-placeholder.md +++ b/content/support/article-management/article-metadata-placeholder.md @@ -1,42 +1,49 @@ title: Article metadata # Article metadata -**WIP** +*Coming soon* + -> Joe, this page could do with your input. +Article metadata can be edited through either the **Archive** page or through **Edit metadata**. Both can be found under **Logs, documents and more** in the blue workflow bar. --How to find article metadata. -Published VS in-progress +![" "](../images/logs-edit-metadata.png) -The first block of the page lists most of the article's metadata. To change it you can click **Edit** button. +The first block of the **Article archive** page lists most of the article's metadata. To change it you can click **Edit** button. - +![Top of the article archive page](../images/article-archive-edit-metadata.png) -Additionally, you can make changes to the author records and re-order them as required. +This will take you to the following page, where you can edit the article's metadata: + +!["Edit metadata page, displaying the title and abstract."](../images/edit-metadata.png) + +Make sure you scroll down and click **Update metadata** to save any changes. + +![" "](../images/update-metadata.png) + +On this page, after the block for the article metadata, you can also edit the author metadata and funder information. ## Metadata fields +*Coming soon* + ## Identifiers -Any identifiers such as DOIs are listed here and a link to manage them is in the top right of the block. +Janeway can mint CrossRef and DataCite DOIs and if working with data imported from other platforms can also maintain existing publisher IDs, such as an OJS ID. -- Identifiers Janeway can handle +Identifiers associated with an article can be found through **Identifiers** under **Logs, documents and more**. Though DataCite DOIs will not show up here and need to be managed through the DataCite plugin. - +!["The identifiers page. It displays a list of identifiers associated with the journal, including a DOI, OJS id and DOAJ is. There are columns for each showing whether they are registered, and for DOI showing options to register, poll, desposit and view the response XML. There are also delete buttons for all identifiers."](../images/article-identifiers.png) > [!TIP] -> You can also manage DOIs at the journal level as an editor (and at the press level as a staff user) using the DOI Manager. - -## Publication Information - -The article archive page has a link to the Pre-Publication page where you can make changes to any details there. +> You can also manage CrossRef DOIs at the journal level as an editor (and at the press level as a staff user) using the DOI Manager. ## Google Scholar - - Google Scholar indexing is automatic; they use a webcrawler that looks for relevant materials (articles, monographs, preprints, reports, etc). It takes some time for new journals to appear on Google Scholar and for changes to existing content to show. [Google Scholar advises](https://scholar.google.com/intl/en/scholar/inclusion.html#troubleshooting) it may take 6-9 months for changes to appear. - - If your journal is not properly indexed: - - Contact support, we work with them to make sure all journals are captured - - Metadata issues +Google Scholar indexing is automatic; they use a webcrawler that looks for relevant materials (articles, monographs, preprints, reports, etc). It takes some time for new journals to appear on Google Scholar and for changes to existing content to show. [Google Scholar advises](https://scholar.google.com/intl/en/scholar/inclusion.html#troubleshooting) it may take 6-9 months for changes to appear. + +If your journal is not properly indexed, contact support, we work with Google Scholar to make sure all journals are captured + \ No newline at end of file diff --git a/content/support/article-management/article-sections.md b/content/support/article-management/article-sections.md index 452b7b12..fe29fb16 100644 --- a/content/support/article-management/article-sections.md +++ b/content/support/article-management/article-sections.md @@ -1,12 +1,14 @@ title: Article sections # Article sections -Sections are ways of grouping articles by their content type, e.g. "Research Articles" or "Reviews". +Sections are ways of grouping articles by their content type, e.g. "Research articles" or "Reviews". + +*More coming soon* - Where to find sections - Image of how to find. -## An appropriate H2 header I am yet to write +## Managing sections From this interface, you can edit the sections available on your journal. @@ -18,28 +20,28 @@ For each section, you can supply: - Plural name - Number of reviewers - - The number of reviewers generally required for this article type, may be 0 for editorials, etc. + The number of reviewers generally required for this article type, may be 0 for editorials, etc. - Is filterable - - Whether this section should appear in the All Articles list filter options. + Whether this section should appear in the All Articles list filter options. - Sequence - - Order sections should appear in, can be changed using this field or by dragging and dropping. + Order sections should appear in, can be changed using this field or by dragging and dropping. - Section editors - - The section editors that can be assigned to handle articles within this section. + The section editors that can be assigned to handle articles within this section. - Editors - - Editors for this section will be notified when new papers are submitted to it. + Editors for this section will be notified when new papers are submitted to it. - Public submissions - - Checked if you want new submissions to be able to select this section. + Checked if you want new submissions to be able to select this section. - Indexing - - Whether this section is put forward for indexing. + Whether this section is put forward for indexing. - Auto-assign editors - - Articles submitted to this section will be automatically assigned to any editors and/or section editors selected on the 'Editors' and/or 'Section Editors' box above. + Articles submitted to this section will be automatically assigned to any editors and/or section editors selected on the 'Editors' and/or 'Section Editors' box above. You can edit sections, but you cannot delete a section when it would orphan an article. If you wish to remove a section, first migrate all of the articles using that section to a different section, then the delete button will become available. diff --git a/content/support/article-management/articles-management-placeholder.md b/content/support/article-management/articles-management-placeholder.md index 9b054a6a..89420891 100644 --- a/content/support/article-management/articles-management-placeholder.md +++ b/content/support/article-management/articles-management-placeholder.md @@ -1,12 +1,14 @@ title: Articles # Articles +*To be edited* + Once an article is published, you may need to change it, e.g., upload a new galley or tweak the metadata if there is an error. All published articles can be found on the Articles page under Back Content. The Article back content page lists both published and rejected papers. You can search and then select an article to edit. > [!TIP] -> You can also edit papers by going to their page and using the account drop-down to select **Edit Article**. +> You can also edit papers by going to their page and using the account drop-down to select **Edit article**. diff --git a/content/support/contributing-guide.md b/content/support/contributing-guide.md index b1c36d41..52b1ad8c 100644 --- a/content/support/contributing-guide.md +++ b/content/support/contributing-guide.md @@ -108,4 +108,4 @@ This will be displayed as: This is known as “escaping.” See the [Jinja documentation](https://jinja.palletsprojects.com/en/3.0.x/templates/#escaping) -for more details. +for more details. \ No newline at end of file diff --git a/content/support/email-and-reminders/email-index-placeholder.md b/content/support/email-and-reminders/email-index-placeholder.md index 5ed2a1ea..954e763d 100644 --- a/content/support/email-and-reminders/email-index-placeholder.md +++ b/content/support/email-and-reminders/email-index-placeholder.md @@ -1,2 +1,41 @@ title: Emails and reminders on Janeway # Emails and reminders on Janeway + +Janeway uses email to support many key editorial and publishing workflows; including reviewer invitations, decision notifications, revision requests, publication alerts, and automated reminders. + +This section explains: +- How to check what emails were sent and when. +- How to customise email content through templates and how to work with email template variables. +- How to set up automated reminders. +- How to set up publication notifications. + + + +## How email works in Janeway (at a glance) + +- Emails are sent automatically or manually as part of article workflows. +- All outgoing emails related to an article are logged. +- Depending on your email service, delivery status information is available through the email log as well. +- Some emails (such as reminders and notifications) are sent automatically based on dates or events. +- Email content can be customised per journal using templates. + +>[!NOTE] +> Due to GDPR restrictions, Janeway does not offer any options for email campaigns. + +## Common questions + +- *“A reviewer says they didn’t get the email — what should I do?”* + Start with Email logs to confirm whether the email was sent and, if necessary, resend it. + +- *“I want to change the wording of reminder emails.”* + Edit the relevant template under Email templates. Use information in Email template variables to insert information safely. + +- *“Why didn’t a reminder email send?”* + Check Scheduling reminders and confirm that due dates were set correctly. If reminders still do not send, contact your system administrator. + +- *“Can readers (un)subscribe to/from publication notifications?”* + Yes. Readers manage their notification preferences via their profile page. See Publication notifications for more information. + + + +If something is unclear or you are unsure whether a change is safe to make, contact your system administrator. \ No newline at end of file diff --git a/content/support/email-and-reminders/email-logs-placeholder.md b/content/support/email-and-reminders/email-logs-placeholder.md index 3a5398b3..9f0bda04 100644 --- a/content/support/email-and-reminders/email-logs-placeholder.md +++ b/content/support/email-and-reminders/email-logs-placeholder.md @@ -1,16 +1,78 @@ title: Email logs # Email logs -All outgoing emails sent through Janeway are tracked in the article log. +All outgoing emails sent through Janeway are tracked in the article log. This allows editors, journal managers and staff to confirm which emails have been sent, when they were sent, and (where supported) their delivery status. -You can view an article's log by accessing an article either through its workflow stage or through the archive (Dashboard -\> Left hand menu --\> Back Content -\> Articles) and using the Stages, Logs and More. -drop down select Log - +Email logs are commonly used when: +- A reviewer or author reports not receiving an email. +- You need to confirm that a decision or notification was sent. +- An email needs to be resent. + +## Accessing email logs + +You can view an article's logs through **Logs, docs and more**, which appears in the blue workflow progress at the top of the article screen. + +You can access this through: + + - The article's workflow stage, or + - The archive (Dashboard -\> Left hand menu +-\> Back Content -\> Articles). + +![Screenshot showing where to access Logs, docs and more](email-logs-access.png) + +## Understanding the log entries + +Each entry in the log records an action that has taken place on the article. The following information is shown: + +- Entry type + The type of action that was logged ("Review request accepted" or "Typesetting complete" for example). +- Date +- Actor + The user or system process that intiated the action. +- Level + + +If the logged action relates to an email, additional details are available: +- Addressees + The recipient(s) of the email, including any CC or BCC addresses. +- Subject +- Email status + Information about the delivery status of the email. See &&Interpreting email statuses** below for more information. +- There is an option to click through to see the email content. + +![Screenshot of an email log entry showing status and actions.](article-log.png) ## Interpreting statuses -- what do the statuses mean? +Emails sent through Janeway may display a delivery status, indicated with both text and coloured dots. + +>[!NOTE] +>If your installation does not use Mailgun, but another email service (for example, Googlemail), the coloured dots will not display meaningful status information. + +Janeway can only track events that occur within the system and the configured email service. It cannot track what happens after an email leaves that service (for example, if an email is blocked by the recipient’s local mail server). + +If you suspect persistent email delivery issues, contact your system administrator. + +### Email status meanings + +The following statuses can appear: + +- No information + No delivery information is available from the email service. +- Accepted + The email has been accepted by the email service for delivery. +- Delivered + The email has been delivered to the recipient’s mail server. +- Failed + The email could not be delivered. + +>[!NOTE] +> Seeing "No information" under email status does not necessarily mean an email was not sent. ## Actions -- what do the buttons do, explain. +From this page there are also two things you can do: +- Refresh the email status + This checks the latest delivery status for the email. This can be used to check the delivery status. This cannot detect issues on the recipient’s side (such as local spam filtering). + +- View email content + This displays the email message that was sent From this screen, you can also resend the email. \ No newline at end of file diff --git a/content/support/email-and-reminders/email-publication-notification-placeholder.md b/content/support/email-and-reminders/email-publication-notification-placeholder.md index 87e4e13f..deabea17 100644 --- a/content/support/email-and-reminders/email-publication-notification-placeholder.md +++ b/content/support/email-and-reminders/email-publication-notification-placeholder.md @@ -1,14 +1,47 @@ title: Publication notifications # Publication notifications -Janeway supports publication notifications via a new role called "reader". This feature can be toggled on or off for any given journal. Once the setting is toggled on, anyone with an account can sign up to receive emails when new articles are published via their profile page. This feature has been designed with continuous publication in mind but will also work well for those who publish full issues. +Janeway supports publication notifications through the **Reader** role. This feature allows users to receive email notifications when new articles are published in a journal. + +Publication notifications can be enabled or disabled on a per-journal basis. When enabled, any user with a Janeway account can opt in to receive notifications via their profile page. + +This feature is designed primarily for continuous publication workflows, but also works for journals that publish complete issues. -Journal staff can toggle the feature by visiting Manager \> Publication Notification (Readers) and using the link displayed on that page (see figure above). +## Enabling publication notifications + +Journal staff can enable or disable publication notifications from the Manager dashboard (Manager \> Publication notification (readers)). On this page, use the toggle or link displayed on that page to enable or disable the feature for the journal. -Readers can sign up for notifications by logging into a journal and selecting the Edit Profile link from the account menu (top right hand of any page). +Once enabled, users will be able to subscribe to notifications from their profile. + +## Subscribing to notifications + +Users can sign up for publication notifications by: +1. Logging in to the journal. +2. Opening the account menu in the top-right corner of the screen. +3. Selecting **Edit profile**. +4. Enabling publication notifications (Reader role). + +![Screenshot showing the option to subscribe to publication notifications on the user profile page](../images/publication-notifications-profile.png) + +The **Reader** role is not a workflow role and does not grant access to editorial or journal management features. It is used only to manage publication notification preferences. + +For more information about roles, see **Roles and permissions**. + + + +## How notification emails are sent + +Publication notifications are sent as a daily email digest: +- All articles published on a given day are included in a single email. +- If no articles are published on a particular day, no notification is sent. +- Emails are sent using BCC, so recipients do not see other subscribers’ email addresses. -Emails are sent in a digest format (all published articles are sent in one email) once per day. On days when no articles are published no notifications are sent. Emails are sent using BCC so only a single email is sent. + \ No newline at end of file diff --git a/content/support/email-and-reminders/email-reminders.md b/content/support/email-and-reminders/email-reminders.md index dbd2a992..88ca1c3f 100644 --- a/content/support/email-and-reminders/email-reminders.md +++ b/content/support/email-and-reminders/email-reminders.md @@ -1,47 +1,76 @@ title: Scheduling reminders # Scheduling reminders -Janeway lets you define your own email reminders for overdue Reviews and Revision assignments. They are defined using the following: +Janeway allows you to schedule automated email reminders for review** and revision assignments. These reminders help prompt reviewers and authors when deadlines are approaching or have passed. + +Reminders are configured at the journal level and are sent automatically based on the due dates set by editors. + +## Reminder types + +Janeway supports three types of reminder emails: + +- **Review (invited)** + Sent when a reviewer has been invited but has not yet accepted the review request. + +- **Review (accepted)** + Sent when a reviewer has accepted a review request but has not yet submitted their review. + +- **Revision** + Sent to authors who have an active revision request. + +Review reminders are sent based on the **review assignment due date** set by the editor. +Revision reminders are sent based on the **revision due date** set by the editor. + +For all reminder types, you can choose to send reminders **before or after** the due date. + +Multiple reminders can be created for the same task (for example, one before and one after the due date). + +## Configuring a reminder + +Each reminder is defined using the following settings: - Type - - Review (new), Review (accepted) or Revision reminder. + The reminder category: "Review (invited)", "Review (accepted)", or "Revision". -- Run Type - - Whether to run before or after the request is due. +- Run type + Whether the reminder should be sent before or after the assignment due date. - Days - - The number of days before or after the request is due this reminder should be sent. + The number of days before or after the due date that the reminder should be sent. -- Template Name - - The template name should be used when sending the reminder. If this template does not exist, you will be asked to create it. +- Template name + The email template used for the reminder. + If the selected template does not exist, you will be prompted to create it. -- Subject - - The email subject to send with the reminder. + -Janeway supports three types of reminder emails: +- Subject + The subject line of the reminder email. -- Review (Invited) - - Sent when a reviewer has been invited but not accepted a review request. -- Review (Accepted) - - Sent when a reviewer has accepted a review request but not yet completed it. -- Revision - - Sent to authors with active revision requests. +## Reminder email templates -Review reminders, both invited and accepted, are sent based on the review assignment due date set by the editor. Revision reminders are sent based on the revision request due date set by the editor. You can set reminders to be sent either before or after the set due date. +Reminder emails use standard email templates and have access to specific objects, depending on the reminder type: -A reminder email has access to three objects in the template: - Review_assignment or revision (depending on which type of reminder) -- Journal - - The journal sending the reminder. -- Article - - The appropriate article -On the edit template page, there is a guide that shows some of the variables you can use when generating these templates. +- Journal + The journal sending the reminder. + +- Article + The appropriate article. + +The **Edit template** page includes guidance and examples showing some of the variables available for use in reminder emails. -Once a reminder is created, a Cron job on the server will start processing requests, but it will not process these for Review and Revision requests that have passed the reminder dates. +## How reminders are sent -> [!TIP] -> If automated reminders are not being sent for your journal the most likely explanation is that the cron job has not been setup properly. You should contact your administrator, who can set up the call to the send_reminders management command. +Once a reminder has been created, it is processed automatically by a scheduled background task (sometimes called a 'cron job' ) on the server. + +This task checks for review and revision assignments that match the reminder criteria and sends emails when appropriate. +>[!IMPORTANT] +> Reminders will not be sent for review or revision requests where the reminder date has already passed at the time the task runs. + +> [!TIP] +> If automated reminders are not being sent, the most likely cause is that the scheduled background task (cron job) has not been set up correctly. You should contact your administrator, who can set up the call to the send_reminders management command. \ No newline at end of file diff --git a/content/support/email-and-reminders/email-template-variables.md b/content/support/email-and-reminders/email-template-variables.md index cc666b26..a940ba09 100644 --- a/content/support/email-and-reminders/email-template-variables.md +++ b/content/support/email-and-reminders/email-template-variables.md @@ -2,18 +2,67 @@ title: Email template variables # Email template variables -This section needs dev input. (Some stuff below looks like it needs backticks, but idk dawg) -Also needs a little more info on how to put this into use. Probably part on this page, part on other pages. +Email template variables allow Janeway to automatically insert information into emails, such as article titles, reviewer names or due dates. -## Templates +You do not need technical knowledge to use variables, but it is important to use them *exactly as shown*, unless you are confident about what they do. Changing or removing parts of a variable can cause emails to display incorrectly. If you are unsure, contact your system administrator or Janeway support. -### Review Assignment +This page explains: -Template Code: review_assignment +- What variables are. +- Which variables are available in common templates. +- How to use them safely. -This template is sent to potential reviewers inviting them to submit a review. +For general guidance on editing templates, see Email templates . -Objects in this Template's context: +## What are email template variables? + +Variables are placeholders that Janeway replace with real information when an email is sent. + +For example: + +- The reviewer’s name. +- The article title. +- A review deadline. +- A link to a review task. + +Variables always appear inside double curly brackets, for example: + +`{% raw %}{{ review_assignment.date_due }}{% endraw %}` + +When the email is sent, Janeway replaces this with the actual due date. + +>[!IMPORTANT] +> Variables must be copied exactly (if copying from reference). Do not add spaces, punctuation or text inside the brackets. You can safely change the surrounding text. + +## Example template: Review assignment + +Template code: review_assignment + +This email is sent to potential reviewers when they are invited to review an article. + +The following information can be inserted into the email using variables: + +- Article information (title, abstract, journal name). +- Reviewer information. +- Editor information. +- Review details, such as the due date. +- A secure review link. + +Commonly used variables include: + +- `{% raw %}{{ article.safe_title }}{% endraw %}` + The article title. +- `{% raw %}{{ editor.first_name }}{% endraw %}` + The editor’s first name. +- `{% raw %}{{ review_assignment.reviewer.full_name }}{% endraw %}` + The reviewer's full name. +- `{% raw %}{{ review_assignment.date_due }}{% endraw %}` + The review due date. +- `{% raw %}{{ review_url }}{% endraw %}` + The link the reviewer uses to access the review. + +### Review assignment objects (advanced users) +If you are a technical user and/or familiar with objects, here is a list of objects in this template's context: - article, an Article object. - editor, an Account object. @@ -21,7 +70,44 @@ Objects in this Template's context: - review_url, a reversed URL with FQDN. - article_details, a string with article and review information in it, inc. Title, due date etc. -## Objects +## Using variables in practice + +Here are some common examples you can copy and reuse. + +- Review due date + `{% raw %}{{ review_assignment.date_due }}{% endraw %}` + +- Article title + `{% raw %}{{ article.safe_title }}{% endraw %}` + +- Journal name + `{% raw %}{{ article.journal.name }}{% endraw %}` + +- Review link + `{% raw %}{{ review_url }}{% endraw %}` + +- Revisions link + `{% raw %}{{ do_revisions_url }}{% endraw %}` + +- The title of the issue this article is projected to be part of + `{% raw %}{{ article.projected_issue.display_title }}{% endraw %}` + +- The article's correspondence author + `{% raw %}{{ article.correspondence_author.full_name|se_can_see_pii:article }}{% endraw %}` + + +If you use a variable with information that isn't available; e.g. a middlename for a user who has not provided one, it will be ignored and display a blank space instead. + +>[!NOTE] +> Certain variables, such as the title, have `safe_` appended to the second half of the object. This is to ensure they display correctly. + +>[!NOTE] +> In certain templates, the author name variable will include "`|se_can_see_pii:article`". This determines the visibility of the variable's information to section editors when using triple anonymous review. You do not need to edit this or otherwise worry about this when not using triple anonymous review. + +## Commonly used objects (advanced reference) +The sections below describe the main objects you may encounter. + +### Objects Listed here is a non-exhaustive list of the objects that you may have access to in an email template. @@ -38,7 +124,7 @@ KEY - DateTime is a field that stores a internationalised date and time. - Email is a validated email address. -### Account +### Account object reference The account object stores information about users. @@ -63,7 +149,7 @@ The account object stores information about users. - is_staff (Bool) - date_joined (DateTime) -### Article +### Article object reference The article object contains the following attributes: @@ -83,7 +169,7 @@ The article object contains the following attributes: - rights (Str) - article_number (Int) -### Journal +### Journal object reference The journal object contains the following attributes: @@ -109,7 +195,7 @@ The journal object contains the following attributes: - sequence (Int) - disable_front_end (Bool) -### ReviewAssignment +### ReviewAssignment object reference - article (FK `Object Article`) - reviewer (FK `Object Account`) @@ -129,17 +215,3 @@ The journal object contains the following attributes: - review_file (FK File) - display_review_file (Bool) -## Using Object Variables in Templates - -If I wanted to display the due date I could use: - -`{% raw %}{{ review_assignment.date_due }}{% endraw %}` - -If I wanted to display the title of the issue this article is projected -to be in I can use: - -`{% raw %}{{ article.projected_issue.display_title }}{% endraw %}` - -If I wanted to display an article's journal's name I would use: - -`{% raw %}{{ article.journal.name }}{% endraw %}` diff --git a/content/support/email-and-reminders/email-templates.md b/content/support/email-and-reminders/email-templates.md index 0a5e066d..49094148 100644 --- a/content/support/email-and-reminders/email-templates.md +++ b/content/support/email-and-reminders/email-templates.md @@ -1,22 +1,25 @@ title: Email templates # Email templates -The email templates system allows you to search through and edit all of the email templates for a given journal. +The email templates system allows you to view, search and edit the email templates used by a journal. These templates control the content of both automated and manually sent emails (for example, review invitations, reminders and decision emails). > [!WARNING] -> Editing an email template could cause it to break. +> Editing an email template can cause emails to display incorrectly if placeholders are changed or removed. -Each email template has access to different objects, making documenting this quite difficult. We have a list of objects available and will provide examples below. If you are uncertain about how to update an email template or uncomfortable, you can reach out to your administrator or Janeway Support. +Each email template has access to a specific set of objects (such as an article, review assignment or journal). Because this varies by template, there is no documentation for every possible option. However, more information can be found on the Email variables page and template examples are available as well. If you are uncertain about how to update an email template or uncomfortable, you can reach out to your administrator or Janeway Support. ## Editing templates -When editing a template, you will see the default version of the email at the top and a rich-text editor below. If you do not have a specific setting for your journal (i.e. you've never overwritten the default setting) the rich text box will appear blank. To get started, copy the default version into the rich-text box and edit it. -> [!TIP] -> When editing an email that has a URL placeholder (like `{% raw %}{{ review_url }}{% endraw %}`) it is important that you do not add anything immediately after this placeholder as email clients may interpret them as part of the link. +When editing an email template, you will see: +- The default version of the email at the top of the page. - +- A rich-text editor below, where you can create a customised version for your journal. -## Template examples +If your journal has not previously customised a template, the rich-text editor will appear blank. -**TBC** +To get started, copy the default version into the rich-text box and edit it. +> [!WARNING] +> When editing an email that includes a URL placeholder (for example `{% raw %}{{ review_url }}{% endraw %}`), do not add text immediately after the placeholder. Email clients may treat added characters as part of the link, which will break it. + + \ No newline at end of file diff --git a/content/support/guides/account-set-up-placeholder.md b/content/support/guides/account-set-up-placeholder.md deleted file mode 100644 index c09726e6..00000000 --- a/content/support/guides/account-set-up-placeholder.md +++ /dev/null @@ -1,9 +0,0 @@ -title: Set up an Account on Janeway - -# Set up an Account on Janeway - -## Account without a submission - -## Account with a submission - -## Setting up as an editor diff --git a/content/support/guides/account-set-up.md b/content/support/guides/account-set-up.md new file mode 100644 index 00000000..7b74ff84 --- /dev/null +++ b/content/support/guides/account-set-up.md @@ -0,0 +1,31 @@ +title: Creating an account on Janeway + +# Creating an account on Janeway + +From the front page of a journal, select **Register** to set up an account. Complete the form and activate your account using the link sent to you by email. Once your account is set up and activated, you can sign in to Janeway. + +If you are an author making a submission, you don't need to create an account. One will be created as part of the submission process. + +If you have been invited to review, you may be able to complete your review without creating an account if the journal has enabled one-click peer review. + +If the journal is part of a press and you have access to another journal in that press, you may already have an account. Sign in using your existing credentials. If you make a submission, you automatically receive the author role. If you need other roles on the journal, ask an editor or press manager to assign the relevant roles. + +## Setting up as an editor + +To create an editor account, first register using the steps above. An editor, press manager, or someone with **Staff** permission then needs to assign you the editor role. + +## Editing your account + +You can edit your account by clicking on the account icon in the top-right corner. This displays either your initials or a profile picture, if one has been set. Click **Profile** to open the profile page, where you can edit your profile. + +![" "](../images/profile-dropdown.png) + +On this page, you can do the following: +- Update your email address. +- Change your password. +- Update your affiliation. +- Update personal details, such as name, ORCID, social media links, biography, and signature. +- Set a profile picture. +- Set review interests. +- Set your timezone. +- Set your profile visibility. \ No newline at end of file diff --git a/content/support/guides/account-troubleshooting-placeholder.md b/content/support/guides/account-troubleshooting-placeholder.md index cad2aeb8..86f8d7f6 100644 --- a/content/support/guides/account-troubleshooting-placeholder.md +++ b/content/support/guides/account-troubleshooting-placeholder.md @@ -2,6 +2,27 @@ title: Account troubleshooting # Account troubleshooting +## Activate your account + +If you are sure your password is correct and you cannot login, your account has likely not been activated yet. +This is usually resolved either by: +- Requesting a password reset link. This will send you an account activation email, if your account has not yet been activated. If your account was not created by you (or an editor) but was imported into Janeway, this will not work. You will need to use the option below. + +- An editor or journal manager activating your account. (See Activating a user account for instructions ) + +### Activating a user account + +1. Go to **Journal users** on the **Manager** interface. +2. Find the user in question through the searchbox and/or filter by account activation status. + !["A screenshot of the search options for the user search. Including a text field and various filters."](../images/search-inactive.png) +3. Click **Edit** for the appropriate user + ![" "](../images/edit-user.png) +4. Set the account activation toggle to **Yes**. + ![" "](../images/active-toggle.png) +5. Make sure to save the change made by clicking the **Save** button at the bottom of the page. +6. The account is now active. + + ## New password ### Reset your password @@ -15,7 +36,7 @@ If you have forgotten your password and need to reset it: 5. Click the link in the email. 6. Fill in the password fields to set a new password. -![The login page with 'Forgot your password' highlighted.](../images/forgotten_password.png) +![The login page with 'Forgot your password' highlighted.](../images/forgotten-password.png) If you have not received the password reset email, contact **Support**. @@ -28,4 +49,4 @@ If you know your Janeway password and want to update it: 4. Go to the **Update password** block and fill in your current and new passwords in the respective fields. 5. Click the **Update password** button. -## Activate your account + diff --git a/content/support/guides/getting-started-placeholder.md b/content/support/guides/getting-started-placeholder.md index 0cb2ca64..b8d06a9e 100644 --- a/content/support/guides/getting-started-placeholder.md +++ b/content/support/guides/getting-started-placeholder.md @@ -4,3 +4,5 @@ title: Getting started with Janeway * Registering an account and setting up permissions. * Navigating Janeway. + +*Coming soon* diff --git a/content/support/guides/janeway-guides.md b/content/support/guides/janeway-guides.md index c72cc4a9..d5030b6a 100644 --- a/content/support/guides/janeway-guides.md +++ b/content/support/guides/janeway-guides.md @@ -1,6 +1,9 @@ title: Janeway guides # Janeway guides +This is a landing page for guides available. +*Coming soon* + +safety check ![" "](../images/all-settings-google.png) @@ -77,3 +80,5 @@ Testy test | 👁️ | **View** | Opens the selected issue’s management view. | | 🗑️ | **Delete** | Removes the issue permanently. | | 🔘 | **Make current** | Marks the issue as the current active issue (used for public display). | + +--> diff --git a/content/support/guides/janeway-metadata.md b/content/support/guides/janeway-metadata.md index 668c37df..3b571d23 100644 --- a/content/support/guides/janeway-metadata.md +++ b/content/support/guides/janeway-metadata.md @@ -2,6 +2,8 @@ title: Metadata on Janeway # Metadata on Janeway +*This is a work in progress* + ## Managing metadata - How is metadata collected / created - What metadata fields exist on Janeway diff --git a/content/support/guides/journal-design-placeholder.md b/content/support/guides/journal-design-placeholder.md index 33f8905c..252a6405 100644 --- a/content/support/guides/journal-design-placeholder.md +++ b/content/support/guides/journal-design-placeholder.md @@ -1,12 +1,15 @@ title: Journal design # Journal design -## Images -Image guidelines -## Themes -Janeway has three available themes that determine the appearance of a journal and its layout. These themes are Clean, Material and OLH. You can read more about the themes in this section. All three can be customised using CSS and the **Custom Styling** plugin . +*Coming soon* + diff --git a/content/support/guides/journal-setup-placeholder.md b/content/support/guides/journal-setup-placeholder.md index 4894f552..d9d0fa20 100644 --- a/content/support/guides/journal-setup-placeholder.md +++ b/content/support/guides/journal-setup-placeholder.md @@ -2,6 +2,8 @@ title: Set up your journal # Set up your journal +*This is a work in progress* + Journal name Journal domain diff --git a/content/support/guides/workflow-author.md b/content/support/guides/workflow-author.md index bad7d25f..af3e1b86 100644 --- a/content/support/guides/workflow-author.md +++ b/content/support/guides/workflow-author.md @@ -1,7 +1,7 @@ title: Author guide # Author guide -This guide will walk you through the Janeway journal submission system. +This guide will walk you through the Janeway journal submission system. ## Navigating the submission process Generally, all Janeway journals' submission systems will look the same. Along the top of the page, you will see a progress bar with five stages. Once a stage has been completed, the corresponding segment of the bar will turn into a link. You can use this bar to return to an earlier screen if you need to make changes. @@ -9,47 +9,49 @@ Generally, all Janeway journals' submission systems will look the same. Along th ![Submission progress bar, showing the five stages: Submission started, Article information, Author information, Article files, Review your submission.](../images/workflow/author-submission-navigation.png) ## New submissions -There are multiple ways to submit a journal article on Janeway: +There are multiple ways to submit a journal article on Janeway. If you do not have an account yet: - - From the **Submission** page on the main site (if this is not visible on a journal website, they may not be accepting submissions at this time). + +- First, begin from the **Submission** page on the main site. If this is not visible on a journal website, they may not be accepting submissions at this time. ![An example submissions page. The submissions button on the page and the navbar items for Start a submission and Submissions are highlighted.](../images/workflow/author-submission-webpage.png) If you already have an account: - - From the drop-down menu in the top right-hand corner. This will be visible both on the journal webpage when you click **Account** and within Janeway when you click on your profile in the top right-hand corner. -- On the journal website: +- First, begin from the drop-down menu in the top right-hand corner of the page. This will be visible both on the journal webpage when you click **Account** and within Janeway when you click on your profile in the top right-hand corner. + +This is an example of how this will appear on the journal website: ![The dropdown menu on the journal website.](../images/workflow/author-submission-dropdown-website.png) -- On the Janeway journal platform: +This is an example of how this will appear on the Janeway journal platform: ![The dropdown menu on the submission platform](../images/workflow/author-submission-dropdown-loggedin.png) -- From the author dashboard within Janeway. +This is an example of how this will appear from the author dashboard within Janeway. ![The author dashboard block in Janeway. Submit new article in the top right corner of the block is highlighted.](../images/workflow/author-dashboard-block.png) -If you already have an account, you will usually automatically be given the author role in Janeway when you submit an article. However, some journals will ask you to provide the details of the manuscript’s author or select yourself as the author manually. For more information on this, see the Author information section of this guide. +If you already have an account, you will usually automatically be given the author role in Janeway when you submit an article. However, some journals will ask you to provide the details of the manuscript’s author or select yourself as the author manually. For more information on this, see the **Author information** section of this guide. ### The author agreement The first page of the submission process is the author agreement. Depending on how a journal is set up, this may appear slightly different, and not all of these fields may be displayed. ![The author agreement page.](../images/workflow/author-author-agreement.png) -- Publication fees +- Publication fees - This is where you will see any publication fees, including Voluntary Author Contributions (VACs) or Article Processing Charges (APCs) that apply to the submission. > [!NOTE] -> Please note that a Voluntary Author Contribution and Article Processing Charge are different. The former is entirely optional and not required for publication in a journal. For more information about publication fees, visit the relevant journal’s policy page(s) or contact its editorial team. - -- Submission checklist - - The submission checklist will display any steps you need to take before submitting the manuscript (e.g. formatting). -- Copyright notice - - The copyright notice specifies the license under which the paper will be published and any rights you may need to sign over to the publisher. -- Competing interests - - If you have any competing interests that the editors should take into account when examining your paper, this is where you will need to disclose them. +> Note that a "Voluntary Author Contribution" and "Article Processing Charge" are different. The former is entirely optional and not required for publication in a journal. For more information about publication fees, visit the relevant journal’s policy page(s) or contact its editorial team. + +- Submission checklist + The submission checklist will display any steps you need to take before submitting the manuscript (e.g. formatting). +- Copyright notice + The copyright notice specifies the license under which the paper will be published and any rights you may need to sign over to the publisher. +- Competing interests + If you have any competing interests that the editors should take into account when examining your paper, this is where you will need to disclose them. If they have been enabled, the publication fees, submission checklist and copyright notice fields will be required. This means that you _must_ select the checkboxes in order to complete a submission. If you have any issues with any of the clauses, it is best to contact the editor(s) before you submit your work. @@ -59,21 +61,20 @@ The **article information** page is where you will provide the metadata for your ![The article information page, filled with example data.](../images/workflow/author-article-information.png) Metadata that may be requested on this page: -- Title - - This field is always required. +- Title + This field is always required. - Subtitle -- Abstract - - Whether or not an abstract is required will depend on the individual journal. -- Language - - This is usually only required if the journal publishes in multiple languages. -- Section - - This refers to the type of article the paper is (e.g., research article, book review, editorial, etc.) -- Licence - - This is usually disabled if the journal only accepts one license type. -- Keywords - - You can add keywords to your article to help people discover it. To add keywords, type the word or phrase into the textbox and press 'Enter' to add it. If you wish to delete a keyword, click the **X** icon next to it within the textbox. Keywords can include spaces and special characters. - -![""](../images/workflow/author-keywords.png) +- Abstract + Whether or not an abstract is required will depend on the individual journal. +- Language + This is usually only required if the journal publishes in multiple languages. +- Section + This refers to the type of article the paper is (e.g., research article, book review, editorial, etc.). +- Licence + This is usually disabled if the journal only accepts one license type. +- Keywords + You can add keywords to your article to help people discover it. To add keywords, type the word or phrase into the textbox and press 'Enter' to add it. If you wish to delete a keyword, click the **X** icon next to it within the textbox. Keywords can include spaces and special characters. + !["The field to enter keywords."](../images/workflow/author-keywords.png) Individual journals can add more fields to this page. These will be displayed under **Additional fields**. @@ -86,7 +87,7 @@ To add more authors to a submission, you can either search the journal's author - This lets you search the journal's database of authors by using their email address or ORCID. You cannot search using a name or institution. - If a matching record is found, they will be added as a co-author. If not, you will be notified that no account has been found. - ![" "](..\images\workflow\author-submission-author-search.png) + !["The Add more authors block with the button to search for authors highlighted."](../images/workflow/author-submission-author-search.png) - Adding authors through **Add author manually** - The **Add author manually** button lets you create a new author record for authors if they do not already have one. The following fields are mandatory in Janeway: @@ -94,18 +95,20 @@ To add more authors to a submission, you can either search the journal's author - Last name - Email address - ![" "](..\images\workflow\author-submission-author-manual.png) +This will not create a new account for the additionaly author(s), it will only create an author record with no account attached. If they wish to login and check the article's progress, they can create an account with the same email address that was used on the author record (submission). Either the submitting author or an editor can then link the account to the author record. + +!["The page where someone can manually add an author to the submission and enter their details."](../images/workflow/author-submission-author-manual.png) If the search of the journal's author list or ORCID search are successful, author details will be added automatically. You can still make edits, by clicking on **Edit author details**. When an author already has an account with the journal or another journal under the press, this submission will be linked to their existing record. To change the correspondence author, another author with a pre-existing (confirmed) account needs to be added. If no other co-authors have an account, the submitting author is required to remain the correspondence author. ->NOTE +>[!NOTE] >The correspondence author does not necessarily have to be the primary author. The correspondence author can also be changed after submission. Janeway uses [Research Organization Registry (ROR)](https://ror.org/) to manage affiliation data. You can add author affiliation by clicking **Edit author details** and scrolling down to **Affiliations**. From here, you can add, remove and edit affiliations. If an author ORCID has been provided, their affiliation will be added automatically from their ORCID. You can still edit this, if it is incorrect. -![" "](..\images\workflow\author-submission-edit-details.png) +!["An example author on a submission, with the button to edit author details highlighted."](../images/workflow/author-submission-edit-details.png) After the submission is completed, co-authors will be notified and will be able to access the submission and update or edit their details. @@ -120,20 +123,20 @@ To add a file, click the **Upload** button under either **Manuscript file** or * You are required to add a label to any file uploaded, but the description field is optional. For manuscript files, we recommend something along the lines of "submitted manuscript". For figure files, this label should correspond with the information in the manuscript (e.g. the "Figure 1" in your manuscript should be labelled as "Figure 1" when you upload it here). -You can add only one manuscript file, but multiple figures and/or data files. +While you can add only one manuscript file, multiple figures and/or data files can be added. ### Funding You will then be asked to supply information about any relevant funding. You can search for your funding source using our **Search for funder** function or add them manually. When adding a funder, you will be given the option to provide an optional Funder DOI and Grant ID. -![""](../images/workflow/author-funding.png) -![""](../images/workflow/author-add-funder.png) +!["The funding information page."](../images/workflow/author-funding.png) +!["The funder ID block, with example information."](../images/workflow/author-add-funder.png) If you do not have any funders to add, you can skip this page by clicking **Save and continue** without adding any funders. ### Review The **Review** page displays a run-down of the article you've submitted, metadata, files and authors. From here, you can click **Complete** to submit or jump back to other stages to make changes. Once you have finalised your submission, you cannot make any changes until editors request revisions (if applicable). -![""](../images/workflow/author-submission-review.png) +!["The submission confirmation page."](../images/workflow/author-submission-review.png) ## Revisions If an article is accepted, it may enter the peer review process. Once a submission has been reviewed, editors may request that authors revise their files based on recommendations from reviewers. There are three types of revision requests: @@ -153,7 +156,7 @@ When an editor requests revisions, there are two ways to start this process: 3. Scroll down to **Submitted articles**. 4. Click the **Revision request** button next to the article. -![""](../images/workflow/author-submitted-articles.png) +!["The block showing submitted articles and their status in the workflow"](../images/workflow/author-submitted-articles.png) Once you have accessed the revision request, you can view the available peer reviews. You can also download, revise, and upload new files. @@ -181,40 +184,49 @@ The typesetters will then use this final manuscript to create the finished artic Typeset proofs are not an opportunity to make changes to the content or style of a manuscript: the file that goes into production is final. It is expected that only a handful (less than 10) of very minor changes should be requested at the proofing stage, if any. -### To complete a copyediting author revision: +### To complete a copyediting author revision: + 1. Upload your revised manuscript by replacing the copyeditor's version of the file with your own updated version. -![""](../images/workflow/author-copyedited-files.png) +!["The block for copyedited files, listing copyedited files accompanied by a download button and replace button for each file."](../images/workflow/author-copyedited-files.png) 2. Fill in the **Note to the editor** field with any additional information. 3. Select a Decision (either **Accept** or **Corrections required**). 4. Click **Complete copyedit task**. -![""](../images/workflow/author-complete-copyedit-task.png) +!["The block where authors can leave notes to the editor, record their decision and the button they click to complete the task."](../images/workflow/author-complete-copyedit-task.png) ## Proofing After your paper has been accepted and copyedited, the editors might send you a request to proof the typeset manuscript. This is the final version that will be made publicly available once the article gets published in the journal. -[" "](/content/support/images/workflow/author-proofing-block.png) +You can access your proofing tasks either through the link sent to you by email or through the proofing task button on your dashboard. -[" "](/content/support/images/workflow/author-proofing-view-assignment.png) +!["The proofing block on the author dashboard, displaying there is one proofing task."](../images/workflow/author-proofing-task.png) + +!["A zoomed out version of the proofing block on the author dashboard, displaying there is one proofing task, to show users where on the page it is"](../images/workflow/author-proofing-block.png) + +!["The page displaying a list of open proofing assignments."](../images/workflow/author-proofing-view-assignment.png) For journals that publish content in multiple media formats (HTML, PDF, XML, etc.), it is important that you check all these files before publication. This will not require any technical knowledge; authors are not expected to be able to open and read XML/HTML code. Instead, Janeway provides a **View file** button, which allows you to preview how the article will look once it is published. -![Typeset Files download and preview](../images/workflow/author-proofing-view-file.png) +![Typeset Files download and preview](../images/workflow/author-proofreading.png) Once you've previewed the files, you can provide feedback in two ways: -- Fill in the **Notes** field. You can use this to add not just text, but also to paste in screenshots or other relevant images. +- Fill in the **Notes** field. + You can use this to add not just text, but also to paste in screenshots or other relevant images. -![Providing proofreading notes via a text editor](../images/workflow/author-proofreading-notes.png) + ![Providing proofreading notes via a text editor](../images/workflow/author-proofreading-notes.png) -- Upload an annotated file. In the case of PDF files, you can download the file and make annotations offline using PDF readers. When this is done, you can upload the annotated file for the editor to review. +- Upload an annotated file. + In the case of PDF files, you can download the file and make annotations offline using PDF readers. When this is done, you can upload the annotated file for the editor to review. -![Providing proofreading notes by uploading an annotated file.](../images/workflow/author-proofreading-annotated-file.png) + ![Providing proofreading notes by uploading an annotated file.](../images/workflow/author-proofreading-annotated-file.png) It is important to proof all the files thoroughly in order to avoid unnecessary follow-up rounds. This saves everyone time, work, and money and makes the publishing process run much more smoothly. -Click **Mark task as complete** to finish proofreading. Once you have provided your feedback, the editorial team might send you another proofing task once the requested corrections have been made. If this happens, the process will be exactly the same as in the first round of proofing. If there are no (or only very minor) corrections, you will likely not be asked to review again. +To finish proofing, click **Mark task as complete**. Once you click this button, you will not be able to return to this page. + +Once you have provided your feedback, the editorial team might send you another proofing task once the requested corrections have been made. If this happens, the process will be exactly the same as in the first round of proofing. If there are no (or only very minor) corrections, you will likely not be asked to review again. Once the article is published, all authors will receive a notification through the email addresses used when the article was submitted (except if this has been updated before publication). diff --git a/content/support/guides/workflow-copyeditor.md b/content/support/guides/workflow-copyeditor.md index cd7966b3..6d50a775 100644 --- a/content/support/guides/workflow-copyeditor.md +++ b/content/support/guides/workflow-copyeditor.md @@ -7,12 +7,12 @@ When a new copyediting assignment is created, you will receive an email containi On this page, you will see three columns of copyediting tasks. -- **Awaiting initial decision** - - New tasks you have not accepted or declined. -- **In progress** - - Tasks you have accepted but not completed. -- **Completed** - - Tasks you have completed. +- **Awaiting initial decision** + New tasks you have not accepted or declined. +- **In progress** + Tasks you have accepted but not completed. +- **Completed** + Tasks you have completed. To start a new task, press the **Accept** button. The task will then be displayed as **In progress**. To begin copyediting, click **View** on the task's card. @@ -22,24 +22,24 @@ To start a new task, press the **Accept** button. The task will then be displaye Once you have clicked into a paper, the next page you see will be broken into four sections: -- **Guidelines** - - Here you will find the journal's copyediting guidelines. These will help you complete your task, so you may wish to have them open in another tab as you copyedit in case you need to refer back to them. +- **Guidelines** + Here you will find the journal's copyediting guidelines. These will help you complete your task, so you may wish to have them open in another tab as you copyedit in case you need to refer back to them. -- **Article files** - - A list of the files supplied by the editor for copyediting. From here, you can download the necessary files to work on and any supplemental files (e.g., additional figures) using the download icon (highlighted in the image below). +- **Article files** + A list of the files supplied by the editor for copyediting. From here, you can download the necessary files to work on and any supplemental files (e.g., additional figures) by clicking the **Download** icon. -- **Copyedited files** - - A list of files you have uploaded. Use the **Upload file** button to add a new file when you have completed copyediting it. +- **Copyedited files** + A list of files you have uploaded. Use the **Upload file** button to add a new file when you have completed copyediting it. -- **Complete task** - - Here you can enter a note for the editor and mark the task as complete. +- **Complete task** + Here you can enter a note for the editor and mark the task as complete. ![The ‘Article Copyediting’ page. It displays information about the manuscript, the article files, completed files and a ‘comments to the editor’ textbox. The ‘Download’, ‘Upload File’ and ‘Complete copyedit task’ buttons are highlighted.](../images/workflow/copyedit-page.png) ### Article files & copyedited files ![The ‘Article files’ and ‘Copyedited files’ section. It shows the files, their filenames, labels and download buttons. There is also an upload file button for copyedited files.](../images/workflow/copyedit-files.png) -This is where you can find the necessary files to complete the copyediting task. This will include the manuscript and other files, such as figures. You can upload the copyedited manuscript using the **Upload file** button. +This is where you can find the necessary files to complete the copyediting task. This will include the manuscript and other files, such as figures. You can upload the copyedited manuscript using the **Upload file** button. ### Complete task ![The ‘Complete task’ section with a textbox for the notes to the editor. There is a ‘Complete copyedit task’ button at the bottom.](../images/workflow/copyedit-complete-task.png) diff --git a/content/support/guides/workflow-editor-copyediting.md b/content/support/guides/workflow-editor-copyediting.md index 325b9f85..9243f472 100644 --- a/content/support/guides/workflow-editor-copyediting.md +++ b/content/support/guides/workflow-editor-copyediting.md @@ -5,22 +5,24 @@ The copyediting stage allows you to assign, track and complete copyediting tasks ## Assigning a copyeditor -To start the copyediting of an article, the first thing you will need to do is open a copyediting task and assign a copyeditor. To do this, click **Add a copyedit assignment**. This will open a new page where you can do the following: +To start the copyediting of an article, the first thing you will need to do is open a copyediting task and assign a copyeditor. To do this, click **Add a copyedit assignment**. -- Select a copyeditor. +!["The copyediting page, with the Add a copyedit assignment button highlighted."](../images/workflow/editor-copyedit-add-assignment.png) + +This will open a new page where you can do the following: + +1. Select a copyeditor. - Or give a user the copyeditor role, if they do not yet have it. -- Select the files to be copyedited. +2. Select the files to be copyedited. - Any of the previously uploaded manuscript files will be available for selection. If the file you require is not listed, you can upload it by returning to the previous screen and clicking on **Document management**. - - If required, you can also select any additional appendices or figure files. -- Leave notes for the copyeditor. -- Set a due date. + - If required, you can also select any additional appendices or figure files. +3. Leave notes for the copyeditor. +4. Set a due date. >[!Warning] -> If you are both the editor and copyeditor, do not perform the copyedit through this interface. Instead access it through the copyediting block on the main dashboard. +> If you are both the editor and copyeditor, do not perform the copyedit through this interface. Instead, access it through the copyediting block on the main dashboard. Once you have clicked **Add copyeditor**, you will be directed to the notification page where you can send an email to notify the copyeditor. - -![]() > [!NOTE] > If a copyeditor already has an active copyediting task for this article, they will not appear in the list; you should first close that task if you wish to assign them again. @@ -30,21 +32,22 @@ You can make as many copyediting assignments as needed and track them from the c After an assignment has been set up, the copyeditor can log in to Janeway and complete the task. You can see the copyediting from the copyeditor's point of view in the copyeditor guide. -Before the task is accepted, you can edit the notes and due date or delete the assignment. Once the copyeditor has accepted the task, these options are removed and replaced with a **Review** button. The **Action log** will also be updated to reflect this. - -![]() +Before the task is accepted, you can edit the notes and due date or delete the assignment. Once the copyeditor has accepted the task, these options are removed and replaced with a **Review** button. The **Action log** will also be updated to reflect this. ## Review copyediting -![]() -The review copyedit page presents the response from the copyeditor, including their notes and any files they uploaded. You can now do one of three things under **Actions** on the right-hand side: +!["The copyediting page, with two completed copyedits visible. The review buttons for both assignments are highlighted."](../images/workflow/editor-copyedit-review.png) + +The review copyedit page presents the response from the copyeditor, including their notes and any files they uploaded. You can download the copyedited manuscript using the **Download** icon. You can also do one of three things under **Actions** on the right-hand side: + +- **Accept copyedit** + This closes the task. +- **Request author review** + Ask the author to review the copyedits. +- **Reopen the task** + Ask the copyeditor to make further changes. -- **Accept copyedit** - - This closes the task. -- **Request author review** - - Ask the author to review the copyedits. -- **Reopen the task** - - Ask the copyeditor to make further changes. +!["The actions block."](../images/workflow/editor-copyedit-review-page.png) Requesting author review will ask the author to review the copyedit and inform the editor if any corrections are required. The author can also upload a file if they have made corrections or used track changes. diff --git a/content/support/guides/workflow-editor-draft-decision.md b/content/support/guides/workflow-editor-draft-decision.md index ed7e76e4..e64326fe 100644 --- a/content/support/guides/workflow-editor-draft-decision.md +++ b/content/support/guides/workflow-editor-draft-decision.md @@ -3,21 +3,23 @@ title: Editor guide to draft decisions Draft decisions (DD) are an optional element of the review workflow. It allows section editors to submit a draft of their editorial decision for approval by an editor. When enabled, a section editor will only see the draft decision feature on the **Decision helper** page. -The options for draft decision types are the same as those in the standard decision workflow: -- Accept - - The article is moved into copyediting. - -- Minor revisions - - The section editor should provide the author with guidance on implementing the feedback from the peer reviewers. +!["The draft decision page."](../images/workflow/editor-draft-decision.png) -- Major revisions - - The section editor should provide the author with guidance on implementing the feedback from the peer reviewers. If an article requires major revisions, another round of peer review must be undertaken once the revisions are complete. +The options for draft decision types are the same as those in the standard decision workflow: +- **Accept** + The article is moved into copyediting. + +- **Minor revisions** + The section editor should provide the author with guidance on implementing the feedback from the peer reviewers. + +- **Major revisions** + The section editor should provide the author with guidance on implementing the feedback from the peer reviewers. If an article requires major revisions, another round of peer review must be undertaken once the revisions are complete. -- Conditional accept - - This option allows the section editor to request revisions from the author. +- **Conditional accept** + This option allows the section editor to request revisions from the author. -- Decline - - The article will be archived, and the author will be notified. +- **Decline** + The article will be archived, and the author will be notified. ## Draft decision workflows For section editors, the workflow will look like this: @@ -31,15 +33,22 @@ For section editors, the workflow will look like this: - Email to the editor - Draft email to author +!["The draft decision helper page."](../images/workflow/editor-draft-decision-screen.png) + For editors, this process will look like the following: 1. Access the draft decision through the link in the notification email or **Decision helper > Draft decisions**. The draft decisions will be listed under **Existing drafts**. +!["The draft decisions button."](../images/workflow/editor-draft-decision-button.png) + > [!NOTE] > Do not start filling in the **Add a draft decision** form – the section editor will already have drafted an email to the author in **Existing draft decisions**. 2. Review the draft decision and email by clicking **Edit**. +![" "](../images/workflow/editor-draft-decision-edit.png) + 3. If required, you can edit the decision type, due date and email to the author. You can also view any completed peer reviews on this screen. -4. Accept or decline the draft. If accepted, the decision made by the section editor(s) will be actioned. +!["The page where editors can edit the draft decision."](../images/workflow/editor-draft-decision-final.png) +4. Accept or decline the draft. If accepted, the decision made by the section editor(s) will be actioned. diff --git a/content/support/guides/workflow-editor-pandoc.md b/content/support/guides/workflow-editor-pandoc.md index adb637a5..5c0f51d8 100644 --- a/content/support/guides/workflow-editor-pandoc.md +++ b/content/support/guides/workflow-editor-pandoc.md @@ -1,17 +1,17 @@ title: Editor guide to typesetting with Pandoc # Editor guide to typesetting with Pandoc -The Pandoc plugin provides an option to generate HTML files from submissions in DOCX or RTF format and set these HTML files as galleys. +The Pandoc plugin provides an option to generate HTML files from submissions in DOCX or RTF format and set these newly generated HTML files as galleys. To work on a file, find it under **Files for typesetting** and click **Options**. This will present two options: -- Convert -This makes the file available for download to readers. This feature is useful when you want to make the original manuscript file available. +!["The files for typesetting block."](../images/workflow/editor-typesetting-options.png) -- Transform to HTML -This option transforms the manuscript file (DOCX or RTF) into an HTML file that displays the article within a web browser. +- Convert: This option makes the file available for download to readers. This feature is useful when you want to make the original manuscript file available. -Once a file has been converted or transformed, it will be listed under **Current galleys**. If you have done both, it will display twice. +- Transform to HTML: This option transforms the manuscript file (DOCX or RTF) into an HTML file that displays the article within a web browser. + +Once a file has been converted or transformed to HTML, it will be listed under **Current galleys**. If you have done both, it will display twice. You can now edit the galley and manage images as outlined in the Editor - typesetting guide . @@ -21,7 +21,7 @@ If needed, you can also edit galleys on Janeway. This is currently only availabl >[!TIP] > If your journal is 'examplejournal.com', it is 'examplejournal.com/file-editor'. If your journal link looks like 'example.com/journal', it is 'example.com/journal/file-editor'. -On the file editor, you can find a table with all HTML and XML galleys in your journal - both published and unpublished. HTML galleys can be edited in either a rich-text editor or plain text editor, XML galleys can only be edited in a plain text editor (Pandoc will not generate XML files). You edit a galley file by clicking **Edit**. +On the file editor, you can find a table with all HTML and XML galleys in your journal - both published and unpublished. HTML galleys can be edited in either a rich-text editor or plain text editor. XML galleys can only be edited in a plain text editor (Pandoc will not generate XML files - so if you are using Pandoc exclusively, you will not see any XML files). To edit a galley file, you can click **Edit**. >[!NOTE] > A rich text editor will display content as it will appear on the page (Like Microsoft Word or Google Drive). A plain text editor will display the code, rather than how the content will appear on the page. diff --git a/content/support/guides/workflow-editor-prepub.md b/content/support/guides/workflow-editor-prepub.md index 68517e35..c40c1fd0 100644 --- a/content/support/guides/workflow-editor-prepub.md +++ b/content/support/guides/workflow-editor-prepub.md @@ -36,7 +36,7 @@ Articles usually have a DOI (Digital Object Identifier) automatically assigned a DOI links should redirect to the article, without intermediate steps. To ensure the redirect is working properly, you can check the number of "hops" shown in the bulleted list. There should be no more than two. See the image below for example. -![“ “](../images/workflow/prepub_doi.png) +![" "](../images/workflow/prepub_doi.png) If the DOI has more than two hops, or you see something else, you need to look more closely at the DOI's details. Select **Edit** and check the **Status** column for an indication of what to do next. See Interpreting DOI status for more information. @@ -71,7 +71,7 @@ Check the **Mark as Complete** box to move on to the next step. The last step before publishing the article is setting the publication notifications. This is an optional step that allows you to notify authors, co-authors, section editors or others of publication. You can add people in either the CC or BCC fields. You can also amend the subject line, email body, and add attachments. -The dates/times you see in the email correspond to the timezone set in your user profile or the default timezone (UTC) if none has been set. +The dates/times you see in the email correspond to the timezone set in your user profile or the default timezone (UTC) if none has been set. Check the **Mark as Complete** box to move on to the next step. @@ -79,7 +79,7 @@ Check the **Mark as Complete** box to move on to the next step. Once you have completed all the steps, you are ready to publish the article. The **Publish this article** button is located at the top of the page, on the right-hand side. Any remaining warnings, including options to address them, will accompany it. > [!NOTE] -> The warning regarding whether an article is marked as peer reviewed will always remain. This allows editors to double-check this and easily adjust, if needed. +> The warning regarding whether an article is marked as peer reviewed will always remain. This allows editors to double-check this and adjust, if needed. Once the **Publish this article** has been clicked, the article is now scheduled to publish at the specified time. Once an article is live, you can see it on the Articles page and you may wish to check if all files display correctly. For information on managing articles after publication, see: Content management. diff --git a/content/support/guides/workflow-editor-review.md b/content/support/guides/workflow-editor-review.md index ae8f1964..edeaac9a 100644 --- a/content/support/guides/workflow-editor-review.md +++ b/content/support/guides/workflow-editor-review.md @@ -9,31 +9,35 @@ This guide will cover the default review workflow, which applies to single anony The first step to start peer review is to select the file(s) to review by clicking on **Add files**. You will be able to either select a file or upload a new file. If you are using anonymous peer review, you may need to check the uploaded manuscript for identifying information and reupload a new file. All reviewers for a given review round can access the files selected. -If this is not the first round of review, you will need to open a new review round by clicking on **⊕New review round** +If this is not the first round of review, you will need to open a new review round by clicking on **⊕ New review round** -After the appropriate files have been selected, you can add the reviewers. You can either select a reviewer from the list presented to you, select an existing user who does not yet have the reviewer role (**Enrol existing user**) or invite a new reviewer who does not yet have an account (**Add new reviewer**). These buttons can be found in the top-right corner of the screen, in blue text. +After the appropriate files have been selected, you can add the reviewers. You do this by clicking **Add new reviewer**. -![]() +!["The peer review page."](../images/workflow/editor-review-setup.png) -When assigning the reviewer, you can also select the review form, review type (open, single or double anonymous) and set the due date. You can set defaults for these in review settings to minimise the customisation needed here. Once you have selected a reviewer and are happy with the review settings, click **Add reviewer** to confirm. You will then be shown the outgoing email on the next page, which you can edit or select the option to skip sending this email. +Now, you can either select a reviewer from the list presented to you, select an existing user who does not yet have the reviewer role (**Enrol existing user**) or invite a new reviewer who does not yet have an account (**Add new reviewer**). + + >[!TIP] + >It is recommended to turn on [one-click review]( ) . This allows reviewers to complete a review using a unique link without needing to register an account or log in. + +!["The add review assignment page, focussed on the select reviewer block."](../images/workflow/editor-review-add-reviewer.png) + +When assigning the reviewer, you can also select the review form, review type (open, single or double anonymous) and set the due date. You can set defaults for these in review settings to minimise the customisation needed here. Once you have selected a reviewer and are happy with the review settings, click **Add reviewer** at the bottom of the page to confirm. You will then be shown the outgoing email on the next page, which you can edit or select the option to skip sending this email. Once the reviewer has been assigned, they can access the system to accept or decline the review, and (if accepted) do the review. You can see how this appears to reviewers and what the review process looks like for them in the reviewer guide . -> [!NOTE] -> We recommend turning on one-click peer review which allows reviewers to complete the review without creating an account. - ### Managing a review Once a review has been requested, it will be listed on the review page. The initial stage of any review is "Awaiting acknowledgement" - this means the review has not yet responded to the review invitation. -![]() +!["A review awaiting acknowledgement."](../images/workflow/editor-review-awaiting-acknowledgement.png) Once a review has been requested, you can do one of the following: - See the review by clicking on the **View** button (though no meaningful information will be available until the review is completed). -Or by clicking on the dropdown button ⏷ , the following options will also become available: +Or by clicking on the ⏷ **dropdown** icon, the following options will also become available: - You can click **Reset** to return the review status to “Awaiting acknowledgement” if the reviewer mistakenly withdraws or declines the review. - Edit the review settings (due date, review type, review form). @@ -59,35 +63,43 @@ You can see what the author sees in the review section of the author guide. ). First, you will see all completed reviews in a column with a toggle detailing whether the review is visible to the author. +![" "](../images/workflow/editor-share-review-bulk.png) + #### Controlling individual review answers In addition to making the overall review available for authors to read, you can control the individual answers to review questions. This option is available on the individual review pages, under **Answer visibility**. -![]() +![" "](../images/workflow/editor-review-answer-visibility.png) Toggling the sections on or off will determine whether the author can see answers to specific review questions when they look at the review. No answers will be visible until the top toggle, which enables the author to access the review, has been switched on. The default visibility of each review question can be configured through the review forms (see review settings ). ## Making a review decision If you are ready to make a decision after a round of review, you can click on **Make a decision** to open the **Decision helper** page. On this page, you will see a summary of reviewer recommendations, their review form answers and a list of uncompleted reviews. -![]() +!["The decision helper page."](../images/workflow/editor-review-decision-helper.png) + In addition to this, the following buttons are available: -- **Accept article** - - Accepts the article, allows you to email the author and moves the article into the next stage. -- **New review round** - - Adds a new review round. Any open review assignments on the current round are withdrawn, and a new round is set up. This process is often done after round 1 and the author has completed revisions. You can still see previous rounds through the tab at the top of the page. -- **Reject article** - - Rejects the article, removes it from the workflow and allows you to email the author. -- **Request revisions** - - Allows you to request the author revises their paper. +- **Accept article** + Accepts the article, allows you to email the author and moves the article into the next stage. +- **New review round** + Adds a new review round. Any open review assignments on the current round are withdrawn, and a new round is set up. This process is often done after round 1 and the author has completed revisions. You can still see previous rounds through the tab at the top of the page. +- **Reject article** + Rejects the article, removes it from the workflow and allows you to email the author. +- **Request revisions** + Allows you to request the author revises their paper. If enabled: -- **Draft a decision** - - Allows section editors to draft one of the above decisions for approval by an editor. -- **Share peer reviews** - - Allows an editor to email all of the reviewers who participated in the review of an article and share a link to all of the review reports. +- **Draft a decision** + Allows section editors to draft one of the above decisions for approval by an editor. +- **Share peer reviews** + Allows an editor to email all of the reviewers who participated in the review of an article and share a link to all of the review reports. > [!NOTE] > This setting must first be enabled before the option will be displayed, see Review settings. @@ -102,8 +114,6 @@ Once you have chosen to request revisions, you will be taken to a page where you Once an author has completed the revisions, you will be notified, and you can find their revised manuscript, cover letter to the editor and cover letter to the reviewers under **Revision requests** by clicking **View**. -![]() - You can now either accept the article and move it to copyediting or open another round of review. ## Sharing reviews amongst reviewers @@ -111,14 +121,13 @@ You can share completed peer reviews among reviewers. This can be set up through - After the first round of review. -Once the first round of review is complete, a new option will be present on the **Decision helper** screen to mark the reviews as shareable. It will send an email to the reviewers, providing them with a link to access and view the review content. + - Once the first round of review is complete, a new option will be present on the **Decision helper** screen to mark the reviews as shareable. It will send an email to the reviewers, providing them with a link to access and view the review content. -[]() +!["The decision helper page with the option to share reviews highlighted."](../images/workflow/editor-review-decision-helper-share-reviews.png) - Sharing reviews in the second round and beyond -Reviews from previous rounds can also be automatically shared with reviewers on the current round. When reviewers access the review interface, they will be given the choice to view anonymous reviews completed by their peers. Editors can modify the message to clarify why reviewers can view the reviews through the review settings . -[]() + - Reviews from previous rounds can also be automatically shared with reviewers on the current round. When reviewers access the review interface, they will be given the choice to view anonymous reviews completed by their peers. Editors can modify the message to clarify why reviewers can view the reviews through the review settings . ### Deleting a review round This will delete the current review round in its entirety. It will remove the files, assigned reviewers, and any reviews already completed from the current round. diff --git a/content/support/guides/workflow-editor-submission.md b/content/support/guides/workflow-editor-submission.md index 2e695586..2e554ab6 100644 --- a/content/support/guides/workflow-editor-submission.md +++ b/content/support/guides/workflow-editor-submission.md @@ -11,11 +11,15 @@ By default, editors are notified by email once a new article has been submitted. ## Reviewing submissions When you click on an article in the list of new submissions, you will be taken to a page with an overview of the submission. -![" "](..\images\workflow\editor-submission-overview.png) + +![" "](../images/workflow/editor-submission-overview.png) + The left block of the page displays the article’s metadata and author metadata, whilst workflow actions and potential editors are displayed on the right. -Before the article can enter the workflow, it must be assigned to an Editor or Section editor through **Add editors**. -![" "](..\images\workflow\editor-submission-editors.png) +Before the article can enter the workflow, it must be assigned to an Editor or Section editor through **Add editors**. + +!["The blocks for adding editors and displaying assigned editors."](../images/workflow/editor-submission-editors.png) + Once assigned, the editor can do one of the following through **Actions**: - Move the article to review (**Move to review**). @@ -23,7 +27,8 @@ Once assigned, the editor can do one of the following through **Actions**: - Accept the article outright, skipping peer review (**Accept article**). If you reject the article, there will be an opportunity to provide an explanation to the author. -![" "](..\images\workflow\editor-submission-actions.png) + +!["The actions block."](../images/workflow/editor-submission-actions.png) Accepting the article will move it into Copyediting, skipping peer review. You can do this for editorials or other submissions that do not require peer review. @@ -38,6 +43,6 @@ The projected issue functionality can be used internally to keep track of plans On this page, you can also edit author details. This is done by clicking **Edit author metadata** which will take you to a screen where you can edit author details, change the author order, change the correspondence author, or add authors. To edit an author's affiliation, click **Edit author details** and scroll down to the **Affiliations** block, where you can edit, add or remove an author's affiliation(s). -![" "](..\images\workflow\editor-submission-edit-author.png) +!["The edit author page."](../images/workflow/editor-submission-edit-author.png) Janeway uses [Research Organization Registry (ROR)](https://ror.org/) to manage affiliation data, this ensures consistent formatting of affiliation data and links authors to their instituions, improving metadata quality. You can search for an institution or, if no match is found, add the details manually. diff --git a/content/support/guides/workflow-editor-typesetting.md b/content/support/guides/workflow-editor-typesetting.md index 2b6a4a4a..497bea75 100644 --- a/content/support/guides/workflow-editor-typesetting.md +++ b/content/support/guides/workflow-editor-typesetting.md @@ -20,15 +20,21 @@ You can **Claim** an article to indicate who is managing its typesetting (this d After selecting an article, you will be taken to the typesetting page. This page is divided into blocks: -* At the top, you can see the rounds which are used for both typesetting and proofing, similar to the peer review page. From here, you start rounds and assign typesetters and proofreaders. +- At the top, you can see the rounds which are used for both typesetting and proofing, similar to the peer review page. From here, you start rounds and assign typesetters and proofreaders. -* Under this, there is **Files for typesetting** where files used in typesetting are listed - this includes manuscript files, images and any pre-existing galleys. +!["The typesetting page."](../images/workflow/editor-typesetting-rounds.png) -* This is followed by **Galleys**, which lists typeset files (galleys) which will become available to readers. +- Under this, there is **Files for typesetting** where files used in typesetting are listed - this includes manuscript files, images and any pre-existing galleys. -* Finally, **Optional files** contains the supplementary files (data files, appendices, etc.) and (if using) source files (intermediate files used by typesetters, e.g. Adobe InDesign files). +- This is followed by **Galleys**, which lists typeset files (galleys) which will become available to readers. -* The **Actions** block, where you can start new rounds or complete typesetting, is on the right-hand side - similar to the peer review and copyediting stages. +!["The files for typesetting and current galleys blocks."](../images/workflow/editor-typesetting-files-blocks.png) + +- Finally, **Optional files** contains the supplementary files (data files, appendices, etc.) and (if using) source files (intermediate files used by typesetters, e.g. Adobe InDesign files). + +- The **Actions** block, where you can start new rounds or complete typesetting, is on the right-hand side - similar to the peer review and copyediting stages. + +!["The typesetting page with the Actions block highlighted."](../images/workflow/editor-typesetting-actions.png) You can see the typesetter's view and their experience of the workflow in the typesetter guide. @@ -42,7 +48,7 @@ Galleys are typeset files used for proofing and displaying content. Typeset file All typeset files will become available for download from the article page once the article is published. Janeway can display JATS XML or HTML galleys and list other formats as downloads. ## File labels -When uploading typeset files, Janeway will ask you to set a label. The label will be displayed publicly in the option to download a file as 'Download [label]'. So if you set the label as 'PDF', it will be 'Download PDF'. +When uploading typeset files, Janeway will ask you to set a label. The label will be displayed publicly in the option to download a file as 'Download [label]'. So if you set the label as 'PDF', it will be 'Download PDF'. Labels can also be used to denote the language of a file to readers. For instance, labelling a PDF file as 'PDF (EN)' and another as 'PDF (ES)' will allow readers to download the correct PDF for their language. @@ -56,7 +62,11 @@ You should set the supplementary file in advance of sending the article for type ## Upload galleys yourself (workflow) If you do not use a typesetter or file conversion through Janeway, you can upload typeset files yourself by clicking **Upload new typeset file** in the **Current galleys** section. Once you have selected a file, you can also mark whether the file should be public upon publication and set its label. -When uploading an HTML or XML file with images, they must be uploaded separately, as HTML and XML files do not contain the images themselves (like a DOCX or PDF file might). Images can be uploaded by clicking **Edit galley** and using the upload functions provided, for more information see: Images and figure files . +![" "](../images/workflow/editor-typesetting-upload-new-typeset-file.png) + +When uploading an HTML or XML file with images, they must be uploaded separately, as HTML and XML files do not contain the images themselves (like a DOCX or PDF file might). Images can be uploaded by clicking the **Edit** icon and using the upload functions on the page it leads to, for more information see: Images and figure files . You can also **Download** the file or **Preview** it, using the respective icons. + +!["Current galleys blocks, with the various buttons highlighted."](../images/workflow/editor-typesetting-galley-buttons.png) > [!CAUTION] > Do not use the image or galley upload for supplementary files. See Supplementary files for more information. @@ -64,18 +74,22 @@ When uploading an HTML or XML file with images, they must be uploaded separately ## Generating typeset files with Janeway (workflow) Janeway also offers the option to convert manuscript files using the [Pandoc plugin](https://github.com/BirkbeckCTP/pandoc), which can generate HTML galleys from a MS Word document. For a full guide on how to manage typesetting with Pandoc, see Typesetting with Pandoc . -If you are interested in using the Pandoc plugin, contact your System administrator (What is a system administrator? . +If you are interested in using the Pandoc plugin, contact your System administrator (What is a system administrator? ). ## Working with a typesetter -This section outlines how to work with an external typesetter, including assigning tasks, reviewing their work, and assigning revisions (if needed). You will need to set up an account for your typesetter. If you have not done this yet, see Account Management for more information. . +This section outlines how to work with an external typesetter, including assigning tasks, reviewing their work, and assigning revisions (if needed). You will need to set up an account for your typesetter. If you have not done this yet, see Account Management for more information. ### Assigning a typesetter -Click **Add typesetter** to open the typesetter assignment page and start a new typesetting assignment. You can now do the following: +Click **Assign a typesetter** to open the typesetter assignment page and start a new typesetting assignment. + +![" "](../images/workflow/editor-typesetting-assign-typesetter.png) + +You can now do the following: 1. Select a typesetter. -2. Select the files you would like this typesetter to work on. +2. Select the files you would like this typesetter to work on. If any galleys are already uploaded, you can select galleys for correction as well. 3. Set a due date. 4. Add any notes, e.g. what file types you would like. 5. Send a notification email to the typesetter (or skip this step). @@ -92,13 +106,20 @@ There is no limit on the number of typesetters you can assign at one time. ### Reviewing the typesetting task -Once the typesetter has completed their task, you will receive an email notification. You can now review the typesetting task and select one of the following three options: - - **Request corrections** - - If you notice a problem with the typeset files straight away, you can request corrections to the typesetter. See Requesting corrections - - **Proofing required** - - Accept the typeset files and record the decision to send the files for proofing. - - **Accept** - - If no (further) proofing or corrections are required, you can accept the files and end the typesetting stage. +Once the typesetter has completed their task, you will receive an email notification. + +!["The typesetting page with a complete typesetting assignment. The review typesetting button is highlighted."](../images/workflow/editor-typesetting-review-typesetting.png) + +You can now review the typesetting task and select one of the following three options: + + - **Request corrections** + If you notice a problem with the typeset files straight away, you can request corrections to the typesetter. See Requesting corrections. + - **Proofing required** + Accept the typeset files and record the decision to send the files for proofing. + - **Accept** + If no (further) proofing or corrections are required, you can accept the files and end the typesetting stage. + +!["The manage assignment block, where an author can make decisions about the typesetting assignment."](../images/workflow/editor-typesetting-review-typesetting-decision.png) ## Proofing @@ -108,12 +129,18 @@ This part of typesetting is used to check galley files for any issues before the Once a typeset file has been uploaded by either a typesetter or editor, proofreading will become available. -Click **Assign proofreaders** to open a new proofing task. All files listed under **Current galleys** will be made available to proofreaders. You can now do the following: +Click **Assign proofreaders** to open a new proofing task. + +![" "](../images/workflow/editor-typesetting-assign-proofreader.png) + +All files listed under **Current galleys** will be made available to proofreaders. You can now do the following: -1. Select the proofreader. +1. Select the proofreader. The list of potential proofreaders is made up of editors, the authors of the paper and any other users with the proofreader role. You can only select one proofreader, but you can add multiple assignments. If you wish to select a user who is not displayed in the list, click **Enrol a proofreader**. +![" "](../images/workflow/editor-typesetting-enroll-proofreader.png) + 2. Set a due date. 3. Provide instructions for the proofreader. @@ -129,7 +156,9 @@ The review page will list the galleys that have been proofed and displays the pr If no further corrections are needed, you can click **Complete typesetting** under **Actions** to finish typesetting and move the article to prepublication. -If you require corrections, click **Request corrections**. +If you require corrections, click **Request corrections**. + +!["The typesetting page, with the request corrections button highlighted."](../images/workflow/editor-typesetting-choice.png) ### Requesting corrections @@ -141,9 +170,10 @@ You can now assign a typesetter to correct issues that were flagged in proofing, >[!TIP] >When requesting corrections, it is recommended to specify the corrections in the notes to the typesetter in addition to what the proofreaders have provided, especially in cases where proofreaders request contradictory corrections. - ## Managing typesetting files -Once typeset files are uploaded into Janeway, they become manageable within the system. To manage a typeset file, click the **Edit✎** icon next to it. +Once typeset files are uploaded into Janeway, they become manageable within the system. To manage a typeset file, click the **Edit** icon next to it. + +!["The current galleys block, with the edit buttons highlighted."](../images/workflow/editor-typesetting-edit-galley.png) On this page, you can do the following: - Replace the typeset file; the old file will be retained in the file history. @@ -162,20 +192,20 @@ For each missing image file, Janeway will present you with a block where you can > [!TIP] > For typeset files with a large number of images, you can also create a ZIP file containing all the images and upload it using the ZIP uploader. Janeway will match the images against the tags in the typeset files. Ensure the image names and file types are an exact match those in the typeset file. +!["The image files page, with the image upload block highlighted."](../images/workflow/editor-typesetting-imagefiles-image.png) + ## Advanced styling The following information is aimed at advanced users, comfortable with CSS / XSL. If a journal has special styling requirements and you are unable to address this yourself, contact your publisher or system administrator. -### CSS File +### CSS file If a given article requires special styling, you can upload a CSS file alongside it and Janeway will output it on the article page. > [!WARNING] > The CSS uploaded here should only target elements inside the
block, otherwise it could break general styling of the site. -### XSL File +### XSL file Janeway's XSL Transformation process uses a version-controlled XSL (Extensible Stylesheet Language) file. When you upload a JATS XML file to Janeway it marks the file as using the current XSL file. This means that as we make changes to the XSL file it will only affect future files uploaded and not any back content. > [!WARNING] > Changing an XML file's XSL may cause it to render differently. It is only recommended that you do this _before_ sending it for proofreading. - - diff --git a/content/support/guides/workflow-reviewer.md b/content/support/guides/workflow-reviewer.md index 7bbc5d24..eecf099d 100644 --- a/content/support/guides/workflow-reviewer.md +++ b/content/support/guides/workflow-reviewer.md @@ -4,66 +4,67 @@ title: Reviewer guide As a reviewer, you can access your review task in two ways: 1. Using the direct link in the review request email. -2. Through the ‘Review’ section on the Janeway Dashboard. +2. Through the **Review** section on the Janeway Dashboard. ## Direct link If the journal has enabled one-click access, you can go straight to the review page (bypassing the login screen) by using the link in the review invitation. Otherwise, you will have to log in as usual to access it. > [!NOTE] -> Do **not** share your link! This link is generated specifically for you and your review task, and functions like a password. If you share it, someone else can access your review task under your name and credentials. +> Do **not** share your link! This link is generated specifically for you and your review task. It functions like a password. If you share it, someone else can access your review task under your name and credentials. ## Dashboard -If you log into Janeway as a reviewer, you will see the **Reviewer** section on your Dashboard. Here, you can see active requests, accepted ones, and reviews you have completed. +If you log into Janeway as a reviewer, you will see the **Reviewer** section on your Dashboard. Here, you can see active review requests, accepted review requests, and any reviews you have completed. If you have any other roles within a journal (e.g. author, editor), you will also see sections for these on your dashboard. ![Reviewer Dashboard block](../../support/images/workflow/reviewer-block.png) -Click **View Requests** to be taken to the Review Requests page. On this page, you can see more information about the review (title, abstract, keywords, etc.) and either accept or decline the task. +Click **View requests** to be taken to the Review Requests page. On this page, you can see more information about the review (title, abstract, keywords, etc.) and either accept or decline the task. ![The two columns on the ‘Review Requests’ page (‘Awaiting initial decision’ and ‘Reviews in progress’). There is a task in the left column that is awaiting a decision. The task block (or card) displays the title, due date and editor initials. It also contains three buttons: ‘View Detail’, ‘Accept Task’ and ‘Decline Task’.)](../../support/images/workflow/reviewer-kanban.png) ## Review request -If you accept the task, you will be taken to the page for the review. It is split into three sections: +If you accept the task, you will be taken to the page for this review. It is split into three sections: -1. General Review Guidelines -2. Review Files -3. Review Form +1. General review guidelines +2. Review files +3. Review form ## General review guidelines This section displays information on how the editor would like you to undertake the review, an introduction to the review form, and metadata. > [!NOTE] -> This section may include both general review guidelines and guidelines specific to this review. These can differ depending on the journal and the type of submission. Please read through these even if you’ve reviewed a paper for this journal before, as they may not be the same as for a previous review task. +> This section may include both general review guidelines and guidelines specific to this review. These can differ depending on the journal and the type of submission. Read through these even if you’ve reviewed a paper for this journal before, as they may not be the same as for a previous review task. -At the bottom of this block, you will find another option to accept or decline this review task. If you initially accepted the task but are no longer available, please decline it here so that it can be offered to someone else. If you opt to decline to review, you will be asked if you can suggest other suitable reviewers. This is optional, but highly encouraged. +At the bottom of this block, you will find another option to accept or decline this review task. If you initially accepted the task but are no longer available, decline it here so that it can be offered to someone else. If you opt to decline to review, you will be asked if you can suggest other suitable reviewers. This is optional, but highly encouraged. ![The ‘Review Request’ page, displaying the ‘General Review Guidelines’ section. The review guidelines, information for the form and accept/decline elements are visible.](../support/images/workflow/reviewer-review-request.png) ## Review files -The files the editor has selected for you to review are listed here. There might be multiple files (e.g. supplementary files), so this block includes the option to download them all as a zip file. +The files the editor has selected for you to review are listed here. There might be multiple files (e.g. supplementary files), so this block includes the option to download them all as a ZIP file. -![The ‘Review Files’ section. One file is shown here with its label (‘Manuscript’ in this instance) filename and the download option. The ‘Download all as ZIP’ is in the top right corner of this section.](../support/images/workflow/reviewer-review-files.png) +![The ‘Review Files’ section. One file is shown here with its label (‘Manuscript’ in this instance) filename and the download option. The ‘Download all as ZIP’ is in the top right corner of this section.](../images/workflow/reviewer-review-files.png) ## Review form This is where you will complete your review. What this looks like will differ from journal to journal, but the main sections will be the same. Each element in the form will be accompanied by a title or description to assist you in completing it. -![The ‘Review Form’ section. It shows the ‘File Upload’, ‘Recommendation’, and ‘Comments for the Editor’ blocks.](../support/images/workflow/reviewer-file-upload.png) + +![The ‘Review Form’ section. It shows the ‘File Upload’, ‘Recommendation’, and ‘Comments for the Editor’ blocks.](../images/workflow/reviewer-file-upload.png) The sections of this form are: -- File upload - - You can upload your review here if you prefer to complete it offline (e.g. by writing down your feedback in a Word document). This section may be disabled, in which case, it will not appear. -- Review form - - This is where you will complete your review. The form may consist of a single text box or be composed of multiple boxes, which can include checkboxes and dropdowns. This will depend on the individual journal, but each part will be accompanied by text that explains what they are looking for. -- Your recommendation - - This will be divided into two subsections: **Decision** and **Comments for the Editor**. -- Decision - - You may select one of the following options for your recommendations: - - Accept without revisions - - Minor revisions required - - Major revisions required - - Reject -- Comments for the Editor - - If you have additional comments, they can be added here. These will be visible only to the editor(s), although they may choose to share them with the author. +- File upload + You can upload your review here if you prefer to complete it offline (e.g. by writing down your feedback in a Word document). This section may be disabled, in which case, it will not appear. +- Review form + This is where you will complete your review. The form may consist of a single text box or be composed of multiple boxes, which can include checkboxes and dropdowns. This will depend on the individual journal, but each part will be accompanied by text that explains what they are looking for. +- Your recommendation + This will be divided into two subsections: **Decision** and **Comments for the editor**. +- Decision + You may select one of the following options for your recommendations: + - Accept without revisions + - Minor revisions required + - Major revisions required + - Reject +- Comments for the editor + If you have additional comments, they can be added here. These will be visible only to the editor(s), although they may choose to share them with the author. ## Review complete -Once you have submitted your review, you will be presented with an overview of what you have written. Please note you will not be able to return to the review page or edit what you have written once you have clicked **Submit**. +Once you have submitted your review, you will be presented with an overview of what you have written. Note you will not be able to return to the review page or edit what you have written once you have clicked **Submit**. \ No newline at end of file diff --git a/content/support/guides/workflow-typesetter.md b/content/support/guides/workflow-typesetter.md index 0263e0dd..b8d943c9 100644 --- a/content/support/guides/workflow-typesetter.md +++ b/content/support/guides/workflow-typesetter.md @@ -23,7 +23,7 @@ For completed assignments, it will display: !["The ‘Typesetting assignments’ page."](../../support/images/workflow/typesetting-assignments.png) -You can then click **View Assignment** to display the assignment page. +You can then click **View assignment** to display the assignment page. ## Typesetting assignments page On this page, you will find relevant information about the typesetting task. This will include the instructions, manuscript files, metadata, options to accept or decline the task, and space to upload completed files. @@ -37,19 +37,18 @@ This page is divided into three sections. - You can access the files to typeset (manuscript files) and any supplementary files. - Under this, you will find space to upload your completed work and (if required) any source files. -- Metadata - - This is where you will find the metadata for the typesetting task. +- Metadata + This is where you will find the metadata for the typesetting task. -- Complete typesetting - - Under this section, you can leave any notes to the editors. - - This is also where you will mark the assignment as complete to submit the uploaded files. +- Complete typesetting + Under this section, you can leave any notes to the editors. This is also where you will mark the assignment as complete to submit the uploaded files. ## Uploading a typeset file !["The files section of the typesetting page. It shows the ‘Files to typeset’, ‘Upload typeset files’ and ‘Upload source file’ options."](../../support/images/workflow/typesetting-files.png) -Click **Upload a New Typeset File** to upload your completed work. +Click **Upload a new typeset file** to upload your completed work. -Source files (such as Adobe InDesign files) can be uploaded using the **Upload New Source File** button (if required). +Source files (such as Adobe InDesign files) can be uploaded using the **Upload new source file** button (if required). !["The ‘Upload a typeset file’ upload. It provides the options to add a label for the file, toggle whether the file should be publicly available after the article is published, choose a file to upload, and confirm the upload."](../../support/images/workflow/typesetting-upload.png) @@ -57,21 +56,21 @@ In this box, you will find the option to label your file with its file type. For Janeway will attempt to provide an appropriate label if this is left blank. However, if you wish to ensure the label is correct, you can manually enter the file type. For instructions on how to edit a label, see the section below. > [!WARNING] -> Janeway operates with the UTF-8 encoding. Please ensure that you upload any HTML and XML files (plain text galleys) using this encoding. +> Janeway operates with the UTF-8 encoding. Ensure that you upload any HTML and XML files (plain text galleys) using this encoding. ## Editing typeset files and uploading additional files -If you need to make changes to the typeset files, you can reupload them or upload additional files through the **Edit Typeset File** page. This page can be accessed by clicking **Edit**. +If you need to make changes to the typeset files, you can reupload them or upload additional files through the **Edit typeset file** page. This page can be accessed by clicking **Edit**. !["The ‘Upload typeset files’ section, showing two uploaded files. It also displays the figure files’ status: ‘N/A’ for a file with no figure files and ‘Missing figures’ for a file with missing figures."](../../support/images/workflow/typesetting-edit-button.png) !["The ‘Edit typeset file’ page."](../../support/images/workflow/typesetting-filehistory.png) This page is divided into three sections: -- The typeset file - - You can replace the typeset file and see the file history here. +- The typeset file + You can replace the typeset file and see the file history here. -- Typeset file details - - This is where you can edit the file label, which denotes the file type. +- Typeset file details + This is where you can edit the file label, which denotes the file type. - Additional file uploads - If authors or editors have already provided images, you can find and select them here. @@ -93,7 +92,7 @@ When a file typeset in HTML or XML contains image links, Janeway will detect the If the image files have already been uploaded onto Janeway, you can select them instead. -If you need to upload a large number of images, it may be faster to use the zip uploader (click on **Upload Zip File**, highlighted in the image below). To do so, create a ZIP archive file with all the image files. The image filenames must match the links in the typeset file; otherwise, they will not be imported. +If you need to upload a large number of images, it may be faster to use the zip uploader (click on **Upload zip file**, highlighted in the image below). To do so, create a ZIP archive file with all the image files. The image filenames must match the links in the typeset file; otherwise, they will not be imported. ## Styling On this page, you can also upload a CSS file associated with the article for an individual style, if required. We recommend avoiding style changes to the header and footer type elements, as this will affect the page's layout. @@ -101,7 +100,7 @@ On this page, you can also upload a CSS file associated with the article for an You can also select the XSL file used to render the HTML from the file. Unless explicitly instructed otherwise, this will be the Janeway default (1.4.3). In that case, the editors will communicate this as part of the typesetting task or agreement. ### Finishing up -Once you finish the typesetting (or correction) task, you can leave a note for the editor, click the button to complete the task and send it to the editor for review. Please note that you cannot return to this page once you complete the task. +Once you finish the typesetting (or correction) task, you can leave a note for the editor, click the button to complete the task and send it to the editor for review. Note that you cannot return to this page once you complete the task. > [!NOTE] > If you attempt to complete the typesetting task with potential issues remaining (e.g. missing image files, typeset files that have not been corrected), Janeway will warn you about this. @@ -115,14 +114,14 @@ default. Here is an example in JATS XML of an isolated bit of Arabic text in a document that is otherwise left-to-right: -![""](../../support/images/workflow/typesetting-arabic-rtl-jats-xml.png) +![" "](../../support/images/workflow/typesetting-arabic-rtl-jats-xml.png) Make sure you use a text editor that shows zero-width unicode characters, like U-2067. The above screenshot is an XML file opened in VS Code. Here is the rendered output: -![""](../../support/images/workflow/typesetting-arabic-rtl-rendered.png) +![" "](../../support/images/workflow/typesetting-arabic-rtl-rendered.png) Notice the following about the code sample: @@ -156,7 +155,7 @@ In some cases you might need to center-align text: ``` The output is: -![""](../../support/images/workflow/typesetting-text-align-center.png) +![" "](../../support/images/workflow/typesetting-text-align-center.png) This is accomplished with the the [styled-content JATS diff --git a/content/support/identifiers/crossref-article-doi-placeholder.md b/content/support/identifiers/crossref-article-doi-placeholder.md index f3747d9d..564d304f 100644 --- a/content/support/identifiers/crossref-article-doi-placeholder.md +++ b/content/support/identifiers/crossref-article-doi-placeholder.md @@ -1,152 +1,137 @@ title: Crossref article DOI # Crossref article DOI +Janeway can automatically register (also called "mint" or "deposit") Digital Object Identifiers (DOIs) for articles with Crossref, provided the journal’s settings are correctly configured. + +This page explains: +- When DOIs are created and updated +- How to check and manage DOIs using the DOI Manager +- How to interpret DOI registration statuses +- Which Crossref settings are required + ## When are DOIs minted? -If all the settings are properly configured (see below), Janeway handles -DOI registration for you, stepping in at a few key points in the -publishing pipeline. +If Crossref settings are correctly configured, Janeway handles DOI registration automatically at key points in the publishing workflow. + +By default, Janeway registers a DOI with Crossref when an article is accepted for publication. + +After acceptance, the DOI will exist in Crossref’s system. However, the web page it points to may not yet be live if the article has not been published. This is expected and does not indicate a problem. + +Provisional metadata is sent, but no author-identifiable details are shared. + +Later, when the article is scheduled for publication, Janeway sends a deposit to Crossref to update the metadata. -By default, a DOI is registered (a.k.a. minted, deposited) with Crossref -when an article is accepted for publication. Some provisional metadata -is sent at this time (No author-identifiable details are shared). When -an article is scheduled for publication, a new request is sent to -Crossref to update all metadata records. +When the article is published, the DOI becomes a working permalink to the published article. > [!TIP] -> You can let editors see a preview of the data that gets sent before -accepting an article. See **Accept Article Warning** under -Review Settings. +> You can allow editors to preview the data that will be sent to Crossref before accepting an article. +> See **Accept article warning** under **Review settings**. -At this stage, the DOI will be registered with Crossref, but the webpage -it points to on your journal website may not be active yet if the -article isn't published yet. That's normal. +## When manual intervention may be needed -The DOI is deposited with Crossref again when the article is published, -so any metadata updated in the interim will also be updated in -Crossref's metadata feeds. This is also when the DOI starts working as a -permalink, in addition to being a unique identifier. +The automatic workflow may be interrupted in some situations, for example: +- Importing backlist content. +- Missing or incomplete metadata. +- Incorrect Crossref settings. -There are things that might interrupt this default behavior. If you are -importing backlist content, or there's an issue with the Crossref -settings entered, or the required metadata isn't there, you may need to -take a more active role. That's where the DOI Manager comes in. +In these cases, you may need to take action using the **DOI Manager**. + +// ## DOI manager -You can see all the DOIs for a journal (if you are an editor) or for a -press (if you are a staff member) in the DOI Manager. +The **DOI Manager** allows you to view and manage DOI registration statuses. If you are an editor at journal level or if you are a staff member at press level. + +The DOI manager can handle up to 25 articles at a time. If your journal has more than 25 articles in total, use the filter to narrow the list of articles. You can filter by date, registration status, or primary issue until you have an actionable set of articles. -First, filter by date, registration status, or primary issue until you -have an actionable set of articles. +Once you have filtered the list, you can: -At the moment, the DOI Manager can handle small batches, such as 20 -articles, with no problems, but it may not be able to handle larger -batches very well. We will optimize it to handle large batches in the -future. +- **Register DOIs** + Sends the article metadata to Crossref for registration. -In some cases, you can preview the XML that will get sent to Crossref. +- **Poll for status** + Checks the DOI status of Janeway articles. -Once you have filtered the articles to your liking, you can take two -actions: **Register DOIs** and **Poll for status**. **Register DOIs** -will package up all the metadata into XML and send it to Crossref. -Crossref will put all the deposits they receive in a queue to process, -so the status may not be immediate. After a few moments (or longer if it -is a large batch), you can use **Poll for status** to check the result. +Crossref processes deposits in a queue, so status updates may not appear immediately. If you want to check the status of a DOI, you can use **Poll for status**. > [!WARNING] -> **Poll for status** on a large group of articles could take a long time, -so test it out on a smaller group first. +> Using **Poll for status** on a large number of articles could take a long time. You may wish to test a small set first when investigating potential issues. + +In some cases, you can also preview the XML that will be sent to Crossref before registering. ## Interpreting registration status -Unknown -Janeway doesn't know the status. Try **Poll for status**. +Each DOI in the DOI Manager shows a registration status: -Not yet registered -This DOI hasn't been registered yet. You can register it if what you see -in the **DOI** column looks right (including pattern previews). +- Unknown + Janeway doesn't know the status. Try **Poll for status**. -Queued at Crossref -The deposit batch you sent is waiting to be read by the Crossref -servers. +- Not yet registered + This DOI hasn't been registered yet. You can register it if what you see in the **DOI** column looks right (including pattern previews). -Registered -Success! Crossref understood all the metadata you sent and didn't find -any problems with it. +- Queued at Crossref + The deposit has been received by Crossref and is waiting to be processed. -> [!TIP] -> A status of **Registered** does not necessarily mean that the DOI will -resolve correctly, if the URL it points to isn't fully operational yet -on the Janeway side (i.e., the article isn't published). +- Registered + Crossref successfully processed the metadata and didn't find any problems with it. -Registered (but some citations not correctly parsed) -Crossref understood the article-level metadata, but when it went to -process the citations, there were errors. Check the XML in the -**Response** column for details. +> [!TIP] +> A status of **Registered** does not necessarily mean the DOI will resolve correctly if the article is not yet published (or if the URL is not operational for other reasons). -Registered with warning -Crossref understood and registered the DOI, but sent back a warning. -Check the XML in the **Response** column for details. +- Registered (but some citations not correctly parsed) + Article metadata was accepted, but citation parsing errors occurred. Check the XML shown in the **Response** column for details. -Registration failed -Crossref tried to register the DOI but couldn't because of a problem. -Check the XML in the **Response** column for details. +- Registered with warning + The DOI was registered, but Crossref returned a warning. Check the **Response** column for more information. -## Crossref Settings +- Registration failed + Crossref could not register the DOI due to an error. Check the **Response** column to identify the issue. -To edit the Crossref settings, select **Crossref Settings** from the -manager interface. The fields are as follows: +## Crossref settings -Use Crossref DOIs -If disabled, no DOIs will be minted +Crossref settings are configured from the Manager interface under **Crossref settings**. On this page, you will find the following fields used to configure Crossref: -Use Crossref Test Deposit Server -If enabled, DOIs will be minted on Crossref's test system +- Use Crossref DOIs + Enables or disables DOI registration for the journal. If disabled, no DOIs will be minted. -Crossref Username -Your crossref username +Use Crossref test deposit server + Sends DOIs to Crossref’s test system instead of the live system. Useful for testing only. -Crossref Password -Your crossref password +- Crossref username + Your Crossref account username. -Crossref Depositor Email -The email address of the depositor +- Crossref password + Your Crossref account password. -Crossref Depositor Name -The name of the depositor +- Crossref depositor email + The email address of the depositor. -Crossref Prefix -The prefix for your crossref account -- usually 10.XXXX +- Crossref depositor name + The name of the depositor -Crossref Registrant Name -The name of the registrant for this journal on Crossref's system (e.g. -Open Library of Humanities) +- Crossref prefix + Your Crossref prefix, usually in the form `10.xxxx`. -DOI Display Prefix -Text to prepend to DOIs -- used to generate DOI URLs +- Crossref registrant name + The registrant name recorded with Crossref for this journal (for example, "Open Library of Humanities"). -DOI Display Suffix -Text to append to DOIs -- also used to generate DOI URLs +## DOI formatting settings -DOI Pattern -The pattern for auto-generating DOIs. Defaults to using the journal code -and article ID (e.g. `orbit.123`): +- DOI display prefix + Text added before the DOI when generating display URLs. Usually `https://doi.org/`. -> `{% raw %}{{ article.journal.code }}.{{ article.pk }}{% endraw %}` +- DOI display suffix + Text added after the DOI when generating display URLs. Usually left blank. -Title DOI -The DOI (not in URL format) registered for this journal (e.g. -`10.001/my-journal`). It is included on all deposits for this journal. -It must be registered ahead of time. +- DOI pattern + The DOI pattern controls how article DOIs are generated automatically. By default, Janeway uses the journal code and article ID, for example: `orbit.123`. Using the following objects: + > `{% raw %}{{ article.journal.code }}.{{ article.pk }}{% endraw %}` -It is mandatory for a journal to have a DOI registered **only** when an -ISSN is not available for a journal, as Crossref requires at least one -unique identifier for every journal. +- Title DOI + The DOI for the journal itself (not in URL format), for example: `10.001/my-journal`. It is included on all deposits for this journal and, is using, must be registered ahead of time. -However, even if your journal has an ISSN, Crossref still recommends -registering a DOI for your journal. We recommend using your journal code -as the DOI. For example, with the prefix of `10.0001` and the journal -code of `abcd`, you could set the journal DOI to `10.0001/abcd`. +A journal DOI is only mandatory if a journal does *not* have an ISSN, as Crossref requires at least one unique identifier per journal. +However, Crossref recommends registering a journal DOI even when an ISSN exists. We recommend using your journal code +as the DOI. For example, with the prefix of `10.0001` and the journal code `abcd`, you could set the journal DOI to `10.0001/abcd`. \ No newline at end of file diff --git a/content/support/identifiers/crossref-issue-doi-placeholder.md b/content/support/identifiers/crossref-issue-doi-placeholder.md index 7e2b41df..081107dc 100644 --- a/content/support/identifiers/crossref-issue-doi-placeholder.md +++ b/content/support/identifiers/crossref-issue-doi-placeholder.md @@ -1,26 +1,41 @@ title: Crossref issue DOI # Crossref issue DOI -## Issue DOI pattern -Janeway supports minting DOIs for journal issues automatically. With -this setting, you can define the pattern used to generate the -issue-level DOI that will be used for registration. +Janeway supports registering (minting) DOIs for journal issues, in addition to article-level DOIs. Issue DOIs are not registered independently. Instead, they are registered with Crossref when an article in the issue has its article DOI minted. The issue DOI is included in the XML send to Crossref, which will then mint the issue DOI. Only the primary issue to which an article is assigned will have its DOI minted. + +>[!NOTE] +> If an issue contains no articles for which it is the primary issue, its DOI will not be minted. -With the default pattern, an issue with ID `1` (and prefix `10.0001`, -and journal code `abcd`) will have a generated DOI of -`10.0001/abcd.issue.1`. +Issue-level DOIs can be generated automatically using a defined pattern or entered manually on a per-issue basis. -A collection with an ID of `2` would have a generated DOI of -`10.0001/abcd.collection.2`. +This page explains how issue DOIs are generated, when they are registered with Crossref, and important limitations to be aware of. ## Auto-register issue-level DOIs -When enabled, issues will have a DOI assigned and registered as soon as -the first article in the issue is scheduled for publication. If an issue +When **Auto-register issue-level DOIs** is enabled in the **Crossref settings**, Janeway will generate an issue DOI and register it with Crossref. +The issue DOI is registered when the first article in the issue has its article DOI minted or is scheduled for publication (this will depend on what the article has its issue set, for more information see: Crossref article DOIs ). The issue DOI is included in the article’s XML metadata sent to Crossref, and no separate action is required to register it. + +> [!IMPORTANT] +> If auto-registration for issue DOIs is enabled, issue DOIs should not be entered manually. To manually set issue DOIs, you must first disable automatic issue DOI registration. + + + +## Issue DOI pattern + +Janeway can automatically generate issue-level DOIs using a configurable pattern. + +Using the default pattern: +- An issue with ID `1`, journal code `abcd`, and prefix `10.0001` will be assigned the DOI: + `10.0001/abcd.issue.1`. + +- A collection with ID `2` will be assigned the DOI: + `10.0001/abcd.collection.2` -**Taken from issues, currently duplicate:** +This pattern is used only if an issue DOI has not been entered manually. ### Issue DOIs diff --git a/content/support/identifiers/identifiers-index-placeholder.md b/content/support/identifiers/identifiers-index-placeholder.md index 1e020ee6..c29695e5 100644 --- a/content/support/identifiers/identifiers-index-placeholder.md +++ b/content/support/identifiers/identifiers-index-placeholder.md @@ -2,6 +2,9 @@ title: Identifiers # Identifiers +*Coming soon* + diff --git a/content/support/images/activate-account.png b/content/support/images/activate-account.png new file mode 100644 index 00000000..9da573d8 Binary files /dev/null and b/content/support/images/activate-account.png differ diff --git a/content/support/images/active-toggle.png b/content/support/images/active-toggle.png new file mode 100644 index 00000000..94457c20 Binary files /dev/null and b/content/support/images/active-toggle.png differ diff --git a/content/support/images/article-archive-edit-metadata.png b/content/support/images/article-archive-edit-metadata.png new file mode 100644 index 00000000..09daa294 Binary files /dev/null and b/content/support/images/article-archive-edit-metadata.png differ diff --git a/content/support/images/article-identifiers.png b/content/support/images/article-identifiers.png new file mode 100644 index 00000000..59e83cf0 Binary files /dev/null and b/content/support/images/article-identifiers.png differ diff --git a/content/support/images/download-icon.png b/content/support/images/download-icon.png new file mode 100644 index 00000000..428f4a70 Binary files /dev/null and b/content/support/images/download-icon.png differ diff --git a/content/support/images/edit-icon.png b/content/support/images/edit-icon.png new file mode 100644 index 00000000..4af8c8d0 Binary files /dev/null and b/content/support/images/edit-icon.png differ diff --git a/content/support/images/edit-metadata.png b/content/support/images/edit-metadata.png new file mode 100644 index 00000000..e82db500 Binary files /dev/null and b/content/support/images/edit-metadata.png differ diff --git a/content/support/images/edit-user.png b/content/support/images/edit-user.png new file mode 100644 index 00000000..2e8769c3 Binary files /dev/null and b/content/support/images/edit-user.png differ diff --git a/content/support/images/forgotten_password.png b/content/support/images/forgotten-password.png similarity index 100% rename from content/support/images/forgotten_password.png rename to content/support/images/forgotten-password.png diff --git a/content/support/images/journal_users.png b/content/support/images/journal-users.png similarity index 100% rename from content/support/images/journal_users.png rename to content/support/images/journal-users.png diff --git a/content/support/images/logs-edit-metadata.png b/content/support/images/logs-edit-metadata.png new file mode 100644 index 00000000..41dfc186 Binary files /dev/null and b/content/support/images/logs-edit-metadata.png differ diff --git a/content/support/images/merge_users.gif b/content/support/images/merge-users.gif similarity index 100% rename from content/support/images/merge_users.gif rename to content/support/images/merge-users.gif diff --git a/content/support/images/press_all_users.png b/content/support/images/press-all-users.png similarity index 100% rename from content/support/images/press_all_users.png rename to content/support/images/press-all-users.png diff --git a/content/support/images/preview-icon.png b/content/support/images/preview-icon.png new file mode 100644 index 00000000..189f4d01 Binary files /dev/null and b/content/support/images/preview-icon.png differ diff --git a/content/support/images/profile-dropdown.png b/content/support/images/profile-dropdown.png new file mode 100644 index 00000000..3b498ad2 Binary files /dev/null and b/content/support/images/profile-dropdown.png differ diff --git a/content/support/images/repositories/repo-additional-fields.png b/content/support/images/repositories/repo-additional-fields.png new file mode 100644 index 00000000..eff1e240 Binary files /dev/null and b/content/support/images/repositories/repo-additional-fields.png differ diff --git a/content/support/images/repositories/repo-author-dash.png b/content/support/images/repositories/repo-author-dash.png new file mode 100644 index 00000000..8660e4c9 Binary files /dev/null and b/content/support/images/repositories/repo-author-dash.png differ diff --git a/content/support/images/repositories/repo-awaiting-moderation.png b/content/support/images/repositories/repo-awaiting-moderation.png new file mode 100644 index 00000000..32514997 Binary files /dev/null and b/content/support/images/repositories/repo-awaiting-moderation.png differ diff --git a/content/support/images/repositories/repo-edit-dash.png b/content/support/images/repositories/repo-edit-dash.png new file mode 100644 index 00000000..2fce2721 Binary files /dev/null and b/content/support/images/repositories/repo-edit-dash.png differ diff --git a/content/support/images/repositories/repo-licences.png b/content/support/images/repositories/repo-licences.png new file mode 100644 index 00000000..7f312b77 Binary files /dev/null and b/content/support/images/repositories/repo-licences.png differ diff --git a/content/support/images/repositories/repo-manager.png b/content/support/images/repositories/repo-manager.png new file mode 100644 index 00000000..78041b0e Binary files /dev/null and b/content/support/images/repositories/repo-manager.png differ diff --git a/content/support/images/repositories/repo-parent-child-subject.png b/content/support/images/repositories/repo-parent-child-subject.png new file mode 100644 index 00000000..3e2c17ad Binary files /dev/null and b/content/support/images/repositories/repo-parent-child-subject.png differ diff --git a/content/support/images/repositories/repo-preprint-controls.png b/content/support/images/repositories/repo-preprint-controls.png new file mode 100644 index 00000000..f82cbef7 Binary files /dev/null and b/content/support/images/repositories/repo-preprint-controls.png differ diff --git a/content/support/images/repositories/repo-pub-controls.png b/content/support/images/repositories/repo-pub-controls.png new file mode 100644 index 00000000..9f0a9535 Binary files /dev/null and b/content/support/images/repositories/repo-pub-controls.png differ diff --git a/content/support/images/repositories/repo-recommendations.png b/content/support/images/repositories/repo-recommendations.png new file mode 100644 index 00000000..5c8bea63 Binary files /dev/null and b/content/support/images/repositories/repo-recommendations.png differ diff --git a/content/support/images/repositories/repo-settings.png b/content/support/images/repositories/repo-settings.png new file mode 100644 index 00000000..fa5a0178 Binary files /dev/null and b/content/support/images/repositories/repo-settings.png differ diff --git a/content/support/images/repositories/repo-subjects.png b/content/support/images/repositories/repo-subjects.png new file mode 100644 index 00000000..3b3d5f0b Binary files /dev/null and b/content/support/images/repositories/repo-subjects.png differ diff --git a/content/support/images/repositories/repo-submit-author-dash.png b/content/support/images/repositories/repo-submit-author-dash.png new file mode 100644 index 00000000..fbf5e855 Binary files /dev/null and b/content/support/images/repositories/repo-submit-author-dash.png differ diff --git a/content/support/images/repositories/repo-submit-frontend.png b/content/support/images/repositories/repo-submit-frontend.png new file mode 100644 index 00000000..fcd4e41f Binary files /dev/null and b/content/support/images/repositories/repo-submit-frontend.png differ diff --git a/content/support/images/repositories/repo-submit-profile-backend.png b/content/support/images/repositories/repo-submit-profile-backend.png new file mode 100644 index 00000000..fbedf9d2 Binary files /dev/null and b/content/support/images/repositories/repo-submit-profile-backend.png differ diff --git a/content/support/images/repositories/repo-update-article.png b/content/support/images/repositories/repo-update-article.png new file mode 100644 index 00000000..01364caa Binary files /dev/null and b/content/support/images/repositories/repo-update-article.png differ diff --git a/content/support/images/repositories/repo-version-moderation.png b/content/support/images/repositories/repo-version-moderation.png new file mode 100644 index 00000000..12c53198 Binary files /dev/null and b/content/support/images/repositories/repo-version-moderation.png differ diff --git a/content/support/images/repositories/repos-add-new.png b/content/support/images/repositories/repos-add-new.png new file mode 100644 index 00000000..b960363c Binary files /dev/null and b/content/support/images/repositories/repos-add-new.png differ diff --git a/content/support/images/search-inactive.png b/content/support/images/search-inactive.png new file mode 100644 index 00000000..953064e1 Binary files /dev/null and b/content/support/images/search-inactive.png differ diff --git a/content/support/images/update-metadata.png b/content/support/images/update-metadata.png new file mode 100644 index 00000000..372e14a3 Binary files /dev/null and b/content/support/images/update-metadata.png differ diff --git a/content/support/images/upload-icon.png b/content/support/images/upload-icon.png new file mode 100644 index 00000000..6a65e52c Binary files /dev/null and b/content/support/images/upload-icon.png differ diff --git a/content/support/images/workflow/author-article-files.png b/content/support/images/workflow/author-article-files.png index 66d1814f..162b098f 100644 Binary files a/content/support/images/workflow/author-article-files.png and b/content/support/images/workflow/author-article-files.png differ diff --git a/content/support/images/workflow/author-proofing-task.png b/content/support/images/workflow/author-proofing-task.png new file mode 100644 index 00000000..cb8f12f8 Binary files /dev/null and b/content/support/images/workflow/author-proofing-task.png differ diff --git a/content/support/images/workflow/author-proofreading.png b/content/support/images/workflow/author-proofreading.png index b83e99a5..676f0a31 100644 Binary files a/content/support/images/workflow/author-proofreading.png and b/content/support/images/workflow/author-proofreading.png differ diff --git a/content/support/images/workflow/author-submission-navigation.png b/content/support/images/workflow/author-submission-navigation.png index 60e8b637..604cd1c1 100644 Binary files a/content/support/images/workflow/author-submission-navigation.png and b/content/support/images/workflow/author-submission-navigation.png differ diff --git a/content/support/images/workflow/copyedit-complete-kanban.png b/content/support/images/workflow/copyedit-complete-kanban.png index 5a566044..31a673df 100644 Binary files a/content/support/images/workflow/copyedit-complete-kanban.png and b/content/support/images/workflow/copyedit-complete-kanban.png differ diff --git a/content/support/images/workflow/copyedit-page.png b/content/support/images/workflow/copyedit-page.png index 4c25ab2c..ed1eaa6d 100644 Binary files a/content/support/images/workflow/copyedit-page.png and b/content/support/images/workflow/copyedit-page.png differ diff --git a/content/support/images/workflow/copyedit-reopened-kanban.png b/content/support/images/workflow/copyedit-reopened-kanban.png index 41378dc6..3e0fd5e3 100644 Binary files a/content/support/images/workflow/copyedit-reopened-kanban.png and b/content/support/images/workflow/copyedit-reopened-kanban.png differ diff --git a/content/support/images/workflow/copyeditor-dashboard.png b/content/support/images/workflow/copyeditor-dashboard.png index 1ee8ed2d..ec46c7ee 100644 Binary files a/content/support/images/workflow/copyeditor-dashboard.png and b/content/support/images/workflow/copyeditor-dashboard.png differ diff --git a/content/support/images/workflow/copyeditor-requests.png b/content/support/images/workflow/copyeditor-requests.png index ee930b85..738b3e34 100644 Binary files a/content/support/images/workflow/copyeditor-requests.png and b/content/support/images/workflow/copyeditor-requests.png differ diff --git a/content/support/images/workflow/editor-copyedit-add-assignment.png b/content/support/images/workflow/editor-copyedit-add-assignment.png new file mode 100644 index 00000000..a4147a62 Binary files /dev/null and b/content/support/images/workflow/editor-copyedit-add-assignment.png differ diff --git a/content/support/images/workflow/editor-copyedit-review-page.png b/content/support/images/workflow/editor-copyedit-review-page.png new file mode 100644 index 00000000..e41abf3f Binary files /dev/null and b/content/support/images/workflow/editor-copyedit-review-page.png differ diff --git a/content/support/images/workflow/editor-copyedit-review.png b/content/support/images/workflow/editor-copyedit-review.png new file mode 100644 index 00000000..d590c8f5 Binary files /dev/null and b/content/support/images/workflow/editor-copyedit-review.png differ diff --git a/content/support/images/workflow/editor-draft-decision-button.png b/content/support/images/workflow/editor-draft-decision-button.png new file mode 100644 index 00000000..086827c0 Binary files /dev/null and b/content/support/images/workflow/editor-draft-decision-button.png differ diff --git a/content/support/images/workflow/editor-draft-decision-edit.png b/content/support/images/workflow/editor-draft-decision-edit.png new file mode 100644 index 00000000..47c65a29 Binary files /dev/null and b/content/support/images/workflow/editor-draft-decision-edit.png differ diff --git a/content/support/images/workflow/editor-draft-decision-final.png b/content/support/images/workflow/editor-draft-decision-final.png new file mode 100644 index 00000000..a91fa758 Binary files /dev/null and b/content/support/images/workflow/editor-draft-decision-final.png differ diff --git a/content/support/images/workflow/editor-draft-decision-screen.png b/content/support/images/workflow/editor-draft-decision-screen.png new file mode 100644 index 00000000..6fdc9386 Binary files /dev/null and b/content/support/images/workflow/editor-draft-decision-screen.png differ diff --git a/content/support/images/workflow/editor-draft-decision.png b/content/support/images/workflow/editor-draft-decision.png new file mode 100644 index 00000000..0d512d4d Binary files /dev/null and b/content/support/images/workflow/editor-draft-decision.png differ diff --git a/content/support/images/workflow/editor-review-add-reviewer.png b/content/support/images/workflow/editor-review-add-reviewer.png new file mode 100644 index 00000000..2cbf8d40 Binary files /dev/null and b/content/support/images/workflow/editor-review-add-reviewer.png differ diff --git a/content/support/images/workflow/editor-review-answer-visibility.png b/content/support/images/workflow/editor-review-answer-visibility.png new file mode 100644 index 00000000..207a9640 Binary files /dev/null and b/content/support/images/workflow/editor-review-answer-visibility.png differ diff --git a/content/support/images/workflow/editor-review-awaiting-acknowledgement.png b/content/support/images/workflow/editor-review-awaiting-acknowledgement.png new file mode 100644 index 00000000..c8776095 Binary files /dev/null and b/content/support/images/workflow/editor-review-awaiting-acknowledgement.png differ diff --git a/content/support/images/workflow/editor-review-decision-helper-share-reviews.png b/content/support/images/workflow/editor-review-decision-helper-share-reviews.png new file mode 100644 index 00000000..ff256048 Binary files /dev/null and b/content/support/images/workflow/editor-review-decision-helper-share-reviews.png differ diff --git a/content/support/images/workflow/editor-review-decision-helper.png b/content/support/images/workflow/editor-review-decision-helper.png new file mode 100644 index 00000000..a51e26a4 Binary files /dev/null and b/content/support/images/workflow/editor-review-decision-helper.png differ diff --git a/content/support/images/workflow/editor-review-setup.png b/content/support/images/workflow/editor-review-setup.png new file mode 100644 index 00000000..1874db3c Binary files /dev/null and b/content/support/images/workflow/editor-review-setup.png differ diff --git a/content/support/images/workflow/editor-share-review-bulk.png b/content/support/images/workflow/editor-share-review-bulk.png new file mode 100644 index 00000000..ccc0ddd3 Binary files /dev/null and b/content/support/images/workflow/editor-share-review-bulk.png differ diff --git a/content/support/images/workflow/editor-share-review-individual.png b/content/support/images/workflow/editor-share-review-individual.png new file mode 100644 index 00000000..4a525fca Binary files /dev/null and b/content/support/images/workflow/editor-share-review-individual.png differ diff --git a/content/support/images/workflow/editor-share-review.png b/content/support/images/workflow/editor-share-review.png new file mode 100644 index 00000000..2ec8cc0f Binary files /dev/null and b/content/support/images/workflow/editor-share-review.png differ diff --git a/content/support/images/workflow/editor-typesetting-actions.png b/content/support/images/workflow/editor-typesetting-actions.png new file mode 100644 index 00000000..b03ab7bd Binary files /dev/null and b/content/support/images/workflow/editor-typesetting-actions.png differ diff --git a/content/support/images/workflow/editor-typesetting-assign-proofreader.png b/content/support/images/workflow/editor-typesetting-assign-proofreader.png new file mode 100644 index 00000000..7873d185 Binary files /dev/null and b/content/support/images/workflow/editor-typesetting-assign-proofreader.png differ diff --git a/content/support/images/workflow/editor-typesetting-assign-typesetter.png b/content/support/images/workflow/editor-typesetting-assign-typesetter.png new file mode 100644 index 00000000..fce517f3 Binary files /dev/null and b/content/support/images/workflow/editor-typesetting-assign-typesetter.png differ diff --git a/content/support/images/workflow/editor-typesetting-choice.png b/content/support/images/workflow/editor-typesetting-choice.png new file mode 100644 index 00000000..0bddb8f5 Binary files /dev/null and b/content/support/images/workflow/editor-typesetting-choice.png differ diff --git a/content/support/images/workflow/editor-typesetting-edit-galley.png b/content/support/images/workflow/editor-typesetting-edit-galley.png new file mode 100644 index 00000000..7ecb98e9 Binary files /dev/null and b/content/support/images/workflow/editor-typesetting-edit-galley.png differ diff --git a/content/support/images/workflow/editor-typesetting-enroll-proofreader.png b/content/support/images/workflow/editor-typesetting-enroll-proofreader.png new file mode 100644 index 00000000..3c8c12d6 Binary files /dev/null and b/content/support/images/workflow/editor-typesetting-enroll-proofreader.png differ diff --git a/content/support/images/workflow/editor-typesetting-files-blocks.png b/content/support/images/workflow/editor-typesetting-files-blocks.png new file mode 100644 index 00000000..f144b96c Binary files /dev/null and b/content/support/images/workflow/editor-typesetting-files-blocks.png differ diff --git a/content/support/images/workflow/editor-typesetting-galley-buttons.png b/content/support/images/workflow/editor-typesetting-galley-buttons.png new file mode 100644 index 00000000..6a40b590 Binary files /dev/null and b/content/support/images/workflow/editor-typesetting-galley-buttons.png differ diff --git a/content/support/images/workflow/editor-typesetting-imagefiles-image.png b/content/support/images/workflow/editor-typesetting-imagefiles-image.png new file mode 100644 index 00000000..c0aab45c Binary files /dev/null and b/content/support/images/workflow/editor-typesetting-imagefiles-image.png differ diff --git a/content/support/images/workflow/editor-typesetting-imagefiles-zipfile.png b/content/support/images/workflow/editor-typesetting-imagefiles-zipfile.png new file mode 100644 index 00000000..f5b110aa Binary files /dev/null and b/content/support/images/workflow/editor-typesetting-imagefiles-zipfile.png differ diff --git a/content/support/images/workflow/editor-typesetting-options.png b/content/support/images/workflow/editor-typesetting-options.png new file mode 100644 index 00000000..efea820d Binary files /dev/null and b/content/support/images/workflow/editor-typesetting-options.png differ diff --git a/content/support/images/workflow/editor-typesetting-review-typesetting-decision.png b/content/support/images/workflow/editor-typesetting-review-typesetting-decision.png new file mode 100644 index 00000000..52259c99 Binary files /dev/null and b/content/support/images/workflow/editor-typesetting-review-typesetting-decision.png differ diff --git a/content/support/images/workflow/editor-typesetting-review-typesetting.png b/content/support/images/workflow/editor-typesetting-review-typesetting.png new file mode 100644 index 00000000..b10b40c6 Binary files /dev/null and b/content/support/images/workflow/editor-typesetting-review-typesetting.png differ diff --git a/content/support/images/workflow/editor-typesetting-rounds.png b/content/support/images/workflow/editor-typesetting-rounds.png new file mode 100644 index 00000000..a3cb3a22 Binary files /dev/null and b/content/support/images/workflow/editor-typesetting-rounds.png differ diff --git a/content/support/images/workflow/editor-typesetting-upload-new-typeset-file.png b/content/support/images/workflow/editor-typesetting-upload-new-typeset-file.png new file mode 100644 index 00000000..1adead8c Binary files /dev/null and b/content/support/images/workflow/editor-typesetting-upload-new-typeset-file.png differ diff --git a/content/support/images/workflow/reviewer-block.png b/content/support/images/workflow/reviewer-block.png index bf3d2246..820f872a 100644 Binary files a/content/support/images/workflow/reviewer-block.png and b/content/support/images/workflow/reviewer-block.png differ diff --git a/content/support/images/workflow/reviewer-file-upload.png b/content/support/images/workflow/reviewer-file-upload.png index 1dd02175..8008b383 100644 Binary files a/content/support/images/workflow/reviewer-file-upload.png and b/content/support/images/workflow/reviewer-file-upload.png differ diff --git a/content/support/images/workflow/reviewer-kanban.png b/content/support/images/workflow/reviewer-kanban.png index eaadd4d7..a7c3fe7d 100644 Binary files a/content/support/images/workflow/reviewer-kanban.png and b/content/support/images/workflow/reviewer-kanban.png differ diff --git a/content/support/images/workflow/reviewer-review-files.png b/content/support/images/workflow/reviewer-review-files.png index 97ad0aa5..6486e73f 100644 Binary files a/content/support/images/workflow/reviewer-review-files.png and b/content/support/images/workflow/reviewer-review-files.png differ diff --git a/content/support/issues-volumes-and-collections/issues-and-volumes.md b/content/support/issues-volumes-and-collections/issues-and-volumes.md index 56865677..24ad827d 100644 --- a/content/support/issues-volumes-and-collections/issues-and-volumes.md +++ b/content/support/issues-volumes-and-collections/issues-and-volumes.md @@ -2,37 +2,48 @@ title: Issues # Issues -On Janeway, issues organise articles for publication. While articles do not have to be part of an issue, some external services (such as Crossref) require that articles be assigned to an issue. As such, it is recommended to use issues where possible. -If your journal uses continuous publication, it is recommended to create yearly issues to add articles to. +On Janeway, issues organise articles for publication. While articles do not +have to be part of an issue, some external services (such as Crossref) require +that articles be assigned to an issue. As such, we recommend using issues where +possible. If your journal uses continuous publication, we recommend creating +yearly issues to add articles to. -Articles are typically assigned to issues during the **Pre-publication** stage, but can be assigned a projected issue at any point in the publication workflow. Issues can also be managed independently through the **Issue manager**, available from both the **Manager** page and the main sidebar. +Articles are typically assigned to issues during the **Pre-publication** stage, +but can be assigned a projected issue at any point in the publication workflow. +Issues can also be managed independently through the **Issue manager**, +available from both the **Manager** page and the main sidebar. ## Issue types -Janeway provides two built-in issue types : +Janeway provides two built-in issue types: - **Issue** The standard publication issue. - **Collection** - Can be used to group related articles across volumes or years. + Used to group related articles across volumes or years. ## Volumes -Issues will automatically be assigned to a volume. They can either have their own volume or share a volume with other issues (e.g., volume 1 - issue 1, volume 1 - issue 2, etc.). +Issues are automatically assigned to a volume. They can either have their own +volume or share a volume with other issues (for example, Volume 1 - Issue 1, +Volume 1 – Issue 2). -You can use volume 0 for (ongoing) thematic collections - especially those that are not tied to a specific year or publication sequence. Using volume 0 will also ensure they do not interrupt the listings of regular issues on the issue page. +You can use Volume 0 for ongoing thematic collections — especially those that are +not tied to a specific year or publication sequence. Using Volume 0 also ensures +they do not interrupt the listings of regular issues on the issue page. >[!NOTE] >If no volume and issue numbers are specified when importing articles, they will be assigned to volume 0 issue 0. For this reason, it is recommended to avoid using volume 0 issue 0, as this may create duplicates when importing. This in turn can cause problems. ## Issue manager -Articles are typically assigned to issues during the pre-publication stage. However, issues can also be managed independently through the **Issue manager**, accessible from both the manager page and the main sidebar. This page lists all existing issues and provides options for creating, editing, reordering, and managing them. +This page lists all existing issues and provides options for creating, editing, reordering, and managing them. ![The Issue manager page.](/content/support/images/issue-manager.png) -Using this page, you can perform the following general actions: +From this page, you can perform the following actions: + - **Sort by date descending / ascending** - Reorder issues by publication date. Sorting changes the display order of issues on the public site, and changes take effect immediately. + Reorders issues by publication date. Sorting changes the display order of issues on the public site, and changes take effect immediately. - **Edit display settings** Opens configuration options for how issue titles and metadata are displayed. For more information, see [Display settings](#display-settings). @@ -48,7 +59,7 @@ In addition, the issue list is presented in a table format. For each issue, the - **Make current** Sets the selected issue as the journal’s current issue. The current issue does not display this button. -You can also drag and drop issues to manually change their order; the new order updates the public display immediately. You can also view publication data such as volume, issue number, publication date, and number of articles directly from the table. +You can also drag and drop issues to manually change their order; the new order updates the public display immediately. You can view publication data such as volume, issue number, publication date, and number of articles directly from the table. ## Creating and editing issue details diff --git a/content/support/journal-management/cache-temp.md b/content/support/journal-management/cache-temp.md index e84fa152..22d2c4ab 100644 --- a/content/support/journal-management/cache-temp.md +++ b/content/support/journal-management/cache-temp.md @@ -1,7 +1,6 @@ title: Clearing the cache # Clearing the cache -Janeway uses a cache to speed up page loading, you can reset the cache -from the Manager page by clicking the Clear Cache button. +Janeway uses a cache to speed up page loading, you can reset the cache from the Manager page by clicking the **Clear cache** button. - + +If an item does not have a large image: +1. Janeway will use the default large image configured in **Images**. +2. If no default image is configured, the system will fall back to the server default image. + +For best results, ensure items included in the carousel have suitable large images set. See **Image guidelines** for recommendations. + +## Exclude option +The **Exclude** tickbox changes how the selection lists behave. + +- **Disabled (default):** + The selected items are **included** in the carousel. + +- **Enabled:** + The selected items are **excluded** from the carousel. + + + +## Selecting items for the carousel + +When selecting specific content for the carousel, Janeway uses a two-column interface: + +- **Available** (left column) +- **Chosen** (right column) + +To include an item in the carousel, select it in **Available** and click the **right-facing arrow** to move it to **Chosen**. + +To remove an item, select it in **Chosen** and click the **left-facing arrow**. + +Buttons below each column allow you to **Select all** or **Remove all** items. + +![" "](image.png) + +### Articles +Articles can be added automatically or selected manually. + +To show recent articles automatically, enable **Latest articles** and set the **Maximum number of articles** to display. For example, if **Latest articles** is enabled and the maximum is 4, the carousel will display the four most recently published articles. + +If you prefer to curate the carousel manually, move articles from **Available** to **Chosen** using the selection interface. + +### News +Enable **Latest news** to automatically display recent announcements, and set the **Maximum number** of items to include Alternatively, you can manually select specific news items using the selector interface described above. + +### Issues and collections +Issues and collections behave the same as articles and news in the carousel. However, instead of the option to show multiple recent issues, is has the option to enable **Current issue** to display the issue currently marked as current. + +>[!TIP] +> If changes are not appearing on the homepage, trying clearing the cache. + +## Image contrast and carousel overlays + +In the carousel, Janeway will display a low-opacity grey overlay on top of the image. This is used to improve the contrast between the image and the text displayed over it (such as the article or news title). + +As a result, the image may appear darker than the original file and/or less vivid than expected. This does _not_ necessarily mean there is a problem with the uploaded image, but may cause issues if you have a strict housestyle. + +### Removing the overlay + +The overlay can be changed or removed through CSS styling (see Custom styling ). However, this should only be done with care. + +> [!WARNING] +> Before removing or reducing the overlay, make sure the text remains clearly readable against the image. + +By default, carousel text is white, so removing the overlay may make text difficult to read if the image is pale, bright, or low-contrast. + +If you are using custom text colours or disable the overlay, make sure there is still sufficient contrast between the text and the background image. + +### Good practice + +- Keep the overlay if your carousel images vary in brightness. +- Test carousel slides with both light and dark images. +- Avoid using very pale or very busy images behind text unless you have checked accessibility impact. +- If editing the CSS, review the carousel on mobile as well as desktop. \ No newline at end of file diff --git a/content/support/journal-management/cms.md b/content/support/journal-management/cms.md index 257cccb2..989297cb 100644 --- a/content/support/journal-management/cms.md +++ b/content/support/journal-management/cms.md @@ -1,37 +1,44 @@ title: Janeway content manager # Janeway content manager -The Content Manager is Janeway's CMS. Pages can be created and edited using our rich text editor. +The **Content manager** provides access to Janeway’s built-in content management system (CMS). It allows you to create and edit static pages for your journal, such as privacy notices, policies, or "About" pages, using a rich-text editor. - + -## Add a New Page +## Add a new page -To add a new page to your journal select "+ Add New Page" and fill in the fields as detailed in the text beneath each field. +To add a new page to your journal website, click **+ Add new page** and fill in the fields as detailed in their helptexts. + +For information on embedding media files within a page, see Media files . -The URL for the page will be generated with these parts: +Pages are immediately public after saving them. -- Your journal's domain name (e.g. orbit.openlibhums.org) -- The path element “site” (a namespace for custom pages) -- The path you entered in the **Link** field. +### Page URLs -An example: +When you create a new page, Janeway automatically generates its URL using the following parts: - - +- Your journal’s domain name (for example, `orbit.openlibhums.org`). +- The path element `/site/`, which is used as a namespace for custom pages. +- The value entered in the **Link** field. -## Edit a Page +An example: `https://orbit.openlibhums.org/site/privacy` -From the Content page you can see a list of the pages currently on your journal. Select Edit to make changes. +For information on adding new pages to your site navigation, see **Navigation**. + -###Delete a Page +## Edit a page -To delete a page use the red Delete button. +The content manager displays a list of all custom pages currently available on your journal. Click **Edit** to make changes. -> [!WARNING] -> Data cannot be recovered so ensure you really want to remove a page before pressing the delete button. +Changes take effect immediately once saved. If you do not see them displayed on the journal page, you may need to refresh your cache. + +You can see a page's editing history by clicking **View history** at the bottom of the edit page. - - +### Delete a page + +To delete a page use the **Delete** button, on the content manager page. + +> [!WARNING] +> Deleted pages cannot be recovered. Make sure you no longer need the page before deleting it. \ No newline at end of file diff --git a/content/support/journal-management/editorial-team.md b/content/support/journal-management/editorial-team.md index cbdafcb6..eac931c6 100644 --- a/content/support/journal-management/editorial-team.md +++ b/content/support/journal-management/editorial-team.md @@ -1,52 +1,71 @@ title: Editorial team # Editorial team - - +The Editorial team interface allows you to create and manage the groups displayed on your journal’s **Editorial team** page. It is accessed from the **Manager dashboard**, under **Content**. -The Editorial Team interface is relatively complex and is made up of: +On this page you can: +- Add and delete editorial groups. +- Edit groups' details and manage members. +- Configure the display name for the editorial team page. +- Configure settings related to the display of editorial groups. -- Editorial Groups -- Editorial Group Members +There is no limit on the number of editorial groups you can create or how many members they can contain. + +Adding someone to an editorial group does not assign them the editor role and it does not affect the permissions given to a user. Editorial groups are used for display purposes only. -You can create as many groups as you like and add as many members as you like. + -When you access the interface the form for making a new group is displayed on the right of the page and the existing groups listed on the left. For each group you can: +## Creating a new group -- Edit the membership -- Edit the group details -- Delete the group -- Drag and drop to re-order them +Creating a new group allows you to add members and display them on the Editorial Team page. Each group is headed by the group name you supply. - +- Name + The group name, e.g. "Editorial team" or "Advisors". -> [!TIP] -> The Group description field supports HTML and presents a rich-text editor. If you do not wish to add an account for each user you can simply list them in the rich text box using, for example, a bulleted list. +- Description + Displayed under the group name on the editorial team page. This field supports rich text and can be used to add additional information about the group. -## Adding a New Group +- Sequence + Controls the order in which groups appear on the page. You can reorder the groups by editing their sequence number or by dragging and dropping them in the list. -Creating a new group allows you to add members and display them on the Editorial Team page. Each group is headed by the group name you supply. +## Editing a group -- Name - - The group name, e.g. Editorial Team or Advisors. +To edit an existing group, click the **Edit members** button. -- Description - - Displayed under the Name header on the Editorial Team page. + -- Sequence - - The order in which the groups should be displayed. You can reorder the groups by editing their sequence or by dragging and dropping their record. +On the left-hand side, you will see a list of current group members. From here you can: -## Adding Members to a Group +- Remove a member from the group. +- Reorder members using drag and drop. -For an existing or newly created group you can use the Edit Members button (Green with a group of outlines) to change the membership of the group. +To add someone to an editorial team, they need to have a Janeway account. A list of available journal users will be visible on the right-hand side of the page. You can search this list and use the **Add** button to include a user in the group. - +If someone does not have an account yet, you can either invite them to create an account or create one on their behalf by clicking **Add new user**. + +If you are setting up a group where multiple users do not have accounts yet, you may wish to use the editorial team import process instead. This process allows you to create editorial groups where the members do not yet have accounts. + +Alternatively, if you do not want to create a Janeway account for every individual, you can list names directly in the **Group description** box. This field supports HTML and uses a rich-text editor, so you ccould list the editors using formatted text (for example, a bulleted list). + +## Editorial group display settings + +The following settings control how editorial groups and members are displayed on the editorial team page. + +- Editorial group page name + The display name of the page that lists your editorial groups. + +- Hide editorial group names + When enabled, group names are not shown on the editorial team page. -On the left is a list of the current members, you can: +- Enable multi-page editorial team display + When enabled, each editorial group is displayed on its own page. This setting is overwitten by **Enable editorial team display**. -- Delete a member from the group -- Reorder the members by dragging and dropping a listing + >[!NOTE] + > **Enable editorial team display** is found in **All settings** and determines whether the editorial team page is available as a default option for the navbar (which presumes a single page for the editorial team). -Journal users are listed on the right and you can add a user to the group using the *Add* button. If a user account does not exist for the user you can use the *Add New User* button to add them. + +- Display Country on Editorial Team Page + When enabled, and where a group member has set a country on their user profile, the country will be displayed next to their name. + If no country is set, nothing is shown. + --> \ No newline at end of file diff --git a/content/support/journal-management/form-elements.md b/content/support/journal-management/form-elements.md index f88a8300..ddb0e6d8 100644 --- a/content/support/journal-management/form-elements.md +++ b/content/support/journal-management/form-elements.md @@ -4,54 +4,61 @@ Custom forms in Janeway have the following aspects to them yada yada. -- Name - - This field provides the name of the submission element - In case of a short question, you could put a question in this field. If using a longer question, you may wish to use a more generic description and provide further guidance in the help text. +- Name + This field provides the name of the element. + In case of a short question, you could put a question in this field. If using a longer question, you may wish to use a more generic description and provide further guidance in the help text. -- Kind - - blabla kinds yada yada I am so tired besties. +- Kind + This determines the type of element, e.g., text field, checkbox, dropdown etc. For an overview of element types available, see Element types - Required - - Check this setting’s box to make this part of the form obligatory to complete. + Check this setting’s box to make this part of the form obligatory to complete. - Order - - This determines the order of elements on the submission form. + This determines the order of elements on the form. - Help text - - This text will display under the submission element and can provide further guidance or information for authors. + This text will display under the form element and can provide further guidance or information for authors. -- Default visibility - - If enabled, this element will be visible to the author by default once the editor has shared the review with them. If disabled, the author will not see this element unless the editor overrides it. +- Default visibility (review forms only) + If this box is ticked, the answer to this form element will be visible to the author by default once the editor has shared the review with them. If disabled, the author will not see this element unless the editor overrides it. ## Element types (kind) -A submission form element can be one of the following kinds: -- Text field - - This is a single-line input area for short text answers such as names, keywords or subjects. It does not allow for formatting. -![Example text field](../../support/images/element-text-field.png) +A form element can be one of the following kinds: +- Text field + This is a single-line input area for short text answers such as names, keywords or subjects. It does not allow for formatting. + + ![Example text field](../../support/images/element-text-field.png) -- Text area - - This is a larger, multi-line input area for longer texts such as comments and descriptions. It allows for formatting and line breaks. -![Example text area](../../support/images/element-text-area.png) +- Text area + This is a larger, multi-line input area for longer texts such as comments and descriptions. It allows for formatting and line breaks. -- Checkbox - - This element asks users to check a box, which can be used to declare no competing interests / agree to terms, for example. -![Example checkbox](../../support/images/element-check-box.png) + ![Example text area](../../support/images/element-text-area.png) -- Select (dropdown) - - Shows a predefined list of options, allowing users to select one. You will need to create the options. This is done through the ‘Choices’ field. The options should be separated by the bar " | " character, e.g. " choice 1|choice 2|choice 2 ". -![Example dropdown](../../support/images/element-select.png) +- Checkbox + This element asks users to check a box, which can be used to declare no competing interests / agree to terms, for example. -- Email - - Specific text field for emails. It checks if the input looks like an email address. / follows the format of an email address. - ![Example email field](../../support/images/element-email.png) + ![Example checkbox](../../support/images/element-check-box.png) + +- Select (dropdown) + Shows a predefined list of options, allowing users to select one. You will need to create the options. This is done through the ‘Choices’ field. The options should be separated by the bar " | " character, e.g. " choice 1|choice 2|choice 2 ". + + ![Example dropdown](../../support/images/element-select.png) + +- Email + Specific text field for emails. It checks if the input looks like an email address. / follows the format of an email address. + + ![Example email field](../../support/images/element-email.png) + +- Upload + Asks the users to upload a file from their device. -- Upload - - Asks the users to upload a file from their device. ![Example upload field](../../support/images/element-file-upload.png) -- Date - -Asks the user to provide a date. - ![Example date field](../../support/images/element-date.png) +- Date + Asks the user to provide a date. + + ![Example date field](../../support/images/element-date.png) > [!NOTE] -> When using an element kind other than 'Select', you can ignore the ‘Choices’ field. +> When using an element kind other than 'Select', you can ignore the 'Choices' field. \ No newline at end of file diff --git a/content/support/journal-management/homepage-layout.md b/content/support/journal-management/homepage-layout.md index 383f06ec..8f2a9a95 100644 --- a/content/support/journal-management/homepage-layout.md +++ b/content/support/journal-management/homepage-layout.md @@ -1,34 +1,46 @@ title: Homepage customisation # Homepage customisation -Here, you can activate features for your journal home page. +The Hhmepage customisation settings allow you to control which features appear on your journal’s home page and how they are displayed. + +From this page, you can: + +- Enable or disable homepage features. +- Configure the content of each feature. +- Change the order in which features appear. -To add a homepage element, select **Add** under **Add Home Page Features** and then select **Configure** to view its options. You can also reorder elements by dragging and dropping them. +## Adding and managing homepage features + +To add a homepage element, select **Add** next to the feature you want to add. Once it has been added, click **Configure** to view its options. You can reorder elements by dragging and dropping them. To delete a homepage element, click the **Delete** icon. + +Any changes take effect immediately, if you do not see them you may need to clear your cache. + +## Homepage features - About - - Displays the journal description. If you edit the description here, it will also change in the other places it appears. + Displays the journal description. If you edit the description here, it will also change in the other places it appears. - Carousel - - A rotating banner that can be configured to display one of the following: - - Latest articles - - Latest news - - A combination of both + A rotating banner that can be configured to display one of the following: + - Latest articles. + - Latest news. + - A combination of both. -You can select the number of items to display and the items you want to include or exclude. +You can select the number of items to display and the items you want to include or exclude. For more information, see carousel configuration. -- Current Issue - - Takes whichever issue is marked as current and displays its table of contents on the home page. To learn how to select a current issue, check the issue page. +- Current issue + Takes whichever issue is marked as current and displays its table of contents on the home page. To learn how to select a current issue, check the issue page. -- Featured Articles - - This option allows you to select a series of articles to display on the homepage. The selected articles are displayed in a grid, cascading onto a new line every three articles. +- Featured articles + This option allows you to select a series of articles to display on the homepage. The selected articles are displayed in a grid, cascading onto a new line every three articles. - HTML - - A generic segment that you can customize according to your needs. It can hold text and more complex HTML, such as a social media feed. + A generic segment that you can customize according to your needs. It can hold text and more complex HTML, such as a social media feed. - News - - Displays a list of the most recent news items. You can configure the number of items to display (the default is 5). + Displays a list of the most recent news items. You can configure the number of items to display (the default is 5). -- Popular Articles - - Displays the most-accessed articles. You can configure the number of items and how recent the articles should be. +- Popular articles + Displays the most-accessed articles. You can configure the number of items and how recent the articles should be. diff --git a/content/support/journal-management/journal-contacts.md b/content/support/journal-management/journal-contacts.md index a9f5c636..91526a03 100644 --- a/content/support/journal-management/journal-contacts.md +++ b/content/support/journal-management/journal-contacts.md @@ -4,16 +4,17 @@ title: Journal contacts You can control the contacts listing for your journal by adding and removing contacts through this interface. Only three fields are used for this: - Name - - The contact's name. + The contact's name. - Email - - The email address that should be contacted. + The email address that should be contacted. - Role - - The contact's role, e.g. editor or reviewer. + The contact's role, e.g. editor or reviewer. -Each outgoing message is recorded in the database and can be viewed in the admin area by staff. + ![Contact Manager interface. The sort handles indicate you can drag and drop to re-order your contacts.](contact-manager.png) - - +Any contacts added will be contactable through a webform, but no email address will be displayed. Each incoming message sent through the contact form is recorded in the database and can be viewed in the admin area by staff. + +Contacts will also be listed on the contacts page, displaying a name and role. Any information added to the contacts field in general settings (such as a physical address) will also be added in this column. \ No newline at end of file diff --git a/content/support/journal-management/journal-management-index-placeholder.md b/content/support/journal-management/journal-management-index-placeholder.md index 08efc5bf..fc6d67c5 100644 --- a/content/support/journal-management/journal-management-index-placeholder.md +++ b/content/support/journal-management/journal-management-index-placeholder.md @@ -1,2 +1,64 @@ title: Journal management # Journal management + +This section brings together the tools and settings used to manage your journal’s website, content, and configuration in Janeway. + +From here you can customise the appearance of your journal site, manage editorial information, create pages and news items, and adjust system settings. + +Most of these tools are available from the Manager dashboard under **Content** or **Journal settings**. + +## Website content and pages +These interfaces help you create and maintain the content that appears on your journal website, such as information pages, navigation links, and downloadable files. + + +* Content manager + Create and edit static pages for your journal, such as About, Policies, or Privacy notices, using Janeway’s built-in content management system. + +* News manager + Create and publish news items on your journal website. News items can appear on the homepage or in the carousel. + +* Media files + Upload files such as author guidelines, templates, or other downloadable documents and embed links to them within your pages. + +* Navigation + Configure the journal’s navigation bar, including enabling built-in pages and creating custom navigation links. + +* Managing rich-text fields + Learn how Janeway’s rich-text editor works and how to avoid formatting issues when copying and pasting text from other applications. + +## Homepage customisation +These settings control how your journal’s homepage elements are displayed. + +* Homepage elements + Configure homepage features such as the carousel, featured articles, popular articles, and other homepage components. + +* Carousel configuration + Additional guidance for configuring homepage carousel elements and troubleshooting common issues. + +* Journal images + Guidance on uploading and formatting images used across the journal website, including logos, cover images, and article images. See also: Image guidelines. + +## Editorial and contact information +Use these interfaces to manage the people and contact details displayed on your journal website. + +* Editorial team + Create and manage editorial groups displayed on the Editorial team page, such as editors, advisory board members, or reviewers. + +* Journal contacts + Add and manage contacts that appear on the journal’s Contact page and receive messages through the contact form. + +## Journal configuration and integration + +* Journal settings + Set key journal details, configure email settings, and adjust various display and integration settings. + +* Image guidelines + Guidance on how and where images appear on the journal site, and image size guidelines. + +* Similarity checker + Configure the Crossref Similarity Check (iThenticate) integration for checking submitted manuscripts. + +* Clearing the cache + If recent changes are not appearing on your journal website, you may need to clear the system cache to refresh stored data. + + \ No newline at end of file diff --git a/content/support/journal-management/journal-settings.md b/content/support/journal-management/journal-settings.md index a2895b05..49a0c467 100644 --- a/content/support/journal-management/journal-settings.md +++ b/content/support/journal-management/journal-settings.md @@ -6,13 +6,13 @@ In journal settings, you can set basic information about the journal, configure If you have the Janeway role of editor or staff, you can access Journal Settings by selecting **Manager** under **Staff**. -## All Settings +## All settings The All Settings page lists every underlying journal-level setting within Janeway and allows you to edit them. The setting groups are: - Crossref - Email -- Email Subject +- Email subject - General - Identifiers - Preprints diff --git a/content/support/journal-management/media-files.md b/content/support/journal-management/media-files.md index 5384f350..d10db4d1 100644 --- a/content/support/journal-management/media-files.md +++ b/content/support/journal-management/media-files.md @@ -1,16 +1,16 @@ title: Media files # Media files -The Media Files manager lets editors upload and host small files. +The Media files manager lets editors upload and host small files, which can then have download links embedded within a page. Examples include: -- Author Guidelines -- Proofing Guidelines -- Article Submission Templates +- Author guidelines +- Proofing guidelines +- Article submission templates Once a file is uploaded a link is provided that you can then insert into CMS pages or templates. > [!NOTE] -> The Media Files section should not be used to upload videos unless you have sufficient storage space/bandwidth. If you use Janeway Hosting you should contact the support team. +> The **Media files** should not be used to upload videos unless you have sufficient storage space/bandwidth. If you use Janeway hosting you should contact the support team. diff --git a/content/support/journal-management/navigation.md b/content/support/journal-management/navigation.md index 8c3ac6ab..dad02090 100644 --- a/content/support/journal-management/navigation.md +++ b/content/support/journal-management/navigation.md @@ -1,62 +1,61 @@ title: Navigation # Navigation -The nav bar is made up of two kinds of items: +A journal's navigation bar (navbar) is customised through the **Content manager**. -- Fixed nav elements that you can turn on or off -- Custom nav items that you can create and modify +The navbar is made up of two types of items: +- Fixed navigation elements that you can turn enable/disable. +- Custom navigation items that you create yourself. -Fixed nav elements include: +Fixed navigation elements include: - Home - News - Articles - Issues - Collections -- Editorial Team +- Editorial team - Submissions - Contact -- Start Submission -- Become a Reviewer +- Start submission +- Become a reviewer -To add a new custom nav item, from the content manager page, select -"Edit Nav" and fill in the fields as desired. Details of how each field -works are displayed below the field. +The default nav consists of a selection of enabled fixed navigation elements. - - -## Footer Navigation - -With some themes, you can put a navigation link in the footer rather -than the top navigation bar. - -Use **For footer** to switch the link to the footer. At the press level, -only the path theme support this feature so far. +![" "](../images/default-nav.png) - +To turn a fixed item on or off, click the **Enable** or **Disable** button next to it. The order of the fixed navigation elements cannot be edited directly. To see how to change the order of fixed navigation elements, see the section on **Modifying the navbar** following this section. -Press managers can also create custom footer links that extend to all -journal websites, such as for publisher policies. +## Modifying the navbar -To do so, create a navigation item and check **Is external**, **For -footer**, and **Extend to journals**. +To add new, custom nav items or change the order of fixed nav items, click **Modify nav**. - +This interface has multiple fields: +- Display name + The page title as it will display in the navigation bar. + +- Link + For internal pages hosted on Janeway, compare the URL of your home page with the URL of the page you wish to link to. Copy anything that comes after the main home page URL here. For page options which are provided by Janeway, this will likely be "/page-name" or "journalcode/page-name" (e.g. "/articles" or "journalcode/articles"). For custom pages you have created, this will likely be "/site/page-name" or "journalcode/site/page-name". + + For external pages, this will be the full URL of the site or page you want to link to. + If you want to create a header for a dropdown on your navigation bar that doesn't also appear as a link in that dropdown, leave this field blank. -## Styling +- Is external + Tick this box if you want to link to an external web page. + +- Sequence + This controls the order in which custom items on your navigation bar appear in relation to one another. + +- Has subnavigation + Tick this box if you want to create a drop-down in your navigation bar from this item. + +- Top-level nav item + If you want this link to fall under an existing drop-down in your navigation bar, select which one it should fall under. -This page displays some general settings for controlling the styling of -your journal. - -- Full Width Nav (only used by the Material theme) - - -No longer on this page: -- Display Editorial Team Images -- Enable Multi Page Editorial Team (splits the editorial team into pages - by Group) - --> +The built-in page options provided by Janeway cannot be reordered directly. To reorder these pages, use 'Create a new nav item' to create a more customisable link to that page, following the same steps as you would for adding other pages to your nav bar, and disable the Janeway default version." + - +For footer navigation, see footer navigation . This is only available at press level/ diff --git a/content/support/journal-management/news-manager.md b/content/support/journal-management/news-manager.md index 419115c3..c99d6e4b 100644 --- a/content/support/journal-management/news-manager.md +++ b/content/support/journal-management/news-manager.md @@ -5,34 +5,34 @@ The news manager allows you to create news items, assign them start- and end dat News items can also displayed in the carousel. -To add a new news item, select the *News Manager*. The interface displays existing news items on the left and a form for adding new items on the right. +To add a new news item, select the **News manager**. The interface displays existing news items on the left and a form for adding new items on the right. The form fields include: -- Title - - The title of the news item. +- Title + The title of the news item. -- Body - - The HTML body of the news item. +- Body + The HTML body of the news item. -- Start display - - The date to start displaying this news item. +- Start display + The date to start displaying this news item. - End display - - The date to stop displaying this news item (can be left blank to display indefinitely). + The date to stop displaying this news item (can be left blank to display indefinitely). - Sequence - - Use for sorting when news items are posted on the same day. + Use for sorting when news items are posted on the same day. - Image file - - An image file to fit the news piece; ensure you have the right to post it. + An image file to fit the news piece; ensure you have the right to post it. -- Custom Byline - - Lets you overwrite the name displayed as the author of the news item. +- Custom byline + Lets you overwrite the name displayed as the author of the news item. - Tags - - A series of tags/keywords for the piece, you can filter news items by tags. + A series of tags/keywords for the piece, you can filter news items by tags. diff --git a/content/support/journal-management/similarity-check.md b/content/support/journal-management/similarity-check.md index 1584e51e..10f71cf4 100644 --- a/content/support/journal-management/similarity-check.md +++ b/content/support/journal-management/similarity-check.md @@ -8,13 +8,13 @@ Janeway supports Crosscheck (also called Similarity Check), which is provided by The settings are: - Enable - - Enables display for Crosscheck buttons +Enables display for Crosscheck buttons - Username - - Your iThenticate service username +Your iThenticate service username - Password - - Your iThenticate service password +Your iThenticate service password More info on Crosscheck/Similarity Check: diff --git a/content/support/journal-management/themes-placeholder.md b/content/support/journal-management/themes-placeholder.md deleted file mode 100644 index 61628110..00000000 --- a/content/support/journal-management/themes-placeholder.md +++ /dev/null @@ -1,43 +0,0 @@ -title: Design themes on Janeway - -# Design themes on Janeway - -Janeway has three available themes that determine the appearance of a journal and its layout. These themes are Clean, Material and OLH. -Themes are based on different styling frameworks - -OLH foundation -Material - Google materialize -Clean - Bootstrap - -Same core feature set, provide the same content. - -Clean is the most differnet from the two - thinner viewport and less prominent images. Clean doesnt display images on the issue page. - -## Clean -* Currently most accessible. -* Minimalistic, less images. - -Examples: - -[Political Philosophy](https://politicalphilosophyjournal.org/) -[Free and Equal](https://freeandequaljournal.org/) - - -Screenshots: - -## Material -Examples: -[The Comics Grid](https://www.comicsgrid.com/) -[Theory and Social Inquiry](https://www.theoryandsocialinquiry.org/) - - -Screenshots - -## OLH -Examples: -[G+C](https://www.genealogy-critique.net/) -[JSCDM](https://www.jscdm.org/) -[ing.grid](https://www.inggrid.org/) -- Note: Quite a lot of customisation! - -Screenshots diff --git a/content/support/plugins/adverts.md b/content/support/plugins/adverts.md index ac1f0539..fec212e1 100644 --- a/content/support/plugins/adverts.md +++ b/content/support/plugins/adverts.md @@ -3,7 +3,7 @@ title: Adverts on Janeway It is possible to show basic adverts on Janeway, this can be (done next to articles (left and right margin)). -This plugin is not currently active and requires further development. If you are a hosted client and wish to show basic adverts on Janeway, please contact Support. +This plugin is not currently active and requires further development. If you are a hosted client and wish to show basic adverts on Janeway, contact Support. Recommended image dimensions : diff --git a/content/support/plugins/books.md b/content/support/plugins/books.md index 95310282..21ea23e1 100644 --- a/content/support/plugins/books.md +++ b/content/support/plugins/books.md @@ -339,7 +339,7 @@ Books import headers specific browser-editor combinations are used. We are investigating this. If the file is not properly read upon upload, you may also wish to try a regular .csv file (not UTF-8 encoded). If you still encounter an -error, please contact Support. +error, contact Support. Once the import file has successfully been uploaded, the imported books will show on the main dashboard. You can now click on these to upload diff --git a/content/support/plugins/pandoc-placeholder.md b/content/support/plugins/pandoc-placeholder.md index f6bc8a78..bf239510 100644 --- a/content/support/plugins/pandoc-placeholder.md +++ b/content/support/plugins/pandoc-placeholder.md @@ -3,6 +3,6 @@ title: Pandoc conversion This Janeway plugin provides a button for typesetters to automatically generate HTML files from user article submissions in DOCX or RTF. These files are first converted to markdown, then to HTML, and then registered as galleys of the original article. -You must have pandoc installed on your server to use this plugin. Please see pandoc's installation documentation __[here](https://pandoc.org/installing.html)__. +You must have pandoc installed on your server to use this plugin. See pandoc's installation documentation __[here](https://pandoc.org/installing.html)__. [GitHub Repo](https://github.com/openlibhums/pandoc_plugin) diff --git a/content/support/press-management/all-users-placeholder.md b/content/support/press-management/all-users-placeholder.md index 7d38fbe4..7106bd98 100644 --- a/content/support/press-management/all-users-placeholder.md +++ b/content/support/press-management/all-users-placeholder.md @@ -5,7 +5,7 @@ title: Managing users at press level From the **Press manager** you can manage users across all journals through the **All users** interface. You can filter users by whether they are active, are staff, their role(s), and their journal(s). -You can easily see what roles and permissions any given user has across all journals. You can remove or grant additional roles and/or permissions for multiple journals without needing to go into each journal or the admin area. For each user, there is also a link available to view their history, edit their profile or 'control' the user. +You can see what roles and permissions any given user has across all journals. You can remove or grant additional roles and/or permissions for multiple journals without needing to go into each journal or the admin area. For each user, there is also a link available to view their history, edit their profile or 'control' the user. >[!NOTE] >Explain what controlling a user is. diff --git a/content/support/press-management/footer.md b/content/support/press-management/footer.md index 046d079b..ff1db05c 100644 --- a/content/support/press-management/footer.md +++ b/content/support/press-management/footer.md @@ -1,9 +1,9 @@ title: Journal footer # Journal footer -As a press manager, you can control some of the elements that appear in the website footer of every journal. +As a press manager, you can control some of the elements that appear in the footer of every journal website. -Some journal indexers require a postal address to be displayed on every journal website. You can add this kind of information with **Edit Press Details** \> **Journal footer text**. +Some journal indexers require a postal address to be displayed on every journal website. You can add a postal address and similar contact information by clicking **Edit press details** and then editing the **Journal footer text** setting. @@ -11,4 +11,10 @@ Some journal indexers require a postal address to be displayed on every journal -You can also add custom links to the footer, such as to publisher policies, using the Content Manager at the press level. +## Footer navigation + +You can also create footer navigation that extends to all journals. This feature is currently only supported in path mode (where journals are served from a shared press domain, such as `www.pressdomain.com/journal`), as opposed to domain mode (where each journal has its own domain, such as `www.journal.com`). This can be used for things such as links to publisher policies. To do this, create a navigation item and check the **Is external**, **For footer**, and **Extend to journals** boxes. + + + + \ No newline at end of file diff --git a/content/support/press-management/press-doi-manager.md b/content/support/press-management/press-doi-manager.md index bb88d2e3..bd5b57b3 100644 --- a/content/support/press-management/press-doi-manager.md +++ b/content/support/press-management/press-doi-manager.md @@ -2,6 +2,8 @@ title: DOI management - press level # DOI management - press level +*Work in progress* + ## Settings CrossRef settings can be set at press level (and then overridden at journal level). **All settings** -> search. Search for either "crossref" or "identifiers" (the setting groupname) should surface most of them. diff --git a/content/support/press-management/press-management-placeholder.md b/content/support/press-management/press-management-placeholder.md index 843cd84d..983333a9 100644 --- a/content/support/press-management/press-management-placeholder.md +++ b/content/support/press-management/press-management-placeholder.md @@ -2,12 +2,15 @@ title: Press management # Press management +*Coming soon* + + + diff --git a/content/support/repository/repo-setup-placeholder.md b/content/support/repository/repo-setup-placeholder.md deleted file mode 100644 index f3a5d05b..00000000 --- a/content/support/repository/repo-setup-placeholder.md +++ /dev/null @@ -1,17 +0,0 @@ -title: Setting up a repository with Janeway - -# Setting up a repository with Janeway - -## About Janeway repositories -Janeway supports hosting repositories for preprints, postprints, field reports, and other publication types within the same press environment as journals. - - -## Getting started -The first step is to enable the repository system in the press-level -settings: - -1. Go to the **Press Manager** -2. Open **Edit Press Details** -3. Turn on **Enable repository system** and save - - diff --git a/content/support/repository/repositories-index-placeholder.md b/content/support/repository/repositories-index-placeholder.md index 325a2f0e..55f1294a 100644 --- a/content/support/repository/repositories-index-placeholder.md +++ b/content/support/repository/repositories-index-placeholder.md @@ -1,2 +1,31 @@ -title: Repositories on Janeway -# Repositories on Janeway +title: Janeway repositories +# Janeway repositories + +Janeway supports hosting repositories for preprints, postprints, field reports, and other publication types within the same press environment as journals. Repository managers can configure and moderate repositories from the Repository Manager. + +## For repository managers + +### [Setting up a repository](repositories-setup-placeholder.md) + +How to enable the repository system in your Janeway press and create a new repository. Covers the Press manager settings required before a repository can be configured. + +### [Repository settings](repositories-settings.md) + +A guide to the five-step repository setup wizard, used for both configuring a new repository and editing the settings of an existing one. Also covers additional configuration options, including licenses, subjects, submission fields, and review recommendations. + +### [Moderator guide](repositories-moderator.md) + +How to manage published and unpublished preprints from the Repository Manager. Covers reviewing and accepting submissions, moderating new versions, and handling review comments. + +### Linking a repository and journal + *Coming soon* + +### Other settings + +*Content coming soon.* + +## For authors + +### [Submitting to a Janeway repository](repositories-submission.md) + +How to submit a preprint to a Janeway repository, including the three submission entry points available in the system. Also covers how to update an existing submission, manage supplementary files, and track the status of pending changes \ No newline at end of file diff --git a/content/support/repository/repositories-moderator.md b/content/support/repository/repositories-moderator.md new file mode 100644 index 00000000..c2c50785 --- /dev/null +++ b/content/support/repository/repositories-moderator.md @@ -0,0 +1,55 @@ +title: Moderator guide + +# Moderator guide + +As a moderator you can find (un)published preprints and preprint stats in the Repository manager, accessible from the left navigation menu. + +!["The repository manager."](../images/repositories/repo-manager.png) + +## Published preprints + +Click the title of a preprint to go to the preprint dashboard. Here, you can view the preprint's metadata, (supplementary) files, versions, and the control panel. + +### Controls + +* Edit metadata +* Contact the owner + Lets you contact the primary author of the preprint by email. You can include attachments and BCC other recipients. +* Log + Opens a log of all emails sent from the system about this preprint. +* Comments + Displays comments made on the published preprint. From here, you can review, publish, and delete them. + +* Invited review comments + From here, you can invite reviews, see active reviews, and see declined and withdrawn reviews. To send a review invitation, the recipient must first be added as a reviewer — either through **Manage reviewers** on the Repository Manager page, or by clicking **Manage reviewers** on the review invitation screen. +* Discussion + Lets you view and comment on internal discussion threads, and open new ones. +* Edit published date +* Un-published this article +* Send to journal + Lets you send the preprint to a journal on the Janeway press. Select the license, section (article type), and the stage to send it to. + +## Unpublished preprints + +Similar to published preprints, click the title of an unpublished preprint in the Repository Manager to go to the preprint page. On this page, you can review the (supplementary) files and metadata. + +If the preprint is suitable after initial review, click **Create a version with this file**. After this, you can invite reviewers and take other actions to process the preprint. To reject the preprint, select **Reject article** in the control panel. An email prompt opens, where you can explain your decision to the authors. When the preprint is ready for publication, click **Accept article** in the control panel and set a publication date. + +### Controls + +!["Preprint controls."](../images/repositories/repo-preprint-controls.png) + +Similar to published preprints, the control panel displays the preprint's status and primary identifier, and presents various options. These are the same as those for published preprints, except that **Edit published date** and **Unpublish this article** are replaced with **Accept article** and **Reject article**. + +## Moderating new versions + +On the Repository manager, in the Stats block, click **Versions awaiting moderation**. + +![" "](../images/repositories/repo-awaiting-moderation.png) + +This displays a list of all versions awaiting moderation and their request type. +Click **View detail** to review the version. Then click **Accept** or **Decline** to record your decision. + +![" "](../images/repositories/repo-version-moderation.png) + +## Handling review comments \ No newline at end of file diff --git a/content/support/repository/repositories-settings.md b/content/support/repository/repositories-settings.md new file mode 100644 index 00000000..5fc6d13c --- /dev/null +++ b/content/support/repository/repositories-settings.md @@ -0,0 +1,53 @@ +title: Repository settings + +# Repository settings + +Clicking**Repository settings** opens the repository setup wizard, which is used for both configuring a new repository and editing the settings of an existing one. + +The wizard has five steps: +1. **Repository details 1** + Key repository details, such as the name, custom domain, and the name of the objects in the repository (for example, "article" or "preprint"). Help text is available on the page. + +2. **Repository details 2** + Provides more detailed repository information, including the repository description and images, and review guidance for users. + +3. **Submission details** + Text shown to users on the submission page, and settings related to review. + +4. **Email templates** + Displays the email templates available on the repository. For more + information on editing email templates and email template variables, + see Email templates. + +## Licenses + +!["The repository licenses page."](../images/repositories/repo-licences.png) + +This page lets you choose which licenses are made available for preprints in this repository. The available licenses are all of those made available on the Janeway press, which is why you may see duplicates. + +## Subjects + +!["The repository subjects page."](../images/repositories/repo-subjects.png) + +This page lets you set the subjects that preprints can fall into. These can be organised hierarchically, with child subjects; for example, "Biology" and "Marine biology". Subjects are grouped together, with the parent subject listed first. + +![" "](../images/repositories/repo-parent-child-subject.png) + +You can also select editors who should be notified of submissions made to this subject. + +## Additional submission fields + +!["Repository additional fields pages."](../images/repositories/repo-additional-fields.png) + +You can set up additional, custom submission fields for your repository on this page. + +## Recommendations + +!["The recommendations page."](../images/repositories/repo-recommendations.png) + +You can create, edit, and delete review recommendations for your repository using the interface here. diff --git a/content/support/repository/repositories-setup-placeholder.md b/content/support/repository/repositories-setup-placeholder.md new file mode 100644 index 00000000..18bef7ad --- /dev/null +++ b/content/support/repository/repositories-setup-placeholder.md @@ -0,0 +1,40 @@ +title: Setting up a repository with Janeway + +# Setting up a repository with Janeway + +## About Janeway repositories +Janeway supports hosting repositories for preprints, postprints, field reports, and other publication types within the same press environment as journals. + + +## Navigating the Janeway repositories + +### Repository manager + +You can view unpublished preprints, preprint stats and published preprints. + +### Preprint stats + +- High-level stats overview +- From here you can navigate to rejected preprints, versions awaiting moderation, orphaned preprints, and the reviewer management page. + +## Getting started +The first step is to enable the repository system in the press-level +settings: + +1. Go to the **Press manager**. +2. Open **Edit press details**. +3. Tick the **Enable repository system** box and click **Save**. +4. Return to the **Press manager**. +5. The **Add a new repository** option appears below the list of journals. + Click it. +![" "](../images/repositories/repos-add-new.png) +6. This opens the repository set-up wizard. See Repository settings for more information diff --git a/content/support/review/review-settings.md b/content/support/review/review-settings.md index 3b19455a..e41ccce0 100644 --- a/content/support/review/review-settings.md +++ b/content/support/review/review-settings.md @@ -5,39 +5,39 @@ Review settings can be found under **Review** on the manager dashboard. ![" "](../../support/images/manager-review-settings.png) -Review settings control how peer review operates. The settings found in this section are the following: +Review settings control how the peer review process operates. The settings found in this section are the following: - Review guidelines - - A set of generic review guidelines that a reviewer should follow. + A set of generic review guidelines that a reviewer should follow. - Default review visibility - - Janeway provides three options for the default review visibility: open, single or double anonymous review. If open, authors can see reviewers and vice versa; if single anonymous reviewers can see authors, if double anonymous, neither can see information on the other. The editor must ensure the manuscript files are sufficiently anonymised when using double anonymous review. To configure triple anonymous review, consult the following page. + Janeway provides three options for the default review visibility: open, single-anonymous, or double-anonymous. If open is chosen, authors can see reviewers and vice versa. If a single anonymous is chosen, reviewers can see the authors' names. If double anonymous is chosen, neither can see information of the other. The editor must ensure the manuscript files are sufficiently anonymised when using double-anonymous review. To configure triple anonymous review, consult the following page. - Default review days - - This setting configures the default number of days a reviewer is given to complete a review. This number is then used to control reminders. This field is set to 56 days (8 weeks) initially. The due date can be changed when assigning a review. + This setting configures the default number of days a reviewer is given to complete a review. This number is then used to control reminders. This field is set to 56 days (8 weeks) initially. The due date can be changed when assigning a review. -- One-click access - - When enabled, a unique access token is added to the reviewer link in the assignment email, allowing the reviewer to view the review without needing to log into the system. After the review is completed, the token is removed to prevent reuse. These tokens are Universally Unique Identifiers (UUID4s), which ensures the link sent to reviewers is unique. +- One-click access + When enabled, a unique access token is added to the reviewer link in the assignment email, allowing the reviewer to view the review without needing to log into the system. After the review is completed, the token is removed to prevent reuse. These tokens are Universally Unique Identifiers (UUID4s), which ensures the link sent to reviewers is unique. - Draft decisions - - If enabled, section editors cannot accept papers after review. Instead, they can make recommendations to editors. + If enabled, section editors cannot accept papers after review. Instead, they can make recommendations to editors. - Enable open peer review - - Turns on the open peer review feature. + Turns on the open peer review feature. - Default review form - - This setting controls the default review form displayed when assigning a reviewer. + This setting controls the default review form displayed when assigning a reviewer. - Reviewer form download - - If enabled, reviewers can download a copy of the review form to complete offline. + If enabled, reviewers can download a copy of the review form to complete offline. - Enable save review progress - - If enabled, reviewers can save the progress in a peer-review assignment and return to complete it later. We recommend only using this when working with particularly long review forms. + If enabled, reviewers can save the progress in a peer-review assignment and return to complete it later. We recommend only using this when working with particularly long review forms. - Accept article warning - - This is a block of text displayed to the editor before they accept an article, prompting initial DOI and metadata registration with Crossref if the journal or press is set to use Crossref. You can use the setting to provide a readout of current metadata so the editor can check what will be sent to Crossref. + This is a block of text displayed to the editor before they accept an article, prompting initial DOI and metadata registration with Crossref if the journal or press is set to use Crossref. You can use the setting to provide a readout of current metadata so the editor can check what will be sent to Crossref. -- Enable expanded review details - - When this setting is enabled, the editor's review dashboard will show all active reviews. Otherwise, it will show a count of completed reviews. +- Enable expanded review details + When this setting is enabled, the editor's review dashboard will show all active reviews. Otherwise, it will show a count of completed reviews. diff --git a/content/support/review/sharing-review.md b/content/support/review/sharing-review.md index 9f1dc95a..edf36790 100644 --- a/content/support/review/sharing-review.md +++ b/content/support/review/sharing-review.md @@ -6,30 +6,30 @@ Completed peer reviews can be shared with authors and between reviewers, both wi ## Sharing reviews with authors Janeway has various controls for how review data is shared with authors. All of these are off by default. These settings are found on the **Review settings** page under the **Author review display** header. These settings are: -- Hide review data from authors before release - - When this setting is enabled, authors will see no information about active peer reviews until the editor makes them available. Otherwise, they can see whether there are reviews in progress and their due dates. +- Hide review data from authors before release + When this setting is enabled, authors will see no information about active peer reviews until the editor makes them available. Otherwise, they can see whether there are reviews in progress and their due dates. -- Enable peer review data on the author page - - When this setting is enabled, the dates for when this review was requested, when it was due and when it was completed will be displayed on the review page along with the content of the peer review. As with the review contents, this information will only appear once the review has been completed and the editor makes it available. +- Enable peer review data on the author page + When this setting is enabled, the dates for when this review was requested, when it was due and when it was completed will be displayed on the review page along with the content of the peer review. As with the review contents, this information will only appear once the review has been completed and the editor makes it available. -- Enable peer review data on review pages - - When this setting is enabled, authors will have access to more information on the review page than just the content of the peer reviews (date the review was requested, date it was due and date it was completed). The data will be displayed on the review page, which is only available after review and once the editor makes it available. +- Enable peer review data on review pages + When this setting is enabled, authors will have access to more information on the review page than just the content of the peer reviews, including the date the review was requested, the date it was due and date it was completed. The data will be displayed on the review page, which is only available after review and once the editor makes it available. ## Sharing reviews between reviewers Editors have two options to share reviews with other peer reviewers. On the **Review settings** page, under the **Sharing peer reviews** header, there are four settings which control how editors can share peer reviews. -- Enable share reviews decision - - This setting needs to be turned on to enable the sharing of reviews between reviewers. It adds the option to share reviews to the decision helper. +- Enable share reviews decision + This setting needs to be turned on to enable the sharing of reviews between reviewers. It adds the option to share reviews to the decision helper. -- Display completed reviews in the review interface - - This setting enables the sharing of reviews between rounds, giving reviewers access to completed reviews from previous rounds. +- Display completed reviews in the review interface + This setting enables the sharing of reviews between rounds, giving reviewers access to completed reviews from previous rounds. -- Display completed reviews in the review interface text - - This text is displayed to reviewers when **Display completed reviews in the review interface** is enabled. It can be used to explain to reviewers why they have access to the reviews and what they have access to. +- Display completed reviews in the review interface text + This text is displayed to reviewers when **Display completed reviews in the review interface** is enabled. It can be used to explain to reviewers why they have access to the reviews and what they have access to. -- Automatically share author response letters - - When this setting is enabled, author response letters (provided when doing revisions) will also be made available to reviewers as a part of sharing peer reviews. +- Automatically share author response letters + When this setting is enabled, author response letters (provided when doing revisions) will also be made available to reviewers as a part of sharing peer reviews. ### Sharing reviews through the decision helper By enabling review sharing in the decision list, editors can send an email to everyone who has completed a review for a given article, including a link to view all completed reviews for that article. Reviews that are incomplete or have no decision are excluded from being shared. diff --git a/content/support/review/triple-anonymous-peer-review.md b/content/support/review/triple-anonymous-peer-review.md index f1365690..3c78f669 100644 --- a/content/support/review/triple-anonymous-peer-review.md +++ b/content/support/review/triple-anonymous-peer-review.md @@ -1,32 +1,30 @@ Title: Triple anonymous peer review # Triple anonymous peer review -In addition to open, single and double anonymous review, Janeway provides the option to use triple anonymous peer review. When this is enabled, authors, reviewers, and editors are all anonymised until the review stage is complete. This review option is, however, slightly more complex than other forms of review. +In addition to open, single and double anonymous review, Janeway provides the option to use triple anonymous peer review. When this is enabled, authors, reviewers, and editors are all anonymised until the review stage is complete. This review process is slightly more complex than other forms of anonymous review. -Using triple anonymous review requires at least one member of the journal team to have non-anonymised access to screen articles at the submission stage. This editor will also need to act as a journal manager. The editors who require anonymised access to the submission need to be given the section editor role. These editors will not have full journal management permission, as this would inherently provide access to author data. +Using triple anonymous review requires at least one member of the journal team to have non-anonymised access to screen articles at the submission stage. This editor will also need to act as a journal manager. The editors who require anonymised access to the submission need to be given the section editor role. These editors will not have full journal management permissions, as this would provide access to author data. ## Key settings for triple anonymous peer review -Two settings must be configured for triple anonymous peer review to work: the personally identifiable information filter and the reply-to address. +Two settings must be configured for triple anonymous peer review to work: the personally identifiable information filter and the reply-to address. These settings are accessible through the **All settings** page. -- Section editor personally identifiable information filter (se_pii_filter) - - Turning on this setting means that all relevant author data will be anonymised for section editors when they are accessing Janeway. This enables them to access the review stage without encountering the author’s personal details. + +- Section editor personally identifiable information filter (se_pii_filter) + Turning on this setting means that all relevant author data will be anonymised for section editors when they are accessing Janeway. This enables them to access the review stage without encountering the author’s personal details. -![" "](../../support/images/see-filter.png) + !["All settings page with the Section editor personally identifiable information filter."](../../support/images/see-filter.png) -- Reply-to address (replyto_address) - - In order to make triple anonymous review possible, author email addresses need to be hidden. Janeway masks these email addresses with your journal’s reply-to address, which you will need to fill in here. +- Reply-to address (replyto_address) + In order to make triple anonymous review possible, author email addresses need to be hidden. Janeway masks these email addresses with your journal’s reply-to address, which you will need to fill in here. -![" "](../../support/images/reply-to.png) + !["All settings page with the reply-to address setting."](../../support/images/reply-to.png) >[!NOTE] > Be sure to check that this is correctly formatted as a valid email address, as an incorrect one will mean author email addresses will be displayed and the review will no longer be anonymous. - -These settings are accessible through the **All settings** page. - ## Triple anonymous peer review in practice -To make triple anonymous peer review possible, the main journal editor must first check a manuscript and ensure that the author cannot be identified through any of its contents, including the file information. If there are any identifying elements, it is this editor's responsibility to remove or redact them. +To make triple anonymous peer review possible, the main journal editor must first check a manuscript and ensure that the author cannot be identified through any of its contents, including the file information. If there are any identifying elements, it is this editor's responsibility to remove or redact them. Once a file has been fully anonymised, the journal editor can assign it to a section editor. The section editor can now manage the peer review process as they normally would. @@ -36,13 +34,13 @@ On Janeway, where a section editor would usually see the author’s personal det Janeway applies anonymisation to the following areas: - Dashboards – this is applied not only on the main dashboard, but also on the kanban view and active submissions section. -- Unassigned. +- Unassigned. - Review – the **Document manager** section will be disabled for section editors so that they cannot view any author details which might be stored there. - View metadata – section editors can view an anonymised version of the metadata, but are blocked from editing it to ensure that they have no access to author information. -- Article log. +- Article log. - Email templates – this allows section editors to send decision letters (e.g. revision requests, acceptances or rejections) without seeing author details. diff --git a/content/support/submission/article-licence-manager.md b/content/support/submission/article-licence-manager.md index 67c2d4a0..1635b1dd 100644 --- a/content/support/submission/article-licence-manager.md +++ b/content/support/submission/article-licence-manager.md @@ -1,29 +1,29 @@ title: Licence manager # Licence manager -![](../../support/images/manager-licence-manager.png) - The licence manager allows you to define the licenses available for submission to your journal. By default, Janeway provides all the CC 4.0 licences and an All Rights Reserved licence. You can edit the list to fit your journal's needs. +![" The manager dashboard with the License manager button highlighted."](../../support/images/manager-licence-manager.png) + Each licence has the following configurable properties: - Name - - Full name, e.g. Creative Commons Attribution 4.0. + Full name, e.g. Creative Commons Attribution 4.0. - Short name - - A shortened name, e.g. CC BY 4.0. + A shortened name, e.g. CC BY 4.0. - URL - - A URL to a description of the licence. + A URL to a description of the licence. - Text - - The text of the licence. + The text of the licence. - Order - - The order in which the licence should appear can be set here or changed via drag and dropping the licences. + The order in which the licence should appear can be set here or changed via drag and dropping the licences. - Available for submission - - If checked, this licence will be available for selection during submission. + If checked, this licence will be available for selection during submission. ![Licence Manager](../../support/images/licence-manager.png) diff --git a/content/support/submission/submission-index-placeholder.md b/content/support/submission/submission-index-placeholder.md deleted file mode 100644 index 817171f0..00000000 --- a/content/support/submission/submission-index-placeholder.md +++ /dev/null @@ -1,21 +0,0 @@ -title: Managing submissions on Janeway -# Managing submissions on Janeway - -There are multiple aspects to managing submissions on Janeway. The two key parts are the submission information page and the submission process. The submission page displays information for potential authors on the journal website. The submission process is where authors submit their manuscript and provide information about the submission. Certain fields, such as the copyright notice, publication fees and submission checklist, appear on both (by default). The textboxes for these are crosslinked; this ensures the information provided to authors regarding submission remains consistent regardless of where it is presented to them. - -![" "](../../support/images/manager-submission.png) - -- The submission page items -This configures the text on the submission page, visible at `[yourjournalwebsite]/submissions`. - -- Submission settings -This configures the submission process itself and how it functions. From here, you can also disable submissions. - -- Submission fields configurator -This configures the submission fields used during the submission process. Any unchecked fields will not be presented during the submission process. If you do not enable the license, language and section (article type) fields, you must set a default value for these. This will set these fields to the default provided in the article metadata. If no default is provided and the field is disabled, the information will not be present in the article metadata. - -- Additional submission fields -If you require any additional submission fields as part of the submission process, you can set them up through this page. - -Other relevant settings you may wish to configure related to submissions are the license manager , which configures the licenses available for your journal, and sections , which set the article types available for the journal and submission. - diff --git a/content/support/submission/submission-index.md b/content/support/submission/submission-index.md new file mode 100644 index 00000000..d646f921 --- /dev/null +++ b/content/support/submission/submission-index.md @@ -0,0 +1,21 @@ +title: Managing submissions on Janeway + +# Managing submissions on Janeway + +There are multiple aspects to managing submissions on Janeway. The two key parts are the submission information page and the submission process. The submission page displays information for potential authors on the journal website. The submission process is where authors submit their manuscript and provide information about the submission. Certain fields, such as the copyright notice, publication fees and submission checklist, appear by default on both. The textboxes for these fields are crosslinked; this ensures the information provided to authors regarding submission remains consistent regardless of where it is presented. + +!["The manager dashboard with the submission relevant blocks highlighted"](../../support/images/manager-submission.png) + +- The submission page items + This configures the text on the submission page, visible at `[yourjournalwebsite]/submissions`. + +- Submission settings + This configures the submission process itself and how it functions. From here, you can also disable submissions. + +- Submission fields configurator + This configures the submission fields used during the submission process. Any unchecked fields will not be presented during the submission process. If you do not enable the license, language and section (article type) fields, you must set a default value for these. This will set these fields to the default provided in the article metadata. If no default is provided and the field is disabled, the information will not be present in the article metadata. + +- Additional submission fields + If you require any additional submission fields as part of the submission process, you can set them up through this page. + +Other relevant settings you may configure related to submissions are the **License manager** , which configures the licenses available for your journal, and **Sections** , which sets the article types available for the journal and submissions. diff --git a/content/support/submission/submission-notifications-placeholder.md b/content/support/submission/submission-notifications.md similarity index 92% rename from content/support/submission/submission-notifications-placeholder.md rename to content/support/submission/submission-notifications.md index 214f6ff0..68d5eb3a 100644 --- a/content/support/submission/submission-notifications-placeholder.md +++ b/content/support/submission/submission-notifications.md @@ -2,7 +2,7 @@ title: Submission notifications # Submission notifications -Janeway allows editors and section editors to be notified when authors create submissions. It is possible to configure this by submission section (e.g. notifying book review editors only for submissions in the book review section) or by individual editors. If no editors are selected to receive submission notifications, all editors will receive notifications. This excludes section editors, they will always need to be manually assigned to relevant sections or will receive no submission notifications. +Janeway allows editors and section editors to be notified when authors create submissions. It is possible to configure this by submission section (e.g. notifying book review editors only for submissions in the book review section) or by individual editors. If no editors are selected to receive submission notifications, all editors will receive notifications. This excludes section editors, as they will will receive no submission notifications if not manually assigned to relevant sections. diff --git a/content/support/submission/submission-settings-placeholder.md b/content/support/submission/submission-settings-placeholder.md deleted file mode 100644 index b80a286a..00000000 --- a/content/support/submission/submission-settings-placeholder.md +++ /dev/null @@ -1,104 +0,0 @@ -Title: Submission settings -# Submission settings - -The submission settings are accessed through the manager dashboard under **Submission** and clicking **Submission settings**. From here, you can configure the submission process, text blocks which overlap with the submission page and submission notifications. - -![" "](../../support/images/manager-submission-settings.png) - -**Submission settings** provides access to three general blocks of settings: - -- Submission control - - This block controls settings relating to whether submission is turned on or off. - -- Editors notified on submission - - This controls who is notified of new submissions. - -- System settings - - This controls a small set of settings related to authors and abstracts. - -- Submission page text - - This controls the text that makes up the submission page - e.g. focus and scope, copyright notice, acceptance criteria, etc. - -- Submission files - - This controls settings around the manuscript files. - - - -## Submission control - -The settings found here are: - -- **Disable journal submission** and **Disabled submission message** - - Checking this box closes submission for the journal. Unchecking it reopens submissions. The textbox allows you to display a message to users when submissions are disabled. - -You can also limit access to submission by requiring users to create an account before being allowed to submit an article. When a user without an account attempts to submit, they will be directed to a page where they can create a new account. - -- Limit access to submission and submission access request text - - Checking this box limits access to submission to registered users. The textbox allows you to display a message to users requesting submission access. - -- Submission access request contact - - This sets the address to whom submission access requests should be sent. - -## Editors notified on submission -- Editors notified on submission - - This allows you to select which – if any – editors are notified of new papers being submitted. - -- Hide assigned editor details - - This prevents the assigned editor from being visible to the author. This does not prevent editors from identifying themselves when, for example, rejecting an article if using an account with their name associated or through email signatures. - -## System settings - -- Abstracts are required - - If this box is checked, all submissions will require an abstract. - -- Enable correspondence authors - - If this is checked, an author can be marked as the correspondence author. - -- User automatically author - - If this is enabled, Janeway assumes the user submitting the paper is its author and automatically fills in their details. They can be removed as the author if required. - -- Non-specialist summary - - If enabled, submitters will be asked to provide a brief, non-technical lay summary of their paper. - -- Copyright submission label - - This label appears on the **Submission** page and this setting allows you to customise the copyright text. For example: "Author(s) agree to the copyright notice, which will apply to this submission if accepted." - -## Submission page text -These settings make up the **Submission** page as well as the **Submission agreement** that authors accept. The submission text can also be edited through **Submission page items** . - -- Submission page text - - This sets the introductory text displayed at the head of the **Submission** page. - -- Focus and scope - - Here you can outline the focus and scope of your journal. - -- Submission checklist - - This is typically a numerical, step-by-step list of things that an author should check or do before submitting their paper. You can make this list as detailed as you need it to be. - -- Copyright notice - - This is where you can provide the information on copyright, licenses used for publishing, and rights retained. - -- Publication fees - - If there are any fees associated with submitting or publishing the paper, these should be outlined here. If there are no publication fees for an author to pay, you can also use this space to say so. - -- Publication cycle - - This is where you describe the journal’s publication schedule, such as whether you publish continuously or at specific points and whether submissions are open only at specific points. - -- Peer review information - - This section allows you to provide information on how peer review is conducted and the steps involved. - -- Acceptance criteria - - Here is where you outline the criteria which your journal uses to evaluate its papers. - -## Submission files -- File submission guidelines - - This describes what files you expect at the time of submission. - -- Manuscript file submission instructions - - Here, you can provide specific instructions for uploading and submitting manuscripts, which will appear on the manuscript upload pop-up. - -- Limit manuscript types - - If you enable this setting, only DOC, DOCX, RTF and ODT files will be accepted as manuscript files during submission. - -- Data and figure file submission instructions - - Here, you can provide specific instructions for uploading and submitting figures and data files, which will appear on the figure and data upload pop-up. diff --git a/content/support/submission/submission-settings.md b/content/support/submission/submission-settings.md new file mode 100644 index 00000000..736830d0 --- /dev/null +++ b/content/support/submission/submission-settings.md @@ -0,0 +1,105 @@ +Title: Submission settings +# Submission settings + +The submission settings are accessed through the manager dashboard under **Submission** and clicking **Submission settings**. From here, you can configure the submission process, the text blocks which overlap with the submission page and the submission notifications. + +!["The manager dashboard with submission settings highlighted."](../../support/images/manager-submission-settings.png) + +**Submission settings** provides access to three general blocks of settings: + +- Submission control + This block controls settings relating to whether submission is turned on or off. + +- Editors notified on submission + This controls who is notified of new submissions. + +- System settings + This controls a small set of settings related to authors and abstracts. + +- Submission page text + This controls the text that makes up the submission page - e.g. focus and scope, copyright notice, acceptance criteria, etc. + +- Submission files + This controls settings around the manuscript files. + + + +## Submission control + +The settings found here are: + +- Disable journal submission and Disabled submission message + Checking this box closes submissions for the journal. Unchecking it reopens submissions. The textbox allows you to display a message to users when submissions are disabled. + +You can also limit access to submission by requiring users to create an account before being allowed to submit an article. When a user without an account attempts to submit, they will be directed to a page where they can create a new account. + +- Limit access to submission and submission access request text + Checking this box limits access to submissions to registered users only. The textbox allows you to display a message to users requesting submission access. + +- Submission access request contact + This sets the address to whom submission access requests should be sent. + +## Editors notified on submission +- Editors notified on submission + This allows you to select which, if any, editors are notified of new papers being submitted. + +- Hide assigned editor details + This prevents the assigned editor from being visible to the author. This does not prevent editors from identifying themselves when, for example, rejecting an article if using an account with their name associated or through email signatures. + +## System settings + +- Abstracts are required + If this box is checked, all submissions will require an abstract. + +- Enable correspondence authors + If this is checked, an author can be marked as the correspondence author. + +- User automatically author + If this is enabled, Janeway assumes the user submitting the paper is its author and automatically fills in their details. They can be removed as the author if required. + +- Non-specialist summary + If enabled, submitters will be asked to provide a brief, non-technical lay summary of their paper. + +- Copyright submission label + This label appears on the **Submission** page and this setting allows you to customise the copyright text. For example: "Author(s) agree to the copyright notice, which will apply to this submission if accepted." + +## Submission page text +These settings make up the **Submission** page as well as the **Submission agreement** that authors accept. The submission text can also be edited through **Submission page items** . + +- Submission page text + This sets the introductory text displayed at the head of the **Submission** page. + +- Focus and scope + Here you can outline the focus and scope of your journal. + +- Submission checklist + This is typically a numerical, step-by-step list of things that an author should check or do before submitting their paper. You can make this list as detailed as you need it to be. + +- Copyright notice + This is where you can provide the information on copyright, licenses used for publishing, and rights retained. + +- Publication fees + If there are any fees associated with submitting or publishing the paper, these should be outlined here. If there are no publication fees for an author to pay, you can also use this space to say so. + +- Publication cycle + This is where you describe the journal’s publication schedule, such as whether you publish continuously or at specific points and whether submissions are open only at specific points. + +- Peer review information + This section allows you to provide information on how peer review is conducted and the steps involved. + +- Acceptance criteria + Here is where you outline the criteria which your journal uses to evaluate its papers. + +## Submission files + +- File submission guidelines + This describes what files you expect at the time of submission. + +- Manuscript file submission instructions + Here, you can provide specific instructions for uploading and submitting manuscripts, which will appear on the manuscript upload pop-up. + +- Limit manuscript types + If you enable this setting, only DOC, DOCX, RTF and ODT files will be accepted as manuscript files during submission. + +- Data and figure file submission instructions + Here, you can provide specific instructions for uploading and submitting figures and data files, which will appear on the figure and data upload pop-up.