diff --git a/.github/workflows/pelican.yml b/.github/workflows/pelican.yml index 751b3d68..92e878d0 100644 --- a/.github/workflows/pelican.yml +++ b/.github/workflows/pelican.yml @@ -1,7 +1,7 @@ name: Deploy to GitHub Pages on: push: - branches: ["main"] + branches: ["main", "b-support-site-mvp"] workflow_dispatch: permissions: contents: read diff --git a/.github/workflows/playwright.yml b/.github/workflows/playwright.yml index fd2092cc..84ec87a0 100644 --- a/.github/workflows/playwright.yml +++ b/.github/workflows/playwright.yml @@ -22,7 +22,7 @@ jobs: - name: Ensure browsers are installed run: python -m playwright install --with-deps - name: Run your tests - run: pytest + run: pytest --failed-first - uses: actions/upload-artifact@v4 if: ${{ !cancelled() }} with: diff --git a/README.md b/README.md index 53fa8e69..50913bc2 100644 --- a/README.md +++ b/README.md @@ -74,9 +74,6 @@ Documentation authors are asked to place all content in `/content/support/`, using GitHub-flavored Markdown and including images in `/content/support/images/`. -Pelican interprets these pages as “articles,” so minimal requirements about -having a `Title` in the YAML metadata apply. - If they are editing on GitHub.com, they can make commits on the perpetual `copyediting` branch, or if they are working locally, they should open a dedicated feature branch. They may often need help with pull requests and diff --git a/content/old-docs/changelog.md b/content/old-docs/changelog.md index 5ff70ca5..6f983c37 100644 --- a/content/old-docs/changelog.md +++ b/content/old-docs/changelog.md @@ -1,5 +1,3 @@ -Title: Changelog - # Changelog Release notes have moved to diff --git a/content/old-docs/dev/api.md b/content/old-docs/dev/api.md index 00f4a4da..61a41711 100644 --- a/content/old-docs/dev/api.md +++ b/content/old-docs/dev/api.md @@ -1,5 +1,3 @@ -Title: API - # API API stands for Application programming interface. APIs are designed to diff --git a/content/old-docs/dev/configuration.md b/content/old-docs/dev/configuration.md index 25639fa0..56358081 100644 --- a/content/old-docs/dev/configuration.md +++ b/content/old-docs/dev/configuration.md @@ -1,5 +1,3 @@ -Title: Technical Configuration - # Technical Configuration This section will discuss the technical configuration of Janeway diff --git a/content/old-docs/dev/installation.md b/content/old-docs/dev/installation.md index 25d5db0c..4db103a9 100644 --- a/content/old-docs/dev/installation.md +++ b/content/old-docs/dev/installation.md @@ -1,5 +1,3 @@ -Title: Installation Guide - # Installation Guide There are a number of ways to get Janeway up and running. For diff --git a/content/old-docs/dev/oidc.md b/content/old-docs/dev/oidc.md index bd57f355..78483512 100644 --- a/content/old-docs/dev/oidc.md +++ b/content/old-docs/dev/oidc.md @@ -1,5 +1,3 @@ -Title: Open ID Connect (OIDC) - # Open ID Connect (OIDC) Support for Open ID Connect has been added in 1.4.2 of Janeway. This diff --git a/content/old-docs/dev/plugins.md b/content/old-docs/dev/plugins.md index d585dc2a..e10fa23b 100644 --- a/content/old-docs/dev/plugins.md +++ b/content/old-docs/dev/plugins.md @@ -1,5 +1,3 @@ -Title: Plugins, Events and Hooks - # Plugins, Events and Hooks
@@ -155,14 +153,14 @@ connect it with core areas of Janeway. {% endraw %}
-
The typesetting plugin's dashboard template renders this block.
-
Kanban cards look like this, they use the workflow/admin css (foundation).
diff --git a/content/old-docs/dev/robotsandsitemaps.md b/content/old-docs/dev/robotsandsitemaps.md index 914cbc08..303612a6 100644 --- a/content/old-docs/dev/robotsandsitemaps.md +++ b/content/old-docs/dev/robotsandsitemaps.md @@ -1,5 +1,3 @@ -Title: Robots and Sitemaps - # Robots and Sitemaps In version 1.4.1 of Janeway we are introducing the generation of Robot diff --git a/content/pages/accessibility-of-this-website.html b/content/pages/accessibility-of-this-website.html index a3aebac0..01d5f8fa 100644 --- a/content/pages/accessibility-of-this-website.html +++ b/content/pages/accessibility-of-this-website.html @@ -3,6 +3,7 @@ Accessibility of this website + {% call page_h1(max_char_width=16) %} diff --git a/content/pages/copyright-and-licensing.html b/content/pages/copyright-and-licensing.html index 42f958b3..cee90161 100644 --- a/content/pages/copyright-and-licensing.html +++ b/content/pages/copyright-and-licensing.html @@ -3,6 +3,7 @@ Copyright and licensing + {% call page_h1(max_char_width=15) %} diff --git a/content/pages/hosting.html b/content/pages/hosting.html index 80257135..3babc8d1 100644 --- a/content/pages/hosting.html +++ b/content/pages/hosting.html @@ -8,6 +8,7 @@ Hosting + {% include "components/hosting_splash.html" %} diff --git a/content/pages/icons.html b/content/pages/icons.html index b3268acf..d31dbd23 100644 --- a/content/pages/icons.html +++ b/content/pages/icons.html @@ -1,5 +1,6 @@ Icons +
diff --git a/content/pages/our-story.html b/content/pages/our-story.html index 521dce35..cd90f5ac 100644 --- a/content/pages/our-story.html +++ b/content/pages/our-story.html @@ -9,6 +9,7 @@ Our story + {% include "components/george_space_splash.html" %} diff --git a/content/pages/support.html b/content/pages/support.html index 46fc8eb6..279a0d33 100644 --- a/content/pages/support.html +++ b/content/pages/support.html @@ -3,7 +3,8 @@ {% from "components/page_section_group.html" import page_section_group %} - Support + Support - work in progress + {% call page_h1() %} diff --git a/content/support/about-the-docs-placeholder.md b/content/pages/support/about-the-docs.md similarity index 91% rename from content/support/about-the-docs-placeholder.md rename to content/pages/support/about-the-docs.md index f9ff8b7d..8794e1bc 100644 --- a/content/support/about-the-docs-placeholder.md +++ b/content/pages/support/about-the-docs.md @@ -1,6 +1,4 @@ -Title: Janeway Documentation - -# Janeway Documentation +# Janeway documentation This guide, whilst not exhaustive, provides various guides for running articles through the workflow, configuring journals and setting up an diff --git a/content/support/accessibility/displaying_accessibilty_information.md b/content/pages/support/accessibility/displaying-accessibility-information.md similarity index 62% rename from content/support/accessibility/displaying_accessibilty_information.md rename to content/pages/support/accessibility/displaying-accessibility-information.md index 94cd1dfc..f88dba27 100644 --- a/content/support/accessibility/displaying_accessibilty_information.md +++ b/content/pages/support/accessibility/displaying-accessibility-information.md @@ -1,5 +1,3 @@ -title: Displaying custom accessibility information - # Displaying custom accessibility information ## Introduction @@ -7,13 +5,11 @@ title: Displaying custom accessibility information Janeway 1.9 introduced an **Accessibility** page linked from the footer. By default, this only shows the platform accessibility information, however, there are settings to include custom press and/or journal specific -information. Journal information can only be displayed if the setting **Allow journal accessibility information** is switched on at the **Press**. It is off by default. +information. Journal information can only be displayed if the setting **Allow journal accessibility information** is switched on at press level. It is off by default. ## Enter press accessibility information -Press accessibility information may be entered in through the **Press manager** under **Edit press details**. There is a section for **Accessibility**, within which there is a rich-text area for **Press accessibility Information**. - -Press manager | Edit press details | Accessibility | Press accessibility information +Press accessibility information may be entered in through the **Press manager** under **Edit press details**. There is a section for **Accessibility**, within which there is a rich-text area for **Press accessibility information**. ![Screenshot: Press accessibility custom information field](../images/a11y-press-custom-info.png) @@ -21,21 +17,17 @@ Press manager | Edit press details | Accessibility | Press accessibility informa After the [press accessibility information](#enter-press-accessibility-information), there is a setting to **Allow journal accessibility information**. This allows each journal to have a unique accessibility statement. -Press manager | Edit press details | Accessibility | Allow journal accessibility information - ![Screenshot: Press setting to allow journal custom accessibility information](../images/a11y-press-allow-journal-info.png) > [!NOTE] -> This setting applies to all **journals** within that **press**. It provides the option to enter text onto the journal **accessibility** page, and will be hidden from readers when it is left blank. +> This setting applies to all journals within that press. It provides the option to enter text onto the journal accessibility page, and will be hidden from readers when it is left blank. ## Enter journal accessibility text > [!WARNING] -> The setting at press level must be switched on to make this available in the journal manager. If this section does not appear within your journal, then please contact your press manager. - -Journal accessibility information may be entered through the **Journal manager** **General** page. +> The setting at press level must be switched on to make this available in the journal manager. If this section does not appear within your journal, then contact your press manager. -Journal manager | General | Accessibility | Accessibility information for the public +Journal accessibility information may be entered through the **Journal manager**, through the **General**/**Journal settings** page. ![Screenshot: Journal accessibility custom information field](../images/a11y-journal-custom-info.png) @@ -43,11 +35,11 @@ Journal manager | General | Accessibility | Accessibility information for the pu This table summarises the information already provided within this document. -| Custom Press Text | Press setting to Allow Journal Text | Custom Journal Text | What is displayed | +| Custom press text | Press setting to allow journal text | Custom journal text | What is displayed | | ----------------- | ----------------------------------- | ------------------- | ------------------------------------ | | _none_ | no | _not available_ | Platform | | _none_ | yes | _none_ | Platform | -| _none_ | yes | Journal Text | Journal Text + Platform | -| Press Text | no | _not available_ | Press Text + Platform | -| Press Text | yes | _none_ | Press Text + Platform | -| Press Text | yes | Journal Text | Journal Text + Press Text + Platform | +| _none_ | yes | Journal text | Journal text + Platform | +| Press text | no | _not available_ | Press text + Platform | +| Press text | yes | _none_ | Press text + Platform | +| Press text | yes | Journal text | Journal text + Press text + Platform | diff --git a/content/pages/support/accessibility/index.md b/content/pages/support/accessibility/index.md new file mode 100644 index 00000000..974097ca --- /dev/null +++ b/content/pages/support/accessibility/index.md @@ -0,0 +1,3 @@ +# Accessibility + +_Coming soon_ diff --git a/content/pages/support/accounts-and-roles/activating-accounts.md b/content/pages/support/accounts-and-roles/activating-accounts.md new file mode 100644 index 00000000..7b8baaca --- /dev/null +++ b/content/pages/support/accounts-and-roles/activating-accounts.md @@ -0,0 +1,69 @@ +# 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, whereas 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. 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**. + ![Account activation toggle.](../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. + +The user will now be able to log in to the journal. + +## Troubleshooting account activation + +Users usually activate through a link sent to them. Activation emails cannot be easily resent, if the user cannot find the original. The solution is for the user to click the password reset link. If they receive the password reset email and click on that link, Janeway activates their account in addition to resetting their password. + +Completing the account activation step does not trigger an email. The user only receives a message saying “Account activated” at the top of the login screen, which is where they are sent next. + +### Troubleshooting ORCID activation + +After completing account registration via ORCID, users may or may not need to complete the activation step. + +- If the user has made an email address public on orcid.org, then Janeway is able to get an email from ORCID, and it can be confident the user did not make a mistake entering their email address, so there is no need to make them find an email link to activate their account. It just logs marks their account as active. + +- However, if no email is public on orcid.org, Janeway can’t be as sure of the email, so it requires the user to do account activation by emailing them a link. Email-based account activation is also triggered if the user logs in via ORCID, reaches the Janeway registration page with email from ORCID pre-populated, and then changes the email address in registration form, because again Janeway can’t be sure the email has no typos, and it is important for it to be correct, so that users do not lose access to their account if they forget their password. + +### Troubleshooting author account activation + +Author accounts don’t get activation any differently from other accounts. It just depends whether someone has logged in to Janeway fully. You can’t log in without activating your account, and you can’t submit an article (as main author actually doing things in Janeway) without being logged in. + +Historically, accounts were created for all co-authors, and they were inactive by default (except for the submitting author--theirs was active). But this is no longer the case from version 1.8. Only author records are created, not accounts. So if co-authors want to create accounts, they need to do the same registration and activation steps as everyone else. + +### Troubleshooting reviewer account activation + +From version 1.8, reviewers are able to review things without logging in, so they won’t have to have active accounts unless they have another reason to. The exception is if a journal has turned one-click review off. + +From version 1.8 onwards, inactive review accounts are also visible in the editor's reviewer selection screen. + +Usually the reason accounts are not active is because activation is off by default, and the user has to activate with the email link, or through another mechanism like ORCID or OIDC, where Janeway can be confident the email address is correct. + +There is one scenario in which the system changes previously active accounts to inactive: if the user starts the email change process, the system marks the account inactive and requires activation via email link, so we can be sure the email doesn’t contain typos. diff --git a/content/pages/support/accounts-and-roles/index.md b/content/pages/support/accounts-and-roles/index.md new file mode 100644 index 00000000..eee5f080 --- /dev/null +++ b/content/pages/support/accounts-and-roles/index.md @@ -0,0 +1,41 @@ +# 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](../accounts-and-roles/managing-user-accounts.md) +- [Roles and permissions](../accounts-and-roles/roles-and-permissions-on-janeway.md) +- [Activating accounts](../accounts-and-roles/activating-accounts.md) +- [ORCID login](../accounts-and-roles/orcid-login.md) +- [Single sign-on (SSO)](#single-sign-on-sso-login) + +## New accounts + +There are two ways to create an account on Janeway: + +1. A user registers for an account through the journal website. +2. An editor, press manager or member of staff can create an account through **Journal users**. + +Generally, it is best to let a user register an account using the first option and then assign any roles as needed, see [Roles and permissions](./roles-and-permissions-on-janeway.md). If this is not possible, indivual user accounts can be created by following these steps: + +1. Go to the **Journal users** page on the Manager dashboard. +2. Click **Add new user** +3. Fill in the user's details. + a. Make sure the **Is active** toggle is set to "Yes". + b. Except if this user requires staff permissions, make sure the **Is staff** permission is set to "No". + c. You will be required to set a password. +4. Click **Save**. + +The user can now either login after requesting a password reset link, through the journal website, or you could send a user their password. The latter is discouraged, as this introduces security risks. + +## Single sign-on (SSO) login + +Janeway supports single sign-on (SSO), allowing users to log in using their institutional credentials. SSO shows up on the login screen as a button reading “Log in with [name of institution]” + +When users log in with SSO the first time, Janeway creates a regular account in the background, recording the name and email that it gets from the SSO system. + +Users who originally signed in with SSO can switch to regular login after resetting their password from the login screen. Likewise, users who registered a normal Janeway account can start using SSO if their Janeway account email address matches the one they use with their institution. + +> [!TIP] +> If you do not see the SSO login option on your installation of Janeway, then it has not been configured. Contact your system administrator for help configuring SSO. + +For information on setting up SSO, see the [Janeway developer docs](https://github.com/openlibhums/janeway/tree/master/docs) - [OIDC specifically](https://github.com/openlibhums/janeway/blob/master/docs/source/dev/oidc.rst), for more information. diff --git a/content/support/accounts-and-roles/account-management.md b/content/pages/support/accounts-and-roles/managing-user-accounts.md similarity index 75% rename from content/support/accounts-and-roles/account-management.md rename to content/pages/support/accounts-and-roles/managing-user-accounts.md index 005036e8..2348c59d 100644 --- a/content/support/accounts-and-roles/account-management.md +++ b/content/pages/support/accounts-and-roles/managing-user-accounts.md @@ -1,16 +1,14 @@ -title: Managing user accounts - # Managing user accounts 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** and **Journal managers** can: +Editors and journal managers can: - 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: +Staff have additional controls for: - Viewing all accounts for the press (Janeway installation), including their journal roles and activation status. - Merging duplicate user accounts. @@ -33,7 +31,7 @@ From this page you can: Each user's assignment history (for example, editorial or review activity) 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** . +This page cannot be used to delete accounts, only deactivate them. Accounts can only be deleted using through the **Admin area** . ## All press users @@ -49,25 +47,31 @@ At press level you can: ## Editing user accounts -Click **Edit** next to a user to open the **Edit user** interface, where you can update a user’s account details. +Click **Edit** next to a user to open the **Edit user** interface, where you can update a user's account details. -Some changes are restricted by permission level. For more information, see the **Permissions** page. +Some changes are restricted by permission level. For more information, see the [**Permissions** page](./roles-and-permissions-on-janeway.md). > [!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. +> To update author details on an accepted article, you must edit the _frozen author record_ on the article's metadata page. ## 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). +![The merge users page](../images/merge-users.png) + > [!WARNING] > An account merge **cannot** be undone. Only merge account when you are certain they can be merged. When accounts are merged: -- All associated items (including articles, tasks, roles and files) are transferred from the source account to the destination account. +- 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. +- Any profile information from the source account is permanently lost. This includes information like email, name, ORCID ID, social media usernames, and preferences about things like profile visibility and preferred timezone. + +## 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. diff --git a/content/pages/support/accounts-and-roles/orcid-login.md b/content/pages/support/accounts-and-roles/orcid-login.md new file mode 100644 index 00000000..585c0e85 --- /dev/null +++ b/content/pages/support/accounts-and-roles/orcid-login.md @@ -0,0 +1,25 @@ +# ORCID login + +## General info + +If ORCID is turned on for a Janeway installation, the login screen has a link that takes you to orcid.org to sign in. Afterward you are returned to Janeway to finish setting up your account or logging in. + +If you create a regular Janeway account first, and later want to log in with ORCID, you can do so. Janeway will attempt to match your records by using the ORCID ID on your Janeway user account or the public email address on your ORCID profile. + +> [!TIP] +> If you do not see the ORCID login option on your installation of Janeway, then it has not been configured. Contact your system administrator for help configuring ORCID. + +## Regular login and single sign-on + +Anyone who does not want to sign in with ORCID can use the regular Janeway login as an alternative. + +The third sign-in option is single sign-on (SSO), where you log in with your university or other institution's credentials. Like ORCID, this has to be set up for each Janeway installation. ORCID login can be enabled alongside SSO with no problems. + +## Managing ORCID IDs + +You can edit your ORCID ID by [editing your account](../guides/creating-an-account-on-janeway.md#editing-your-account). + +> [!WARNING] +> Editing ORCID IDs by hand can cause metadata mixups and trouble logging in with ORCID in the case of mistakes. + +Author ORCID IDs cannot be edited directly, in order to minimize mistakes. You can remove and re-add the author using the ORCID search option. See [Author information](../guides/author-guide.md#author-information). diff --git a/content/support/accounts-and-roles/janeway-roles-and-permissions.md b/content/pages/support/accounts-and-roles/roles-and-permissions-on-janeway.md similarity index 63% rename from content/support/accounts-and-roles/janeway-roles-and-permissions.md rename to content/pages/support/accounts-and-roles/roles-and-permissions-on-janeway.md index 863dcea2..56ce5d84 100644 --- a/content/support/accounts-and-roles/janeway-roles-and-permissions.md +++ b/content/pages/support/accounts-and-roles/roles-and-permissions-on-janeway.md @@ -1,5 +1,3 @@ -title: Roles and permissions on Janeway - # Roles and permissions on Janeway This page explains the different roles available in Janeway and how permissions are managed. @@ -10,23 +8,23 @@ Needs some further work, checks and dev input on a few bits. Need to check out t ## 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. +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 from having another one. - Author - Assigned automatically when a user registers with a journal or submits an article. This can be considered the 'base role'. + Assigned automatically when a user registers with a journal or submits an article. This can be considered the "base role". - Reviewer - 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. + 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). + 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. + 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 editors who only need to handle specific articles within the journal, such as guest editors. - Copyeditor - Typesetter - Proofreader - Reader - 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 + 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](../email-and-reminders/publication-notifications.md) > [!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. @@ -42,7 +40,7 @@ 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.). +- 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 @@ -55,36 +53,40 @@ Staff users can: - 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. +- View the **All articles** page. - Access the **Admin area**. -### Superusers permission +### Superuser permission + +Superuser status allows a user to bypass most role-based permissions restrictions. This effectively allows the user to see most views in Janeway. -‘Superuser’ will assign a user all roles across the system. +There are some cases that superusers cannot access a page. For example, sometimes Janeway only gives access if the user is assigned to a particular task, or if the user was sent particular contact message. ## Granular manager permissions - +Janeway allows more granular permissions for journal managers and editors, using the **Permission** setting group. This can be configured through the **All settings** page, found on the Manager dashboard, and searching for "Permission" + +![" "](../images/permission-group.png) -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: +This can be used on the configuration of licences and sections as following: -- Licenses - Permissions control whether users can access the licenses control pages based on their roles, defaulting to Editor and Journal Manager. +- Licences + Permissions control whether users can access the licences control pages based on their roles, defaulting to Editor and Journal manager. - Sections - Permissions control whether a user can access the sections control pages based on their roles, defaulting to Editor and Journal Manager. + Permissions control whether a user can access the sections control pages based on their roles, defaulting to Editor and Journal manager. ### Editing granular permissions (staff only - advanced) > [!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. +There is no interface for updating the roles that can access the licences and sections pages and the setting is JSON stored in the database. If you are not comfortable or able editing this, contact your system administrator. > [!WARNING] > 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 +By default, both settings read `["editor", "journal-manager"]`. If, for example, you wanted to stop editors from editing licences, you could change it to read `["journal-manager"]`. Once saved, only users with the journal manager role will be able to access the licences pages. ### Granular settings permissions (staff only - advanced) diff --git a/content/pages/support/analytics/article-metrics.md b/content/pages/support/analytics/article-metrics.md new file mode 100644 index 00000000..d98f5d15 --- /dev/null +++ b/content/pages/support/analytics/article-metrics.md @@ -0,0 +1,107 @@ +# Article metrics + +This page provides information about how Janeway measures article reads and downloads, what kind of data is (not) logged, and how Janeway usage logging compares to COUNTER. + +## Article access logs + +Most of the time, when an article is viewed or downloaded, Janeway records an **Article access** log. These logs are the basis of data in the Reporting plugin. + +Logs include a few non-personal details of the action: + +- Whether the user is viewing or downloading +- What type of galley is provided +- What country the user is accessing from + +### Article views by type + +Here are the most common ways an article is viewed. + +- No galley (a.k.a “abstract”) + A view of a webpage for an article that has been published without any galleys. Because no galley has been made public, the user can only see metadata like title, abstract, and authors, not the full text content. +- XML + A view of a webpage for an article that has been marked up as JATS-XML and uploaded with an XML galley. The XML galley has been converted to HTML and the full text of the article has been rendered in the webpage for the user to read in their browser. +- HTML + A view of a webpage for an article that has been marked up as HTML, sometimes via pandoc conversion from Word. The HTML galley has been rendered in the webpage for the user to read in their browser. +- PDF + A view of a PDF loaded in the user’s browser or other window (depending on user preferences outside of Janeway), after they’ve clicked **View PDF** on the article webpage. This link only appears if the journal has ticked **View pdf button** on the **Article settings** page. + +### Article downloads by type + +Here are the most common ways an article is downloaded. + +- XML + A download of a raw JATS-XML file, after the user has clicked **Download XML** on the article webpage. +- HTML + A download of a raw HTML file, after the user has clicked **Download HTML** on the article webpage. This option only appears if the journal has left unticked **Disable html downloads** on the **Article settings** page. +- PDF + A download of a PDF file after the user has clicked **Download PDF** on the article webpage. + +Other less common galley types are possible. If any of these are uploaded, new links to download them appear on the article page, and new article downloads for these types can be logged in the article’s metrics. + +- EPUB +- Word (DOC) +- Word (DOCX) +- OpenDocument Text Document (ODT) +- LaTeX +- RTF +- Other +- Image + +### Events that are not logged + +There are some interactions with article content that are _not_ recorded as **Article access** logs. + +- If a web crawler identifies itself as such (like a search engine crawler or archive indexer), it can access article pages and galley files without triggering an article access log. +- Downloads of full journal issues are available, including galley files. When a user downloads a full issue of files, no article access is logged. +- If there is an XML or PDF galley available, there is a hidden link in the HTML metadata of every article webpage that indexers can use to get the raw file . (It is worth having this link in addition to the user-facing download links because it is provided with a recognizable name that indexers know to look for, `citation_xml_url` or `citation_pdf_url`.) Visits to this link are not logged. +- In the citation section of article metadata, users can download metadata in RIS or BIB formats without triggering any article access log. +- The APIs Janeway provides (JSON and OAI-XML), do not trigger article access logs unless one of the full-text article links is followed. + +### Avoiding duplicate logs + +If a user refreshes a page or clicks on a download link again soon after their first visit, Janeway does not record another access. For most users, the time frame for not counting duplicates is two weeks, because Janeway can recognize their browser session by using a safe cookie. If an article is visited in such a way that only the IP address can be checked, the time frame is one hour. + +However, there may be multiple access events if the user takes multiple actions, such as both viewing and downloading, or downloading multiple galley types. + +Similarly, if a user accesses an article on multiple devices, such as their laptop and their phone, multiple events will be recorded. + +> [!NOTE] +> Janeway needs to use IP addresses to make sure double-clicks or page refreshes are not recorded as new events, but we do not store original IP addresses, only fingerprints (hashes) that cannot be used to recover the original. + +### Filtering out bad traffic + +It is up to server administrators who install and run Janeway to make sure that the installation is not bogged down with exploitative traffic from bots and scrapers. This is because the most effective solutions sit outside Janeway and filter out bad actors before they reach the application layer. + +With OLH-managed installations, we currently use two methods: + +- Since 2025, after a sharp rise in extractive LLM-related traffic, we are trialling using a web firewall utility like Anubis, which poses an algorithmic challenge that makes it computationally expensive for most extractive crawlers to continue. Recognized traditional search and archive indexers like Google Scholar, Crossref, Web of Science, EBSCO, and Proquest are able to pass through this firewall. Other indexers like DOAJ receive content by direct deposit and so are not affected. +- We limit the rate of lots of traffic that comes in rapid succession from the same actor. + +## COUNTER and Janeway + +Janeway does not yet fully support [COUNTER](https://www.countermetrics.org/), a global standard for usage metrics. + +The only current COUNTER metric Janeway could potentially provide is the total global usage per item, journal, or press. This information is available through the [Reporting plugin](reporting.md). + +### COUNTER’s focus on institutional metrics + +COUNTER has historically been focused on showing usage attributable to a particular institution, so that the institution’s subscription cost for paywalled content can be justified. This is why some of the most widely used COUNTER reports omit “Open” and “Free to read” content. + +There are some reports that include “Open” and “Free to read” content, but these reports are less meaningful if the usage cannot be attributed to an institution, according to libraries we have worked with in the past. + +As a diamond open-access platform, Janeway does not track readers’ institutions. Readers are not required to log into anything, and we avoid making inferences about IP addresses. As a result, we would not be able to provide institution data in any COUNTER reports, were we to implement the standard. This is one of the main reasons we have not yet implemented COUNTER. + +### Comparison to COUNTER usage data processing rules + +Janeway and COUNTER have some of the same methods for processing usage data. These include rules around HTTP status codes, filtering double-clicks, and counting unique items (articles) and titles (journals). + +There are also several differences that are worth noting. + +- COUNTER recommends blocking bots and crawlers with a block-list, whereas we use the methods described in [Filtering out bad traffic](#filtering-out-bad-traffic) +- COUNTER makes a distinction in how fully the user accesses or captures the content of an item, which they call the metric type. They categorize more surface encounters like viewing of metadata records and sharing a link to an item with someone else “investigations”, and they categorize more substantive views or downloads of full text or actual content “requests”. Janeway does not distinguish between these types, and instead either records the access or not, depending on which link is used, and whether the actor can get through the firewall, as described above. +- COUNTER requires a separate access method for text and data mining (TDM), whereas Janeway does not make a distinction between TDM and other requests. +- COUNTER requires usage data to be available programmatically via an API with a standardized JSON/TSV structure, whereas Janeway usage data is provided with a custom data model and is not available via an API. +- COUNTER has rules for counting searches in databases, whereas Janeway does not track any search activity, except if a user visits an article page as described above. + +> [!NOTE] +> This section was written with COUNTER 5.1.1 as a reference. diff --git a/content/pages/support/analytics/google-analytics.md b/content/pages/support/analytics/google-analytics.md new file mode 100644 index 00000000..142c58a6 --- /dev/null +++ b/content/pages/support/analytics/google-analytics.md @@ -0,0 +1,16 @@ +# Google analytics + +You can implement Google Analytics code to measure activity on your pages, if you wish. + +The settings for this can be found in **All settings** through the Manager dashoard. + +!["Google analytics settings"](../../support/images/general-settings-google.png) + +Alternatively, you can search for it through **All settings**. +!["Google analytics settings shown on the All settings page"](../../support/images/all-settings-google.png) + +Google Analytics can be done by adding the Google Analytics code (provided by Google) in the **Google Analytics code** field and ticking the **Use Google Analytics 4** box, if using Google Analytics 4. + +For more information, consult the [Google Analytics documentation](https://developers.google.com/analytics). + +For support with issues, contact your system administrator. diff --git a/content/pages/support/analytics/index.md b/content/pages/support/analytics/index.md new file mode 100644 index 00000000..874f9e4a --- /dev/null +++ b/content/pages/support/analytics/index.md @@ -0,0 +1,13 @@ +# Janeway analytics + +Janeway tracks views and downloads for articles, and can report on this activity across your journal or press. This section explains what analytics data is available and how to access it. + +- [Reporting](./reporting.md) + A breakdown of the reports available through the Reporting plugin, including press reports, journal usage by month, article metrics, citations and more. +- [Google Analytics](./google-analytics.md) + Connecting Google Analytics to your journal for additional web traffic insights. +- [Article metrics](./article-metrics.md) + An overview of how Janeway logs article usage, what actors it (does not) allow, and how Janeway measures access compared to COUNTER. + +> [!NOTE] +> Janeway cannot provide usage statistics broken down by institution, since this would require tracking readers behind a paywall in a way Janeway does not support. Author, reviewer and editor affiliation data is available where it has been saved as part of a frozen author record. diff --git a/content/support/analytics/reporting.md b/content/pages/support/analytics/reporting.md similarity index 76% rename from content/support/analytics/reporting.md rename to content/pages/support/analytics/reporting.md index 6a569a37..21637f68 100644 --- a/content/support/analytics/reporting.md +++ b/content/pages/support/analytics/reporting.md @@ -1,8 +1,10 @@ -Title: Reporting +# Reporting plugin -## Reporting plugin +The reporting plugin can be found by clicking **Plugins** in the right-hand sidebar and selecting **Reporting plugin**. -The reporting plugin produces a range of reports for analytics within the Janeway publishing platform. These reports include: +![A screenshot showing where to find the plugin](../images/finding-reporting.png) + +This plugin produces a range of reports for analytics within Janeway. These reports include: - Press report - Journal usage by month @@ -14,20 +16,18 @@ The reporting plugin produces a range of reports for analytics within the Janewa - Journal citations - Book citations - Crossref DOI URLs -- License report +- Licence 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. +## Press report -This report uses the dates specified in the filter when retrieving data. +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. +> If you wish to review statistics over a year, it is recommended to set the end date not on 31/12/yy but on 01/01/yy of the year following. -The first three columns (Submissions, Published Submissions and Rejected Submissions) use the submission date as their data point. +The first three columns (submissions, published submissions and rejected submissions) use the submission date as their data point. ## Journal usage by month @@ -54,7 +54,7 @@ This report shows article citations. It can either show citations per year or of 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. +> It is recommended to deposit citations and produce XML to improve article citation accuracy. ## Article authors @@ -75,9 +75,9 @@ This report shows total book citations using Crossref data. 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 +## Licence 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. +This report shows the number of article using specific licences in the period specified in the date filter. The date filter for this report uses the date an article was published. ## Workflow report diff --git a/content/support/article-management/article-galleys.md b/content/pages/support/article-management/article-galleys.md similarity index 68% rename from content/support/article-management/article-galleys.md rename to content/pages/support/article-management/article-galleys.md index 34c31aec..cad527c6 100644 --- a/content/support/article-management/article-galleys.md +++ b/content/pages/support/article-management/article-galleys.md @@ -1,5 +1,3 @@ -title: Article galleys - # Article galleys ## What is a galley @@ -20,19 +18,19 @@ PDF galleys provide a fixed-layout, print-optimised version of the article. PDFs XML (Extensible Markup Language) galleys contain the structured, machine-readable version of your article. Janeway uses JATS-XML (Journal Article Tag Suite), which is the standard format for scholarly journal articles. JATS-XML captures all the structural elements of an article; headings, paragraphs, citations, figures, tables, author information, and metadata, in a standardised format. -JATS-XML galleys are typically generated by a typesetter. Janeway generates a HTML representation of the JATS-XML galley which can be displayed to readers. All you need to do is upload the JATS-XML as a galley and Janeway will generate a [web page version] of your article. (For information on XSLT .) +JATS-XML galleys are typically generated by a typesetter. Janeway generates a HTML representation of the JATS-XML galley which can be displayed to readers. All you need to do is upload the JATS-XML as a galley and Janeway will generate a web page version of your article. (For information on XSLT see [the typesetter guide](../guides/typesetter-guide.md#styling) and [editor guide](../guides/editor-guide-to-typesetting.md#advanced-styling).) ### HTML -HTML (Hypertext Markup Language) galleys are designed for online reading and allow you to display your content as a webpage. In Janeway, HTML can be generated from XML galleys or converted from Word documents (DOCX or DOC) using the Pandoc plugin . You can also created your own HTML galley and uploaded it to Janeway. +HTML (Hypertext Markup Language) galleys are designed for online reading and allow you to display your content as a webpage. In Janeway, HTML can be generated from XML galleys or converted from Word documents (DOCX or DOC) using the [Pandoc plugin](../guides/editor-guide-to-typesetting-with-pandoc.md). You can also create your own HTML galley and upload it to Janeway. ## Galley preview -Galleys can be previewed as a part of the typesetting stage. They will be listed under **Current galleys** and be viewed using the **Preview** icon. Using this view, you can see the galley content as it would be displayed on your website. The galley preview will **not** have functional download links, a views and download block, or any other information that is not encoded within the file itself. The link of the galley preview will only be accessible to other users with appropriate permissions. +Galleys can be previewed as a part of the typesetting stage. They will be listed under **Current galleys** and be viewed using the **Preview** icon. Using this view, you can see the galley content as it would be displayed on your website. The galley preview will **not** have functional download links, a views and download block, or any other information that is not encoded within the file itself. The link of the galley preview will only be accessible to other users with appropriate permissions. ## Editing galleys -There are various ways to edit galleys, depending on your workflow and which galley types you are using. If you are working with multiple galley types, you may need to make changes to multiple files to ensure consistency across galleys. If you are editing metadata, you will also need to check if the data within Janeway matches the galley. A mismatch can have impact on the archiving and preservation of content by services such as Portico and/or (C)LOCKSS. +There are various ways to edit galleys, depending on your workflow and which galley types you are using. If you are working with multiple galley types, you may need to make changes to multiple files to ensure consistency across galleys. If you are editing metadata, you will also need to check if the data within Janeway matches the galley. A mismatch can have impact on the archiving and preservation of content by services such as [Portico](https://www.portico.org/) and/or [(C)LOCKSS](https://clockss.org/). > [!WARNING] > 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 explaining the change and the reason for it. @@ -41,15 +39,15 @@ There are various ways to edit galleys, depending on your workflow and which gal If you wish to make changes to an XML galley, you can either send it (back) to the typesetter or download the file to edit it yourself. The latter is recommended only for minor changes. XML files can be edited with various softwares such as [Oxygen XML Editor](https://www.oxygenxml.com/), [Sublime Text](https://www.sublimetext.com/) or [Visual Studio Code](https://code.visualstudio.com/). -If you are editing JATS-XML yourself, there are [things we advise you not to do] +If you are editing JATS-XML yourself, there are things to be cautious with: -- Delete or modify tag names unless you are certain of the JATS structure. -- Remove paired tags (opening without closing, or vice versa). -- Change the hierarchical structure of elements. -- Edit special characters or entities (like `<` for `<` or `&` for `&`) unless you understand character encoding. -- Make structural changes (like adding new sections or figures). +- Don't delete or modify tag names unless you are certain of the JATS structure. +- Don't remove paired tags (opening without closing, or vice versa). +- Avoid changing the hierarchical structure of elements. +- Don't edit special characters or entities (like `<` for `<` or `&` for `&`) unless you understand character encoding. +- Avoid making structural changes (like adding new sections or figures). -We recommend consulting your typesetter for the following types of changes to an XML file: +It is recommended to consult your typesetter for the following types of changes to an XML file: - Structural changes; adding or removing sections, figures, or tables. - Complex formatting issues. @@ -57,17 +55,17 @@ We recommend consulting your typesetter for the following types of changes to an - Changes to mathematical equations or special characters. - Any edits where you are uncertain about the correct JATS structure/hierarchy. -Whichever way you make changes to a JATS-XML file, we recommend always checking it using the preview function in Janeway to proof the galley to ensure it displays correctly. +Whichever way you make changes to a JATS-XML file, it is recommended to check it using the [preview function in Janeway](../guides/editor-guide-to-typesetting.md#upload-galleys-yourself-workflow) to proof the galley to ensure it displays correctly. -For information on editing images within an XML file or upload missing images, see Managing galley images . +For information on editing images within an XML file or upload missing images, see [Managing galley images](../guides/editor-guide-to-typesetting.md#image-and-figure-files). ### Editing HTML HTML galleys can be edited in various ways, you can: - You can download the HTML galley, edit it manually and reupload it. -- If using the Pandoc plugin, you can edit the orignal Word document and generate a new HTML file. +- If using the Pandoc plugin, you can edit the original Word document and generate a new HTML file. - You can use Janeway's built-in HTML editor (you may need to check with your system administrator whether this is installed). -> ![Warning] +> [!WARNING] > Changes made using the built-in editor cannot be reversed once the edited files is changed. diff --git a/content/support/article-management/article-images.md b/content/pages/support/article-management/article-images.md similarity index 69% rename from content/support/article-management/article-images.md rename to content/pages/support/article-management/article-images.md index 80def602..9fd5bcfa 100644 --- a/content/support/article-management/article-images.md +++ b/content/pages/support/article-management/article-images.md @@ -1,5 +1,3 @@ -title: Article images - # Article images Articles have three images that are used for display: @@ -10,11 +8,11 @@ Articles have three images that are used for display: This image is used in the heading of the article page (also called a 'hero image'). This image will also be used in the carousel, popular articles and featured articles sections on the homepage, if those are enabled and an article is added to it. It is also used as the meta image if none is supplied. -![Example of the landscape image on the homepage using the OLH theme.](/content/support/images/large-image-homepage.png) +![Example of the landscape image on the homepage using the OLH theme.](../images/large-image-homepage.png) -The exact recommended size of the large image will depend on the theme your journal uses. The height of the display will also ways be 648px, but the width will vary per theme: 1100px on the Clean theme, 1200px on the OLH theme, 1477px on the Material theme. For information on image display, cropping and sizing, see Image guidelines. The image will be resized smaller for display on the homepage. +The exact recommended size of the large image will depend on the theme your journal uses. The height of the display will always be 648px, but the width will vary per theme: 1100px on the Clean theme, 1200px on the OLH theme, 1477px on the Material theme. For information on image display, cropping and sizing, see [Image guidelines](../journal-management/image-guidelines.md). The image will be resized smaller for display on the homepage. -Generally, we recommend large, landscape images to be used for the large image and avoiding images with people or bodies due to potential unexpected cropping. +Generally, large, landscape images are recommended to be used for the large image and avoiding images with people or bodies due to potential unexpected cropping. If no landscape image is uploaded, the **Default large image** will be used where the landscape image is set to display. @@ -22,7 +20,7 @@ If no landscape image is uploaded, the **Default large image** will be used wher The thumbnail is a small square image displayed on pages listing articles such as the **All articles** or the **Issue articles** list. A width-to-height ratio of about 3:4 is recommended. If the image is another size, it will be resized to fit into the box whilst preserving the original image ratio. For an example, see the image below: -![" "](/content/support/images/thumbnails-article-list.png) +![" "](../images/thumbnails-article-list.png) Make sure to set a default image that can show when no individual thumbnail is set. This can be done through **Images** under **Journal settings** on the Manager dashboard. @@ -30,14 +28,14 @@ Make sure to set a default image that can show when no individual thumbnail is s The meta image allows you to override the image displayed on social media when the article is shared. If no meta image is supplied, the large image is used, but it may not display correctly due to its size. -![Example of a meta image on BlueSky](/content/support/images/meta-image-bsky.png) +![Example of a meta image on BlueSky](../images/meta-image-bsky.png) ## Article images manager The Article images manager is an interface for editing all of the images for a given article. To edit the images for a given article through the Article images manager, click on **Edit image**. This page is split into three blocks; one for the large image, one for the thumbnail and one for the meta image. -![Article images page with no images uploaded](/content/support/images/images-manager-blank.png) +![Article images page with no images uploaded](../images/images-manager-blank.png) You can upload an image by: @@ -46,8 +44,8 @@ You can upload an image by: 3. Clicking **Upload**. Once images are uploaded, the page will look similar to the following: -![Article images page with all three images uploaded](/content/support/images/images-manager-full.png) +![Article images page with all three images uploaded](../images/images-manager-full.png) The large image and thumbnail will display a preview and can be removed by clicking **Delete**. The meta image will not display a preview and can be removed by checking the **Clear** box and then clicking **Upload**. -See also: image guidelines +See also: [Image guidelines](../journal-management/image-guidelines.md). diff --git a/content/support/article-management/article-metadata.md b/content/pages/support/article-management/article-metadata.md similarity index 79% rename from content/support/article-management/article-metadata.md rename to content/pages/support/article-management/article-metadata.md index 9c9f23e9..fb43b1fc 100644 --- a/content/support/article-management/article-metadata.md +++ b/content/pages/support/article-management/article-metadata.md @@ -1,8 +1,6 @@ -title: Article metadata - # Article metadata -There are several ways to access and edit an article's metadata in Janeway, depending on whether the article has been published. For more general information on metadata, see: metadata on Janeway. +There are several ways to access and edit an article's metadata in Janeway, depending on whether the article has been published. For more general information on metadata, see: [Metadata on Janeway](../guides/metadata-on-janeway.md). ## Finding article metadata @@ -12,6 +10,8 @@ For articles that are in progress (that is, beyond the unassigned stage), you ca Using the **Actions panel:** Scroll to the bottom-right corner of the article page and select **View metadata**. +![" "](../images/view-metadata.png) + Using the workflow bar: 1. Go to the article page within the workflow. @@ -21,7 +21,7 @@ Using the workflow bar: - **Edit metadata** to edit it. - **Edit author metadata** to edit the author metadata. -![Logs, docs and more menu open, showing Article archive, Edit metadata, and Edit author metadata options](/content/support/images/logs-docs-metadata.png) +![Logs, docs and more menu open, showing Article archive, Edit metadata, and Edit author metadata options](../images/logs-docs-metadata.png) ### Published articles @@ -29,7 +29,7 @@ Using the workflow bar: 2. Click the **Account** dropdown in the top-right corner (make sure you are logged in). 3. Click **Edit article**. This opens the **Article archive** page. - ![Account dropdown on the journal front end, showing the Edit article option](/content/support/images/front-end-metadata.png) + ![Account dropdown on the journal front end, showing the Edit article option](../images/front-end-metadata.png) 4. From the **Article archive** page, you can: - Click **Edit publication information**. @@ -40,41 +40,41 @@ Using the workflow bar: ## Editing metadata -![Logs, documents and more dropdown menu open, showing the Article archive and Edit metadata options](/content/support/images/logs-edit-metadata.png) +![Logs, documents and more dropdown menu open, showing the Article archive and Edit metadata options](../images/logs-edit-metadata.png) The first block of the **Article archive** page lists most of the article's metadata. To edit it, click **Edit**. -![Top of the article archive page, with the Edit button highlighted](/content/support/images/article-archive-edit-metadata.png) +![Top of the article archive page, with the Edit button highlighted](../images/article-archive-edit-metadata.png) This opens the **Edit metadata** page, where you can update the article's title, abstract, and other fields. -![Edit metadata page, displaying the title and abstract fields](/content/support/images/edit-metadata.png) +![Edit metadata page, displaying the title and abstract fields](../images/edit-metadata.png) Scroll down and click **Update metadata** to save your changes. -![Update metadata button at the bottom of the Edit metadata page](/content/support/images/update-metadata.png) +![Update metadata button at the bottom of the Edit metadata page](../images/update-metadata.png) Below the article metadata block, you can also edit author metadata and funder information. ## Identifiers -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 can be managed on an individual basis or, for CrossRef DOIs, in bulk. +Janeway can mint [CrossRef](../identifiers/crossref-article-doi.md) and [DataCite](../plugins/datacite.md) DOIs and, if working with data imported from other platforms, can also maintain existing publisher IDs such as an OJS ID. Identifiers can be managed on an individual basis or, for CrossRef DOIs, in bulk. Identifiers associated with an article can be found through **Identifiers** under **Logs, documents and more**. -![The identifiers page, displaying a list of identifiers associated with the article, including a DOI, OJS ID, and DOAJ ID. For DOIs, there are options to register, poll, deposit, and view the response XML. Delete buttons are available for all identifiers.](/content/support/images/article-identifiers.png) +![The identifiers page, displaying a list of identifiers associated with the article, including a DOI, OJS ID, and DOAJ ID. For DOIs, there are options to register, poll, deposit, and view the response XML. Delete buttons are available for all identifiers.](../images/article-identifiers.png) > [!TIP] > **Advanced:** You can also manage CrossRef DOIs in bulk at the journal level as an editor (and at the press level as a staff user) using the DOI Manager. > [!NOTE] -> **Advanced:** DataCite DOIs do not appear on the identifiers page and must be managed through the DataCite plugin. +> **Advanced:** DataCite DOIs do not appear on the identifiers page and must be managed through the [DataCite plugin](../plugins/datacite.md). -See also: Identifiers +See also: [Identifiers](../identifiers/index.md). ## ROR -Affiliation metadata in Janeway is managed using the [Research Organization Registry](https://ror.org/). ROR assigns persistent identifiers to organizations, similar to how DOIs identify articles, ORCIDs identify people, and ISBNs identify books. This allows multiple names to be associated with a single organization, making discovery and display easier and enabling linked open data. To read more about ROR (and CRediT) on Janeway, see Metadata on Janeway. +Affiliation metadata in Janeway is managed using the [Research Organization Registry](https://ror.org/). ROR assigns persistent identifiers to organizations, similar to how DOIs identify articles, ORCIDs identify people, and ISBNs identify books. This allows multiple names to be associated with a single organization, making discovery and display easier and enabling linked open data. To read more about ROR (and CRediT) on Janeway, see [Metadata on Janeway](../guides/metadata-on-janeway.md). ## Google Scholar diff --git a/content/support/article-management/article-sections.md b/content/pages/support/article-management/article-sections.md similarity index 72% rename from content/support/article-management/article-sections.md rename to content/pages/support/article-management/article-sections.md index a7ea9b1b..2c4db0c2 100644 --- a/content/support/article-management/article-sections.md +++ b/content/pages/support/article-management/article-sections.md @@ -1,9 +1,8 @@ -title: Article sections - # Article sections -Sections (article types) are ways of grouping articles by their content type, e.g. "Research articles" or "Reviews". You can create custom sections through the Section manager on on the Manager dashboard and configure their settings. -![" "](/content/support/images/manager-sections.png) +Sections (article types) are ways of grouping articles by their content type, e.g. "Research articles" or "Reviews". You can create custom sections through the Section manager on the Manager dashboard and configure their settings. + +![" "](../images/manager-sections.png) ## Managing sections @@ -17,13 +16,13 @@ For each section, you can provide the following information and settings: This determines the pluralised name for the section, e.g. 'article' and 'articles'. - Number of reviewers - This determines the number of reviewers generally required for this article type. It can be set too 0 for editorials and other non-peer reviewed content. + This determines the number of reviewers generally required for this article type. It can be set to 0 for editorials and other non-peer reviewed content. - Is filterable - This determines whether this section should appear as a filter option on the All articles list. + This determines whether this section appears as a filter option on the All articles list. - Sequence - This determines the order sections should appear in. This can be edited using this field or by dragging and dropping the sections in order. + This determines the order sections appear in. This can be edited using this field or by dragging and dropping the sections in order. - Section editors This determines which section editors will be notified when new papers are submitted to this section. @@ -41,8 +40,8 @@ For each section, you can provide the following information and settings: This determines whether this section is publicly discoverable and put forward for indexing. Check the box to enable indexing. - Auto-assign editors - This determines whether articles submitted to this section will be automatically assigned to the notified (section) editors (as determined in the preceeding **Section editors** and **Editors** settings). Tick this box to enable auto-assignment. + This determines whether articles submitted to this section will be automatically assigned to the notified (section) editors (as determined in the preceding **Section editors** and **Editors** settings). Tick this box to enable auto-assignment. Sections can always be edited, but they cannot be deleted when articles have been assigned to this section. If you wish to remove a section that already has articles assigned to it, first migrate all of the articles using this section to a different section. Once this has been done, the **Delete** button will become available. -If you are only using one article type, the field in which authors select a section during submission can be disabled using the **Submission configurator**. +If you are only using one article type, the field in which authors select a section during submission can be disabled using the [**Submission configurator**](../submission/submission-settings.md). diff --git a/content/support/article-management/articles-management.md b/content/pages/support/article-management/articles-management.md similarity index 77% rename from content/support/article-management/articles-management.md rename to content/pages/support/article-management/articles-management.md index e433452d..126f2af4 100644 --- a/content/support/article-management/articles-management.md +++ b/content/pages/support/article-management/articles-management.md @@ -1,15 +1,13 @@ -title: Articles - # Articles Once an article is published, you may need to change it — for example, to upload a new galley or correct a metadata error. All published articles can be found on the **Published articles** page under **Back content** in the left-hand sidemenu. -Archived and rejected papers can be found under **Archived articles**. On either page, you can search and then select an article to edit. +Archived and rejected articles can be found under **Archived articles**. On either page, you can search and then select an article to edit. > [!TIP] > You can also edit a published article by going to its page on the journal front end and selecting **Edit article** from the account dropdown. - - +> +> ![Showing the edit metadata option on the front end.](../images/front-end-metadata.png) ## How to use the article archive page @@ -48,14 +46,12 @@ To move an article back into the workflow: Article rejections can also be undone directly from the Article archive page using the **Undo article rejection** button. -![Undo article rejection button](/content/support/images/undo-rejection.png) +![Undo article rejection button](../images/undo-rejection.png) If the article was previously assigned to an editor, it will move to the Review stage. Otherwise, it will move to the Unassigned stage. ## Article display settings - - The **Article display** page has settings for controlling how articles look and how metrics are displayed. - Disable article images @@ -65,7 +61,7 @@ The **Article display** page has settings for controlling how articles look and - Disable metrics display - Suppress citation metrics -How to cite is an auto-generated citation based on a custom OLH citation style. You can suppress it for all articles using **Suppress how to cite**. You can also override it for individual articles by entering a custom citation in the **Edit metadata** pane for each article. +How to cite is an auto-generated citation based on a custom Open Library of Humanities citation style. You can suppress it for all articles using **Suppress how to cite**. You can also override it for individual articles by entering a custom citation in the **Edit metadata** pane for each article. > [!NOTE] > A previous version of the citation included "p" before page ranges. To restore this, enter a custom value in the **Page numbers** field in **Edit metadata** for each article. diff --git a/content/pages/support/article-management/index.md b/content/pages/support/article-management/index.md new file mode 100644 index 00000000..bd27787e --- /dev/null +++ b/content/pages/support/article-management/index.md @@ -0,0 +1,17 @@ +# Article management + +There are various aspects to article management within Janeway and various interfaces to manage them from. This section contains documentation on the following: + +- [Article galleys](../article-management/article-galleys.md) +- [Article images](../article-management/article-images.md) +- [Article metadata](../article-management/article-metadata.md) +- [Article sections](../article-management/article-sections.md) +- [Managing archived and rejected articles](../article-management/articles-management.md#archiving-an-article) + +Additionally, there's a page to manage the publication schedule: + +## Publication schedule + +Any articles that are set to publish on a future date will appear in a list on this page. It will list the title, section, DOI, and scheduled publication date. + +![Article listed for publication in the future](../images/pub-schedule.png) diff --git a/content/support/contributing-guide.md b/content/pages/support/contributing-guide.md similarity index 82% rename from content/support/contributing-guide.md rename to content/pages/support/contributing-guide.md index 1d2e1fff..6b5d640f 100644 --- a/content/support/contributing-guide.md +++ b/content/pages/support/contributing-guide.md @@ -1,5 +1,3 @@ -Title: Contributing to Janeway documentation - # Contributing to Janeway documentation Work-in-process note: This page could explain how people including us and @@ -11,11 +9,11 @@ how to name files and folders. ## Creating and editing pages All the pages of the support site are generated from text files stored under -`/content/support/` in this repository. Old documentation can be found at -`/content/old-docs/` while the support site is being built. +`content/pages/support/` in this repository. Old documentation can be found at +`content/old-docs/` while the support site is being built. Pages for the support site should be written in GitHub-flavored Markdown (GFM). -Image files should be added under `/content/support/images/`. All the content +Image files should be added under `content/pages/support/images/`. All the content can be edited on GitHub, so that you can make use of the Preview tab in GitHub. When creating Git commits, create a dedicated branch if you are working in @@ -38,7 +36,7 @@ Do: my-folder/my-file-name.txt ``` -Don’t: +Don't: - use spaces (reason: shell scripting) - use capital letters (reason: avoid broken links) @@ -52,20 +50,10 @@ Don’t: my&your-folder/my&your-file-name.txt ``` -## Page metadata - -At the beginning of the file, please include the page title, preceded by -`Title: `. It will appear in the browser tab, on search results, and on social -media when the page is shared. - -The page you are reading has this at the top: - -```md -Title: Contributing to Janeway documentation -``` +## Headings -Please also include a top-level heading for each page, using the single hash in -Markdown syntax. Usually this will be the same as the page title. +Include a top-level heading for each page, using the single hash in +Markdown syntax. For example: @@ -75,7 +63,7 @@ For example: ## Internal links -If you want to link to another page in the documentation, use Markdown’s link +If you want to link to another page in the documentation, use Markdown's link syntax, but leave the extension off the file, since eventually it will be an HTML file, not a Markdown file. For example, to create a link to this file from another file in the same folder, you can do this: diff --git a/content/support/downloadables/article-images-import-sample.csv b/content/pages/support/downloadables/article-images-import-sample.csv similarity index 100% rename from content/support/downloadables/article-images-import-sample.csv rename to content/pages/support/downloadables/article-images-import-sample.csv diff --git a/content/support/downloadables/article-images-import-template.csv b/content/pages/support/downloadables/article-images-import-template.csv similarity index 100% rename from content/support/downloadables/article-images-import-template.csv rename to content/pages/support/downloadables/article-images-import-template.csv diff --git a/content/support/downloadables/contact-import-sample.csv b/content/pages/support/downloadables/contact-import-sample.csv similarity index 100% rename from content/support/downloadables/contact-import-sample.csv rename to content/pages/support/downloadables/contact-import-sample.csv diff --git a/content/support/downloadables/contact-import-template.csv b/content/pages/support/downloadables/contact-import-template.csv similarity index 100% rename from content/support/downloadables/contact-import-template.csv rename to content/pages/support/downloadables/contact-import-template.csv diff --git a/content/support/downloadables/cspr-import-sample.csv b/content/pages/support/downloadables/cspr-import-sample.csv similarity index 100% rename from content/support/downloadables/cspr-import-sample.csv rename to content/pages/support/downloadables/cspr-import-sample.csv diff --git a/content/support/downloadables/cspr-import-template.csv b/content/pages/support/downloadables/cspr-import-template.csv similarity index 100% rename from content/support/downloadables/cspr-import-template.csv rename to content/pages/support/downloadables/cspr-import-template.csv diff --git a/content/support/downloadables/editor-import-sample.csv b/content/pages/support/downloadables/editor-import-sample.csv similarity index 100% rename from content/support/downloadables/editor-import-sample.csv rename to content/pages/support/downloadables/editor-import-sample.csv diff --git a/content/support/downloadables/editor-import-template.csv b/content/pages/support/downloadables/editor-import-template.csv similarity index 100% rename from content/support/downloadables/editor-import-template.csv rename to content/pages/support/downloadables/editor-import-template.csv diff --git a/content/support/downloadables/editorial-team-sample.csv b/content/pages/support/downloadables/editorial-team-sample.csv similarity index 100% rename from content/support/downloadables/editorial-team-sample.csv rename to content/pages/support/downloadables/editorial-team-sample.csv diff --git a/content/support/downloadables/editorial-team-template.csv b/content/pages/support/downloadables/editorial-team-template.csv similarity index 100% rename from content/support/downloadables/editorial-team-template.csv rename to content/pages/support/downloadables/editorial-team-template.csv diff --git a/content/support/downloadables/jats-import-sample.zip b/content/pages/support/downloadables/jats-import-sample.zip similarity index 100% rename from content/support/downloadables/jats-import-sample.zip rename to content/pages/support/downloadables/jats-import-sample.zip diff --git a/content/support/downloadables/metadata-template.csv b/content/pages/support/downloadables/metadata-template.csv similarity index 100% rename from content/support/downloadables/metadata-template.csv rename to content/pages/support/downloadables/metadata-template.csv diff --git a/content/support/downloadables/peer-review-import-sample.csv b/content/pages/support/downloadables/peer-review-import-sample.csv similarity index 100% rename from content/support/downloadables/peer-review-import-sample.csv rename to content/pages/support/downloadables/peer-review-import-sample.csv diff --git a/content/support/downloadables/peer-review-import-template.csv b/content/pages/support/downloadables/peer-review-import-template.csv similarity index 100% rename from content/support/downloadables/peer-review-import-template.csv rename to content/pages/support/downloadables/peer-review-import-template.csv diff --git a/content/support/downloadables/reviewer-import-sample.csv b/content/pages/support/downloadables/reviewer-import-sample.csv similarity index 100% rename from content/support/downloadables/reviewer-import-sample.csv rename to content/pages/support/downloadables/reviewer-import-sample.csv diff --git a/content/support/downloadables/reviewer-import-template.csv b/content/pages/support/downloadables/reviewer-import-template.csv similarity index 100% rename from content/support/downloadables/reviewer-import-template.csv rename to content/pages/support/downloadables/reviewer-import-template.csv diff --git a/content/support/downloadables/sample-import.csv b/content/pages/support/downloadables/sample-import.csv similarity index 100% rename from content/support/downloadables/sample-import.csv rename to content/pages/support/downloadables/sample-import.csv diff --git a/content/support/downloadables/sample-update.csv b/content/pages/support/downloadables/sample-update.csv similarity index 100% rename from content/support/downloadables/sample-update.csv rename to content/pages/support/downloadables/sample-update.csv diff --git a/content/support/email-and-reminders/email-logs-placeholder.md b/content/pages/support/email-and-reminders/email-logs.md similarity index 73% rename from content/support/email-and-reminders/email-logs-placeholder.md rename to content/pages/support/email-and-reminders/email-logs.md index 90b9019f..4347b759 100644 --- a/content/support/email-and-reminders/email-logs-placeholder.md +++ b/content/pages/support/email-and-reminders/email-logs.md @@ -1,5 +1,3 @@ -title: Email logs - # Email logs 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. @@ -20,7 +18,7 @@ You can access this through: - The archive (Dashboard -\> Left hand menu -\> Back Content -\> Articles). -![Screenshot showing where to access Logs, docs and more](email-logs-access.png) +![Screenshot showing where to access Logs, docs and more](../images/navigation-logs.png) ## Understanding the log entries @@ -30,9 +28,9 @@ Each entry in the log records an action that has taken place on the article. The 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 - + The user or system process that initiated the action. +- Level + A category that admininstrators use to group logs into reports when working on the server. For emails, the level is always “Info”, and it can be safely ignored when looking at a particular log. If the logged action relates to an email, additional details are available: @@ -40,10 +38,10 @@ If the logged action relates to an email, additional details are available: 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 statuses** below for more information. + Information about the delivery status of the email. See [**Interpreting statuses**](#email-status-meanings) 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) +![Screenshot of an email log entry showing status and actions.](../images/article-log.png) ## Interpreting statuses @@ -52,7 +50,7 @@ Emails sent through Janeway may display a delivery status, indicated with both t > [!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). +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. @@ -65,10 +63,12 @@ The following statuses can appear: - 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 has been delivered to the recipient's mail server. +- Failed The email could not be delivered. +Emails can fail to be delivered for a variety of reasons. There might be a typo in the email address, the recipient’s mailbox might be full, the email service provider might not be operational, or the recipient might have marked emails from the sender as spam. + > [!NOTE] > Seeing "No information" under email status does not necessarily mean an email was not sent. @@ -77,7 +77,7 @@ The following statuses can appear: 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). + 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. diff --git a/content/pages/support/email-and-reminders/email-settings.md b/content/pages/support/email-and-reminders/email-settings.md new file mode 100644 index 00000000..0542d553 --- /dev/null +++ b/content/pages/support/email-and-reminders/email-settings.md @@ -0,0 +1,23 @@ +# Email settings + +In addition to email templates and reminder notifications, there are a few settings which affect emails on Janeway. + +## Reply-to address + +This setting can be found under **General** settings on the Manager dashboard or by searching for it in **All settings**. +The reply-to address can be any address you want replies to go to. If this should not be used by users, you may wish to create a 'noreply' reply-to address (e.g. no-reply-journal@journal.com). + +## From-address + +This setting can be found under **General** settings on the Manager dashboard or by searching for it in **All settings**. +The from-address should be one the server can send emails properly; it should match the SMTP/email settings. If you do not know what this means or are unsure if you have done it correctly, contact your system administrator. + +## Hide author email links + +This setting can be found under **Article display** settings on the Manager dashboard or by searching for it in **All settings**. +If this setting is enabled (the box is ticked), the article page will not display links to email correspondence authors. + +## Auto signature + +This setting can be found under **General** settings on the Manager dashboard or by searching for it in **All settings**. +This setting sets up the email signature for automatic emails send from the system. diff --git a/content/pages/support/email-and-reminders/email-template-variables.md b/content/pages/support/email-and-reminders/email-template-variables.md new file mode 100644 index 00000000..3d1ccafb --- /dev/null +++ b/content/pages/support/email-and-reminders/email-template-variables.md @@ -0,0 +1,170 @@ +# Email template variables + +Email template variables allow Janeway to automatically insert information into emails, such as article titles, reviewer names or due dates. + +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. + +This page explains: + +- What variables are. +- Which variables are available in common templates. +- How to use them safely. + +For general guidance on editing templates, see [Email templates](./email-templates.md). + +## 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: 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 in review assignments include: + +- `{% raw %}{{ article.safe_title }}{% endraw %}` + The article title. +- `{% raw %}{{ review_assignment.reviewer }}{% endraw %}` + The reviewer's full name. +- `{% raw %}{{ editor.first_name }}{% endraw %}` + The editor's first name. +- `{% raw %}{{ review_assignment.date_due }}{% endraw %}` + The review due date. +- `{% raw %}{{ review_url }}{% endraw %}` + The link the reviewer uses to access the review. +- `{% raw %}{{ article_details }}{% endraw %}` + A printout of the article and review information, including title and due date. + +## Other common variables + +Here are some common examples you can copy and reuse across templates. + +> [!TIP] +> Not all variables are available on all templates, so always test out your template to make sure data is coming through. + +- Article title + `{% raw %}{{ article.safe_title }}{% endraw %}` +- Journal name + `{% raw %}{{ article.journal.name }}{% endraw %}` +- Review due date + `{% raw %}{{ review_assignment.date_due }}{% 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|se_can_see_pii:article }}{% endraw %}` + +If you use a variable with information that isn't available, e.g. a middle name for a user who has not provided one, it will be ignored nothing will be displayed. + +> [!NOTE] +> Certain variables have `|safe` appended, or the word “safe” somewhere in the variable, to ensure they display correctly even if they have HTML markup. For example, an article named “Review of Prince’s _1999_” will be stored in the Janeway database as `Review of Prince’s 1999`, and when `{% raw %}{{ article.safe_title }}{% endraw %}` is used in a template, “1999” will be italicized properly. + +> [!NOTE] +> In certain templates, variables related to personally identifying information should have "`|se_can_see_pii:article`" on the end. 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. + +## Variable reference (advanced) + +Below are the main objects you may encounter. This section is for advanced users. + +### Informational variables + +These print out information when put into a template. + +``` +{% raw %}{{ article.id }} +{{ article.safe_title }} +{{ article.abstract|safe }} +{{ article.owner }} +{{ article.owner.email }} +{{ article.owner.salutation }} +{{ article.owner.orcid }} +{{ article.owner.primary_affiliation }} +{{ article.correspondence_author }} +{{ article.correspondence_author.email }} +{{ article.correspondence_author.salutation }} +{{ article.correspondence_author.orcid }} +{{ article.correspondence_author.primary_affiliation }} +{{ article.keyword_list_str }} +{{ article.language }} +{{ article.section }} +{{ article.license }} +{{ article.rights|safe }} +{{ article.article_number }} +{{ journal.code }} +{{ journal.name }} +{{ journal.current_issue }} +{{ journal.description|safe }} +{{ journal.contact_info|safe }} +{{ review_assignment.article }} +{{ review_assignment.reviewer }} +{{ review_assignment.reviewer.email }} +{{ review_assignment.reviewer.salutation }} +{{ review_assignment.reviewer.primary_affiliation }} +{{ review_assignment.editor }} +{{ review_assignment.editor.email }} +{{ review_assignment.editor.salutation }} +{{ review_assignment.editor.primary_affiliation }} +{{ review_assignment.review_round.round_number }} +{{ review_assignment.date_due }} +{{ review_assignment.date_requested }} +{{ review_assignment.date_accepted }} +{{ review_assignment.date_complete }} +{{ review_assignment.decision }} +{{ review_assignment.visibility }} +{{ review_assignment.comments_for_editor }} +{% endraw %} +``` + +> [!TIP] +> Some variables provide links to other ones, so you can chain them together. For example, `review_assignment.article` can be extended with any of the variables beginning `article`, like this: `review_assignment.article.id`. + +### Logical variables + +These provide yes/no (boolean) information and are used in if/else blocks. For example: + +``` +{% raw %}{% if review_assignment.is_complete %} + The review assignment is complete. +{% else %} + The review assignment is incomplete. +{% endif %} +{% endraw %} +``` + +Each of these variables can be used in the first line of the if/else block: + +``` +{% raw %}{% if journal.is_conference %} +{% if review_assignment.is_complete %} +{% if review_assignment.for_author_consumption %} +{% if review_assignment.display_review_file %} +{% if review_assignment.reviewer.is_active %} +{% endraw %} +``` diff --git a/content/support/email-and-reminders/email-templates.md b/content/pages/support/email-and-reminders/email-templates.md similarity index 71% rename from content/support/email-and-reminders/email-templates.md rename to content/pages/support/email-and-reminders/email-templates.md index 9a8a1819..688d626d 100644 --- a/content/support/email-and-reminders/email-templates.md +++ b/content/pages/support/email-and-reminders/email-templates.md @@ -1,5 +1,3 @@ -title: Email templates - # Email templates 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). @@ -7,7 +5,7 @@ The email templates system allows you to view, search and edit the email templat > [!WARNING] > Editing an email template can cause emails to display incorrectly if placeholders are changed or removed. -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. +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](./email-template-variables.md) 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 system administrator or Janeway support. ## Editing templates @@ -24,8 +22,4 @@ 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. - - -## Template examples - -**TBC** +![An example of an edited email template.](../images/edited-template-example.png) diff --git a/content/pages/support/email-and-reminders/index.md b/content/pages/support/email-and-reminders/index.md new file mode 100644 index 00000000..eaf2c0ef --- /dev/null +++ b/content/pages/support/email-and-reminders/index.md @@ -0,0 +1,41 @@ +# 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](./email-logs.md). +- [How to customise email content through templates](./email-templates.md) and [how to work with email template variables](./email-template-variables.md). +- [How to set up automated reminders](./scheduling-reminders.md). +- [How to set up publication notifications](./publication-notifications.md). + +The pages to control these are found through the **Manager dashboard**, under **Cache, cron and emails**. + +![" "](../images/cache-cron-emails.png) + +## 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. See [Email logs](./email-logs.md) for more information. + +- _“I want to change the wording of reminder emails.”_ + Edit the relevant template under [Email templates](./email-templates.md). Use information in [Email template variables](./email-template-variables.md) 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. See[Scheduling reminders](./scheduling-reminders.md) for more information. + +- _“Can readers (un)subscribe to/from publication notifications?”_ + Yes. Readers manage their notification preferences via their profile page. See [Publication notifications](./publication-notifications.md) for more information. + +If something is unclear or you are unsure whether a change is safe to make, contact your system administrator. diff --git a/content/support/email-and-reminders/email-publication-notification-placeholder.md b/content/pages/support/email-and-reminders/publication-notifications.md similarity index 59% rename from content/support/email-and-reminders/email-publication-notification-placeholder.md rename to content/pages/support/email-and-reminders/publication-notifications.md index 2d18824d..dc2049b4 100644 --- a/content/support/email-and-reminders/email-publication-notification-placeholder.md +++ b/content/pages/support/email-and-reminders/publication-notifications.md @@ -1,21 +1,17 @@ -title: Publication notifications - # Publication notifications -Janeway supports publication notifications through the **Reader** role. This feature allows users to receive email notifications when new articles are published in a journal. +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. - +![Publication Notification page, showing the Readers section on the left and Sent Notifications section on the right.](../images/publication-notifications.png) ## 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. - - Once enabled, users will be able to subscribe to notifications from their profile. ## Subscribing to notifications @@ -29,15 +25,9 @@ Users can sign up for publication notifications by: ![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. +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**. - - +For more information about roles, see [**Roles and permissions**](../accounts-and-roles/roles-and-permissions-on-janeway.md). ## How notification emails are sent @@ -45,6 +35,8 @@ 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 using BCC, so recipients do not see other subscribers' email addresses. + +Reader notifications are logged in Janeway, but they are not associated with the respective articles, so they do not show up in an article’s logs. - +Users with access to the admin area can view reader notification logs by selecting the appropriate journal as the log target and “Publication Notification” as the log type. diff --git a/content/support/email-and-reminders/email-reminders.md b/content/pages/support/email-and-reminders/scheduling-reminders.md similarity index 59% rename from content/support/email-and-reminders/email-reminders.md rename to content/pages/support/email-and-reminders/scheduling-reminders.md index 39c27665..904ac7bc 100644 --- a/content/support/email-and-reminders/email-reminders.md +++ b/content/pages/support/email-and-reminders/scheduling-reminders.md @@ -1,8 +1,6 @@ -title: Scheduling reminders - # Scheduling reminders -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. +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. @@ -19,10 +17,9 @@ Janeway supports three types of reminder emails: - **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. +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. +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). @@ -34,10 +31,10 @@ Each reminder is defined using the following settings: The reminder category: "Review (invited)", "Review (accepted)", or "Revision". - Run type - Whether the reminder should be sent before or after the assignment due date. + Whether the reminder is sent before or after the assignment due date. - Days - The number of days before or after the due date that the reminder should be sent. + The number of days before or after the due date that the reminder is sent. - Template name The email template used for the reminder. @@ -60,18 +57,22 @@ Reminder emails use standard email templates and have access to specific objects - Article The appropriate article. -The **Edit template** page includes guidance and examples showing some of the variables available for use in reminder emails. +The **Create reminder template** page (accessed by clicking the **Edit** button under **Template name** on the **Reminders** page) includes guidance and examples showing some of the variables available for use in reminder emails. This information and additional detail can also be found in [Email templates](./email-templates.md) and [Email template variables](./email-template-variables.md) + +![" "](../images/edit-template-name.png) + +![" "](../images/create-reminder1.png) - +![" "](../images/create-reminder2.png) ## How reminders are sent -Once a reminder has been created, it is processed automatically by a scheduled background task (sometimes called a 'cron job' ) on the server. +Once a reminder has been created, it is processed automatically by a scheduled background task (sometimes called a ['cron job'](https://en.wikipedia.org/wiki/Cron) ) 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. +> Reminders are not sent if the reminder date has already passed. This means it is possible to accidentally create a reminder that never sends. To avoid this, set reminders for tomorrow or later. > [!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. +> 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. diff --git a/content/support/example-docs-page.md b/content/pages/support/example-docs-page.md similarity index 90% rename from content/support/example-docs-page.md rename to content/pages/support/example-docs-page.md index 105aceb0..c23a14f8 100644 --- a/content/support/example-docs-page.md +++ b/content/pages/support/example-docs-page.md @@ -1,5 +1,3 @@ -Title: Example Docs Page - # Example Docs Page This is an example of a docs page. It has an image with alt text that [can diff --git a/content/support/guides/account-troubleshooting-placeholder.md b/content/pages/support/guides/account-troubleshooting.md similarity index 60% rename from content/support/guides/account-troubleshooting-placeholder.md rename to content/pages/support/guides/account-troubleshooting.md index 6c594956..737e59fc 100644 --- a/content/support/guides/account-troubleshooting-placeholder.md +++ b/content/pages/support/guides/account-troubleshooting.md @@ -1,29 +1,18 @@ -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 ) +- An editor or journal manager activating your account. (If you are an editor or journal manager, see [Activating a user account](#activating-a-user-account) for more information). ### 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. - - +See: [Activating accounts](../accounts-and-roles/activating-accounts.md#activating-accounts-1) ## New password @@ -33,14 +22,14 @@ If you have forgotten your password and need to reset it: 1. Click **Forgotten your password?** 2. Enter your email address. -3. Click the **Request token** +3. Click the **Request token** button. 4. Open your email inbox and locate the password reset email. The email subject will be "[journal name] Password Reset". It can take a few minutes to arrive and may arrive in your spam folder. 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) -If you have not received the password reset email, contact **Support**. +If you have not received the password reset email, contact **Support**. ## Update your password diff --git a/content/support/guides/workflow-author.md b/content/pages/support/guides/author-guide.md similarity index 88% rename from content/support/guides/workflow-author.md rename to content/pages/support/guides/author-guide.md index 540d6b5f..52394651 100644 --- a/content/support/guides/workflow-author.md +++ b/content/pages/support/guides/author-guide.md @@ -1,5 +1,3 @@ -title: Author guide - # Author guide This guide will walk you through the Janeway journal submission system. @@ -36,7 +34,7 @@ This is an example of how this will appear from the author dashboard within Jane ![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**](#author-information) section of this guide. ### The author agreement @@ -49,18 +47,18 @@ The first page of the submission process is the author agreement. Depending on h - 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. + The copyright notice specifies the licence 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] -> 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. +> 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. 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. ### Article information -The **article information** page is where you will provide the metadata for your submission. Required fields will be marked with an asterisk, but we recommend that you fill out optional fields as well. +The **article information** page is where you will provide the metadata for your submission. Required fields will be marked with an asterisk, but it is recommended that you fill out optional fields as well. ![The article information page, filled with example data.](../images/workflow/author-article-information.png) @@ -76,7 +74,7 @@ Metadata that may be requested on this page: - 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. + This is usually disabled if the journal only accepts one licence 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. @@ -86,7 +84,7 @@ Individual journals can add more fields to this page. These will be displayed un ### Author information -The **Author information** page is where you fill in the relevant information about a submission’s author(s). The person submitting will be automatically added as an author. +The **Author information** page is where you fill in the relevant information about a submission's author(s). The person submitting will be automatically added as an author. To add more authors to a submission, you can either search the journal's author list for existing authors, search by ORCID or add another author manually. @@ -102,22 +100,11 @@ To add more authors to a submission, you can either search the journal's author - Last name - Email address -This will not create a new account for the additional 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. - -- 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: - - First name - - Last name - - Email address - - ![" "](../images/workflow/author-submission-author-manual.png) +This will not create a new account for the additional 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. -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. +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. @@ -140,13 +127,13 @@ Even if they have already been inserted into the manuscript file, you need to ad To add a file, click the **Upload** button under either **Manuscript file** or **Figures and data files**, and a popup will appear. You can select the file from here using the **Choose file** button. -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 are required to add a label to any file uploaded, but the description field is optional. For manuscript files, it is recommended to use 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). 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. +You will then be asked to supply information about any relevant funding. You can search for your funding source using the **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. !["The funding information page."](../images/workflow/author-funding.png) !["The funder ID block, with example information."](../images/workflow/author-add-funder.png) @@ -205,7 +192,7 @@ It is important that all stylistic changes are made at this stage. As many error The typesetters will then use this final manuscript to create the finished article, which will be sent back for checking in the form of typeset proofs. -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. +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 are requested at the proofing stage, if any. ### Completing a copyediting review as an author diff --git a/content/support/guides/workflow-copyeditor.md b/content/pages/support/guides/copyeditor-guide.md similarity index 67% rename from content/support/guides/workflow-copyeditor.md rename to content/pages/support/guides/copyeditor-guide.md index 381e6095..38bc2991 100644 --- a/content/support/guides/workflow-copyeditor.md +++ b/content/pages/support/guides/copyeditor-guide.md @@ -1,8 +1,6 @@ -title: Copyeditor guide - # Copyeditor guide -When a new copyediting assignment is created, you will receive an email containing a link. Click on this link to be taken to the **Copyediting Requests** page, where you can see all of your copyediting tasks. You can also access this page through the copyediting block on the journal dashboard by clicking on **View Requests**. +When a new copyediting assignment is created, you will receive an email containing a link. Click on this link to be taken to the **Copyediting requests** page, where you can see all of your copyediting tasks. You can also access this page through the copyediting block on the journal dashboard by clicking on **View requests**. ![copyeditor dashboard block](../images/workflow/copyeditor-dashboard.png) @@ -27,25 +25,25 @@ Once you have clicked into a paper, the next page you see will be broken into fo 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) by clicking the **Download** icon. + 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. + 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. - ![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) + ![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) +![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) +![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) In this section, you can leave any notes for the editor. They may pass these to the author if so required. @@ -60,10 +58,10 @@ The editor can then either accept your copyedited manuscript and move onto the n ## Reopened task -If the editor has reopened the task, you will receive an email containing a link to the **Copyediting requests** page. There, you will be able to see the request on your Dashboard. +If the editor has reopened the task, you will receive an email containing a link to the **Copyediting requests** page. There, you will be able to see the request on your dashboard. -![The three columns on the ‘Copyedit Requests’ page (‘Awaiting initial decision’, ‘In progress’ and ‘Completed’. There is a task that has been reopened in the middle and the original completed task on the right.](../images/workflow/copyedit-reopened-kanban.png) +![The three columns on the 'Copyedit Requests' page ('Awaiting initial decision', 'In progress' and 'Completed'. There is a task that has been reopened in the middle and the original completed task on the right.](../images/workflow/copyedit-reopened-kanban.png) -It may appear as though the task has been duplicated, but the one in the **Completed** column is the original task, and the one shown under **In Progress** will be the reopened version. +It may appear as though the task has been duplicated, but the one in the **Completed** column is the original task, and the one shown under **In progress** will be the reopened version. From here, this works the same way as any other copyediting task. The updated paper will be found under and can be downloaded from **Article files** for you to work on. Once you have completed your copyedit, it can be uploaded under **Copyedited files**. When you have done this, press **Complete copyedit task** to submit your work. The reopened task will be moved to **Complete** and the editor will be notified. diff --git a/content/support/guides/account-set-up.md b/content/pages/support/guides/creating-an-account-on-janeway.md similarity index 89% rename from content/support/guides/account-set-up.md rename to content/pages/support/guides/creating-an-account-on-janeway.md index e59d46fe..c9989547 100644 --- a/content/support/guides/account-set-up.md +++ b/content/pages/support/guides/creating-an-account-on-janeway.md @@ -1,12 +1,10 @@ -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 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](../review/review-settings.md). 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. @@ -30,3 +28,6 @@ On this page, you can do the following: - Set review interests. - Set your timezone. - Set your profile visibility. + +> [!IMPORTANT] +> Just the unique ID must be entered in the **ORCID** field (e.g. `0000-1234-5678-901X`). Do not include `https://orcid.org/`. diff --git a/content/pages/support/guides/editor-guide-overview.md b/content/pages/support/guides/editor-guide-overview.md new file mode 100644 index 00000000..f6b7dc79 --- /dev/null +++ b/content/pages/support/guides/editor-guide-overview.md @@ -0,0 +1,37 @@ +# Editor guide - overview + +This guide walks editors through the editorial workflow in Janeway, from a new submission to publication. Each stage below links to a dedicated page with step-by-step instructions. + +## The workflow at a glance + +Every article moves through the same core stages, though there are additional, optional and/or alternative stages. + +1. **Submission.** New articles start out unassigned. An editor assigns an editor or section editor to the article, then decides whether to move it to review, accept it outright, or decline it. +2. **Review.** Reviewers assess the manuscript. Editors can run multiple review rounds, request revisions, and share reviews with authors and reviewers. +3. **Copyediting.** A copyeditor prepares the accepted manuscript for typesetting. Authors can review the copyedited manuscript before it moves on. +4. **Typesetting.** Manuscript files are converted into publishable galleys (PDF, HTML, and/or JATS XML) and then proofread. +5. **Pre-publication.** Final checks confirm the metadata, issue assignment, DOI, galley selection, publication date, and article image before the article goes live. +6. **Published.** The article is available to readers. + +Not every article follows this path exactly. See [Workflow variations](#workflow-variations) for the most common branches. + +## Workflow variations + +- **Skip review.** At the submission stage, editors can accept an article outright (for example, editorials) and send it straight to copyediting, bypassing peer review. +- **Decline at any stage.** Articles can be declined at submission or after a review round. Declining removes the article from the workflow and notifies the author. +- **Multiple review rounds.** After an author submits requested revisions, editors can open a new review round instead of moving straight to a decision. +- **Draft decisions.** If your journal enables this option, section editors draft a decision (accept, minor revisions, major revisions, conditional accept, or decline) for an editor to review and approve, rather than deciding directly. +- **Typesetting method.** Editors can upload galleys manually, generate HTML galleys from a DOCX or RTF file using the Pandoc plugin, or assign the work to an external typesetter. A journal can use more than one method. Typesetting can also be skipped if you wish to only publish the format an article was submitted in. +- **Proofing.** Editors can invite authors, editors, or dedicated proofreaders to check galleys before publication, and send flagged issues back to the typesetter for correction. + +There are other variations available; removing copyediting, only using Janeway to display published articles rather than processing them in the system, working with repositories etc. For more information on this, contact the Janeway developer team or your system administrator. + +## Table of contents + +- [Editor guide to submissions](./editor-guide-to-submission.md) — Handle unassigned submissions, assign editors, make initial accept or decline decisions, set projected issues, and edit author details. +- [Editor guide to review](./editor-guide-to-review.md) — Set up review rounds, assign reviewers, share reviews with authors, make a decision, and request revisions. + - [Editor guide to draft decisions](./editor-guide-to-draft-decisions.md) — See how section editors draft decisions and how editors review and approve them. Optional workflow. +- [Editor guide to copyediting](./editor-guide-to-copyediting.md) — Assign copyeditors, review completed copyedits, and request author review. +- [Editor guide to typesetting](./editor-guide-to-typesetting.md) — Upload galleys, work with typesetters, manage proofing, and manage image and typeset files. + - [Editor guide to typesetting with Pandoc](./editor-guide-to-typesetting-with-pandoc.md) — Convert DOCX or RTF files into HTML galleys, and edit galleys directly. +- [Editor guide to pre-publication](./editor-guide-to-prepub.md) — Complete the final metadata, issue, DOI, galley, date, and image checks, then publish. diff --git a/content/support/guides/workflow-editor-copyediting.md b/content/pages/support/guides/editor-guide-to-copyediting.md similarity index 87% rename from content/support/guides/workflow-editor-copyediting.md rename to content/pages/support/guides/editor-guide-to-copyediting.md index 49f8f021..c39c2969 100644 --- a/content/support/guides/workflow-editor-copyediting.md +++ b/content/pages/support/guides/editor-guide-to-copyediting.md @@ -1,5 +1,3 @@ -title: Editor guide to copyediting - # Editor guide to copyediting The copyediting stage allows you to assign, track and complete copyediting tasks. You can also request revisions from authors from this interface. @@ -20,21 +18,19 @@ This will open a new page where you can do the following: 3. Leave notes for the copyeditor. 4. Set a due date. -> [!Warning] +> [!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. 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. +> If a copyeditor already has an active copyediting task for this article, they will not appear in the list, you must first close that task if you wish to assign them again. ## Managing copyediting assignments You can make as many copyediting assignments as needed and track them from the copyediting screen. -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. +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](./copyeditor-guide.md). 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. @@ -42,7 +38,7 @@ Before the task is accepted, you can edit the notes and due date or delete the a !["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: +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. diff --git a/content/support/guides/workflow-editor-draft-decision.md b/content/pages/support/guides/editor-guide-to-draft-decisions.md similarity index 70% rename from content/support/guides/workflow-editor-draft-decision.md rename to content/pages/support/guides/editor-guide-to-draft-decisions.md index ba276fea..07ecdb96 100644 --- a/content/support/guides/workflow-editor-draft-decision.md +++ b/content/pages/support/guides/editor-guide-to-draft-decisions.md @@ -1,8 +1,6 @@ -title: Editor guide to draft decisions - # 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. +Draft decisions 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 draft decision page."](../images/workflow/editor-draft-decision.png) @@ -11,9 +9,10 @@ The options for draft decision types are the same as those in the standard decis - **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 section editor can 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. + The section editor can 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. @@ -38,7 +37,7 @@ For section editors, the workflow will look like this: 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**. +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) diff --git a/content/support/guides/workflow-editor-prepub.md b/content/pages/support/guides/editor-guide-to-prepub.md similarity index 88% rename from content/support/guides/workflow-editor-prepub.md rename to content/pages/support/guides/editor-guide-to-prepub.md index c02d0e58..eb8681fa 100644 --- a/content/support/guides/workflow-editor-prepub.md +++ b/content/pages/support/guides/editor-guide-to-prepub.md @@ -1,5 +1,3 @@ -title: Editor guide to pre-publication - # Editor guide to pre-publication Pre-publication takes you through the last checks before publication, going through each of these final elements step-by-step: @@ -14,7 +12,7 @@ Pre-publication takes you through the last checks before publication, going thro ## Confirm the metadata -Confirming the metadata is the first step in prepublication. This is where you can make final checks and alterations to information such as the author details, abstracts, titles, licenses, funders, etc. +Confirming the metadata is the first step in prepublication. This is where you can make final checks and alterations to information such as the author details, abstracts, titles, licences, funders, etc. If you publish using XML, it is essential to ensure that the abstract and title in the metadata exactly match those of the PDF file. Authors often change their abstracts during revision and copyediting, so the original abstract may require updating before publication. If you copy and paste an abstract into the metadata field, ensure it is pasted without formatting (Janeway will offer to remove formatting). @@ -36,14 +34,13 @@ Check the **Mark as complete** once you are done. ## Verify DOIs -Articles usually have a DOI (Digital Object Identifier) automatically assigned and created (‘minted’) for them by Janeway. The DOI serves as both a unique identifier and a permalink. The **Verify DOI** step lets you check if the DOI is working successfully as a permalink. +Articles usually have a DOI (Digital Object Identifier) automatically assigned and created ('minted') for them by Janeway. The DOI serves as both a unique identifier and a permalink. The **Verify DOI** step lets you check if the DOI is working successfully as a permalink. 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) -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. - +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](../identifiers/crossref-article-doi.md#interpreting-registration-status) for more information. Check the **Mark as complete** box to move on to the next step. ## Select a galley for rendering @@ -67,12 +64,12 @@ Check the **Mark as complete** box to move on to the next step. Upload an image (JPG, PNG or GIF formats are accepted; do not use PDFs) in the pop-up window. Rectangular or landscape images work best, as this image will usually sit at the top of an article. -You can also set an article thumbnail through the **Article image manager**, which is accessible through the Manager dashboard or the Article archive page. More information on managing article images and their recommended dimensions is available here. +You can also set an article thumbnail through the **Article image manager**, which is accessible through the Manager dashboard or the Article archive page. More information on managing article images and their recommended dimensions is [available here](../article-management/article-images.md). > [!TIP] > You can source many free-to-use images from [Unsplash.com](https://unsplash.com/). If you are sourcing images from elsewhere, be aware of any copyright restrictions and only use images that you are permitted to reproduce. -Check the **Mark as Complete** box to move on to the next step. +Check the **Mark as complete** box to move on to the next step. ## Send the publication notifications @@ -81,7 +78,7 @@ 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. -Check the **Mark as Complete** box to move on to the next step. +Check the **Mark as complete** box to move on to the next step. ## Publishing the article @@ -90,6 +87,6 @@ Once you have completed all the steps, you are ready to publish the article. The > [!NOTE] > 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. +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: [Article management](../article-management/articles-management.md). The publishing workflow is now complete – congratulations on your finished article! diff --git a/content/support/guides/workflow-editor-review.md b/content/pages/support/guides/editor-guide-to-review.md similarity index 77% rename from content/support/guides/workflow-editor-review.md rename to content/pages/support/guides/editor-guide-to-review.md index eb11c113..bd0d20a5 100644 --- a/content/support/guides/workflow-editor-review.md +++ b/content/pages/support/guides/editor-guide-to-review.md @@ -1,10 +1,8 @@ -title: Editor guide to review - # Editor guide to review The review workflow may take various shapes depending on the type of review a journal uses. This workflow allows you to assign articles to reviewers, gather the reviews and communicate a decision about the article to the author. -This guide will cover the default review workflow, which applies to single anonymous, double anonymous, and most of the open and triple anonymous workflows. There are additional guides for triple anonymous peer review and sharing reviews and author responses. Additionally, there is information available on configuring the peer review process and setting up review forms. +This guide will cover the default review workflow, which applies to single anonymous, double anonymous, and most of the open and triple anonymous workflows. There are additional pages with information on using [triple anonymous peer review](../review/triple-anonymous-peer-review.md) and [sharing reviews and author responses](../review/sharing-reviews.md). Additionally, there is information available on [configuring the peer review process](../review/index.md) and [setting up review forms](../review/review-forms.md). ## Setting up a review @@ -19,15 +17,15 @@ After the appropriate files have been selected, you can add the reviewers. You d 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. +> It is recommended to turn on [one-click review](../review/review-settings.md). 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. +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](../review/review-settings.md) 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 . +You can see how this appears to reviewers and what the review process looks like for them in the [reviewer guide](./reviewer-guide.md). ### Managing a review @@ -43,7 +41,7 @@ Or by clicking on the ⏷ **dropdown** icon, the following options will also bec - 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). -- Rate the reviewer. The reviewers’ average ratings will be visible when selecting them for review. +- Rate the reviewer. The reviewers' average ratings will be visible when selecting them for review. - Withdraw the review. - Delete the review. - If you have admin permissions, you can edit the review details in Admin. @@ -52,7 +50,7 @@ Or by clicking on the ⏷ **dropdown** icon, the following options will also bec ### Viewing and editing reviews -Once a reviewer has completed their review, you can view it using the **View** button. You can see the reviewer’s feedback, comments to you as the editor, and you will have the option to edit the review if needed. When an author reads the review, they will see only your edited version, not the reviewer's original version. You can reset the feedback to its original, unedited version at any time. +Once a reviewer has completed their review, you can view it using the **View** button. You can see the reviewer's feedback, comments to you as the editor, and you will have the option to edit the review if needed. When an author reads the review, they will see only your edited version, not the reviewer's original version. You can reset the feedback to its original, unedited version at any time. > [!NOTE] > Janeway will retain a copy of the original review and this will remain visible to editors when opening the review. @@ -61,7 +59,7 @@ Once a reviewer has completed their review, you can view it using the **View** b Once a review is complete, editors can share it with the author(s). They are unavailable to authors by default. If the review includes a file, you will have the option to make it available to the author as well. -You can see what the author sees in the review section of the author guide. +You can see what the author sees in the review section of the [author guide](./author-guide.md). There are two ways reviews can be made available: @@ -70,7 +68,7 @@ There are two ways reviews can be made available: ![" "](../images/workflow/editor-share-review.png) ![" "](../images/workflow/editor-share-review-individual.png) -- ‘In bulk’ when making a decision, after clicking on **Make a decision** (for more information, see Decision helper ). First, you will see all completed reviews in a column with a toggle detailing whether the review is visible to the author. +- 'In bulk' when making a decision, after clicking on **Make a decision**. 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) @@ -80,7 +78,7 @@ In addition to making the overall review available for authors to read, you can ![" "](../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 ). +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](../review/review-settings.md) and [review forms](../review/review-forms.md)). ## Making a review decision @@ -107,7 +105,7 @@ If enabled: 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. +> These settings must first be enabled before the options will be displayed, see [Review settings](../review/review-settings.md). ## Request revisions @@ -124,7 +122,7 @@ You can now either accept the article and move it to copyediting or open another ## Sharing reviews amongst reviewers -You can share completed peer reviews among reviewers. This can be set up through the **Review settings** interface . Once sharing reviews has been set up, there are two ways in which reviews can be shared. +You can share completed peer reviews among reviewers. This can be set up through the [**Review settings**](../review/review-settings.md) interface. Once sharing reviews has been set up, there are two ways in which reviews can be shared. - 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. @@ -132,7 +130,7 @@ You can share completed peer reviews among reviewers. This can be set up through !["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](../review/review-settings.md). ### Deleting a review round diff --git a/content/support/guides/workflow-editor-submission.md b/content/pages/support/guides/editor-guide-to-submission.md similarity index 75% rename from content/support/guides/workflow-editor-submission.md rename to content/pages/support/guides/editor-guide-to-submission.md index 787884bd..7509dad6 100644 --- a/content/support/guides/workflow-editor-submission.md +++ b/content/pages/support/guides/editor-guide-to-submission.md @@ -1,5 +1,3 @@ -title: Editor guide to submissions - # Editor guide to submissions The editorial workflow in Janeway starts with the Unassigned stage, where you can find new submissions for your journal and assign them to an editor. You can also use this stage as an editorial screening stage, where you make the initial decision about submissions - whether to proceed with them or reject outright. @@ -9,7 +7,7 @@ The editorial workflow in Janeway starts with the Unassigned stage, where you ca By default, editors are notified by email once a new article has been submitted. This email contains a link to the submitted article. New submissions can also be accessed through the Dashboard by clicking on **Unassigned**. Clicking this will take you to a list of all submissions that do not yet have an editor assigned. > [!NOTE] -> Notifications can also be set up per article type (section) or for specific (section) editors. See information on setting up submission notifications and setting up article sections. +> Notifications can also be set up per article type (section) or for specific (section) editors. See information on setting up [submission notifications](../submission/submission-notifications.md) and setting up [article sections](../article-management/article-sections.md). ## Reviewing submissions @@ -17,7 +15,7 @@ When you click on an article in the list of new submissions, you will be taken t ![" "](../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. +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**. @@ -39,7 +37,7 @@ If you move the article into review and are its author, you will initially be bl ## Projected issues -You can also assign a submission to a projected issue. This can be set or changed at any point in the publication workflow. To set a projected issue, click **Assign Projected Issue** on the article page and select the chosen issue from the dropdown, and click **Save**. This article's projected issue will now be set. You can unset a projected issue by selecting the blank option. +You can also assign a submission to a [projected issue](../issues-volumes-and-collections/issues-and-volumes.md). This can be set or changed at any point in the publication workflow. To set a projected issue, click **Assign Projected Issue** on the article page and select the chosen issue from the dropdown, and click **Save**. This article's projected issue will now be set. You can unset a projected issue by selecting the blank option. The projected issue functionality can be used internally to keep track of plans and communicate with typesetters, without affecting issue assignment or displaying information publicly. It is helpful for journals that add articles to issues on a rolling basis and publish them individually. @@ -50,4 +48,4 @@ To edit an author's affiliation, click **Edit author details** and scroll down t !["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. +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 institutions, 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-pandoc.md b/content/pages/support/guides/editor-guide-to-typesetting-with-pandoc.md similarity index 69% rename from content/support/guides/workflow-editor-pandoc.md rename to content/pages/support/guides/editor-guide-to-typesetting-with-pandoc.md index 976d1af8..34cf19c4 100644 --- a/content/support/guides/workflow-editor-pandoc.md +++ b/content/pages/support/guides/editor-guide-to-typesetting-with-pandoc.md @@ -1,5 +1,3 @@ -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 newly generated HTML files as galleys. @@ -8,17 +6,19 @@ To work on a file, find it under **Files for typesetting** and click **Options** !["The files for typesetting block."](../images/workflow/editor-typesetting-options.png) -- 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. +- 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. -- Transform to HTML: This option transforms the manuscript file (DOCX or RTF) into an HTML file that displays the article within a web browser. +- 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 . +You can now edit the galley and manage images as outlined in the [Editor - typesetting guide](./editor-guide-to-typesetting.md#image-and-figure-files). ## Editing galleys -If needed, you can also edit galleys on Janeway. This is currently only available through a direct link by adding '/file-editor/' to the end of your journal homepage webaddress. +If needed, you can also edit galleys on Janeway. This is only available through a direct link by adding '/file-editor/' to the end of your journal homepage webaddress. > [!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'. @@ -28,4 +28,4 @@ On the file editor, you can find a table with all HTML and XML galleys in your j > [!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. -You can now edit the galley and save it. Changes made through this editor cannot be undone once you have saved the galley. If you are making changes to an already published article, the changes will be visible to readers once you have saved the galley. Missing images should not be uploaded through this editor, but through the Image Manager within the Typesetting interface . +You can now edit the galley and save it. Changes made through this editor cannot be undone once you have saved the galley. If you are making changes to an already published article, the changes will be visible to readers once you have saved the galley. Missing images must not be uploaded through this editor, but through the [**Image Manager**](./editor-guide-to-typesetting.md#image-and-figure-files) within the typesetting interface. diff --git a/content/support/guides/workflow-editor-typesetting.md b/content/pages/support/guides/editor-guide-to-typesetting.md similarity index 79% rename from content/support/guides/workflow-editor-typesetting.md rename to content/pages/support/guides/editor-guide-to-typesetting.md index 7438da24..c9527d53 100644 --- a/content/support/guides/workflow-editor-typesetting.md +++ b/content/pages/support/guides/editor-guide-to-typesetting.md @@ -1,24 +1,20 @@ -title: Editor guide to typesetting - # Editor guide to typesetting This stage covers typesetting and proofreading of typeset files. This guide will provide the following information: -- An outline of the typesetter page -- Information on files relevant to typesetting -- An overview of the three types of typesetting workflows - - Uploading galleys yourself. - - Converting files within Janeway. - - Working with an external typesetter. -- An overview of the proofing workflow. -- Information on managing typeset files. -- Managing image and figure files. - - +- [An outline of the typesetter page.](#the-typesetting-stage) +- [Information on files relevant to typesetting.](#typesetting-files) +- An overview of the three types of typesetting workflows. + - [Uploading galleys yourself.](#upload-galleys-yourself-workflow) + - [Converting files within Janeway.](#generating-typeset-files-with-janeway-workflow) + - [Working with an external typesetter.](#working-with-a-typesetter) +- [An overview of the proofing workflow.](#proofing) +- [Information on managing typeset files.](#managing-typesetting-files) +- [Managing image and figure files.](#image-and-figure-files). ## The typesetting stage -The typesetting overview screen shows all articles currently in typesetting, with their status. +The typesetting overview screen shows all articles in typesetting, with their status. You can **Claim** an article to indicate who is managing its typesetting (this doesn't restrict other editors' access). To see all your claimed articles, use the filter in the top-right corner to show only **My assignments**. After selecting an article, you will be taken to the typesetting page. This page is divided into blocks: @@ -39,7 +35,7 @@ After selecting an article, you will be taken to the typesetting page. This page !["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. +You can see the typesetter's view and their experience of the workflow in the [typesetter guide](./typesetter-guide.md). ## Typesetting files @@ -57,7 +53,7 @@ When uploading typeset files, Janeway will ask you to set a label. The label wil 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. -For PDF, XML and HTML files, Janeway can automatically set the label to the file type if left blank. For other filetypes, it will default to ‘OTHER’ if left blank. +For PDF, XML and HTML files, Janeway can automatically set the label to the file type if left blank. For other filetypes, it will default to 'OTHER' if left blank. ## Supplementary files @@ -67,26 +63,26 @@ 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. +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 will be public upon publication and set its label. ![" "](../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. +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](#image-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. +> Do not use the image or galley upload for supplementary files. See [Supplementary files](#supplementary-files) for more information. ## 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 . +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](./editor-guide-to-typesetting-with-pandoc.md). -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. ## 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](../accounts-and-roles/managing-user-accounts.md) for more information. ### Assigning a typesetter @@ -103,7 +99,7 @@ You can now do the following: 5. Send a notification email to the typesetter (or skip this step). > [!TIP] -> You can customise the typesetting instructions through the typesetting guidelines setting , in order to avoid having to repeat instructions in the notes box on every typesetting assignment. +> You can customise the typesetting instructions through the [typesetting guidelines setting](#typesetting-guidelines-setting), in order to avoid having to repeat instructions in the notes box on every typesetting assignment. If no issue has been set yet for this article, you can do this now. Typesetters may need this information (especially if working with JATS-XML). @@ -121,7 +117,7 @@ Once the typesetter has completed their task, you will receive an email notifica 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 . + If you notice a problem with the typeset files straight away, you can request corrections to the typesetter. See [Requesting corrections](#requesting-corrections). - **Proofing required** Accept the typeset files and record the decision to send the files for proofing. - **Accept** @@ -161,7 +157,7 @@ Proofing assignments can still be edited before the proofreader accepts them, in Once proofreaders have finished their task, you can review their feedback and any uploaded annotated documents by clicking **Manage** on the proofreader assignment. -The review page will list the galleys that have been proofed and displays the proofreader’s feedback. If the proofreader uploaded an annotated document, you can also view it on this page. +The review page will list the galleys that have been proofed and displays the proofreader's feedback. If the proofreader uploaded an annotated document, you can also view it on this page. If no further corrections are needed, you can click **Complete typesetting** under **Actions** to finish typesetting and move the article to prepublication. @@ -171,7 +167,7 @@ If you require corrections, click **Request corrections**. ### Requesting corrections -You can now assign a typesetter to correct issues that were flagged in proofing, as outlined in Assigning a typesetter . In addition to the previous steps, you can now also do the following: +You can now assign a typesetter to correct issues that were flagged in proofing, as outlined in [Assigning a typesetter](#assigning-a-typesetter). In addition to the previous steps, you can now also do the following: - Provide the typesetter with an annotated document, if one was provided. - Select the galleys that require corrections. @@ -182,7 +178,7 @@ You can now assign a typesetter to correct issues that were flagged in proofing, ## 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) @@ -191,9 +187,9 @@ On this page, you can do the following: - Replace the typeset file; the old file will be retained in the file history. - Edit the file label. - (Un)mark the file as public. -- Manage image files -- Manage CSS files -- Manage XSL files +- [Manage image files](#image-and-figure-files). +- [Manage CSS files](#css-file). +- [Manage XSL files](#xsl-file). ### Image and figure files @@ -217,11 +213,17 @@ The following information is aimed at advanced users, comfortable with CSS / XSL 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. +> The CSS uploaded here must only target elements inside the \ block, otherwise it could break general styling of the site. ### 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. +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 when changes are made 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. + +## Typesetting guidelines setting + +The typsetting guidelines shown to the typesetters can be edited through the **Typesetting guidelines** setting. This setting can be found through **All settings** on the Manager dashboard. + +![" "](../images/typesetting-guidelines.png) diff --git a/content/support/guides/getting-started-placeholder.md b/content/pages/support/guides/getting-started.md similarity index 76% rename from content/support/guides/getting-started-placeholder.md rename to content/pages/support/guides/getting-started.md index 769da385..9296b001 100644 --- a/content/support/guides/getting-started-placeholder.md +++ b/content/pages/support/guides/getting-started.md @@ -1,5 +1,3 @@ -title: Getting started with Janeway - # Getting started with Janeway - Registering an account and setting up permissions. diff --git a/content/pages/support/guides/index.md b/content/pages/support/guides/index.md new file mode 100644 index 00000000..bd774998 --- /dev/null +++ b/content/pages/support/guides/index.md @@ -0,0 +1,4 @@ +# Janeway guides + +This is a landing page for guides available. +_Coming soon_ diff --git a/content/support/guides/journal-design-placeholder.md b/content/pages/support/guides/journal-design.md similarity index 95% rename from content/support/guides/journal-design-placeholder.md rename to content/pages/support/guides/journal-design.md index 4dc671df..359a8aa4 100644 --- a/content/support/guides/journal-design-placeholder.md +++ b/content/pages/support/guides/journal-design.md @@ -1,5 +1,3 @@ -title: Journal design - # Journal design _Coming soon_ diff --git a/content/support/guides/journal-setup-placeholder.md b/content/pages/support/guides/journal-setup.md similarity index 73% rename from content/support/guides/journal-setup-placeholder.md rename to content/pages/support/guides/journal-setup.md index 2609f714..3da14894 100644 --- a/content/support/guides/journal-setup-placeholder.md +++ b/content/pages/support/guides/journal-setup.md @@ -1,5 +1,3 @@ -title: Set up your journal - # Set up your journal _This is a work in progress_ @@ -27,16 +25,16 @@ Journal design - see guide . - Typesetters (if applicable) - Editors - Editorial board - Can be imported, see import plugin. + Can be imported, see [import plugin](../plugins/imports-plugin.md). ## Submission - Enable or disable submission. -- Setup licences for submission. or triple anonymous +- Review type: double or single anonymous, [open peer review](../review/open-peer-review.md) or [triple anonymous](../review/triple-anonymous-peer-review.md) - Review form - One-click peer review diff --git a/content/support/guides/janeway-metadata.md b/content/pages/support/guides/metadata-on-janeway.md similarity index 95% rename from content/support/guides/janeway-metadata.md rename to content/pages/support/guides/metadata-on-janeway.md index cd9b4619..d2c6d7b5 100644 --- a/content/support/guides/janeway-metadata.md +++ b/content/pages/support/guides/metadata-on-janeway.md @@ -1,5 +1,3 @@ -title: Metadata on Janeway - # Metadata on Janeway _This is a work in progress_ @@ -48,7 +46,7 @@ ROR data is available from Janeway in these places: - auto-generated JATS XML stubs - Crossref deposits (XML) - the OAI-PMH feed (XML) -- the Open Access Switchboard (via the **OA Switchboard** plugin) +- the Open Access Switchboard (via the [**OA Switchboard** plugin](../plugins/oaswitchboard.md)) diff --git a/content/pages/support/guides/navigating-janeway.md b/content/pages/support/guides/navigating-janeway.md new file mode 100644 index 00000000..aeea3d85 --- /dev/null +++ b/content/pages/support/guides/navigating-janeway.md @@ -0,0 +1,34 @@ +# Navigating Janeway + +There are various ways to navigate Janeway, depending on where you are on Janeway, what you are doing and where you are trying to go. + +There are three distinct areas of Janeway to navigate: + +- Web content + - The web content (or front-end) is the public-facing website that shows the articles, homepage and other content you want to share with those visiting the journal. It will also be where information such as author guidelines, policy and submission guidance is displayed. + +- The back office + - This is the part of Janeway you see when you are logged in. This is where you process articles (review, copyediting, typesetting etc.), configure workflows and manage the journal more broadly. You can access journal settings, journal styling, user information, article metadata, email templates and more from here. + +- The admin area + - This part of Janeway is intended for system administrators and advanced users. From here, you can check various types of data and settings, directly edit information and troubleshoot issues. We recommend not using this interface if you are not comfortable with it, and contacting your system administrator or support contact if you encounter any difficulties + +## Journal and press website + +The journal and / or press website (also called 'frontend') can be navigated through the navigation bar ('navbar') at the top of the website. To setup your navbar, see this section on [customing the navbar](../journal-management/navigation.md). + +In addition, the privacy policy, accessibility and similar items can also be linked in the footer. To setup your footer, see [Footer navigation](../press-management/footer.md). + +If you are logged in, you can click on **Account** or the circular icon with your profile picture (if set). This will present you with a dropdown. From the dropdown, you can navigate to the back office by selecting **Dashboard** or **Manager**. From there, you can configure the journal, the submissions portal, your profile, or the admin area. Which of these are visible will depend on your permissions and role(s) within the journal. + +## Navigating Janeway workflows and management areas + +Also called the 'backoffice' + +Dashboard + +Manager interface + +## Admin area + +Ordered by the underlying database - cannot be changed. diff --git a/content/pages/support/guides/proofreader-guide.md b/content/pages/support/guides/proofreader-guide.md new file mode 100644 index 00000000..c4d0b435 --- /dev/null +++ b/content/pages/support/guides/proofreader-guide.md @@ -0,0 +1,43 @@ +# Proofreader guide + +As a proofreader you may be assigned proofing tasks for a paper. These will be assigned after a paper has gone through a round of typesetting. When a new assignment is made you will receive and email and be able to see the requests from the journal dashboard, they will be displayed as part of the typesetting block. + +The following users can be assigned as proofreaders: + +- Authors of the paper +- Editors +- Users with the Proofreader role + +![ The typesetting block on the dashboard. It displays typesetting and proofreading tasks.](../images/workflow/typesetting-proofreading-tasks.png) + +## Proofreading assignments + +On the proofreading overview page, you will see tasks in progress and completed tasks. Click **View assignment** to open a proofreading assignment. + +![A screenshot of the Proofreading assignments page, showing two blocks of Your proofreading assignments. The top one is open assignments and has a View assignment clickable text on the right. The bottom one is completed assignments and has a column for Completed with a date.](../images/workflow/proofing-assignments.png) + +The proofreading page is broken down into three sections: + +### Task definition + +This is a note written by an editor when the proofing task is created. This often includes instructions / guidance. + +### Files for proofreading + +This section lists the files for proofreading (galleys) that have been assigned to you. +Common galley types are: PDF, HTML and XML. + +Janeway has a **Preview** button that opens a preview on a separate browser window. You can leave comments in the textbox in the notes section., you do not need to annotate the galleys directly. Make sure to click **Save notes** after filling in this section. + +![" "](../images/workflow/proofing-task.png) + +> [!NOTE] +> It is unusual to see both XML and HTML files for proofing, as XML itself is a source from which HTML is generated (thus not requiring a seperate HTML file). What filetypes are available will depend on your publisher. + +### Annotated files upload + +If you do wish to annotate a file or share a document with notes, you can upload it using this section. It is generally recommended not to directly annotate XML/HTML as this may complicate the process, but your publisher will likely have provided instructions in the task definition. + +## Completing proofreading + +When you are done with your proofreading task, you can mark the task as complete by clicking **Mark task as complete**. You will not be able to return to this page after it has been marked as complete. If you have not opened one or multiple of the proofreading files, Janeway will give you a warning. diff --git a/content/support/guides/workflow-reviewer.md b/content/pages/support/guides/reviewer-guide.md similarity index 75% rename from content/support/guides/workflow-reviewer.md rename to content/pages/support/guides/reviewer-guide.md index 393a9f71..7fa5c83f 100644 --- a/content/support/guides/workflow-reviewer.md +++ b/content/pages/support/guides/reviewer-guide.md @@ -1,5 +1,3 @@ -title: Reviewer guide - # Reviewer guide As a reviewer, you can access your review task in two ways: @@ -20,11 +18,11 @@ If you log into Janeway as a reviewer, you will see the **Reviewer** section on 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) +![Reviewer Dashboard block](../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. -![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) +![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'.)](../images/workflow/reviewer-kanban.png) ## Review request @@ -39,23 +37,23 @@ If you accept the task, you will be taken to the page for this review. It is spl 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. 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, 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) +![The 'Review Request' page, displaying the 'General Review Guidelines' section. The review guidelines, information for the form and accept/decline elements are visible.](../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 ‘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) +![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.](../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: diff --git a/content/support/guides/workflow-typesetter.md b/content/pages/support/guides/typesetter-guide.md similarity index 81% rename from content/support/guides/workflow-typesetter.md rename to content/pages/support/guides/typesetter-guide.md index a270a525..4c5041ef 100644 --- a/content/support/guides/workflow-typesetter.md +++ b/content/pages/support/guides/typesetter-guide.md @@ -1,12 +1,10 @@ -title: Typesetter workflow guide - # Typesetter workflow guide When you are assigned a typesetting task in Janeway, you will receive an email notification containing a link. This link will lead to the Janeway dashboard. !["The typesetter Dashboard displaying the number of typesetter tasks assigned."](../../support/images/workflow/typesetting-dashboardblock.png) -On the dashboard, you can see a block that displays the current number of open typesetting assignments. If you click on this block, it will take you to the **Typesetting Assignments** page, and you will be able to see both your currently open typesetting assignments (the top block) and your completed assignments (the bottom block). +On the dashboard, you can see a block that displays the current number of open typesetting assignments. If you click on this block, it will take you to the **Typesetting assignments** page, and you will be able to see both your open typesetting assignments (the top block) and your completed assignments (the bottom block). For open assignments, it will display: @@ -23,7 +21,7 @@ For completed assignments, it will display: - Date it was assigned - Completion date -!["The ‘Typesetting assignments’ page."](../../support/images/workflow/typesetting-assignments.png) +!["The 'Typesetting assignments' page."](../../support/images/workflow/typesetting-assignments.png) You can then click **View assignment** to display the assignment page. @@ -31,7 +29,7 @@ You can then click **View assignment** to display the assignment 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. -!["The ‘Assignment information’ page."](../../support/images/workflow/typesetting-interface.png) +!["The 'Assignment information' page."](../../support/images/workflow/typesetting-interface.png) This page is divided into three sections. @@ -50,28 +48,28 @@ This page is divided into three sections. ## 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) +!["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. Source files (such as Adobe InDesign files) can be uploaded by clicking **Upload new source file**. -!["The 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) +!["The typeset file upload. It provides the options to add a label for the file, toggle whether the file will be publicly available after the article is published, choose a file to upload, and confirm the upload."](../../support/images/workflow/typesetting-upload.png) -In this box, you can label your file with its file format. For instance, if this is an HTML file, you should label it as ‘HTML’. If it is a PDF, you should label it as ‘PDF’, etc. +In this box, you can label your file with its file format. For instance, if this is an HTML file, you should label it as 'HTML'. If it is a PDF, you should label it as 'PDF', etc. 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**. -!["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 '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) +!["The 'Edit typeset file' page."](../../support/images/workflow/typesetting-filehistory.png) This page is divided into three sections: @@ -99,7 +97,7 @@ This will open a page where you can download and reinstate previous versions or !["A screenshot displaying the available options for adding image files: uploading a file in a section for a dedicated image (displaying its filename), uploading images as additional files or uploading a zip file."](../../support/images/workflow/typesetting-image-upload.png) -When a file typeset in HTML or XML contains image links, Janeway will detect these and prompt you to upload the image files. The file names should match the `src` or `href` used in the XML/HTML and be relative (e.g. `src="fig1.jpg`). +When a file typeset in HTML or XML contains image links, Janeway will detect these and prompt you to upload the image files. The file names must match the `src` or `href` used in the XML/HTML and be relative (e.g. `src="fig1.jpg`). If the image files have already been uploaded onto Janeway, you can select them instead. @@ -107,7 +105,7 @@ If you need to upload a large number of images, it may be faster to use the zip ## 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. +On this page, you can also upload a CSS file associated with the article for an individual style, if required. It is recommended to avoid style changes to the header and footer type elements, as this will affect the page's layout. 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. diff --git a/content/support/identifiers/crossref-article-doi-placeholder.md b/content/pages/support/identifiers/crossref-article-doi.md similarity index 91% rename from content/support/identifiers/crossref-article-doi-placeholder.md rename to content/pages/support/identifiers/crossref-article-doi.md index 281c9582..39fa9897 100644 --- a/content/support/identifiers/crossref-article-doi-placeholder.md +++ b/content/pages/support/identifiers/crossref-article-doi.md @@ -1,8 +1,6 @@ -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. +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: @@ -17,7 +15,7 @@ If Crossref settings are correctly configured, Janeway handles DOI registration 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. +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. @@ -26,9 +24,7 @@ Later, when the article is scheduled for publication, Janeway sends a deposit to When the article is published, the DOI becomes a working permalink to the published article. > [!TIP] -> 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**. - - +> 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**](../review/review-settings.md). ## When manual intervention may be needed @@ -97,7 +93,7 @@ Crossref settings are configured from the Manager interface under **Crossref set Enables or disables DOI registration for the journal. If disabled, no DOIs will be minted. Use Crossref test deposit server - Sends DOIs to Crossref’s test system instead of the live system. Useful for testing only. + Sends DOIs to Crossref's test system instead of the live system. Useful for testing only. - Crossref username Your Crossref account username. @@ -135,5 +131,5 @@ Use Crossref test deposit server 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 +However, Crossref recommends registering a journal DOI even when an ISSN exists. It is recommended to use 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`. diff --git a/content/support/identifiers/crossref-issue-doi-placeholder.md b/content/pages/support/identifiers/crossref-issue-doi.md similarity index 50% rename from content/support/identifiers/crossref-issue-doi-placeholder.md rename to content/pages/support/identifiers/crossref-issue-doi.md index 388ea246..56e288be 100644 --- a/content/support/identifiers/crossref-issue-doi-placeholder.md +++ b/content/pages/support/identifiers/crossref-issue-doi.md @@ -1,5 +1,3 @@ -title: Crossref issue DOI - # Crossref issue DOI 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. @@ -11,27 +9,13 @@ Issue-level DOIs can be generated automatically using a defined pattern or enter 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 **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. - - +## When and how issue DOIs are formed -## Issue DOI pattern +When a new issue is created, and at any time after, editors can put in a manual DOI for an issue. -Janeway can automatically generate issue-level DOIs using a configurable pattern. +If no DOI is manually put in by the time the first article is added to the issue, then one will be automatically created based on the issue DOI pattern. -Using the default pattern: +Here are a few examples of how the default pattern works: - An issue with ID `1`, journal code `abcd`, and prefix `10.0001` will be assigned the DOI: `10.0001/abcd.issue.1`. @@ -39,7 +23,16 @@ Using the default pattern: - A collection with ID `2` will be assigned the DOI: `10.0001/abcd.collection.2` -This pattern is used only if an issue DOI has not been entered manually. +An auto-generated issue DOI can be edited afterward if needed, though this can cause problems if the DOI is already registered and the registration is not subsequently updated. + +> [!TIP] +> Janeway never overwrites manually input DOIs, and what it sends for registration always matches the value you see in the DOI field. + +## Auto-register issue-level DOIs + +When **Auto-register issue-level DOIs** is enabled in the **Crossref settings**, Janeway will register the DOI that appears in the issue DOI field with Crossref. This could be a manually entered DOI or an auto-generated one. + +The issue DOI is registered when the first article in the issue has its article DOI minted (for more information see: [Crossref article DOIs](./crossref-article-doi.md)). The issue DOI is included in the article's XML metadata sent to Crossref, and no separate action is required to register it. > [!TIP] > If you are migrating a Janeway installation from a version that did not @@ -49,6 +42,4 @@ This pattern is used only if an issue DOI has not been entered manually. > [!WARNING] > When an article is part of two or more issues, only the primary issue -> DOI will be registered with Crossref. In a future version, it will be -> possible to register issue DOIs on their own, even when they have no -> articles or all its articles are part of multiple issues. +> DOI will be registered with Crossref. diff --git a/content/pages/support/identifiers/index.md b/content/pages/support/identifiers/index.md new file mode 100644 index 00000000..e85b4ec4 --- /dev/null +++ b/content/pages/support/identifiers/index.md @@ -0,0 +1,31 @@ +# Identifiers & discovery + +Janeway supports minting Digital Object Identifiers (DOIs) for articles and issues through Crossref and DataCite. This section explains how DOIs are generated and registered, and covers other identifier and discovery services relevant to your journal. + +- [Crossref article DOI](./crossref-article-doi.md) + When article DOIs are minted, how to check and manage them using the DOI Manager, and the Crossref settings required. +- [Crossref issue DOI](./crossref-issue-doi.md) + How issue-level DOIs are generated and registered alongside article DOIs, and important limitations to be aware of. +- [DataCite DOIs](../plugins/datacite.md) + Registering DOIs with DataCite as an alternative to Crossref. + +## 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 your system administrator or Janeway support. + +If you experience issues with the metadata, the first step is to compare the galleys against the meta-tags in the HTML for any mismatches. + + diff --git a/content/support/images/a11y-journal-custom-info.png b/content/pages/support/images/a11y-journal-custom-info.png similarity index 100% rename from content/support/images/a11y-journal-custom-info.png rename to content/pages/support/images/a11y-journal-custom-info.png diff --git a/content/support/images/a11y-press-allow-journal-info.png b/content/pages/support/images/a11y-press-allow-journal-info.png similarity index 100% rename from content/support/images/a11y-press-allow-journal-info.png rename to content/pages/support/images/a11y-press-allow-journal-info.png diff --git a/content/support/images/a11y-press-custom-info.png b/content/pages/support/images/a11y-press-custom-info.png similarity index 100% rename from content/support/images/a11y-press-custom-info.png rename to content/pages/support/images/a11y-press-custom-info.png diff --git a/content/support/images/activate-account.png b/content/pages/support/images/activate-account.png similarity index 100% rename from content/support/images/activate-account.png rename to content/pages/support/images/activate-account.png diff --git a/content/support/images/active-toggle.png b/content/pages/support/images/active-toggle.png similarity index 100% rename from content/support/images/active-toggle.png rename to content/pages/support/images/active-toggle.png diff --git a/content/support/images/all-settings-google.png b/content/pages/support/images/all-settings-google.png similarity index 100% rename from content/support/images/all-settings-google.png rename to content/pages/support/images/all-settings-google.png diff --git a/content/support/images/article-archive-edit-metadata.png b/content/pages/support/images/article-archive-edit-metadata.png similarity index 100% rename from content/support/images/article-archive-edit-metadata.png rename to content/pages/support/images/article-archive-edit-metadata.png diff --git a/content/support/images/article-identifiers.png b/content/pages/support/images/article-identifiers.png similarity index 100% rename from content/support/images/article-identifiers.png rename to content/pages/support/images/article-identifiers.png diff --git a/content/pages/support/images/article-log.png b/content/pages/support/images/article-log.png new file mode 100644 index 00000000..2570266c Binary files /dev/null and b/content/pages/support/images/article-log.png differ diff --git a/content/support/images/books-add-chapter.png b/content/pages/support/images/books-add-chapter.png similarity index 100% rename from content/support/images/books-add-chapter.png rename to content/pages/support/images/books-add-chapter.png diff --git a/content/support/images/books-add-contributor.png b/content/pages/support/images/books-add-contributor.png similarity index 100% rename from content/support/images/books-add-contributor.png rename to content/pages/support/images/books-add-contributor.png diff --git a/content/support/images/books-add-format.png b/content/pages/support/images/books-add-format.png similarity index 100% rename from content/support/images/books-add-format.png rename to content/pages/support/images/books-add-format.png diff --git a/content/support/images/books-addbook-dashboard.png b/content/pages/support/images/books-addbook-dashboard.png similarity index 100% rename from content/support/images/books-addbook-dashboard.png rename to content/pages/support/images/books-addbook-dashboard.png diff --git a/content/support/images/books-addbook-details.png b/content/pages/support/images/books-addbook-details.png similarity index 100% rename from content/support/images/books-addbook-details.png rename to content/pages/support/images/books-addbook-details.png diff --git a/content/support/images/books-category-dashboard.png b/content/pages/support/images/books-category-dashboard.png similarity index 100% rename from content/support/images/books-category-dashboard.png rename to content/pages/support/images/books-category-dashboard.png diff --git a/content/support/images/books-category-display.png b/content/pages/support/images/books-category-display.png similarity index 100% rename from content/support/images/books-category-display.png rename to content/pages/support/images/books-category-display.png diff --git a/content/support/images/books-dashboardblock-highlight.png b/content/pages/support/images/books-dashboardblock-highlight.png similarity index 100% rename from content/support/images/books-dashboardblock-highlight.png rename to content/pages/support/images/books-dashboardblock-highlight.png diff --git a/content/support/images/books-dashboardblock.png b/content/pages/support/images/books-dashboardblock.png similarity index 100% rename from content/support/images/books-dashboardblock.png rename to content/pages/support/images/books-dashboardblock.png diff --git a/content/support/images/books-final-manuscript.png b/content/pages/support/images/books-final-manuscript.png similarity index 100% rename from content/support/images/books-final-manuscript.png rename to content/pages/support/images/books-final-manuscript.png diff --git a/content/support/images/books-format-metrics.png b/content/pages/support/images/books-format-metrics.png similarity index 100% rename from content/support/images/books-format-metrics.png rename to content/pages/support/images/books-format-metrics.png diff --git a/content/support/images/books-metrics-dashboard.png b/content/pages/support/images/books-metrics-dashboard.png similarity index 100% rename from content/support/images/books-metrics-dashboard.png rename to content/pages/support/images/books-metrics-dashboard.png diff --git a/content/support/images/books-metrics.png b/content/pages/support/images/books-metrics.png similarity index 100% rename from content/support/images/books-metrics.png rename to content/pages/support/images/books-metrics.png diff --git a/content/support/images/books-web-buttons.png b/content/pages/support/images/books-web-buttons.png similarity index 100% rename from content/support/images/books-web-buttons.png rename to content/pages/support/images/books-web-buttons.png diff --git a/content/pages/support/images/cache-cron-emails.png b/content/pages/support/images/cache-cron-emails.png new file mode 100644 index 00000000..1b3105b6 Binary files /dev/null and b/content/pages/support/images/cache-cron-emails.png differ diff --git a/content/pages/support/images/carousel-selector.png b/content/pages/support/images/carousel-selector.png new file mode 100644 index 00000000..f2fd6223 Binary files /dev/null and b/content/pages/support/images/carousel-selector.png differ diff --git a/content/support/images/clock-icon.png b/content/pages/support/images/clock-icon.png similarity index 100% rename from content/support/images/clock-icon.png rename to content/pages/support/images/clock-icon.png diff --git a/content/pages/support/images/cms.png b/content/pages/support/images/cms.png new file mode 100644 index 00000000..81e12892 Binary files /dev/null and b/content/pages/support/images/cms.png differ diff --git a/content/pages/support/images/contacts-manager.png b/content/pages/support/images/contacts-manager.png new file mode 100644 index 00000000..1e44c998 Binary files /dev/null and b/content/pages/support/images/contacts-manager.png differ diff --git a/content/support/images/copyright-submission-process.png b/content/pages/support/images/copyright-submission-process.png similarity index 100% rename from content/support/images/copyright-submission-process.png rename to content/pages/support/images/copyright-submission-process.png diff --git a/content/support/images/copyright-submissions-page.png b/content/pages/support/images/copyright-submissions-page.png similarity index 100% rename from content/support/images/copyright-submissions-page.png rename to content/pages/support/images/copyright-submissions-page.png diff --git a/content/support/images/create-issue.png b/content/pages/support/images/create-issue.png similarity index 100% rename from content/support/images/create-issue.png rename to content/pages/support/images/create-issue.png diff --git a/content/pages/support/images/create-reminder1.png b/content/pages/support/images/create-reminder1.png new file mode 100644 index 00000000..7f418194 Binary files /dev/null and b/content/pages/support/images/create-reminder1.png differ diff --git a/content/pages/support/images/create-reminder2.png b/content/pages/support/images/create-reminder2.png new file mode 100644 index 00000000..0ab64b45 Binary files /dev/null and b/content/pages/support/images/create-reminder2.png differ diff --git a/content/support/images/custom-submission-display-setting.png b/content/pages/support/images/custom-submission-display-setting.png similarity index 100% rename from content/support/images/custom-submission-display-setting.png rename to content/pages/support/images/custom-submission-display-setting.png diff --git a/content/support/images/custom-submission-general-setting.png b/content/pages/support/images/custom-submission-general-setting.png similarity index 100% rename from content/support/images/custom-submission-general-setting.png rename to content/pages/support/images/custom-submission-general-setting.png diff --git a/content/support/images/custom-submission-page-item.png b/content/pages/support/images/custom-submission-page-item.png similarity index 100% rename from content/support/images/custom-submission-page-item.png rename to content/pages/support/images/custom-submission-page-item.png diff --git a/content/support/images/custom-submission-setting.png b/content/pages/support/images/custom-submission-setting.png similarity index 100% rename from content/support/images/custom-submission-setting.png rename to content/pages/support/images/custom-submission-setting.png diff --git a/content/support/images/default-nav.png b/content/pages/support/images/default-nav.png similarity index 100% rename from content/support/images/default-nav.png rename to content/pages/support/images/default-nav.png diff --git a/content/support/images/download-icon.png b/content/pages/support/images/download-icon.png similarity index 100% rename from content/support/images/download-icon.png rename to content/pages/support/images/download-icon.png diff --git a/content/support/images/edit-icon.png b/content/pages/support/images/edit-icon.png similarity index 100% rename from content/support/images/edit-icon.png rename to content/pages/support/images/edit-icon.png diff --git a/content/support/images/edit-metadata.png b/content/pages/support/images/edit-metadata.png similarity index 100% rename from content/support/images/edit-metadata.png rename to content/pages/support/images/edit-metadata.png diff --git a/content/pages/support/images/edit-template-name.png b/content/pages/support/images/edit-template-name.png new file mode 100644 index 00000000..47a58f37 Binary files /dev/null and b/content/pages/support/images/edit-template-name.png differ diff --git a/content/support/images/edit-user.png b/content/pages/support/images/edit-user.png similarity index 100% rename from content/support/images/edit-user.png rename to content/pages/support/images/edit-user.png diff --git a/content/pages/support/images/edited-template-example.png b/content/pages/support/images/edited-template-example.png new file mode 100644 index 00000000..43876bef Binary files /dev/null and b/content/pages/support/images/edited-template-example.png differ diff --git a/content/pages/support/images/editorial-team.png b/content/pages/support/images/editorial-team.png new file mode 100644 index 00000000..446fcb3c Binary files /dev/null and b/content/pages/support/images/editorial-team.png differ diff --git a/content/support/images/element-check-box.png b/content/pages/support/images/element-check-box.png similarity index 100% rename from content/support/images/element-check-box.png rename to content/pages/support/images/element-check-box.png diff --git a/content/support/images/element-date.png b/content/pages/support/images/element-date.png similarity index 100% rename from content/support/images/element-date.png rename to content/pages/support/images/element-date.png diff --git a/content/support/images/element-email.png b/content/pages/support/images/element-email.png similarity index 100% rename from content/support/images/element-email.png rename to content/pages/support/images/element-email.png diff --git a/content/support/images/element-file-upload.png b/content/pages/support/images/element-file-upload.png similarity index 100% rename from content/support/images/element-file-upload.png rename to content/pages/support/images/element-file-upload.png diff --git a/content/support/images/element-select.png b/content/pages/support/images/element-select.png similarity index 100% rename from content/support/images/element-select.png rename to content/pages/support/images/element-select.png diff --git a/content/support/images/element-text-area.png b/content/pages/support/images/element-text-area.png similarity index 100% rename from content/support/images/element-text-area.png rename to content/pages/support/images/element-text-area.png diff --git a/content/support/images/element-text-field.png b/content/pages/support/images/element-text-field.png similarity index 100% rename from content/support/images/element-text-field.png rename to content/pages/support/images/element-text-field.png diff --git a/content/pages/support/images/finding-reporting.png b/content/pages/support/images/finding-reporting.png new file mode 100644 index 00000000..2440f1de Binary files /dev/null and b/content/pages/support/images/finding-reporting.png differ diff --git a/content/support/images/forgotten-password.png b/content/pages/support/images/forgotten-password.png similarity index 100% rename from content/support/images/forgotten-password.png rename to content/pages/support/images/forgotten-password.png diff --git a/content/support/images/front-end-metadata.png b/content/pages/support/images/front-end-metadata.png similarity index 100% rename from content/support/images/front-end-metadata.png rename to content/pages/support/images/front-end-metadata.png diff --git a/content/support/images/general-settings-google.png b/content/pages/support/images/general-settings-google.png similarity index 100% rename from content/support/images/general-settings-google.png rename to content/pages/support/images/general-settings-google.png diff --git a/content/support/images/images-manager-blank.png b/content/pages/support/images/images-manager-blank.png similarity index 100% rename from content/support/images/images-manager-blank.png rename to content/pages/support/images/images-manager-blank.png diff --git a/content/support/images/images-manager-full.png b/content/pages/support/images/images-manager-full.png similarity index 100% rename from content/support/images/images-manager-full.png rename to content/pages/support/images/images-manager-full.png diff --git a/content/support/images/import-export-update-start.png b/content/pages/support/images/import-export-update-start.png similarity index 100% rename from content/support/images/import-export-update-start.png rename to content/pages/support/images/import-export-update-start.png diff --git a/content/pages/support/images/insert-image-tinymce.png b/content/pages/support/images/insert-image-tinymce.png new file mode 100644 index 00000000..eb9f6024 Binary files /dev/null and b/content/pages/support/images/insert-image-tinymce.png differ diff --git a/content/support/images/issue-add-articles.png b/content/pages/support/images/issue-add-articles.png similarity index 100% rename from content/support/images/issue-add-articles.png rename to content/pages/support/images/issue-add-articles.png diff --git a/content/support/images/issue-manager.png b/content/pages/support/images/issue-manager.png similarity index 100% rename from content/support/images/issue-manager.png rename to content/pages/support/images/issue-manager.png diff --git a/content/pages/support/images/issue-table-of-contents.png b/content/pages/support/images/issue-table-of-contents.png new file mode 100644 index 00000000..14f5c84a Binary files /dev/null and b/content/pages/support/images/issue-table-of-contents.png differ diff --git a/content/support/images/journal-users.png b/content/pages/support/images/journal-users.png similarity index 100% rename from content/support/images/journal-users.png rename to content/pages/support/images/journal-users.png diff --git a/content/support/images/large-image-article.png b/content/pages/support/images/large-image-article.png similarity index 100% rename from content/support/images/large-image-article.png rename to content/pages/support/images/large-image-article.png diff --git a/content/support/images/large-image-homepage.png b/content/pages/support/images/large-image-homepage.png similarity index 100% rename from content/support/images/large-image-homepage.png rename to content/pages/support/images/large-image-homepage.png diff --git a/content/support/images/licence-manager.png b/content/pages/support/images/licence-manager.png similarity index 100% rename from content/support/images/licence-manager.png rename to content/pages/support/images/licence-manager.png diff --git a/content/support/images/lists-with-definitions.png b/content/pages/support/images/lists-with-definitions.png similarity index 100% rename from content/support/images/lists-with-definitions.png rename to content/pages/support/images/lists-with-definitions.png diff --git a/content/support/images/logs-docs-metadata.png b/content/pages/support/images/logs-docs-metadata.png similarity index 100% rename from content/support/images/logs-docs-metadata.png rename to content/pages/support/images/logs-docs-metadata.png diff --git a/content/support/images/logs-docs-more.png b/content/pages/support/images/logs-docs-more.png similarity index 100% rename from content/support/images/logs-docs-more.png rename to content/pages/support/images/logs-docs-more.png diff --git a/content/support/images/logs-edit-metadata.png b/content/pages/support/images/logs-edit-metadata.png similarity index 100% rename from content/support/images/logs-edit-metadata.png rename to content/pages/support/images/logs-edit-metadata.png diff --git a/content/pages/support/images/manage-editorial-team-membership.png b/content/pages/support/images/manage-editorial-team-membership.png new file mode 100644 index 00000000..b207ffd1 Binary files /dev/null and b/content/pages/support/images/manage-editorial-team-membership.png differ diff --git a/content/support/images/manager-enrolled-users.png b/content/pages/support/images/manager-enrolled-users.png similarity index 100% rename from content/support/images/manager-enrolled-users.png rename to content/pages/support/images/manager-enrolled-users.png diff --git a/content/support/images/manager-licence-manager.png b/content/pages/support/images/manager-licence-manager.png similarity index 100% rename from content/support/images/manager-licence-manager.png rename to content/pages/support/images/manager-licence-manager.png diff --git a/content/support/images/manager-news.png b/content/pages/support/images/manager-news.png similarity index 100% rename from content/support/images/manager-news.png rename to content/pages/support/images/manager-news.png diff --git a/content/support/images/manager-review-forms.png b/content/pages/support/images/manager-review-forms.png similarity index 100% rename from content/support/images/manager-review-forms.png rename to content/pages/support/images/manager-review-forms.png diff --git a/content/support/images/manager-review-settings.png b/content/pages/support/images/manager-review-settings.png similarity index 100% rename from content/support/images/manager-review-settings.png rename to content/pages/support/images/manager-review-settings.png diff --git a/content/support/images/manager-sections.png b/content/pages/support/images/manager-sections.png similarity index 100% rename from content/support/images/manager-sections.png rename to content/pages/support/images/manager-sections.png diff --git a/content/support/images/manager-submission-fields-configurator.png b/content/pages/support/images/manager-submission-fields-configurator.png similarity index 100% rename from content/support/images/manager-submission-fields-configurator.png rename to content/pages/support/images/manager-submission-fields-configurator.png diff --git a/content/support/images/manager-submission-page-items.png b/content/pages/support/images/manager-submission-page-items.png similarity index 100% rename from content/support/images/manager-submission-page-items.png rename to content/pages/support/images/manager-submission-page-items.png diff --git a/content/support/images/manager-submission-settings.png b/content/pages/support/images/manager-submission-settings.png similarity index 100% rename from content/support/images/manager-submission-settings.png rename to content/pages/support/images/manager-submission-settings.png diff --git a/content/support/images/manager-submission.png b/content/pages/support/images/manager-submission.png similarity index 100% rename from content/support/images/manager-submission.png rename to content/pages/support/images/manager-submission.png diff --git a/content/support/images/manuscript-label.png b/content/pages/support/images/manuscript-label.png similarity index 100% rename from content/support/images/manuscript-label.png rename to content/pages/support/images/manuscript-label.png diff --git a/content/pages/support/images/merge-users.png b/content/pages/support/images/merge-users.png new file mode 100644 index 00000000..308be68d Binary files /dev/null and b/content/pages/support/images/merge-users.png differ diff --git a/content/support/images/meta-image-bsky.png b/content/pages/support/images/meta-image-bsky.png similarity index 100% rename from content/support/images/meta-image-bsky.png rename to content/pages/support/images/meta-image-bsky.png diff --git a/content/support/images/navigation-logs.png b/content/pages/support/images/navigation-logs.png similarity index 100% rename from content/support/images/navigation-logs.png rename to content/pages/support/images/navigation-logs.png diff --git a/content/pages/support/images/news-item.png b/content/pages/support/images/news-item.png new file mode 100644 index 00000000..2fe31451 Binary files /dev/null and b/content/pages/support/images/news-item.png differ diff --git a/content/pages/support/images/news-manager.png b/content/pages/support/images/news-manager.png new file mode 100644 index 00000000..536b1117 Binary files /dev/null and b/content/pages/support/images/news-manager.png differ diff --git a/content/support/images/open-peer-review-metadata.png b/content/pages/support/images/open-peer-review-metadata.png similarity index 100% rename from content/support/images/open-peer-review-metadata.png rename to content/pages/support/images/open-peer-review-metadata.png diff --git a/content/support/images/open-peer-review-pane.png b/content/pages/support/images/open-peer-review-pane.png similarity index 100% rename from content/support/images/open-peer-review-pane.png rename to content/pages/support/images/open-peer-review-pane.png diff --git a/content/pages/support/images/permission-group.png b/content/pages/support/images/permission-group.png new file mode 100644 index 00000000..25d3e57a Binary files /dev/null and b/content/pages/support/images/permission-group.png differ diff --git a/content/support/images/plus-icon.png b/content/pages/support/images/plus-icon.png similarity index 100% rename from content/support/images/plus-icon.png rename to content/pages/support/images/plus-icon.png diff --git a/content/support/images/prepublication-open-peer-review.png b/content/pages/support/images/prepublication-open-peer-review.png similarity index 100% rename from content/support/images/prepublication-open-peer-review.png rename to content/pages/support/images/prepublication-open-peer-review.png diff --git a/content/support/images/press-all-users.png b/content/pages/support/images/press-all-users.png similarity index 100% rename from content/support/images/press-all-users.png rename to content/pages/support/images/press-all-users.png diff --git a/content/support/images/preview-icon.png b/content/pages/support/images/preview-icon.png similarity index 100% rename from content/support/images/preview-icon.png rename to content/pages/support/images/preview-icon.png diff --git a/content/support/images/profile-dropdown.png b/content/pages/support/images/profile-dropdown.png similarity index 100% rename from content/support/images/profile-dropdown.png rename to content/pages/support/images/profile-dropdown.png diff --git a/content/support/images/pub-schedule.png b/content/pages/support/images/pub-schedule.png similarity index 100% rename from content/support/images/pub-schedule.png rename to content/pages/support/images/pub-schedule.png diff --git a/content/pages/support/images/publication-notifications-profile.png b/content/pages/support/images/publication-notifications-profile.png new file mode 100644 index 00000000..d32adca5 Binary files /dev/null and b/content/pages/support/images/publication-notifications-profile.png differ diff --git a/content/old-docs/nstatic/publication-notifications.png b/content/pages/support/images/publication-notifications.png similarity index 100% rename from content/old-docs/nstatic/publication-notifications.png rename to content/pages/support/images/publication-notifications.png diff --git a/content/support/images/reply-to.png b/content/pages/support/images/reply-to.png similarity index 100% rename from content/support/images/reply-to.png rename to content/pages/support/images/reply-to.png diff --git a/content/support/images/repositories/repo-additional-fields.png b/content/pages/support/images/repositories/repo-additional-fields.png similarity index 100% rename from content/support/images/repositories/repo-additional-fields.png rename to content/pages/support/images/repositories/repo-additional-fields.png diff --git a/content/support/images/repositories/repo-author-dash.png b/content/pages/support/images/repositories/repo-author-dash.png similarity index 100% rename from content/support/images/repositories/repo-author-dash.png rename to content/pages/support/images/repositories/repo-author-dash.png diff --git a/content/support/images/repositories/repo-awaiting-moderation.png b/content/pages/support/images/repositories/repo-awaiting-moderation.png similarity index 100% rename from content/support/images/repositories/repo-awaiting-moderation.png rename to content/pages/support/images/repositories/repo-awaiting-moderation.png diff --git a/content/support/images/repositories/repo-edit-dash.png b/content/pages/support/images/repositories/repo-edit-dash.png similarity index 100% rename from content/support/images/repositories/repo-edit-dash.png rename to content/pages/support/images/repositories/repo-edit-dash.png diff --git a/content/support/images/repositories/repo-licences.png b/content/pages/support/images/repositories/repo-licences.png similarity index 100% rename from content/support/images/repositories/repo-licences.png rename to content/pages/support/images/repositories/repo-licences.png diff --git a/content/support/images/repositories/repo-manager.png b/content/pages/support/images/repositories/repo-manager.png similarity index 100% rename from content/support/images/repositories/repo-manager.png rename to content/pages/support/images/repositories/repo-manager.png diff --git a/content/support/images/repositories/repo-parent-child-subject.png b/content/pages/support/images/repositories/repo-parent-child-subject.png similarity index 100% rename from content/support/images/repositories/repo-parent-child-subject.png rename to content/pages/support/images/repositories/repo-parent-child-subject.png diff --git a/content/support/images/repositories/repo-preprint-controls.png b/content/pages/support/images/repositories/repo-preprint-controls.png similarity index 100% rename from content/support/images/repositories/repo-preprint-controls.png rename to content/pages/support/images/repositories/repo-preprint-controls.png diff --git a/content/support/images/repositories/repo-pub-controls.png b/content/pages/support/images/repositories/repo-pub-controls.png similarity index 100% rename from content/support/images/repositories/repo-pub-controls.png rename to content/pages/support/images/repositories/repo-pub-controls.png diff --git a/content/support/images/repositories/repo-recommendations.png b/content/pages/support/images/repositories/repo-recommendations.png similarity index 100% rename from content/support/images/repositories/repo-recommendations.png rename to content/pages/support/images/repositories/repo-recommendations.png diff --git a/content/support/images/repositories/repo-settings.png b/content/pages/support/images/repositories/repo-settings.png similarity index 100% rename from content/support/images/repositories/repo-settings.png rename to content/pages/support/images/repositories/repo-settings.png diff --git a/content/support/images/repositories/repo-subjects.png b/content/pages/support/images/repositories/repo-subjects.png similarity index 100% rename from content/support/images/repositories/repo-subjects.png rename to content/pages/support/images/repositories/repo-subjects.png diff --git a/content/support/images/repositories/repo-submit-author-dash.png b/content/pages/support/images/repositories/repo-submit-author-dash.png similarity index 100% rename from content/support/images/repositories/repo-submit-author-dash.png rename to content/pages/support/images/repositories/repo-submit-author-dash.png diff --git a/content/support/images/repositories/repo-submit-frontend.png b/content/pages/support/images/repositories/repo-submit-frontend.png similarity index 100% rename from content/support/images/repositories/repo-submit-frontend.png rename to content/pages/support/images/repositories/repo-submit-frontend.png diff --git a/content/support/images/repositories/repo-submit-profile-backend.png b/content/pages/support/images/repositories/repo-submit-profile-backend.png similarity index 100% rename from content/support/images/repositories/repo-submit-profile-backend.png rename to content/pages/support/images/repositories/repo-submit-profile-backend.png diff --git a/content/support/images/repositories/repo-update-article.png b/content/pages/support/images/repositories/repo-update-article.png similarity index 100% rename from content/support/images/repositories/repo-update-article.png rename to content/pages/support/images/repositories/repo-update-article.png diff --git a/content/support/images/repositories/repo-version-moderation.png b/content/pages/support/images/repositories/repo-version-moderation.png similarity index 100% rename from content/support/images/repositories/repo-version-moderation.png rename to content/pages/support/images/repositories/repo-version-moderation.png diff --git a/content/support/images/repositories/repos-add-new.png b/content/pages/support/images/repositories/repos-add-new.png similarity index 100% rename from content/support/images/repositories/repos-add-new.png rename to content/pages/support/images/repositories/repos-add-new.png diff --git a/content/support/images/review-form-add-element.png b/content/pages/support/images/review-form-add-element.png similarity index 100% rename from content/support/images/review-form-add-element.png rename to content/pages/support/images/review-form-add-element.png diff --git a/content/support/images/review-form-open-peer-review.png b/content/pages/support/images/review-form-open-peer-review.png similarity index 100% rename from content/support/images/review-form-open-peer-review.png rename to content/pages/support/images/review-form-open-peer-review.png diff --git a/content/support/images/review-form-preview.png b/content/pages/support/images/review-form-preview.png similarity index 100% rename from content/support/images/review-form-preview.png rename to content/pages/support/images/review-form-preview.png diff --git a/content/support/images/review-forms-add-form.png b/content/pages/support/images/review-forms-add-form.png similarity index 100% rename from content/support/images/review-forms-add-form.png rename to content/pages/support/images/review-forms-add-form.png diff --git a/content/support/images/review-forms-edit-delete.png b/content/pages/support/images/review-forms-edit-delete.png similarity index 100% rename from content/support/images/review-forms-edit-delete.png rename to content/pages/support/images/review-forms-edit-delete.png diff --git a/content/support/images/review-open-peer-review.png b/content/pages/support/images/review-open-peer-review.png similarity index 100% rename from content/support/images/review-open-peer-review.png rename to content/pages/support/images/review-open-peer-review.png diff --git a/content/support/images/reviewer-block.png b/content/pages/support/images/reviewer-block.png similarity index 100% rename from content/support/images/reviewer-block.png rename to content/pages/support/images/reviewer-block.png diff --git a/content/support/images/reviewer-file-upload.png b/content/pages/support/images/reviewer-file-upload.png similarity index 100% rename from content/support/images/reviewer-file-upload.png rename to content/pages/support/images/reviewer-file-upload.png diff --git a/content/support/images/reviewer-kanban.png b/content/pages/support/images/reviewer-kanban.png similarity index 100% rename from content/support/images/reviewer-kanban.png rename to content/pages/support/images/reviewer-kanban.png diff --git a/content/support/images/reviewer-review-files.png b/content/pages/support/images/reviewer-review-files.png similarity index 100% rename from content/support/images/reviewer-review-files.png rename to content/pages/support/images/reviewer-review-files.png diff --git a/content/support/images/reviewer-review-request.png b/content/pages/support/images/reviewer-review-request.png similarity index 100% rename from content/support/images/reviewer-review-request.png rename to content/pages/support/images/reviewer-review-request.png diff --git a/content/support/images/reviews-that-can-be-displayed.png b/content/pages/support/images/reviews-that-can-be-displayed.png similarity index 100% rename from content/support/images/reviews-that-can-be-displayed.png rename to content/pages/support/images/reviews-that-can-be-displayed.png diff --git a/content/support/images/search-inactive.png b/content/pages/support/images/search-inactive.png similarity index 100% rename from content/support/images/search-inactive.png rename to content/pages/support/images/search-inactive.png diff --git a/content/support/images/see-filter.png b/content/pages/support/images/see-filter.png similarity index 100% rename from content/support/images/see-filter.png rename to content/pages/support/images/see-filter.png diff --git a/content/support/images/submission-page-item-list.png b/content/pages/support/images/submission-page-item-list.png similarity index 100% rename from content/support/images/submission-page-item-list.png rename to content/pages/support/images/submission-page-item-list.png diff --git a/content/support/images/thumbnail-issuepage.png b/content/pages/support/images/thumbnail-issuepage.png similarity index 100% rename from content/support/images/thumbnail-issuepage.png rename to content/pages/support/images/thumbnail-issuepage.png diff --git a/content/support/images/thumbnails-article-list.png b/content/pages/support/images/thumbnails-article-list.png similarity index 100% rename from content/support/images/thumbnails-article-list.png rename to content/pages/support/images/thumbnails-article-list.png diff --git a/content/support/images/trashcan-icon.png b/content/pages/support/images/trashcan-icon.png similarity index 100% rename from content/support/images/trashcan-icon.png rename to content/pages/support/images/trashcan-icon.png diff --git a/content/support/images/trashcan.png b/content/pages/support/images/trashcan.png similarity index 100% rename from content/support/images/trashcan.png rename to content/pages/support/images/trashcan.png diff --git a/content/support/images/triangle-down.svg b/content/pages/support/images/triangle-down.svg similarity index 100% rename from content/support/images/triangle-down.svg rename to content/pages/support/images/triangle-down.svg diff --git a/content/pages/support/images/typesetting-guidelines.png b/content/pages/support/images/typesetting-guidelines.png new file mode 100644 index 00000000..e78f80ba Binary files /dev/null and b/content/pages/support/images/typesetting-guidelines.png differ diff --git a/content/support/images/undo-rejection.png b/content/pages/support/images/undo-rejection.png similarity index 100% rename from content/support/images/undo-rejection.png rename to content/pages/support/images/undo-rejection.png diff --git a/content/support/images/unlink-icon.png b/content/pages/support/images/unlink-icon.png similarity index 100% rename from content/support/images/unlink-icon.png rename to content/pages/support/images/unlink-icon.png diff --git a/content/support/images/update-metadata.png b/content/pages/support/images/update-metadata.png similarity index 100% rename from content/support/images/update-metadata.png rename to content/pages/support/images/update-metadata.png diff --git a/content/support/images/upload-icon.png b/content/pages/support/images/upload-icon.png similarity index 100% rename from content/support/images/upload-icon.png rename to content/pages/support/images/upload-icon.png diff --git a/content/pages/support/images/view-metadata.png b/content/pages/support/images/view-metadata.png new file mode 100644 index 00000000..7b8d1f7d Binary files /dev/null and b/content/pages/support/images/view-metadata.png differ diff --git a/content/support/images/workflow/author-add-funder.png b/content/pages/support/images/workflow/author-add-funder.png similarity index 100% rename from content/support/images/workflow/author-add-funder.png rename to content/pages/support/images/workflow/author-add-funder.png diff --git a/content/support/images/workflow/author-article-files.png b/content/pages/support/images/workflow/author-article-files.png similarity index 100% rename from content/support/images/workflow/author-article-files.png rename to content/pages/support/images/workflow/author-article-files.png diff --git a/content/support/images/workflow/author-article-information.png b/content/pages/support/images/workflow/author-article-information.png similarity index 100% rename from content/support/images/workflow/author-article-information.png rename to content/pages/support/images/workflow/author-article-information.png diff --git a/content/support/images/workflow/author-author-agreement.png b/content/pages/support/images/workflow/author-author-agreement.png similarity index 100% rename from content/support/images/workflow/author-author-agreement.png rename to content/pages/support/images/workflow/author-author-agreement.png diff --git a/content/support/images/workflow/author-author-information.png b/content/pages/support/images/workflow/author-author-information.png similarity index 100% rename from content/support/images/workflow/author-author-information.png rename to content/pages/support/images/workflow/author-author-information.png diff --git a/content/support/images/workflow/author-complete-copyedit-task.png b/content/pages/support/images/workflow/author-complete-copyedit-task.png similarity index 100% rename from content/support/images/workflow/author-complete-copyedit-task.png rename to content/pages/support/images/workflow/author-complete-copyedit-task.png diff --git a/content/support/images/workflow/author-copyedit-1.png b/content/pages/support/images/workflow/author-copyedit-1.png similarity index 100% rename from content/support/images/workflow/author-copyedit-1.png rename to content/pages/support/images/workflow/author-copyedit-1.png diff --git a/content/support/images/workflow/author-copyedited-files.png b/content/pages/support/images/workflow/author-copyedited-files.png similarity index 100% rename from content/support/images/workflow/author-copyedited-files.png rename to content/pages/support/images/workflow/author-copyedited-files.png diff --git a/content/support/images/workflow/author-dashboard-block.png b/content/pages/support/images/workflow/author-dashboard-block.png similarity index 100% rename from content/support/images/workflow/author-dashboard-block.png rename to content/pages/support/images/workflow/author-dashboard-block.png diff --git a/content/support/images/workflow/author-funding.png b/content/pages/support/images/workflow/author-funding.png similarity index 100% rename from content/support/images/workflow/author-funding.png rename to content/pages/support/images/workflow/author-funding.png diff --git a/content/support/images/workflow/author-keywords.png b/content/pages/support/images/workflow/author-keywords.png similarity index 100% rename from content/support/images/workflow/author-keywords.png rename to content/pages/support/images/workflow/author-keywords.png diff --git a/content/support/images/workflow/author-proofing-block.png b/content/pages/support/images/workflow/author-proofing-block.png similarity index 100% rename from content/support/images/workflow/author-proofing-block.png rename to content/pages/support/images/workflow/author-proofing-block.png diff --git a/content/support/images/workflow/author-proofing-task.png b/content/pages/support/images/workflow/author-proofing-task.png similarity index 100% rename from content/support/images/workflow/author-proofing-task.png rename to content/pages/support/images/workflow/author-proofing-task.png diff --git a/content/support/images/workflow/author-proofing-view-assignment.png b/content/pages/support/images/workflow/author-proofing-view-assignment.png similarity index 100% rename from content/support/images/workflow/author-proofing-view-assignment.png rename to content/pages/support/images/workflow/author-proofing-view-assignment.png diff --git a/content/support/images/workflow/author-proofing-view-file.png b/content/pages/support/images/workflow/author-proofing-view-file.png similarity index 100% rename from content/support/images/workflow/author-proofing-view-file.png rename to content/pages/support/images/workflow/author-proofing-view-file.png diff --git a/content/support/images/workflow/author-proofreading-annotated-file.png b/content/pages/support/images/workflow/author-proofreading-annotated-file.png similarity index 100% rename from content/support/images/workflow/author-proofreading-annotated-file.png rename to content/pages/support/images/workflow/author-proofreading-annotated-file.png diff --git a/content/support/images/workflow/author-proofreading-notes.png b/content/pages/support/images/workflow/author-proofreading-notes.png similarity index 100% rename from content/support/images/workflow/author-proofreading-notes.png rename to content/pages/support/images/workflow/author-proofreading-notes.png diff --git a/content/support/images/workflow/author-proofreading.png b/content/pages/support/images/workflow/author-proofreading.png similarity index 100% rename from content/support/images/workflow/author-proofreading.png rename to content/pages/support/images/workflow/author-proofreading.png diff --git a/content/support/images/workflow/author-submission-author-manual.png b/content/pages/support/images/workflow/author-submission-author-manual.png similarity index 100% rename from content/support/images/workflow/author-submission-author-manual.png rename to content/pages/support/images/workflow/author-submission-author-manual.png diff --git a/content/support/images/workflow/author-submission-author-search.png b/content/pages/support/images/workflow/author-submission-author-search.png similarity index 100% rename from content/support/images/workflow/author-submission-author-search.png rename to content/pages/support/images/workflow/author-submission-author-search.png diff --git a/content/support/images/workflow/author-submission-dropdown-loggedin.png b/content/pages/support/images/workflow/author-submission-dropdown-loggedin.png similarity index 100% rename from content/support/images/workflow/author-submission-dropdown-loggedin.png rename to content/pages/support/images/workflow/author-submission-dropdown-loggedin.png diff --git a/content/support/images/workflow/author-submission-dropdown-website.png b/content/pages/support/images/workflow/author-submission-dropdown-website.png similarity index 100% rename from content/support/images/workflow/author-submission-dropdown-website.png rename to content/pages/support/images/workflow/author-submission-dropdown-website.png diff --git a/content/support/images/workflow/author-submission-edit-details.png b/content/pages/support/images/workflow/author-submission-edit-details.png similarity index 100% rename from content/support/images/workflow/author-submission-edit-details.png rename to content/pages/support/images/workflow/author-submission-edit-details.png diff --git a/content/support/images/workflow/author-submission-navigation.png b/content/pages/support/images/workflow/author-submission-navigation.png similarity index 100% rename from content/support/images/workflow/author-submission-navigation.png rename to content/pages/support/images/workflow/author-submission-navigation.png diff --git a/content/support/images/workflow/author-submission-review.png b/content/pages/support/images/workflow/author-submission-review.png similarity index 100% rename from content/support/images/workflow/author-submission-review.png rename to content/pages/support/images/workflow/author-submission-review.png diff --git a/content/support/images/workflow/author-submission-webpage.png b/content/pages/support/images/workflow/author-submission-webpage.png similarity index 100% rename from content/support/images/workflow/author-submission-webpage.png rename to content/pages/support/images/workflow/author-submission-webpage.png diff --git a/content/support/images/workflow/author-submitted-articles.png b/content/pages/support/images/workflow/author-submitted-articles.png similarity index 100% rename from content/support/images/workflow/author-submitted-articles.png rename to content/pages/support/images/workflow/author-submitted-articles.png diff --git a/content/support/images/workflow/copyedit-complete-kanban.png b/content/pages/support/images/workflow/copyedit-complete-kanban.png similarity index 100% rename from content/support/images/workflow/copyedit-complete-kanban.png rename to content/pages/support/images/workflow/copyedit-complete-kanban.png diff --git a/content/support/images/workflow/copyedit-complete-task.png b/content/pages/support/images/workflow/copyedit-complete-task.png similarity index 100% rename from content/support/images/workflow/copyedit-complete-task.png rename to content/pages/support/images/workflow/copyedit-complete-task.png diff --git a/content/support/images/workflow/copyedit-files.png b/content/pages/support/images/workflow/copyedit-files.png similarity index 100% rename from content/support/images/workflow/copyedit-files.png rename to content/pages/support/images/workflow/copyedit-files.png diff --git a/content/support/images/workflow/copyedit-page.png b/content/pages/support/images/workflow/copyedit-page.png similarity index 100% rename from content/support/images/workflow/copyedit-page.png rename to content/pages/support/images/workflow/copyedit-page.png diff --git a/content/support/images/workflow/copyedit-reopened-kanban.png b/content/pages/support/images/workflow/copyedit-reopened-kanban.png similarity index 100% rename from content/support/images/workflow/copyedit-reopened-kanban.png rename to content/pages/support/images/workflow/copyedit-reopened-kanban.png diff --git a/content/support/images/workflow/copyeditor-dashboard.png b/content/pages/support/images/workflow/copyeditor-dashboard.png similarity index 100% rename from content/support/images/workflow/copyeditor-dashboard.png rename to content/pages/support/images/workflow/copyeditor-dashboard.png diff --git a/content/support/images/workflow/copyeditor-requests.png b/content/pages/support/images/workflow/copyeditor-requests.png similarity index 100% rename from content/support/images/workflow/copyeditor-requests.png rename to content/pages/support/images/workflow/copyeditor-requests.png diff --git a/content/support/images/workflow/editor-copyedit-add-assignment.png b/content/pages/support/images/workflow/editor-copyedit-add-assignment.png similarity index 100% rename from content/support/images/workflow/editor-copyedit-add-assignment.png rename to content/pages/support/images/workflow/editor-copyedit-add-assignment.png diff --git a/content/support/images/workflow/editor-copyedit-review-page.png b/content/pages/support/images/workflow/editor-copyedit-review-page.png similarity index 100% rename from content/support/images/workflow/editor-copyedit-review-page.png rename to content/pages/support/images/workflow/editor-copyedit-review-page.png diff --git a/content/support/images/workflow/editor-copyedit-review.png b/content/pages/support/images/workflow/editor-copyedit-review.png similarity index 100% rename from content/support/images/workflow/editor-copyedit-review.png rename to content/pages/support/images/workflow/editor-copyedit-review.png diff --git a/content/support/images/workflow/editor-draft-decision-button.png b/content/pages/support/images/workflow/editor-draft-decision-button.png similarity index 100% rename from content/support/images/workflow/editor-draft-decision-button.png rename to content/pages/support/images/workflow/editor-draft-decision-button.png diff --git a/content/support/images/workflow/editor-draft-decision-edit.png b/content/pages/support/images/workflow/editor-draft-decision-edit.png similarity index 100% rename from content/support/images/workflow/editor-draft-decision-edit.png rename to content/pages/support/images/workflow/editor-draft-decision-edit.png diff --git a/content/support/images/workflow/editor-draft-decision-final.png b/content/pages/support/images/workflow/editor-draft-decision-final.png similarity index 100% rename from content/support/images/workflow/editor-draft-decision-final.png rename to content/pages/support/images/workflow/editor-draft-decision-final.png diff --git a/content/support/images/workflow/editor-draft-decision-screen.png b/content/pages/support/images/workflow/editor-draft-decision-screen.png similarity index 100% rename from content/support/images/workflow/editor-draft-decision-screen.png rename to content/pages/support/images/workflow/editor-draft-decision-screen.png diff --git a/content/support/images/workflow/editor-draft-decision.png b/content/pages/support/images/workflow/editor-draft-decision.png similarity index 100% rename from content/support/images/workflow/editor-draft-decision.png rename to content/pages/support/images/workflow/editor-draft-decision.png diff --git a/content/support/images/workflow/editor-review-add-reviewer.png b/content/pages/support/images/workflow/editor-review-add-reviewer.png similarity index 100% rename from content/support/images/workflow/editor-review-add-reviewer.png rename to content/pages/support/images/workflow/editor-review-add-reviewer.png diff --git a/content/support/images/workflow/editor-review-answer-visibility.png b/content/pages/support/images/workflow/editor-review-answer-visibility.png similarity index 100% rename from content/support/images/workflow/editor-review-answer-visibility.png rename to content/pages/support/images/workflow/editor-review-answer-visibility.png diff --git a/content/support/images/workflow/editor-review-awaiting-acknowledgement.png b/content/pages/support/images/workflow/editor-review-awaiting-acknowledgement.png similarity index 100% rename from content/support/images/workflow/editor-review-awaiting-acknowledgement.png rename to content/pages/support/images/workflow/editor-review-awaiting-acknowledgement.png diff --git a/content/support/images/workflow/editor-review-decision-helper-share-reviews.png b/content/pages/support/images/workflow/editor-review-decision-helper-share-reviews.png similarity index 100% rename from content/support/images/workflow/editor-review-decision-helper-share-reviews.png rename to content/pages/support/images/workflow/editor-review-decision-helper-share-reviews.png diff --git a/content/support/images/workflow/editor-review-decision-helper.png b/content/pages/support/images/workflow/editor-review-decision-helper.png similarity index 100% rename from content/support/images/workflow/editor-review-decision-helper.png rename to content/pages/support/images/workflow/editor-review-decision-helper.png diff --git a/content/support/images/workflow/editor-review-setup.png b/content/pages/support/images/workflow/editor-review-setup.png similarity index 100% rename from content/support/images/workflow/editor-review-setup.png rename to content/pages/support/images/workflow/editor-review-setup.png diff --git a/content/support/images/workflow/editor-share-review-bulk.png b/content/pages/support/images/workflow/editor-share-review-bulk.png similarity index 100% rename from content/support/images/workflow/editor-share-review-bulk.png rename to content/pages/support/images/workflow/editor-share-review-bulk.png diff --git a/content/support/images/workflow/editor-share-review-individual.png b/content/pages/support/images/workflow/editor-share-review-individual.png similarity index 100% rename from content/support/images/workflow/editor-share-review-individual.png rename to content/pages/support/images/workflow/editor-share-review-individual.png diff --git a/content/support/images/workflow/editor-share-review.png b/content/pages/support/images/workflow/editor-share-review.png similarity index 100% rename from content/support/images/workflow/editor-share-review.png rename to content/pages/support/images/workflow/editor-share-review.png diff --git a/content/support/images/workflow/editor-submission-actions.png b/content/pages/support/images/workflow/editor-submission-actions.png similarity index 100% rename from content/support/images/workflow/editor-submission-actions.png rename to content/pages/support/images/workflow/editor-submission-actions.png diff --git a/content/support/images/workflow/editor-submission-edit-author.png b/content/pages/support/images/workflow/editor-submission-edit-author.png similarity index 100% rename from content/support/images/workflow/editor-submission-edit-author.png rename to content/pages/support/images/workflow/editor-submission-edit-author.png diff --git a/content/support/images/workflow/editor-submission-editors.png b/content/pages/support/images/workflow/editor-submission-editors.png similarity index 100% rename from content/support/images/workflow/editor-submission-editors.png rename to content/pages/support/images/workflow/editor-submission-editors.png diff --git a/content/support/images/workflow/editor-submission-overview.png b/content/pages/support/images/workflow/editor-submission-overview.png similarity index 100% rename from content/support/images/workflow/editor-submission-overview.png rename to content/pages/support/images/workflow/editor-submission-overview.png diff --git a/content/support/images/workflow/editor-typesetting-actions.png b/content/pages/support/images/workflow/editor-typesetting-actions.png similarity index 100% rename from content/support/images/workflow/editor-typesetting-actions.png rename to content/pages/support/images/workflow/editor-typesetting-actions.png diff --git a/content/support/images/workflow/editor-typesetting-assign-proofreader.png b/content/pages/support/images/workflow/editor-typesetting-assign-proofreader.png similarity index 100% rename from content/support/images/workflow/editor-typesetting-assign-proofreader.png rename to content/pages/support/images/workflow/editor-typesetting-assign-proofreader.png diff --git a/content/support/images/workflow/editor-typesetting-assign-typesetter.png b/content/pages/support/images/workflow/editor-typesetting-assign-typesetter.png similarity index 100% rename from content/support/images/workflow/editor-typesetting-assign-typesetter.png rename to content/pages/support/images/workflow/editor-typesetting-assign-typesetter.png diff --git a/content/support/images/workflow/editor-typesetting-choice.png b/content/pages/support/images/workflow/editor-typesetting-choice.png similarity index 100% rename from content/support/images/workflow/editor-typesetting-choice.png rename to content/pages/support/images/workflow/editor-typesetting-choice.png diff --git a/content/support/images/workflow/editor-typesetting-edit-galley.png b/content/pages/support/images/workflow/editor-typesetting-edit-galley.png similarity index 100% rename from content/support/images/workflow/editor-typesetting-edit-galley.png rename to content/pages/support/images/workflow/editor-typesetting-edit-galley.png diff --git a/content/support/images/workflow/editor-typesetting-enroll-proofreader.png b/content/pages/support/images/workflow/editor-typesetting-enroll-proofreader.png similarity index 100% rename from content/support/images/workflow/editor-typesetting-enroll-proofreader.png rename to content/pages/support/images/workflow/editor-typesetting-enroll-proofreader.png diff --git a/content/support/images/workflow/editor-typesetting-files-blocks.png b/content/pages/support/images/workflow/editor-typesetting-files-blocks.png similarity index 100% rename from content/support/images/workflow/editor-typesetting-files-blocks.png rename to content/pages/support/images/workflow/editor-typesetting-files-blocks.png diff --git a/content/support/images/workflow/editor-typesetting-galley-buttons.png b/content/pages/support/images/workflow/editor-typesetting-galley-buttons.png similarity index 100% rename from content/support/images/workflow/editor-typesetting-galley-buttons.png rename to content/pages/support/images/workflow/editor-typesetting-galley-buttons.png diff --git a/content/support/images/workflow/editor-typesetting-imagefiles-image.png b/content/pages/support/images/workflow/editor-typesetting-imagefiles-image.png similarity index 100% rename from content/support/images/workflow/editor-typesetting-imagefiles-image.png rename to content/pages/support/images/workflow/editor-typesetting-imagefiles-image.png diff --git a/content/support/images/workflow/editor-typesetting-imagefiles-zipfile.png b/content/pages/support/images/workflow/editor-typesetting-imagefiles-zipfile.png similarity index 100% rename from content/support/images/workflow/editor-typesetting-imagefiles-zipfile.png rename to content/pages/support/images/workflow/editor-typesetting-imagefiles-zipfile.png diff --git a/content/support/images/workflow/editor-typesetting-options.png b/content/pages/support/images/workflow/editor-typesetting-options.png similarity index 100% rename from content/support/images/workflow/editor-typesetting-options.png rename to content/pages/support/images/workflow/editor-typesetting-options.png diff --git a/content/support/images/workflow/editor-typesetting-review-typesetting-decision.png b/content/pages/support/images/workflow/editor-typesetting-review-typesetting-decision.png similarity index 100% rename from content/support/images/workflow/editor-typesetting-review-typesetting-decision.png rename to content/pages/support/images/workflow/editor-typesetting-review-typesetting-decision.png diff --git a/content/support/images/workflow/editor-typesetting-review-typesetting.png b/content/pages/support/images/workflow/editor-typesetting-review-typesetting.png similarity index 100% rename from content/support/images/workflow/editor-typesetting-review-typesetting.png rename to content/pages/support/images/workflow/editor-typesetting-review-typesetting.png diff --git a/content/support/images/workflow/editor-typesetting-rounds.png b/content/pages/support/images/workflow/editor-typesetting-rounds.png similarity index 100% rename from content/support/images/workflow/editor-typesetting-rounds.png rename to content/pages/support/images/workflow/editor-typesetting-rounds.png diff --git a/content/support/images/workflow/editor-typesetting-upload-new-typeset-file.png b/content/pages/support/images/workflow/editor-typesetting-upload-new-typeset-file.png similarity index 100% rename from content/support/images/workflow/editor-typesetting-upload-new-typeset-file.png rename to content/pages/support/images/workflow/editor-typesetting-upload-new-typeset-file.png diff --git a/content/support/images/workflow/prepub_doi.png b/content/pages/support/images/workflow/prepub_doi.png similarity index 100% rename from content/support/images/workflow/prepub_doi.png rename to content/pages/support/images/workflow/prepub_doi.png diff --git a/content/pages/support/images/workflow/proofing-assignments.png b/content/pages/support/images/workflow/proofing-assignments.png new file mode 100644 index 00000000..29124da0 Binary files /dev/null and b/content/pages/support/images/workflow/proofing-assignments.png differ diff --git a/content/pages/support/images/workflow/proofing-task.png b/content/pages/support/images/workflow/proofing-task.png new file mode 100644 index 00000000..5e802e05 Binary files /dev/null and b/content/pages/support/images/workflow/proofing-task.png differ diff --git a/content/support/images/workflow/reviewer-block.png b/content/pages/support/images/workflow/reviewer-block.png similarity index 100% rename from content/support/images/workflow/reviewer-block.png rename to content/pages/support/images/workflow/reviewer-block.png diff --git a/content/support/images/workflow/reviewer-file-upload.png b/content/pages/support/images/workflow/reviewer-file-upload.png similarity index 100% rename from content/support/images/workflow/reviewer-file-upload.png rename to content/pages/support/images/workflow/reviewer-file-upload.png diff --git a/content/support/images/workflow/reviewer-kanban.png b/content/pages/support/images/workflow/reviewer-kanban.png similarity index 100% rename from content/support/images/workflow/reviewer-kanban.png rename to content/pages/support/images/workflow/reviewer-kanban.png diff --git a/content/support/images/workflow/reviewer-review-files.png b/content/pages/support/images/workflow/reviewer-review-files.png similarity index 100% rename from content/support/images/workflow/reviewer-review-files.png rename to content/pages/support/images/workflow/reviewer-review-files.png diff --git a/content/support/images/workflow/reviewer-review-request.png b/content/pages/support/images/workflow/reviewer-review-request.png similarity index 100% rename from content/support/images/workflow/reviewer-review-request.png rename to content/pages/support/images/workflow/reviewer-review-request.png diff --git a/content/support/images/workflow/typesetting-arabic-rtl-jats-xml.png b/content/pages/support/images/workflow/typesetting-arabic-rtl-jats-xml.png similarity index 100% rename from content/support/images/workflow/typesetting-arabic-rtl-jats-xml.png rename to content/pages/support/images/workflow/typesetting-arabic-rtl-jats-xml.png diff --git a/content/support/images/workflow/typesetting-arabic-rtl-rendered.png b/content/pages/support/images/workflow/typesetting-arabic-rtl-rendered.png similarity index 100% rename from content/support/images/workflow/typesetting-arabic-rtl-rendered.png rename to content/pages/support/images/workflow/typesetting-arabic-rtl-rendered.png diff --git a/content/support/images/workflow/typesetting-assignments.png b/content/pages/support/images/workflow/typesetting-assignments.png similarity index 100% rename from content/support/images/workflow/typesetting-assignments.png rename to content/pages/support/images/workflow/typesetting-assignments.png diff --git a/content/support/images/workflow/typesetting-dashboardblock.png b/content/pages/support/images/workflow/typesetting-dashboardblock.png similarity index 100% rename from content/support/images/workflow/typesetting-dashboardblock.png rename to content/pages/support/images/workflow/typesetting-dashboardblock.png diff --git a/content/support/images/workflow/typesetting-edit-button.png b/content/pages/support/images/workflow/typesetting-edit-button.png similarity index 100% rename from content/support/images/workflow/typesetting-edit-button.png rename to content/pages/support/images/workflow/typesetting-edit-button.png diff --git a/content/support/images/workflow/typesetting-filehistory.png b/content/pages/support/images/workflow/typesetting-filehistory.png similarity index 100% rename from content/support/images/workflow/typesetting-filehistory.png rename to content/pages/support/images/workflow/typesetting-filehistory.png diff --git a/content/support/images/workflow/typesetting-files.png b/content/pages/support/images/workflow/typesetting-files.png similarity index 100% rename from content/support/images/workflow/typesetting-files.png rename to content/pages/support/images/workflow/typesetting-files.png diff --git a/content/support/images/workflow/typesetting-image-upload.png b/content/pages/support/images/workflow/typesetting-image-upload.png similarity index 100% rename from content/support/images/workflow/typesetting-image-upload.png rename to content/pages/support/images/workflow/typesetting-image-upload.png diff --git a/content/support/images/workflow/typesetting-interface.png b/content/pages/support/images/workflow/typesetting-interface.png similarity index 100% rename from content/support/images/workflow/typesetting-interface.png rename to content/pages/support/images/workflow/typesetting-interface.png diff --git a/content/pages/support/images/workflow/typesetting-proofreading-tasks.png b/content/pages/support/images/workflow/typesetting-proofreading-tasks.png new file mode 100644 index 00000000..5afc1e4f Binary files /dev/null and b/content/pages/support/images/workflow/typesetting-proofreading-tasks.png differ diff --git a/content/support/images/workflow/typesetting-text-align-center.png b/content/pages/support/images/workflow/typesetting-text-align-center.png similarity index 100% rename from content/support/images/workflow/typesetting-text-align-center.png rename to content/pages/support/images/workflow/typesetting-text-align-center.png diff --git a/content/support/images/workflow/typesetting-upload.png b/content/pages/support/images/workflow/typesetting-upload.png similarity index 100% rename from content/support/images/workflow/typesetting-upload.png rename to content/pages/support/images/workflow/typesetting-upload.png diff --git a/content/support/images/workflow/workflow-images.txt b/content/pages/support/images/workflow/workflow-images.txt similarity index 100% rename from content/support/images/workflow/workflow-images.txt rename to content/pages/support/images/workflow/workflow-images.txt diff --git a/content/support/issues-volumes-and-collections/collections-placeholder.md b/content/pages/support/issues-volumes-and-collections/collections.md similarity index 96% rename from content/support/issues-volumes-and-collections/collections-placeholder.md rename to content/pages/support/issues-volumes-and-collections/collections.md index 1b957adf..56e2e79c 100644 --- a/content/support/issues-volumes-and-collections/collections-placeholder.md +++ b/content/pages/support/issues-volumes-and-collections/collections.md @@ -1,5 +1,3 @@ -title: Collections - # Collections Collections differ in so much as they are not a primary issue for a paper but tend to be collections of papers with similar topics across multiple issues. So an article may be in the Thomas Pynchon Collection but its primary issue may be Volume 1 Issue 2 2019. You can also define your own issue types in the Django admin area. diff --git a/content/pages/support/issues-volumes-and-collections/index.md b/content/pages/support/issues-volumes-and-collections/index.md new file mode 100644 index 00000000..44ef8822 --- /dev/null +++ b/content/pages/support/issues-volumes-and-collections/index.md @@ -0,0 +1,8 @@ +# Issues, volumes and collections on Janeway + +Janeway organises published articles into issues, which are in turn grouped into volumes. Collections offer an additional way to group related articles across issues and volumes. This section explains how each of these works and how to manage them. + +- [Issues](issues-and-volumes.md) + How issues and volumes work in Janeway, the built-in issue type, and how articles are assigned to issues via the Issue manager. +- [Collections](collections.md) + How collections differ from issues, and how organise collections that don't follow the regular volume/issue order. diff --git a/content/support/issues-volumes-and-collections/issues-and-volumes.md b/content/pages/support/issues-volumes-and-collections/issues-and-volumes.md similarity index 68% rename from content/support/issues-volumes-and-collections/issues-and-volumes.md rename to content/pages/support/issues-volumes-and-collections/issues-and-volumes.md index 67f4f403..4141feab 100644 --- a/content/support/issues-volumes-and-collections/issues-and-volumes.md +++ b/content/pages/support/issues-volumes-and-collections/issues-and-volumes.md @@ -1,8 +1,6 @@ -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, we recommend using issues where possible. If your journal uses continuous publication, we recommend creating 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, 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. 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. @@ -28,7 +26,7 @@ You can use Volume 0 for ongoing thematic collections — especially those that 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) +![The Issue manager page.](../images/issue-manager.png) From this page, you can perform the following actions: @@ -43,25 +41,25 @@ From this page, you can perform the following actions: In addition, the issue list is presented in a table format. For each issue, the following actions are available: -- **View** +- **View** Opens the [Manage issue](#managing-existing-issues) page, where you can edit metadata, manage the table of contents, assign guest editors, and upload galleys. -- **Delete** +- **Delete** Permanently deletes the issue. This cannot be undone. -- **Make current** - Sets the selected issue as the journal’s current issue. The current issue does not display this button. +- **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 view publication data such as volume, issue number, publication date, and number of articles directly from the table. ## Creating and editing issue details -You can create new issues from this page using the **Create issue** button and you view and edit the detail of individual issues by selecting them. +You can create new issues from this page using the **Create issue** button and you view and edit the detail of individual issues by selecting them. -![An empty create issue form](/content/support/images/create-issue.png) +![An empty create issue form](../images/create-issue.png) You can set the standard issue metadata and images for the issue on this page. Information on the sizes of the cover image and large image can be found in the Styling section. In addition, you can also provide identifiers for the issue (DOI or ISBN), set an issue type or provide an issue code. - **Issue code** - This optional alphanumeric [slug]() is used to generate a human-readable URL for an issue. It should consist of lowercase letters, numbers, and hyphens (no spaces or special characters). + This optional alphanumeric [slug]() is used to generate a human-readable URL for an issue. It can consist of lowercase letters, numbers, and hyphens (no spaces or special characters). For example, if you enter winter-special-issue, the issue URL will be: `yourjournal.com/collection/code/winter-special-issue/` @@ -69,14 +67,14 @@ You can set the standard issue metadata and images for the issue on this page. I You can select the issue type here; you can either select 'issue' or 'collection', or any custom issue types you have created for the journal. - **Issue DOI** - You can enter the issue DOI here. It will be registered when articles belonging to it are registered. The value entered should be the DOI only (not a full URL). If the 'issue autoregistration' setting is enabled, this field should remain empty, as the DOI will be created automatically during the article registration process. + You can enter the issue DOI here. It will be registered when articles belonging to it are registered. The value entered must be the DOI only (not a full URL). If the 'issue autoregistration' setting is enabled, this field must remain empty, as the DOI will be created automatically during the article registration process. - **Issue ISBN** If this issue has an ISBN, it can be entered here. This will only be relevant for specific (non-serial) types of content such as conference proceedings. ## Managing existing issues -Clicking on **View** in the table listing all issues takes you through to the issue page where you can alter an individual issue. The page is split into four sections. +Clicking on **View** in the table listing all issues takes you through to the issue page where you can alter an individual issue. The page is split into four sections. - **Issue management** This block displays the issue metadata and allows you to edit it, delete it, mark it as the current issue, and if the issue is published there is a link to view it on the journal website. @@ -94,20 +92,21 @@ In this section, you can add articles to or remove articles from the issue, sort For each section, there are arrow icons that allow you to move the section up and down; each of the articles can be dragged and dropped into order from inside their section. -![Issue table of contents](/content/support/images/issue-table of contents.png) +![Issue table of contents](../images/issue-table-of-contents.png) + +You can drop an article from an issue by clicking **Remove** and add new ones by clicking **Add article**. -You can drop an article from an issue by clicking **Remove** and add new ones by clicking **Add article**. -[" "](/content/support/images/issue-add-articles.png) +![" "](../images/issue-add-articles.png) -A list of all articles in the journal not already in the issue is displayed, and you can click the **Add** button to place it in the issue. +A list of all articles in the journal not already in the issue is displayed, and you can click the **Add** button to place it in the issue. ### Guest editors -An issue can list guest editors if the articles aren't being handled by the normal editorial team. Click **Manage** to add or edit guest editors for the issue/collection. When adding a new guest editor you can also enter a role other than 'Guest editor', which is set as the default. All users with activated accounts are listed here, click the **Add** button next to their name to add them as a guest editor. +An issue can list guest editors if the articles aren't being handled by the normal editorial team. Click **Manage** to add or edit guest editors for the issue/collection. When adding a new guest editor you can also enter a role other than 'Guest editor', which is set as the default. All users with activated accounts are listed here, click the **Add** button next to their name to add them as a guest editor. ## Display settings -To configure how issue titles and details are displayed, click **Edit display settings** in the top-right corner of the **Issue management** page. +To configure how issue titles and details are displayed, click **Edit display settings** in the top-right corner of the **Issue management** page. You can turn these elements on or off: @@ -117,7 +116,7 @@ You can turn these elements on or off: - Issue title - Article number - Article page numbers -- Issue DOI - see [Issue DOI management]() +- Issue DOI - see [Issue DOI management](../identifiers/crossref-issue-doi.md) - Group issues by decade If your journal has a lot of issues you can use this feature to allow readers to jump to a specific decade on the issues interface. @@ -131,7 +130,7 @@ Example display formats: > If you want to display a custom issue title, disable everything except issue title, and use that field to form the issue display for each issue. > [!TIP] -> You can use the article number field to set an arbitrary number for each article, whether to distinguish articles within each volume or issue or to number articles across volumes and issues. Article number is an optional field separate from article ID and can be set in **Edit metadata**. +> You can use the article number field to set an arbitrary number for each article, whether to distinguish articles within each volume or issue or to number articles across volumes and issues. Article number is an optional field separate from article ID and can be set in **Edit metadata**. ## Projected issues diff --git a/content/support/janeway-styleguide.md b/content/pages/support/janeway-styleguide.md similarity index 99% rename from content/support/janeway-styleguide.md rename to content/pages/support/janeway-styleguide.md index 3c2a6186..c36da9be 100644 --- a/content/support/janeway-styleguide.md +++ b/content/pages/support/janeway-styleguide.md @@ -1,5 +1,3 @@ -title: Janeway style guide - # Janeway style guide ## In this guide @@ -17,7 +15,7 @@ title: Janeway style guide
About this guide -- This style guide is adapted from the [Google style guide](https://developers.google.com/style) (which is available under a CC-BY 4.0 license) and has been adjusted to meet Janeway’s requirements. It will also follow Google’s structure. This document is **NOT** intended to cover all issues. It currently contains summaries for ease of access while we adopt the guide, and additions, exceptions, and deviations from the Google guide. In the long term, it will serve solely to outline exceptions, deviations, additions, etc. from the Google guide. (Hopefully, there will not be many) +- This style guide is adapted from the [Google style guide](https://developers.google.com/style) (which is available under a CC-BY 4.0 licence) and has been adjusted to meet Janeway’s requirements. It will also follow Google’s structure. This document is **NOT** intended to cover all issues. It currently contains summaries for ease of access while we adopt the guide, and additions, exceptions, and deviations from the Google guide. In the long term, it will serve solely to outline exceptions, deviations, additions, etc. from the Google guide. (Hopefully, there will not be many) - This style guide **_does not_** follow OLH or OLHJ style - this is as it a) will have different requirements than OLH(J), b) will make this style guide easier to customise and maintain. - This guide uses UK English. - This guide uses the [Chicago style (17th edition)](https://www.chicagomanualofstyle.org/book/ed17/frontmatter/toc.html) for citations and referencing (see also [Purdue's Online Writing Lab's guidance for Chicago 17th](https://owl.purdue.edu/owl/research_and_citation/chicago_manual_17th_edition/cmos_formatting_and_style_guide/chicago_manual_of_style_17th_edition.html)). diff --git a/content/support/journal-management/carousel.md b/content/pages/support/journal-management/carousel.md similarity index 84% rename from content/support/journal-management/carousel.md rename to content/pages/support/journal-management/carousel.md index d7a01fc2..e71072dd 100644 --- a/content/support/journal-management/carousel.md +++ b/content/pages/support/journal-management/carousel.md @@ -1,5 +1,3 @@ -title: Carousel configuration - # Carousel configuration The homepage carousel is a rotating banner that can display selected content from your journal, such as articles, news items, issues, or collections. These content types can be mixed within the same carousel. @@ -14,11 +12,11 @@ To remove the carousel from your homepage, click the **Delete** icon next to it. ## Customising carousel content -The carousel can display three types of content articles, news items, and issues and collections. All of these can appear together in the same carousel. The carousel does not enforce a fixed display order. It cycles through the selected items continuously. For usability reasons, we keeping the total number of items between 5-6 items, and avoiding more than 10. +The carousel can display three types of content articles, news items, and issues and collections. All of these can appear together in the same carousel. The carousel does not enforce a fixed display order. It cycles through the selected items continuously. For usability reasons, it is best to limit the total number of items to 5-6, and avoid more than 10. ### Images used in the carousel -The image shown in the carousel comes from the `large image` associated with the item, these are set as part of creating a news item, creating an issue or collection, or publishing an article. +The image shown in the carousel comes from the `large image` associated with the item, these are set as part of [creating a news item](./news-manager.md), [creating an issue or collection](../issues-volumes-and-collections/index.md), or [publishing an article](../article-management/article-images.md). If an item does not have a large image: @@ -32,12 +30,10 @@ For best results, ensure items included in the carousel have suitable large imag The **Exclude** tickbox changes how the selection lists behave. - **Disabled (default):** - The selected items are **included** in the carousel. + The selected items are _included_ in the carousel. - **Enabled:** - The selected items are **excluded** from the carousel. - - + The selected items are _excluded_ from the carousel. ## Selecting items for the carousel @@ -52,7 +48,7 @@ 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) +![" "](../images/carousel-selector.png) ### Articles @@ -68,10 +64,10 @@ Enable **Latest news** to automatically display recent announcements, and set th ### 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. +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 marked as current. > [!TIP] -> If changes are not appearing on the homepage, trying clearing the cache. +> If changes are not appearing on the homepage, trying [clearing the cache](./clearing-the-cache.md). ## Image contrast and carousel overlays diff --git a/content/support/journal-management/cache-temp.md b/content/pages/support/journal-management/clearing-the-cache.md similarity index 96% rename from content/support/journal-management/cache-temp.md rename to content/pages/support/journal-management/clearing-the-cache.md index 9fcfcf03..82b63c3a 100644 --- a/content/support/journal-management/cache-temp.md +++ b/content/pages/support/journal-management/clearing-the-cache.md @@ -1,5 +1,3 @@ -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. diff --git a/content/support/journal-management/editorial-team.md b/content/pages/support/journal-management/editorial-team.md similarity index 76% rename from content/support/journal-management/editorial-team.md rename to content/pages/support/journal-management/editorial-team.md index 0575b993..d5425a25 100644 --- a/content/support/journal-management/editorial-team.md +++ b/content/pages/support/journal-management/editorial-team.md @@ -1,8 +1,6 @@ -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 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**. On this page you can: @@ -15,7 +13,7 @@ There is no limit on the number of editorial groups you can create or how many m 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. - +![The Editorial Team interface](../images/editorial-team.png) ## Creating a new group @@ -32,9 +30,9 @@ Creating a new group allows you to add members and display them on the Editorial ## Editing a group -To edit an existing group, click the **Edit members** button. +To edit an existing group, click the **Manage group members** button. - +![The Editorial Team edit page.](../images/manage-editorial-team-membership.png) On the left-hand side, you will see a list of current group members. From here you can: @@ -45,7 +43,7 @@ To add someone to an editorial team, they need to have a Janeway account. A list 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. +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](../plugins/imports-editorial-team.md) 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). @@ -62,12 +60,8 @@ The following settings control how editorial groups and members are displayed on - 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**. +- Display Country on Editorial Team Page + When enabled, and where a group member has an affiliation that has a country listed, the country will be displayed next to their name. If no country is set, nothing is shown. + > [!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). - - diff --git a/content/support/journal-management/form-elements.md b/content/pages/support/journal-management/form-elements.md similarity index 52% rename from content/support/journal-management/form-elements.md rename to content/pages/support/journal-management/form-elements.md index 1c1d021e..7526072c 100644 --- a/content/support/journal-management/form-elements.md +++ b/content/pages/support/journal-management/form-elements.md @@ -1,8 +1,6 @@ -title: Form elements - # Form elements -Custom forms in Janeway have the following aspects to them yada yada. +Custom forms in Janeway have the following aspects to them: @@ -11,13 +9,18 @@ Custom forms in Janeway have the following aspects to them yada yada. 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 - This determines the type of element, e.g., text field, checkbox, dropdown etc. For an overview of element types available, see Element types + This determines the type of element, e.g., text field, checkbox, dropdown etc. For an overview of element types available, see [Element types](#element-types-kind). + +- Choices + The **Choices** field is used in the 'Select(dropdown)' element. It will, however, always appear. If you are not using the 'Select(dropdown)' element, you should ignore it. - Required - Check this setting’s box to make this part of the form obligatory to complete. + Checking this box will make it obligatory for users to complete that specific field. This means that they cannot submit the form without doing so. Unchecking it means that it will become optional. - Order - This determines the order of elements on the form. + This determines the order of the elements on the form. This is expressed numerically, so “1” means that the element will be displayed first, “2” means that it will be displayed second, etc. + + You also have the option to click and drag elements from the full form view to reorder them. - Help text This text will display under the form element and can provide further guidance or information for authors. @@ -29,40 +32,39 @@ Custom forms in Janeway have the following aspects to them yada yada. A form element can be one of the following kinds: -- Text field +- **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 +- **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) -- Checkbox - This element asks users to check a box, which can be used to declare no competing interests / agree to terms, for example. +- **Checkbox** + This allows you to ask users to tick a box. These can be used to declare no competing interests or agree to terms and conditions. ![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 ". +- **Select (dropdown)** + This lets you provide a set of options to be displayed in a dropdown list, allowing users to select one. + + To add these options, use the **Choices** field. The options must be separated by the bar (" | ") character. This will look like this: "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. +- **Email** + This is a specific text field for emails. It checks if an email address is correctly formatted before a user submits the form and prompts them to edit it, if it is not. ![Example email field](../../support/images/element-email.png) -- Upload - Asks the users to upload a file from their device. +- **Upload** + This lets a user upload a file from their device. ![Example upload field](../../support/images/element-file-upload.png) -- Date - Asks the user to provide a date. +- **Date** + This 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. diff --git a/content/support/journal-management/homepage-layout.md b/content/pages/support/journal-management/homepage-customisation.md similarity index 78% rename from content/support/journal-management/homepage-layout.md rename to content/pages/support/journal-management/homepage-customisation.md index bbec6533..4e36411a 100644 --- a/content/support/journal-management/homepage-layout.md +++ b/content/pages/support/journal-management/homepage-customisation.md @@ -1,8 +1,6 @@ -title: Homepage customisation - # Homepage customisation -The Homepage customisation settings allow you to control which features appear on your journal’s home page and how they are displayed. +The homepage 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: @@ -10,13 +8,11 @@ From this page, you can: - Configure the content of each feature. - Change the order in which features appear. - - ## 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. +Any changes take effect immediately, if you do not see them you may need to [clear your cache](./clearing-the-cache.md). ## Homepage features @@ -29,10 +25,10 @@ Any changes take effect immediately, if you do not see them you may need to clea - Latest news. - A combination of both. -You can select the number of items to display and the items you want to include or exclude. For more information, see carousel configuration. +You can select the number of items to display and the items you want to include or exclude. For more information, see [carousel configuration](./carousel.md). - 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. + 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 [issues page](../issues-volumes-and-collections/index.md). - 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. diff --git a/content/support/journal-management/image-guidelines-hell.md b/content/pages/support/journal-management/image-guidelines.md similarity index 97% rename from content/support/journal-management/image-guidelines-hell.md rename to content/pages/support/journal-management/image-guidelines.md index c92b8f0e..a1577aa8 100644 --- a/content/support/journal-management/image-guidelines-hell.md +++ b/content/pages/support/journal-management/image-guidelines.md @@ -1,5 +1,3 @@ -title: Image guidelines - # Image guidelines - -- 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. +- [Content manager](./janeway-content-manager.md) + 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 +- [News manager](./news-manager.md) Create and publish news items on your journal website. News items can appear on the homepage or in the carousel. -- Media files +- [Media files](./media-files.md) 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. +- [Navigation](./navigation.md) + 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. +- [Managing rich-text fields](./rich-text.md) + 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. +These settings control how your journal's homepage elements are displayed. -- Homepage elements +- [Homepage elements](./homepage-customisation.md) Configure homepage features such as the carousel, featured articles, popular articles, and other homepage components. -- Carousel configuration +- [Carousel configuration](./carousel.md) 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. +- [Journal images]() + Guidance on uploading and formatting images used across the journal website, including logos, cover images, and article images. ## Editorial and contact information Use these interfaces to manage the people and contact details displayed on your journal website. -- Editorial team +- [Editorial team](./editorial-team.md) 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 contacts](./journal-contacts.md) + 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 +- [Journal settings](./journal-settings.md) Set key journal details, configure email settings, and adjust various display and integration settings. -- Image guidelines +- [Image guidelines](./image-guidelines.md) Guidance on how and where images appear on the journal site, and image size guidelines. -- Similarity checker +- [Similarity checker](./similarity-check.md) Configure the Crossref Similarity Check (iThenticate) integration for checking submitted manuscripts. -- Clearing the cache +- [Clearing the cache](./clearing-the-cache.md) If recent changes are not appearing on your journal website, you may need to clear the system cache to refresh stored data. - + diff --git a/content/support/journal-management/cms.md b/content/pages/support/journal-management/janeway-content-manager.md similarity index 54% rename from content/support/journal-management/cms.md rename to content/pages/support/journal-management/janeway-content-manager.md index f6242496..b1e34464 100644 --- a/content/support/journal-management/cms.md +++ b/content/pages/support/journal-management/janeway-content-manager.md @@ -1,18 +1,14 @@ -title: Janeway content manager - # Janeway content manager -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. +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. - +![Content manager](../images/cms.png) ## Add a new page 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 . - - +For information on embedding media files within a page, see [Media files](./media-files.md). Pages are immediately public after saving them. @@ -20,21 +16,19 @@ Pages are immediately public after saving them. 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`). +- 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. An example: `https://orbit.openlibhums.org/site/privacy` -For information on adding new pages to your site navigation, see **Navigation**. - - +For information on adding new pages to your site navigation, see [**Navigation**](./navigation.md). ## Edit a page -The content manager displays a list of all custom pages currently available on your journal. Click **Edit** to make changes. +The content manager displays a list of all custom pages available on your journal. Click **Edit** to make changes. -Changes take effect immediately once saved. If you do not see them displayed on the journal page, you may need to refresh your cache. +Changes take effect immediately once saved. If you do not see them displayed on the journal page, you may need to [refresh your cache](./clearing-the-cache.md). You can see a page's editing history by clicking **View history** at the bottom of the edit page. diff --git a/content/support/journal-management/journal-contacts.md b/content/pages/support/journal-management/journal-contacts.md similarity index 83% rename from content/support/journal-management/journal-contacts.md rename to content/pages/support/journal-management/journal-contacts.md index 3817307d..e99ef047 100644 --- a/content/support/journal-management/journal-contacts.md +++ b/content/pages/support/journal-management/journal-contacts.md @@ -1,5 +1,3 @@ -title: Journal contacts - # 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: @@ -13,7 +11,7 @@ You can control the contacts listing for your journal by adding and removing con - Role The contact's role, e.g. editor or reviewer. - ![Contact Manager interface. The sort handles indicate you can drag and drop to re-order your contacts.](contact-manager.png) + ![Contact manager interface. The sort handles indicate you can drag and drop to re-order your contacts.](../images/contacts-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. diff --git a/content/support/journal-management/journal-settings.md b/content/pages/support/journal-management/journal-settings.md similarity index 63% rename from content/support/journal-management/journal-settings.md rename to content/pages/support/journal-management/journal-settings.md index 49a0c467..ca226870 100644 --- a/content/support/journal-management/journal-settings.md +++ b/content/pages/support/journal-management/journal-settings.md @@ -1,5 +1,3 @@ -title: Journal settings - # Journal settings In journal settings, you can set basic information about the journal, configure home page elements, upload logos and banner images, and adjust some display elements. @@ -8,7 +6,7 @@ If you have the Janeway role of editor or staff, you can access Journal 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: +The **All settings** page lists every underlying journal-level setting within Janeway and allows you to edit them. The setting groups are: - Crossref - Email @@ -34,23 +32,3 @@ The general journal settings page is home to various configuration settings for - Remote website settings - Language settings - Integration with Slack or Discord - - diff --git a/content/support/journal-management/media-files.md b/content/pages/support/journal-management/media-files.md similarity index 55% rename from content/support/journal-management/media-files.md rename to content/pages/support/journal-management/media-files.md index 995624b5..06f182ac 100644 --- a/content/support/journal-management/media-files.md +++ b/content/pages/support/journal-management/media-files.md @@ -1,5 +1,3 @@ -title: Media files - # Media files The Media files manager lets editors upload and host small files, which can then have download links embedded within a page. @@ -12,6 +10,4 @@ Examples include: Once a file is uploaded a link is provided that you can then insert into CMS pages or templates. > [!NOTE] -> 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. - - +> The **Media files** must not be used to upload videos unless you have sufficient storage space/bandwidth. If you use Janeway hosting you can contact the support team. diff --git a/content/support/journal-management/navigation.md b/content/pages/support/journal-management/navigation.md similarity index 95% rename from content/support/journal-management/navigation.md rename to content/pages/support/journal-management/navigation.md index a5e06f77..955ae60e 100644 --- a/content/support/journal-management/navigation.md +++ b/content/pages/support/journal-management/navigation.md @@ -1,5 +1,3 @@ -title: Navigation - # Navigation A journal's navigation bar (navbar) is customised through the **Content manager**. @@ -57,7 +55,7 @@ The built-in page options provided by Janeway cannot be reordered directly. To r -For footer navigation, see footer navigation . This is only available at press level/ +For footer navigation, see [footer navigation](../press-management/footer.md). This is only available at press level/ ## Footer Navigation @@ -82,7 +80,7 @@ footer**, and **Extend to journals**. This page displays some general settings for controlling the styling of your journal. -- Full Width Nav (only used by the Material theme) +- Full width nav (only used by the Material theme) +News items can also displayed in [the carousel](./carousel.md). -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, click **Add news item**. - +![" "](../images/news-manager.png) The form fields include: @@ -28,12 +26,12 @@ The form fields include: 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; this will display at the top as a banner image. - 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. These tags are case-sensitive. - +![An example of a published news item with tags, an author and a banner image.](../images/news-item.png) diff --git a/content/pages/support/journal-management/rich-text.md b/content/pages/support/journal-management/rich-text.md new file mode 100644 index 00000000..35702eab --- /dev/null +++ b/content/pages/support/journal-management/rich-text.md @@ -0,0 +1,52 @@ +# Managing rich text fields + +Many fields in Janeway allow you to enter rich text. Rich text can be formatted with links, italics, bolding, numbered lists, block quotes, and other elements. It also makes structural markup like heading levels and list structure possible, so that your content can be more accessible to users of text-to-speech or other assistive technologies. + +Most of the time, it is straightforward to use the toolbar of formatting options to format content. But there are a few tricks to using Janeway’s rich text editor. + +## Copy-pasting from Word or another app + +If you copy-paste from another rich-text environment like a DOCX document, Janeway tries to help you manage how much formatting comes over. + +> “Formatted paste detected. Click ‘OK’ to paste as text or ‘Cancel’ to keep the formatting.” + +Selecting OK will remove all the formatting (markup) in the source text. You will have to reformat bold, italic, and lists, re-enter links, and make sure any headings are marked up with the right level. + +Selecting Cancel will attempt to keep all the source formatting. Note that this may not have intended results, since the journal website applies its own styling, so there may be visual inconsistencies, or only a fraction of the kept formatting may be strictly necessary. + +### Technical details of clearing or keeping formatting + +This section explains the technical details of the copy-paste process, requiring some knowledge of HTML and CSS. + +Clearing the formatting effectively removes all the HTML markup from the text. Line breaks are preserved only with newline characters (`\n`). Semantic markup like heading levels and list structures are removed, and link references are lost. + +Keeping the formatting not only keeps the HTML markup but creates in-line CSS style rules in the HTML markup. An example of how this might look is `

test

`. + +> [!TIP] +> If you can edit HTML, consider preparing your page in a code editor and then copy-pasting into the code view of the Janeway rich-text field. This will allow you to keep exactly the markup you want. By pasting into the code view, you bypass the question about clearing or keeping formatting. + +## Inserting images + +You can insert images into rich-text content by using the [media manager](./media-files.md). + +![""](../images/insert-image-tinymce.png) + +1. Upload your image to the media manager and copy the URL. +2. In the rich-text field toolbar, select **Insert** and then **Image**. +3. Paste the media manager URL into the **Source** field. +4. Enter alternative text for your image in the **Alternative description** field. +5. Edit the width and height if desired, to change how large the image displays. +6. Select **Save**. + +## What cannot be put in rich-text fields + +The rich-text field does not support some types of media, as these could lead to that could lead to [Cross Site Scripting](https://owasp.org/www-community/attacks/xss/) attacks. + +These elements are always removed from the content when you click **Save**. + +- Audio or video players, including copy-paste embeds from other platforms like YouTube, are removed. +- JavaScript code is removed. +- Some CSS rules are removed. + +> [!NOTE] +> These elements are removed by applying a bleach algorithm to the page markup. Server administrators can change what elements are removed by changing the Django settings beginning `BLEACH_`. diff --git a/content/support/journal-management/similarity-check.md b/content/pages/support/journal-management/similarity-check.md similarity index 95% rename from content/support/journal-management/similarity-check.md rename to content/pages/support/journal-management/similarity-check.md index 157eb343..401c5e6e 100644 --- a/content/support/journal-management/similarity-check.md +++ b/content/pages/support/journal-management/similarity-check.md @@ -1,5 +1,3 @@ -title: Similarity checker - # Similarity checker Janeway supports Crosscheck (also called Similarity Check), which is provided by iThenticate. You can sign up for an account via Crossref, allowing you to send submitted manuscripts for originality checking. diff --git a/content/support/journal-management/themes-placeholder.md b/content/pages/support/journal-management/themes.md similarity index 94% rename from content/support/journal-management/themes-placeholder.md rename to content/pages/support/journal-management/themes.md index ca791f03..a2a8bead 100644 --- a/content/support/journal-management/themes-placeholder.md +++ b/content/pages/support/journal-management/themes.md @@ -1,5 +1,3 @@ -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. @@ -15,7 +13,7 @@ Clean is the most differnet from the two - thinner viewport and less prominent i ## Clean -- Currently most accessible. +- Most accessible. - Minimalistic, less images. Examples: diff --git a/content/pages/support/plugins/adverts.md b/content/pages/support/plugins/adverts.md new file mode 100644 index 00000000..847a8495 --- /dev/null +++ b/content/pages/support/plugins/adverts.md @@ -0,0 +1,12 @@ +# Adverts on Janeway + +Status: Inactive +[GitHub adverts plugin repository](https://github.com/openlibhums/adverts) + +This plugin requires further development. If you are a hosted client and wish to show basic adverts on Janeway, contact support. + +It is possible to show basic adverts on Janeway, in the page margins. These will display as small, square images. + +Recommended image dimensions : + + diff --git a/content/pages/support/plugins/annotator-plugins.md b/content/pages/support/plugins/annotator-plugins.md new file mode 100644 index 00000000..966778f5 --- /dev/null +++ b/content/pages/support/plugins/annotator-plugins.md @@ -0,0 +1,6 @@ +# Annotator overview + +- Hypothesis (active) - [GitHub repository](https://github.com/openlibhums/annotators) +- Disqus (inactive) - [GitHub repository](https://github.com/openlibhums/disqus) + +Disqus is not GDPR-compliant and may not suit those required to adhere to it. diff --git a/content/support/plugins/apc-placeholder.md b/content/pages/support/plugins/apc.md similarity index 50% rename from content/support/plugins/apc-placeholder.md rename to content/pages/support/plugins/apc.md index 5d0ffa51..bc5bdb3e 100644 --- a/content/support/plugins/apc-placeholder.md +++ b/content/pages/support/plugins/apc.md @@ -1,10 +1,10 @@ -title: Article publication charges - # Article publication charges -Active -(GitHub Repo)[https://github.com/openlibhums/apc] +Status: Active +[GitHub repository](https://github.com/openlibhums/apc) -This plugin enables Janeway to set, manage and track Article Publication Charges (APCs) or Voluntary Author Contributions (VACs). -The APC manager is designed to track accepted publications for Gold OA journals, but it is not intended to configure paywalls. +This plugin enables Janeway to set, manage and track Article Publication Charges (APCs) or Voluntary Author Contributions (VACs). The manager is designed to track accepted publications, but it cannot and will not configure paywalls. It has a waiver management system, allowing you to mark articles as invoiced and paid, but does no more than that (e.g. no billing). + +> [!IMPORTANT] +> This plugin **does not** enable paywalls of any kind. Janeway will never contain paywalls. diff --git a/content/support/plugins/archiving-overview-placeholder.md b/content/pages/support/plugins/archiving-overview.md similarity index 90% rename from content/support/plugins/archiving-overview-placeholder.md rename to content/pages/support/plugins/archiving-overview.md index a74f5012..d4865eb8 100644 --- a/content/support/plugins/archiving-overview-placeholder.md +++ b/content/pages/support/plugins/archiving-overview.md @@ -1,5 +1,3 @@ -title: Archiving plugins - # Archiving plugins - Portico (active) @@ -8,10 +6,10 @@ title: Archiving plugins - Library of Congress transporter (active) - [GitHub Repo](https://github.com/openlibhums/loc_transporter) -- C/Lockss (active) +- C/LOCKSS (active) - Only used for the archival statement - [GitHub Repo](https://github.com/openlibhums/lockss) -- FTP +- FTP (active) - [GitHub Repo](https://github.com/openlibhums/janeway-ftp) - This package contains FTP, SFTP and Helpers use to prepare and deposit articles from a Janeway instance. diff --git a/content/pages/support/plugins/books.md b/content/pages/support/plugins/books.md new file mode 100644 index 00000000..40d81320 --- /dev/null +++ b/content/pages/support/plugins/books.md @@ -0,0 +1,381 @@ +# Books plugin + +Status: active +[GitHub repository](https://github.com/openlibhums/books) + +Through this plugin, all book-related tasks and metadata are managed. +This plugin has three key functionalities: + +- Adding new books through either individual uploads or a bulk import. +- Metrics for reporting (overall or monthly) +- Categories - this can be used for imprints, series or other types of + categorisation you may wish to use for published materials. + +## Main dashboard + +![Books plug-in dashboard, displaying all books with titles and their details, and the various functionalities in the right-hand top.](../images/books-dashboardblock.png) + +From the books dashboard, you can manage all tasks and data related to +monographs (or similar items). It also provides an overview of all items +published through this plug-in and the following information for all of +them (they can also be sorted by any of these): + +- ID +- Title +- Subtitle +- First author +- ISBN +- DOI +- Date published +- Reads +- Downloads + +![""](../images/books-dashboardblock-highlight.png) + +The bar on top represents access to the key functions of the books plugin: + +- Metrics by month +- (General) Metrics +- Import books +- Categories +- Add new book + +## Categories + +This is where categories can be created that books can be assigned to;such as imprints, collections or even record labels. + +All current categories are displayed on the right-hand side, with a link +to the live website where you can view all monographs present +in a category. + +Whilst books can be assigned to a category at any moment, it is +necessary to create the category before a book can be assigned. +Categories cannot be created through the **Add a new book** interface. + +![The categories dashboard, listing the existing categories on the left. For the existing categories, the number of books in the category are displayed, as well as buttons to edit and delete. On the right, the form to add a new category is visible with multiple textboxes.](../images/books-category-dashboard.png) + +When adding a new category, the following fields are available: + +- Name + This is a required field. + +- Description + +- Display title + Leave this unchecked if you want to hide the category title. + +- Chapter name + This is where the 'Chapter' label can be edited, in case the + individual components of publications assigned to this category + are not chapters. This is a required field. + +- Chapter name plural + This is where the plural for the 'Chapter' label can be edited + to ensure the label is pluralised correctly. This is a required + field. + +- Buy button text + This defaults to “Buy this Book”. If the item is not a book, you + will need to update this field. This is a required field. + +![An example of how changing the 'Chapter name' fields results in a change on the website. Instead of 'Chapters' it reads 'Assignment Sets' on the dropdown. The text in the dropdown now reads 'Introduction to Open Access - workbook (the title) has the following Assignment Sets:'. It then goes on to list these.](../images/books-category-display.png) + +> [!NOTE] +> This field is case-sensitive. If you do not wish for these words to be +> capitalised by default (and thus mid-sentence), you need to enter them +> in lowercase. See the image above for an example of how this label +> displays when it is capitalised. Janeway will automatically capitalise +> the words when they appear at the start of a sentence. + +## Adding a new book + +New monographs are added by clicking **Add new book**, which is +positioned rightmost in the topbar of the main dashboard. + +![The 'Add a new book' page. On the left, the book details can be filled into various text boxes. On the right are sections for 'Contributors', 'Formats' and 'Chapters'. These are currently blocked, which is indicated for each of them with a red bar and the text “Save book before adding contributors/formats/chapters”.](../images/books-addbook-dashboard.png) + +Before the manuscript files can be uploaded, various metadata fields +need to be completed first, displayed on the left-hand side of the page +under **Book details**. + +![""](../images/books-addbook-details.png) + +This section contains the following fields: + +- Prefix + +- Title + This is a required field. + +- Subtitle + +- Category + This is where a publication can be assigned to an imprint, if + applicable. + +- Description + The book's description can be provided here. + +- Pages + This is the total number of pages. + +- Edited volume? + If this is an edited volume, tick this box. This will ensure the + citation is adjusted to match. + +- Open Access? + If this monograph is Open Access, tick this box. This will + ensure the monograph is marked as open access and made available + on the website. + +- Date embargo + This will specify the date until which the title is embargoed. + +- Date published + This will specify the date of publication (this can be before + the upload date for example if the official publication date + precedes the date on which the digital edition was made + available). + +- Publisher name + This is a required field. + +- Publisher location + This is a required field. + +- Cover + +- DOI + DOIs for monographs and chapters cannot be minted directly + through Janeway, but if a DOI has been chosen, it can be added + here. To mint a DOI for a monograph or chapter after it has been + uploaded, you can do so through the [Crossref + website](https://apps.crossref.org/webDeposit/) + +- ISBN + +- Purchase URL + If this book has an option for physical purchase, this is where + this can be linked. It will show as an option next to the 'Read' + and 'Download' buttons on the book's page. + +- Remote URL + If this monograph is not hosted on Janeway but you would like it + linked on the website, this is where to provide the link. If the + monograph is hosted on Janeway (if you are uploading manuscript + files), there is no need for this. + +- Remote label + This will set the label for the link above. If not set, it will + display the domain name. + +- Licence information + Add copyright and/or licence information here. + +- Custom how-to-cite + To be used only if the citation block generated by Janeway is + not suitable. + +After the required fields above have been filled in and you have pressed +**Save book**, you can now move onto the following steps (displayed on the +right-hand side in Janeway): + +### Contributors + +All contributors to a volume can be entered here. If you are uploading +individual chapters in addition to the full manuscript, the respective +authors and/or contributors for these chapters will need to be entered +here. If they are not entered here, they can not be selected as +contributors when uploading individual chapters. + +![The page for adding new contributors and its fields.](../images/books-add-contributor.png) + +This page contains the following fields: + +- First name + This is a required field. + +- Middle name + +- Last name + This is a required field. + +- Affiliation + This is a required field. + +- Email + +- Sequence + This determines the order in which contributors are displayed + and will be auto-filled (but can be edited). This is a required + field. + +### Formats + +This is where manuscript files are uploaded. Various file types can be +used, such as PDF, EPUB and Mobi. + +![The page where manuscript files can be uploaded. Fields are described in the text below this image.](../images/books-add-format.png) + +This page contains the following fields: + +- Title + The title field is where you specify the format. This will be + displayed on the website as 'Download \[title\]' (see image + below). This field is case-sensitive, so you may wish to be + consistent with capitalisation. This is a required field. + +- Sequence + The sequence field will determine in what order the respective + **Read** and **Download** options will be displayed. This is useful + to ensure consistency in order of the options across books. + +When an .ePub is uploaded, Janeway will generate a **Read this book** +option on the book page. This allows users to read the book using an +online reader, without requiring a download. This can be disabled on +request. + +![The download, read, and buy buttons as they appear to users on the press website.](../images/books-web-buttons.png) + +Make sure that the filename of the file uploaded is consistent and +correct. Whilst Janeway will change the filename to the title +internally, depending on the application used to open the document after +download, the original filename might still be visible. Google Chrome is +an example of an application that might still display the original +filename in its reader toolbar, as displayed in the image below. + +![""](../images/books-final-manuscript.png) + +> [!NOTE] +> **Read this book** will always follow the ePub download option and **Buy +> this book** will always be the last one in the sequence. + +### Chapters + +![Chapter dashboard with various fields for entering metadata.](../images/books-add-chapter.png) + +If uploading individual chapters, this is where they are uploaded and +the metadata is entered. This might be of particular interest if the +book is an edited volume with multiple contributors; individual chapter +uploads with their respective metadata allow for higher discoverability. + +> [!NOTE] +> The chapter-level uploads are limited to one file, so only one file type +> can be used here. + +This page contains the following fields: + +- Title + This is a required field. + +- Description + This is a required field. + +- Pages + +- DOI + Janeway will not automatically generate a DOI for individual + chapters, these will need to be registered with Crossref + manually. This can be done through the [Crossref + website](https://apps.crossref.org/webDeposit/) + +- Number + This is where the chapter number is set; this can be zero for + prelims, appendices etc. + +- Date embargo + +- Date published + +- Sequence + This will determine in what order the chapters are displayed. + This field will autofill and chapters will appear in the order + they were added to Janeway, but this can be edited through this + field. This is a required field. + +- Contributors + This is where contributors to chapters can be selected, for them + to appear their details need to have been entered in the + **Contributors** fields through the **Book details** dashboard. + +- Licence information + +- Keywords + This is a list from which keywords can be selected. + +## Importing books + +You can import the metadata for multiple monographs into Janeway at once +using the **Import books** option. This is commonly used for migrations. + +Metadata can be imported using a .csv file encoded in UTF-8 [^1] with +certain headers. An example import with pre-prepared headers is coming soon. + +These headers are: + +| Field | Notes | Required? | +| ------------------ | -------------------------------------------------- | --------- | +| Prefix | | No | +| Title | | Yes | +| Subtitle | | No | +| Description | | No | +| Pages | | Yes [^2] | +| Edited volume | If this is an edited volume, set this field to '1' | No | +| Date published | | No | +| Publisher name | | No | +| Publisher location | | No | +| DOI | | No | +| ISBN | | No | +| Purchase URL | | No | + +Books import headers + +> [!WARNING] +> Due to a bug, UTF-8 does not seem to be properly recognised when specific browser-editor combinations are used. 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, 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 +the files themselves and to make any further edits. + +[^1]: Using a character encoding other than UTF-8 can cause bugs during imports or updates. See “[What is character encoding?](https://www.w3.org/International/questions/qa-what-is-encoding)” These apps save .csvs with UTF-8 by default: OpenRefine, LibreOffice, Google Sheets, and Apple Numbers. However! If you use Microsoft Excel, keep in mind some versions don't automatically create .csv files with UTF-8 character encoding. This may cause punctuation and special characters to be garbled on import. So, when saving, look for the '.csv (UTF-8)' option in the drop-down box. + +[^2]: Required due to a bug. + +## Reporting metrics for books + +Reporting for books does not run through the reporting plug-in, instead +it is done separately through the books plug-in. + +![The Books metrics page.](../images/books-metrics-dashboard.png) + +On this page, you can view the general access metrics for monographs, as +well as for each format of a monograph. On this page, date ranges can be +selected per day, rather than per month as in the 'Metrics by month' +page. The date range affects both the Book Metrics field and the Format +Metrics field. + +> [!NOTE] +> If a monograph is not available for open-access downloading/reading, no +> data will be collected and the metrics will remain at 0. + +### Books metrics + +The first section of this dashboard displays the total views and +downloads (each in their respective column) per book. The columns can be +sorted by ID, subtitle, first author name, date published, reads +and downloads. + +![""](../images/books-metrics.png) + +### Format metrics + +This section sorts the data by format, providing insights into how +specific formats are performing. This section can be sorted by format, +title, views and downloads. + +![""](../images/books-format-metrics.png) + +> [!NOTE] +> The total views and downloads in this report may differ slightly from +> the amounts listed in the monthly report discussed above. This is due to +> an issue with time zones and the cutoff points used for the calculation. diff --git a/content/pages/support/plugins/commission.md b/content/pages/support/plugins/commission.md new file mode 100644 index 00000000..2cee9d16 --- /dev/null +++ b/content/pages/support/plugins/commission.md @@ -0,0 +1,7 @@ +# Commissioning content + +Status: Active +[GitHub repository](https://github.com/openlibhums/commission) + +This plugin adds functionality for editors to commission articles. +To commission articles for a section, they first need to be set up through the journal [section manager](../article-management/article-sections.md). Only sections with public submissions enabled can be used for commmisioning. diff --git a/content/support/plugins/consortial-billing.md b/content/pages/support/plugins/consortial-billing.md similarity index 91% rename from content/support/plugins/consortial-billing.md rename to content/pages/support/plugins/consortial-billing.md index b465f6af..671a2443 100644 --- a/content/support/plugins/consortial-billing.md +++ b/content/pages/support/plugins/consortial-billing.md @@ -1,7 +1,6 @@ -title: Consortial billing plugin - # Consortial billing plugin +Status: Active [GitHub Repo](https://github.com/openlibhums/consortial_billing) This plugin is also known as the **Supporters plugin**. @@ -15,8 +14,8 @@ annual billing process. There are a few things to configure before the plugin can be used. -> [!Note] -> Developers can import a sample configuration. See the plugin’s README. +> [!NOTE] +> Developers can import a sample configuration. See the plugin's README. ### Currencies @@ -72,7 +71,7 @@ one country each. There also must be one default agent, which will be assigned to supporters in all countries not covered by a local billing agent. The redirect URL controls whether the user who fills out the signup form will -be redirected to the billing agent’s website to complete the process. +be redirected to the billing agent's website to complete the process. | Name | Country | Redirect URL | Default | | ------- | ------- | ------------------- | ------- | @@ -105,8 +104,8 @@ data model: - Support level - Billing setup -Let’s say there are 5 support levels, ranging from standard to platinum. -And let’s say there are 4 billing setups, including 1 default setup where +Let's say there are 5 support levels, ranging from standard to platinum. +And let's say there are 4 billing setups, including 1 default setup where you as publisher are the billing agent for most supporters in most countries, plus 3 other setups where an external billing agent is in charge of all the supporters in a particular country. @@ -125,5 +124,5 @@ For how the size affects the fee, see **Supporter sizes**. GNI per capita is another important variable that will come into play with fees calculated from base bands, especially with the default billing agent and countries around the world. In the example above, the default billing setup -is tied to Germany as a relatively stable base from which we can calculate fees +is tied to Germany as a relatively stable base from which fees can be calculated around the world. diff --git a/content/support/plugins/custom-styling-placeholder.md b/content/pages/support/plugins/custom-styling.md similarity index 73% rename from content/support/plugins/custom-styling-placeholder.md rename to content/pages/support/plugins/custom-styling.md index 7fcf3121..0644742e 100644 --- a/content/support/plugins/custom-styling-placeholder.md +++ b/content/pages/support/plugins/custom-styling.md @@ -1,10 +1,9 @@ -title: Custom styling - # Custom styling -A Janeway plugin that allows a staff member to add custom CSS directives to a journal or press site, giving the user control over the styling of each site. +Status: Active +[GitHub repository](https://github.com/openlibhums/customstyling) -[GitHub Repo](https://github.com/openlibhums/customstyling) +This is a Janeway plugin that allows a staff member to add custom CSS directives to a journal or press site, giving the user control over the styling of each site. ## CSS variables @@ -26,4 +25,4 @@ If your journal or press uses the OLH theme, you can quickly update the colour p } ``` -These variables do not work on the Material or Clean themes yet, though we have plans to add these or similar variables for those themes. +These variables do not work on the Material or Clean themes. diff --git a/content/support/plugins/datacite.md b/content/pages/support/plugins/datacite.md similarity index 98% rename from content/support/plugins/datacite.md rename to content/pages/support/plugins/datacite.md index ae56aabc..1273b18d 100644 --- a/content/support/plugins/datacite.md +++ b/content/pages/support/plugins/datacite.md @@ -1,8 +1,7 @@ -title: DataCite plugin - # DataCite plugin -[GitHub Repo](https://github.com/openlibhums/datacite) +Status: Active +[GitHub repository](https://github.com/openlibhums/datacite) The DataCite plugin is an alternative to Janeway's built-in Crossref support. It registers Digital Object Identifiers (DOIs) with [DataCite](https://datacite.org/) rather than Crossref, and it manages the deposit for you. DOIs are stored on the same identifier record as with Crossref DOIs, so the rest of Janeway treats a DataCite DOI the same way it treats any other DOI. diff --git a/content/support/plugins/discovery-overview-placeholder.md b/content/pages/support/plugins/discovery-overview.md similarity index 71% rename from content/support/plugins/discovery-overview-placeholder.md rename to content/pages/support/plugins/discovery-overview.md index 49ba6294..0812a750 100644 --- a/content/support/plugins/discovery-overview-placeholder.md +++ b/content/pages/support/plugins/discovery-overview.md @@ -1,13 +1,11 @@ -title: Discovery placeholder file. - -# Discovery placeholder file. +# Discovery overview - OAI-PMH - KBART - FTP -- DataCite (active) - Need to be its own page. - - [GitHub Repo](https://github.com/openlibhums/datacite) +- DataCite (active) + - [GitHub repository](https://github.com/openlibhums/datacite) - Allows staff to mint Datacite DOIs. - Works the same as CrossRef DOI. Username and poassword through API. - Different from CrossRef: creates a draft DOI at acceptance. Exists on the server but istn available publicly, allows you to check before publication. @@ -18,13 +16,13 @@ title: Discovery placeholder file. - This is a plugin for Janeway that allows exporting of journal and article metadata to DOAJ. - ScienceOpen (beta release) - - [GitHub Repo](https://github.com/openlibhums/so_transporter) + - [GitHub repository](https://github.com/openlibhums/so_transporter) - EBSCO (beta release) - An FTP plugin for depositing works with EBSCO. - - [GitHub Repo](https://github.com/openlibhums/ebsco_transporter) + - [GitHub repository](https://github.com/openlibhums/ebsco_transporter) -See also: FTP plugin. +See also: [FTP plugin](). ## EBSCO diff --git a/content/support/plugins/import-export-update.md b/content/pages/support/plugins/import-export-update.md similarity index 65% rename from content/support/plugins/import-export-update.md rename to content/pages/support/plugins/import-export-update.md index 70e766b7..7188d08d 100644 --- a/content/support/plugins/import-export-update.md +++ b/content/pages/support/plugins/import-export-update.md @@ -1,14 +1,12 @@ -title: Import, export, update - # Import, export, update -Note to SH: Update to clarify article level metadata only goes on the main author row. Update import example as well. + The Import / Export / Update tool lets you perform some batch actions in Janeway. You can import and export article metadata and files, and you can update some fields of existing articles. - +!["The Import, Export, Update start page<"](../images/import-export-update-start.png) ## Importing @@ -16,22 +14,22 @@ With this tool, you can create new articles in Janeway and load them directly into the desired workflow stage (peer review, copyediting, typesetting, or prepublication). -1. Download a copy of the [metadata template](../support/downloadables/metadata-template.csv) and open it up to edit it. +1. Download a copy of the [metadata template](../downloadables/metadata-template.csv) and open it up to edit it. You can use most spreadsheet applications, but make sure you will be able to save it as a CSV with UTF-8 character encoding.[^1] -2. Enter the metadata, one article per row. See the [Metadata Field - Reference](#metadata-field-reference) and the [sample - import](../support/downloadables/sample-import.csv) for pointers. For multi-author +2. Enter the metadata, one article per row. See the [Metadata field + reference](#metadata-field-reference) and the [sample + import](../downloadables/sample-import.csv) for pointers. For multi-author articles, insert a new row for each author, and only fill in the author fields on extra rows. 3. Save the file with a name of your choosing. -4. From the journal's dashboard, navigate to **All Articles** under +4. From the journal's dashboard, navigate to **All articles** under **Staff** in the lower left. You need to have 'staff' access to view - this page. (The tool also appears as **Article Import, Export, - Update** in the Imports plugin start page.) -5. Select **Upload Update** and upload your file. (It says 'update', + this page. (The tool also appears as **Article import, export, + update** in the Imports plugin start page.) +5. Select **Upload update** and upload your file. (It says 'update', but this is how you import new things too.) -6. A table should load in your browser showing you the data, before you +6. A table will load in your browser showing you the data, before you import it. If everything looks good, select **Import**. > [!TIP] @@ -51,18 +49,18 @@ typesetting, or prepublication). ## Exporting -You can export a CSV containing metadata for all the articles currently +You can export a CSV containing metadata for all the articles in a given workflow stage. It will also download selected files from that stage. -1. From the journal's dashboard, navigate to **All Articles** under +1. From the journal's dashboard, navigate to **All articles** under **Staff** in the lower left. You need to have 'staff' access to view this page. -2. Use the **Filter by Stage** drop-down menu to choose a set of +2. Use the **Filter by stage** drop-down menu to choose a set of articles you want to export. 3. If you want to download associated files, use the **Files** column to add files for each article. -4. Select **Export All** or **Export Filtered**. A ZIP file should be +4. Select **Export all** or **Export filtered**. A ZIP file will be downloaded containing the metadata in `article-data.csv` and the article files in subfolders numbered by article ID. @@ -74,7 +72,7 @@ have to click through each individual article to make the change. 1. To update one field, you have to provide data for all the fields, or at least most of them, because the tool interprets empty fields literally, and will save empty fields (potentially overwriting older - data). So we recommend you first export the set of articles, and use + data). So it is recommended to first export the set of articles, and use that as the basis for changes. See [Exporting](#exporting). > [!WARNING] @@ -84,18 +82,18 @@ have to click through each individual article to make the change. spreadsheet software of choice (but be careful with character encoding). 3. Edit the metadata as desired. You an rearrange the columns but the - column names have to stay exactly the same. See the [sample update](../support/downloadables/sample-update.csv), which shows changes made to the - data in [sample import](../support/downloadables/sample-import.csv). See also the - [Metadata Field Reference](#metadata-field-reference) for details on + column names have to stay exactly the same. See the [sample update](../downloadables/sample-update.csv), which shows changes made to the + data in [sample import](../downloadables/sample-import.csv). See also the + [Metadata field reference](#metadata-field-reference) for details on each field. 4. Save the CSV file with a name of your choosing. -5. On the **All Articles** page, select **Upload Update** and upload +5. On the **All articles** page, select **Upload update** and upload your CSV file. -6. A table should load in your browser showing you the data you +6. A table will load in your browser showing you the data you uploaded, so you can look it over before importing it. If everything looks good, select **Import**. -## Metadata Field Reference +## Metadata field reference The table below shows you what actions (i.e. import, export, update) you can perform with each field (yes/no). For example, you can't _import_ @@ -103,7 +101,7 @@ article IDs, because Janeway assigns them for you to make sure they're unique. But you can (must) use article IDs during the update process, so Janeway can recognize the articles. -Much the same, while you can put something in Stage to send the content +Much the same, while you can put something in **Stage** to send the content to the right part of Janeway on initial import, you can't subsequently _update_ the workflow stage for articles already in the system, because it might break editor or author tasks in progress. @@ -115,50 +113,52 @@ titles. You also have to provide article titles when you are updating articles, even if you're not updating the titles but something else, like the keywords. -| Field | Notes | Import | Export | Update | -| ------------------------- | ----------------------------------- | -------------- | ------ | ------------------------------------- | -| Janeway ID | controlled and assigned by Janeway | no, will break | yes | yes, required[^2] | -| Article title | incl. subtitle; use \ for ital | yes, required | yes | yes, required | -| Article abstract | use \ for italics | yes, optional | yes | yes, optional, saves empty values | -| Keywords | separate keywords with commas | yes, optional | yes | yes, optional, saves empty values | -| Rights | Rights statement (free text) | yes, optional | yes | yes, optional, saves empty values | -| Licence | name of licence[^3] | yes, optional | yes | yes, optional, saves empty values | -| Language | name of language or ISO code[^4] | yes, optional | yes | yes, optional, saves empty values | -| Peer reviewed (Y/N) | Y or N | yes, optional | yes | yes, optional, saves empty values | -| Author salutation | useful in templated emails | yes, optional | yes | no, ignored | -| Author given name | a.k.a. first name | yes, optional | yes | yes, optional, saves empty values | -| Author middle name | or middle initial | yes, optional | yes | yes, optional, saves empty values | -| Author surname | a.k.a. last name or family name | yes, optional | yes | yes, optional, saves empty values[^5] | -| Author suffix | e.g: 'Jr.' or 'III' | yes, optional | yes | yes, optional, saves empty values | -| Author email | recommended[^6] | yes, optional | yes | complicated![^7] | -| Author ORCID | starting with 'https' or the number | yes, optional | yes | yes, optional, saves empty values | -| Author institution | \_ | yes, optional | yes | yes, optional, saves empty values | -| Author department | \_ | yes, optional | yes | yes, optional, saves empty values | -| Author biography | \_ | yes, optional | yes | yes, optional, saves empty values | -| Author is primary (Y/N) | Y or N[^8] | yes, optional | yes | yes, optional, saves empty values | -| Author is corporate (Y/N) | i.e. an organization | yes, optional | yes | no, will make duplicates | -| DOI | starting with '10' | yes, optional | yes | yes, optional, ignores empty values | -| DOI (URL form) | starting with 'https' | no, ignored | yes | no, ignored | -| Date accepted | YYYY-MM-DD (or any ISO 8601[^9]) | yes, optional | yes | yes, optional, saves empty values | -| Date published | YYYY-MM-DD (or any ISO 8601) | yes, optional | yes | yes, optional, saves empty values | -| Article number | integer (arbitrary / custom) | yes, optional | yes | yes, optional, saves empty values | -| First page | integer | yes, optional | yes | yes, optional, saves empty values | -| Last page | integer | yes, optional | yes | yes, optional, saves empty values | -| Page numbers (custom) | Custom page range such as 'x–ix' | yes, optional | yes | yes, optional, saves empty values | -| Competing interests | \_ | yes, optional | yes | yes, optional, saves empty values | -| Article section | e.g. 'Article', 'Review' | yes, optional | yes | yes, optional, ignores empty values | -| Stage | the production workflow stage[^10] | yes, optional | yes | no, ignored[^11] | -| File import identifier | for advanced users[^12] | yes, optional | yes | yes, optional | -| Journal code | must match Janeway | yes, required | yes | yes, required | -| Journal title override | Override for this article[^13] | yes, optional | yes | yes, optional | -| ISSN override | '0000-0000' for new journals[^14] | yes, optional | yes | yes, optional | -| Volume number | '0' if not specified | yes, optional | yes | no, ignored | -| Issue number | '0' if not specified | yes, optional | yes | no, ignored | -| Issue title | e.g. 'Winter 2022' | yes, optional | yes | yes, optional, saves empty values | -| Issue pub date | YYYY-MM-DD (or any ISO 8601)[^15] | yes, optional | yes | yes, optional | -| PDF URI | A valid URI (advanced users) | yes, optional | no | yes, optional | - -## Custom Submission Fields +If an article has multiple authors, rows for additional authors after the first only contain author data - no article metadata. See the [sample import](../downloadables/sample-import.csv) for an example. + +| Field | Notes | Import | Export | Update | +| ------------------------- | ------------------------------------- | -------------- | ------ | ------------------------------------- | +| Janeway ID | controlled and assigned by Janeway | no, will break | yes | yes, required[^2] | +| Article title | incl. subtitle; use \ for ital | yes, required | yes | yes, required | +| Article abstract | use \ for italics | yes, optional | yes | yes, optional, saves empty values | +| Keywords | separate keywords with commas | yes, optional | yes | yes, optional, saves empty values | +| Rights | Rights statement (free text) | yes, optional | yes | yes, optional, saves empty values | +| Licence | name of licence[^3] | yes, optional | yes | yes, optional, saves empty values | +| Language | name of language or ISO code[^4] | yes, optional | yes | yes, optional, saves empty values | +| Peer reviewed (Y/N) | Y or N | yes, optional | yes | yes, optional, saves empty values | +| Author salutation | useful in templated emails | yes, optional | yes | no, ignored | +| Author given name | a.k.a. first name | yes, optional | yes | yes, optional, saves empty values | +| Author middle name | or middle initial | yes, optional | yes | yes, optional, saves empty values | +| Author surname | a.k.a. last name or family name | yes, optional | yes | yes, optional, saves empty values[^5] | +| Author suffix | e.g: 'Jr.' or 'III' | yes, optional | yes | yes, optional, saves empty values | +| Author email | recommended[^6] | yes, optional | yes | complicated![^7] | +| Author ORCID | starting with 'https' or the number | yes, optional | yes | yes, optional, saves empty values | +| Author institution | \_ | yes, optional | yes | yes, optional, saves empty values | +| Author department | \_ | yes, optional | yes | yes, optional, saves empty values | +| Author biography | \_ | yes, optional | yes | yes, optional, saves empty values | +| Author is primary (Y/N) | Y or N[^8] | yes, optional | yes | yes, optional, saves empty values | +| Author is corporate (Y/N) | i.e. if the author is an organization | yes, optional | yes | no, will make duplicates | +| DOI | starting with '10' | yes, optional | yes | yes, optional, ignores empty values | +| DOI (URL form) | starting with 'https' | no, ignored | yes | no, ignored | +| Date accepted | YYYY-MM-DD (or any ISO 8601[^9]) | yes, optional | yes | yes, optional, saves empty values | +| Date published | YYYY-MM-DD (or any ISO 8601) | yes, optional | yes | yes, optional, saves empty values | +| Article number | integer (arbitrary / custom) | yes, optional | yes | yes, optional, saves empty values | +| First page | integer | yes, optional | yes | yes, optional, saves empty values | +| Last page | integer | yes, optional | yes | yes, optional, saves empty values | +| Page numbers (custom) | Custom page range such as 'x–ix' | yes, optional | yes | yes, optional, saves empty values | +| Competing interests | \_ | yes, optional | yes | yes, optional, saves empty values | +| Article section | e.g. 'Article', 'Review' | yes, optional | yes | yes, optional, ignores empty values | +| Stage | the production workflow stage[^10] | yes, optional | yes | no, ignored[^11] | +| File import identifier | for advanced users[^12] | yes, optional | yes | yes, optional | +| Journal code | must match Janeway | yes, required | yes | yes, required | +| Journal title override | Override for this article[^13] | yes, optional | yes | yes, optional | +| ISSN override | '0000-0000' for new journals[^14] | yes, optional | yes | yes, optional | +| Volume number | '0' if not specified | yes, optional | yes | no, ignored | +| Issue number | '0' if not specified | yes, optional | yes | no, ignored | +| Issue title | e.g. 'Winter 2022' | yes, optional | yes | yes, optional, saves empty values | +| Issue pub date | YYYY-MM-DD (or any ISO 8601)[^15] | yes, optional | yes | yes, optional | +| PDF URI | A valid URI (advanced users) | yes, optional | no | yes, optional | + +## Custom submission fields If your journal has any additional submission fields available, this plugin will also allow you to export and update such fields. @@ -172,7 +172,7 @@ The header location is irrelevant, as long as the header matches the name of the field in Janeway exactly. [^1]: - The Janeway ID should only be populated when updating a record + The Janeway ID must only be populated when updating a record that already exists in Janeway. These IDs are allocated by the system and can not be set by the user. @@ -208,18 +208,17 @@ name of the field in Janeway exactly. and these won't work without email addresses. [^7]: - You should include existing email addresses in your CSV when + You must include existing email addresses in your CSV when you're trying to update other fields. You can also add or remove author records from an article with this tool. However, you - shouldn't use this tool to change an author's email address, because + must not use this tool to change an author's email address, because Janeway will think you're trying to add a new author and will create - a duplicate account with the new address. We will improve this - behaviour in the future. + a duplicate account with the new address. [^8]: 'Author is primary' tells Janeway which author is the - correspondence author. Generally, one and only one author should be - marked 'Y' and the rest 'N' or blank. If you leave this field blank + correspondence author. Only one author can be + marked 'Y', and the rest must be 'N' or blank. If you leave this field blank for all authors, the article won't have a correspondence author. [^9]: @@ -235,10 +234,8 @@ name of the field in Janeway exactly. is left blank, the article will be put in the `Unassigned` stage [^11]: - Currently the workflow stage cannot be changed en masse once the - articles are imported, since that might break tasks in progress. In - the future we want to make it possible to change the stage of - multiple articles. + The workflow stage cannot be changed en masse once the + articles are imported, since that might break tasks in progress. [^12]: You can import PDF galleys with this process using the PDF URI @@ -257,7 +254,7 @@ name of the field in Janeway exactly. [^14]: The ISSN override field works in the same way as the journal - title override, and it should only be used if you want to display a + title override, and it must only be used if you want to display a different ISSN for specific articles in special circumstances. [^15]: diff --git a/content/pages/support/plugins/imports-article-images.md b/content/pages/support/plugins/imports-article-images.md new file mode 100644 index 00000000..60c36f27 --- /dev/null +++ b/content/pages/support/plugins/imports-article-images.md @@ -0,0 +1,26 @@ +# Article images import + +The article images import tool allows you to supply an article +identifier and a URL for an image. Janeway will download the image and +set it as the articles large image file (also known as the hero image). + +> [!WARNING] +> You MUST ensure you have a licence/permission to download and use the image. It is recommended to use Unsplash (or similar services), where images are licensed similar to CC0. The URL must be directly to the image, not the landing page. On Unsplash you can get this by right-clicking on the **Download free** button and selecting **Copy link address**. + +1. Download the [article image import template](../downloadables/article-images-import-template.csv). +2. Fill in the details, you can add on article per line. +3. On the Imports Plugin main page select **Article images** and click + **Start import**. +4. Select your CSV and **Upload it**. +5. Click **Import** to complete the process. + +> [!TIP] +> Download the [article image import sample](../downloadables/article-images-import-sample.csv) CSV to see example data. + +## Metadata field reference + +| Field | Notes | +| --------------- | ---------------------------------------- | +| Identifier type | Must be either id, doi or pub-id | +| Identifier | The corresponding ID, DOI or Pub-ID | +| URL | A URL leading directly to an image file. | diff --git a/content/pages/support/plugins/imports-contacts.md b/content/pages/support/plugins/imports-contacts.md new file mode 100644 index 00000000..8b5af369 --- /dev/null +++ b/content/pages/support/plugins/imports-contacts.md @@ -0,0 +1,16 @@ +# Contact import + +The contact import tool allows you to create contacts by uploading a CSV (Comma-separated values) file. + +> [!WARNING] +> This importer is site-specific. You must access the import tool from the press or journal you want it import the contacts into. + +1. Download the [contact import template](../downloadables/contact-import-template.csv). +2. Enter your press or journal contact details, one per row. +3. On the Imports Plugin main page select **Contact import** and click + **Start import**. +4. Select your CSV and upload it. +5. Click **Import** to complete the process. + +> [!TIP] +> Download the [contact import sample](../downloadables/contact-import-sample.csv) CSV to see example data. diff --git a/content/support/plugins/imports-editor.md b/content/pages/support/plugins/imports-editor.md similarity index 66% rename from content/support/plugins/imports-editor.md rename to content/pages/support/plugins/imports-editor.md index e93fbe26..9bdf4924 100644 --- a/content/support/plugins/imports-editor.md +++ b/content/pages/support/plugins/imports-editor.md @@ -1,20 +1,18 @@ -title: Editors import - # Editors import The editor import tool allows you to create editor accounts by uploading -a CSV (Comma Seperated Value) file. +a CSV (Comma-separated values) file. > [!WARNING] -> This importer is site-specific. You should be accessing the import tool +> This importer is site-specific. You must access the import tool > from the press or journal you want it import the editors into. To import editor accounts: -1. Download the [editors import template](../support/downloadables/editor-import-template.csv). +1. Download the [editors import template](../downloadables/editor-import-template.csv). 2. Enter your editor's details, one per row. 3. On the Imports Plugin main page select **Editors Import** and click - **Start Import**. + **Start import**. 4. Select your CSV and, if you want you editors to receive a password reset notification check that option. 5. Click **Import** to complete the process. @@ -25,5 +23,5 @@ To import editor accounts: > spam. > [!TIP] -> Download the [editors import sample](../support/downloadables/editor-import-sample.csv) +> Download the [editors import sample](../downloadables/editor-import-sample.csv) > CSV to see example data. diff --git a/content/pages/support/plugins/imports-editorial-team.md b/content/pages/support/plugins/imports-editorial-team.md new file mode 100644 index 00000000..a58fba6e --- /dev/null +++ b/content/pages/support/plugins/imports-editorial-team.md @@ -0,0 +1,30 @@ +# Editorial team import + +The Editorial team import allows you to create your editorial team by +uploading a CSV (Comma Separated Value) file. + +> [!NOTE] +> If you include a user in your editorial team CSV that does not yet have +> an account one will be created for them. If an account already exists +> that account will be added as a group member. Accounts created during +> this import are not assigned any roles. + +To import your editorial team: + +1. Download the + [editorial team template](../downloadables/editor-import-template.csv). +2. Enter the details of your editorial team members, one per row. +3. The last field "group name" must match for all the members you + want to be in the same group eg. "Editor" or "Reviews editors". +4. On the Imports Plugin main page select **Editorial team import** and + click **Start import**. +5. Upload your file. +6. Click **Import** to complete the process. + +If you have enabled the editorial team page these groups and members +will be live. If not you can view them from the editorial team page on +the journal manager. + +> [!TIP] +> Download the [editorial team sample](../downloadables/editorial-team-sample.csv) +> CSV to see example data. diff --git a/content/support/plugins/imports-jats.md b/content/pages/support/plugins/imports-jats.md similarity index 79% rename from content/support/plugins/imports-jats.md rename to content/pages/support/plugins/imports-jats.md index 2a1eb21b..80cff019 100644 --- a/content/support/plugins/imports-jats.md +++ b/content/pages/support/plugins/imports-jats.md @@ -1,5 +1,3 @@ -title: JATS import - # JATS import The JATS import tool allows you to upload a single article as a JATS XML @@ -20,8 +18,8 @@ If you want to import multiple JATS files or a single JATS file with its figures you first need to prepare a zip (.zip) file. The top level directory can be called anything you like. Inside that -directory you should add you JATS XML files. Image files can be added -and should match the xlink:href of the figure or graphic. +directory you must add your JATS XML files. Image files can be added +and must match the xlink:href of the figure or graphic. - articles (top level directory) - article_1234.xml @@ -30,7 +28,7 @@ and should match the xlink:href of the figure or graphic. - article_9876_fig_1.jpg - article_9876_fig_2.jpg -If the href of the images includes a directory name you should include +If the href of the images includes a directory name you must include that directory: - articles/ (top level directory) @@ -45,5 +43,5 @@ Once you have prepared you zip file you can follow the instructions above and select the zip file in place of the JATS file. > [!TIP] -> Download the [JATS import sample](../support/downloadables/jats-import-sample.zip) CSV +> Download the [JATS import sample](../downloadables/jats-import-sample.zip) CSV > to see an example zip file. diff --git a/content/support/plugins/imports-peer-review.md b/content/pages/support/plugins/imports-peer-review.md similarity index 74% rename from content/support/plugins/imports-peer-review.md rename to content/pages/support/plugins/imports-peer-review.md index 62bf87d1..93c3bc03 100644 --- a/content/support/plugins/imports-peer-review.md +++ b/content/pages/support/plugins/imports-peer-review.md @@ -1,9 +1,7 @@ -title: Article review import - # Article review import The article review import tool allows you to create peer reviews by -uploading a CSV (Comma Seperated Value) file. +uploading a CSV (Comma-separated values) file. > [!WARNING] > This tool only allows the import of reviews as files, as such you may @@ -12,7 +10,7 @@ uploading a CSV (Comma Seperated Value) file. To import peer reviews: 1. Download the - [article review import template](../support/downloadables/reviewer-import-template.csv). + [article review import template](../downloadables/reviewer-import-template.csv). 2. Enter your peer review details, one per row. 3. On the Imports Plugin main page select **Reviewer Import** and click **Start Import**. @@ -24,13 +22,13 @@ To import peer reviews: | Field | Notes | | --------------------- | ---------------------------------------------------------- | -| Identifier Type | Should be either id, doi or pub-id | +| Identifier Type | Must be either id, doi or pub-id | | Identifier | The corresponding ID, DOI or Pub-ID | | Review recommendation | Either: accept, minor_revisions, major_revisions or reject | | Review filename | Path to a file on disk eg: /home/username/files/review.pdf | -| Date Fields | All date fields should be in ISO format YYYY-MM-DD | +| Date Fields | All date fields must be in ISO format YYYY-MM-DD | | Visibility | Either: open, blind or double-blind | > [!TIP] -> Download the [article review import sample](../support/downloadables/reviewer-import-sample.csv) +> Download the [article review import sample](../downloadables/reviewer-import-sample.csv) > CSV to see example data. diff --git a/content/pages/support/plugins/imports-plugin.md b/content/pages/support/plugins/imports-plugin.md new file mode 100644 index 00000000..7ab299b3 --- /dev/null +++ b/content/pages/support/plugins/imports-plugin.md @@ -0,0 +1,33 @@ +# Imports + +Status: Active +[GitHub repository](https://github.com/openlibhums/imports) + +> [!WARNING] +> Users in the European Union should ensure that the data they are +> importing is done so in line with the General Data Protection +> Regulation. + +The Imports plugin contains several toolsets for getting content into +and out of Janeway. The main one for publishers using Janeway is the +**Import / Export / Update** toolset. + +## Features + +- [Import, export, update](./import-export-update.md) + - Importing + - Exporting + - Updating + - Metadata field reference + - Custom submission fields +- [Editorial team import](./imports-editorial-team.md) +- [Reviewer import](./imports-reviewers.md) +- [Article review import](./imports-peer-review.md) + - Metadata field reference +- [Editors import](./imports-editor.md) +- [Contact import](./imports-contacts.md) +- [Copyright, submission, publication fees & reviewer guidelines import](./imports-submission-settings.md) +- [Article images import](./imports-article-images.md) + - Metadata field reference +- [JATS import](./imports-jats.md) +- [Wordpress import](./imports-wordpress.md) diff --git a/content/support/plugins/imports-reviewers.md b/content/pages/support/plugins/imports-reviewers.md similarity index 65% rename from content/support/plugins/imports-reviewers.md rename to content/pages/support/plugins/imports-reviewers.md index b1c99289..0eb158c1 100644 --- a/content/support/plugins/imports-reviewers.md +++ b/content/pages/support/plugins/imports-reviewers.md @@ -1,20 +1,18 @@ -title: Reviewer import - # Reviewer import The Reviewer import tool allows you to create reviewer accounts by -uploading a CSV (Comma Seperated Value) file. +uploading a CSV (Comma-separated values) file. > [!WARNING] -> This importer is site specific. You should be accessing the import tool +> This importer is site specific. You must access the import tool > from the press or journal you want it import the reviewers into. To import reviewer accounts: 1. Download the - [reviewer import template](../support/downloadables/reviewer-import-template.csv). + [reviewer import template](../downloadables/reviewer-import-template.csv). 2. Enter your reviewer details, one per row. -3. If you wish to add more than one interest you should separate them +3. If you wish to add more than one interest you must separate them with a semi colon eg. interest one; interest two; interest three. 4. On the Imports Plugin main page select **Reviewer Import** and click **Start Import**. @@ -28,5 +26,5 @@ To import reviewer accounts: > spam. > [!TIP] -> Download the [reviewer import sample](../support/downloadables/reviewer-import-sample.csv) CSV to see +> Download the [reviewer import sample](../downloadables/reviewer-import-sample.csv) CSV to see > example data. diff --git a/content/support/plugins/imports-submission-settings.md b/content/pages/support/plugins/imports-submission-settings.md similarity index 69% rename from content/support/plugins/imports-submission-settings.md rename to content/pages/support/plugins/imports-submission-settings.md index 7c8460db..d31f6cfa 100644 --- a/content/support/plugins/imports-submission-settings.md +++ b/content/pages/support/plugins/imports-submission-settings.md @@ -1,14 +1,12 @@ -title: Copyright, submission, publication fees & reviewer guidelines import - # Copyright, submission, publication fees & reviewer guidelines import This tool allows you to update some article submission specific settings -by uploading a CSV (Comma Seperated Value) file. +by uploading a CSV (Comma-separated values) file. > [!TIP] > You can import settings into multiple journals using this tool. -1. Download the [import template](downloadables/cspr-import-template.csv). +1. Download the [import template](../downloadables/cspr-import-template.csv). 2. Enter details, you can import settings for multiple journals, one on each line. Journal codes can be found on the press manager page. 3. On the Imports Plugin main page select **Copyright, Submission, @@ -18,5 +16,5 @@ by uploading a CSV (Comma Seperated Value) file. 5. Click **Import** to complete the process. > [!TIP] -> Download the [import sample](../support/downloadables/cspr-import-sample.csv) +> Download the [import sample](../downloadables/cspr-import-sample.csv) > CSV to see example data. diff --git a/content/pages/support/plugins/imports-wordpress.md b/content/pages/support/plugins/imports-wordpress.md new file mode 100644 index 00000000..efb81dc6 --- /dev/null +++ b/content/pages/support/plugins/imports-wordpress.md @@ -0,0 +1,13 @@ +# WordPress import + +This import tool allows you to import posts from a Wordpress site into a Janeway journal's news system. + +> [!WARNING] +> This importer is site specific. You should be accessing the import tool from the press or journal you want it import the posts into. + +To import Wordpress posts: + +1. Start the import process +2. Enter the base url, username and password for your Wordpress site +3. Select a user to be the owner of the news imports +4. Click the **Import** button. diff --git a/content/support/plugins/plugins-overview.md b/content/pages/support/plugins/index.md similarity index 91% rename from content/support/plugins/plugins-overview.md rename to content/pages/support/plugins/index.md index 8e4e1152..0017c3b5 100644 --- a/content/support/plugins/plugins-overview.md +++ b/content/pages/support/plugins/index.md @@ -1,5 +1,3 @@ -title: Plugins available on Janeway - # Plugins available on Janeway ## VAC (Voluntary Author Contributions) @@ -18,7 +16,7 @@ This plugin imports previously published content into Janeway without going thro ## BePress migration -This plugin imports content from [BePress] (https://bepress.com/) into Janeway. It is used for migrations between platforms. +This plugin imports content from [BePress](https://bepress.com/) into Janeway. It is used for migrations between platforms. ## Books / Multimedia @@ -112,6 +110,5 @@ This plugin imports content from [Open Journal Systems](https://openjournalsyste This plugin enables the Disqus discussion platform for journal. It is used to add a comment section feature. -NOTE: DisQus is not GDPR compliant. If you require GDPR compliancy, we recommend considering Hypothes.is instead. AS it is not GDPR - -DEV NOTE: This may be broken and need investigation. We may wish to offer Hypothes.is instead. DisQus may not be GDPR compliant -> internal comment system? It might be time to retire this plugin. +> [!NOTE] +> DisQus is not GDPR compliant. If you require GDPR compliancy, it is recommended to consider Hypothes.is instead. diff --git a/content/support/plugins/isolinear.md b/content/pages/support/plugins/isolinear.md similarity index 83% rename from content/support/plugins/isolinear.md rename to content/pages/support/plugins/isolinear.md index 1554cc23..03a0a559 100644 --- a/content/support/plugins/isolinear.md +++ b/content/pages/support/plugins/isolinear.md @@ -1,9 +1,10 @@ -title: Isolinear (preprints) - # Isolinear (preprints) +Status: Active +[GitHub repository](https://github.com/openlibhums/isolinear) + Isolinear is a plugin for Janeway that integrates the preprint workflow into the journal workflow. -See also: Repository Documentation +See also: [Repository documentation](../repository/index.md). ## How this plugin works diff --git a/content/pages/support/plugins/migrations-overview.md b/content/pages/support/plugins/migrations-overview.md new file mode 100644 index 00000000..248f5dbf --- /dev/null +++ b/content/pages/support/plugins/migrations-overview.md @@ -0,0 +1,26 @@ +# Migrations plugins + +- Wordpress (active) + - [GitHub repository](https://github.com/openlibhums/imports) + - This tool allows you to import posts from a Wordpress site into a Janeway journal's news system. See [WordPress imports](./imports-wordpress.md). +- JATS (active) + - [GitHub repository](https://github.com/openlibhums/imports) + - See [JATS import documentation](./imports-jats.md) +- OJS import (active) + - [GitHub repository](https://github.com/openlibhums/imports/tree/main/ojs) + - A Janeway plugin for importing OJS content. +- OJS export + - [GitHub repository](https://github.com/openlibhums/ojs-janeway) + - An OJS plugin for exporting data for ingest into Janeway, in a custom JSON format. +- ePrints (active) + - [GitHub repository](https://github.com/openlibhums/eprints) + - This is a plugin for importing ePrints articles into Janeway. +- BePress (active) + - [GitHub repository](https://github.com/openlibhums/bepress) + - This plugin allows you to import an export of a bepress Digital Commons publication into a Janeway instance. +- Ingenta (active) + - [GitHub repository](https://github.com/openlibhums/ingenta) + - This is a plugin for ingesting back content from the Ingenta platform into Janeway It requires an SGML dump from the publication to be migrated. +- Back content plugin (active) + - [GitHub repository](https://github.com/openlibhums/back_content) + - This plugin allows for fast loading of articles into Janeway. diff --git a/content/support/plugins/oaswitchboard.md b/content/pages/support/plugins/oaswitchboard.md similarity index 56% rename from content/support/plugins/oaswitchboard.md rename to content/pages/support/plugins/oaswitchboard.md index 5a1d3d4e..3b6da6ec 100644 --- a/content/support/plugins/oaswitchboard.md +++ b/content/pages/support/plugins/oaswitchboard.md @@ -1,5 +1,6 @@ -title: OA switchboard - # OA switchboard +Status: Active +[GitHub repository](https://github.com/openlibhums/oaswitchboard) + This is a plugin for Janeway that enables OA Switchboard p1-pio messages to be sent. diff --git a/content/support/plugins/pandoc-placeholder.md b/content/pages/support/plugins/pandoc.md similarity index 54% rename from content/support/plugins/pandoc-placeholder.md rename to content/pages/support/plugins/pandoc.md index adb1959f..132c5937 100644 --- a/content/support/plugins/pandoc-placeholder.md +++ b/content/pages/support/plugins/pandoc.md @@ -1,9 +1,12 @@ -title: Pandoc conversion - # Pandoc conversion +Status: Active +[GitHub Repo](https://github.com/openlibhums/pandoc_plugin) + 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. See pandoc's installation documentation **[here](https://pandoc.org/installing.html)**. +The pandoc user documentation can be found in the [workflow guides](../guides/editor-guide-to-typesetting-with-pandoc.md). -[GitHub Repo](https://github.com/openlibhums/pandoc_plugin) +It is recommended to use this together with the [file editor application](https://github.com/openlibhums/file_editor). + +You must have pandoc installed on your server to use this plugin. See [pandoc's installation documentation](https://pandoc.org/installing.html). diff --git a/content/support/plugins/production-transporter-placeholder.md b/content/pages/support/plugins/production-transporter.md similarity index 85% rename from content/support/plugins/production-transporter-placeholder.md rename to content/pages/support/plugins/production-transporter.md index b2317961..6a4b0862 100644 --- a/content/support/plugins/production-transporter-placeholder.md +++ b/content/pages/support/plugins/production-transporter.md @@ -1,5 +1,3 @@ -title: Production transporter - # Production transporter [GitHub Repo](https://github.com/openlibhums/production_transporter) diff --git a/content/support/press-management/press-doi-manager.md b/content/pages/support/press-management/doi-management-at-press-level.md similarity index 65% rename from content/support/press-management/press-doi-manager.md rename to content/pages/support/press-management/doi-management-at-press-level.md index 0909657d..35848581 100644 --- a/content/support/press-management/press-doi-manager.md +++ b/content/pages/support/press-management/doi-management-at-press-level.md @@ -1,6 +1,4 @@ -title: DOI management - press level - -# DOI management - press level +# DOI management at press level _Work in progress_ @@ -11,4 +9,4 @@ CrossRef settings can be set at press level (and then overridden at journal leve ## DOI manager -Manage DOIs across journals, same as journal level DOI manager, but now you can filter by journal and select appropriately. The same limits apply as on journal level. See DOI manager for more information on how to use the DOI manager. +Manage DOIs across journals, same as journal level DOI manager, but now you can filter by journal and select appropriately. The same limits apply as on journal level. See [DOI manager](../identifiers/index.md) for more information on how to use the DOI manager. diff --git a/content/pages/support/press-management/footer.md b/content/pages/support/press-management/footer.md new file mode 100644 index 00000000..af86ba20 --- /dev/null +++ b/content/pages/support/press-management/footer.md @@ -0,0 +1,9 @@ +# Journal footer + +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 a postal address and similar contact information by clicking **Edit press details** and then editing the **Journal footer text** setting. + +## Footer navigation + +You can also create footer navigation that extends to all journals. This feature is 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. diff --git a/content/pages/support/press-management/index.md b/content/pages/support/press-management/index.md new file mode 100644 index 00000000..d88f59de --- /dev/null +++ b/content/pages/support/press-management/index.md @@ -0,0 +1,16 @@ +# Press management + +_Coming soon_ + +The **Press manager** page brings together settings and tools that apply across every journal on your press. It's accessible to users with the **staff** role, and is where you configure press-wide details, users, and journal-level overrides. + +![The Press Manager page](../../images/press-manager.png) + +- [Journal management at press level](./journal-management-press-level.md) + An overview of the Press manager dashboard, including press-wide journal settings and overrides. +- [Managing users at press level](./managing-users-at-press-level.md) + How to view, filter and manage user roles and permissions across all journals from the **All users** interface, as well as merging duplicate accounts through the **Merge users** interface. +- [Journal footer](./footer.md) + Configuring the postal address, contact details and navigation links shown in every journal's footer. +- [DOI management – press level](./doi-management-at-press-level.md) + Managing Crossref DOI settings and the DOI Manager across journals from the press level. diff --git a/content/support/press-management/journal-management-press-level.md b/content/pages/support/press-management/journal-management-press-level.md similarity index 96% rename from content/support/press-management/journal-management-press-level.md rename to content/pages/support/press-management/journal-management-press-level.md index d4b5fa57..64fa2bc2 100644 --- a/content/support/press-management/journal-management-press-level.md +++ b/content/pages/support/press-management/journal-management-press-level.md @@ -1,5 +1,3 @@ -title: Journal management at press level - # Journal management at press level - Journal default settings diff --git a/content/support/press-management/all-users-placeholder.md b/content/pages/support/press-management/managing-users-at-press-level.md similarity index 85% rename from content/support/press-management/all-users-placeholder.md rename to content/pages/support/press-management/managing-users-at-press-level.md index 4894c60a..a2d12eae 100644 --- a/content/support/press-management/all-users-placeholder.md +++ b/content/pages/support/press-management/managing-users-at-press-level.md @@ -1,5 +1,3 @@ -title: Managing users at press level - # Managing users at press level From the **Press manager** you can manage users across all journals through the **All users** interface. @@ -7,18 +5,19 @@ You can filter users by whether they are active, are staff, their role(s), and t 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. + ## Merging users -If a user has multiple accounts (often the case after changing institutions and making a new account if the older email is no longer accessible), these can be merged at press level, as such only press managers can do this. +If a user has multiple accounts (often the case after changing institutions and making a new account if the older email is no longer accessible), these can be merged at press level, as such only press managers can do this. This can be done through the **Merge users** page. Merges from left into right. This **cannot** be undone. Merges everything - articles, review assignments etc. Does not affect frozen author records. The email address can still be changed after the merge. -> [!Caution] -> A user merge cannot be undone. Always double-check you have selected the right email addresses from both columns. If you have merged the wrong users, contact **Support** as soon as possible (though we cannot guarantee we can undo the merge). +> [!CAUTION] +> A user merge cannot be undone. Always double-check you have selected the right email addresses from both columns. If you have merged the wrong users, contact **Support** as soon as possible (though there is no guarantee the merge can be undone). 1. Search both columns -2. Select users. +2. Select users 3. Click **Merge** diff --git a/content/support/repository/repositories-index-placeholder.md b/content/pages/support/repository/index.md similarity index 74% rename from content/support/repository/repositories-index-placeholder.md rename to content/pages/support/repository/index.md index 13a459e5..d584e9ef 100644 --- a/content/support/repository/repositories-index-placeholder.md +++ b/content/pages/support/repository/index.md @@ -1,22 +1,20 @@ -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) +### [Setting up a repository](./setting-up-a-repository-with-janeway.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) +### [Repository settings](./repository-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. +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 licences, subjects, submission fields, and review recommendations. -### [Moderator guide](repositories-moderator.md) +### [Moderator guide](./moderator-guide.md) -How to manage published and unpublished preprints from the Repository Manager. Covers reviewing and accepting submissions, moderating new versions, and handling review comments. +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 @@ -28,6 +26,6 @@ _Content coming soon._ ## For authors -### [Submitting to a Janeway repository](repositories-submission.md) +### [Submitting to a Janeway repository](./submitting-to-a-janeway-repository.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 diff --git a/content/support/repository/repositories-moderator.md b/content/pages/support/repository/moderator-guide.md similarity index 97% rename from content/support/repository/repositories-moderator.md rename to content/pages/support/repository/moderator-guide.md index b47a9ea8..7ecd7265 100644 --- a/content/support/repository/repositories-moderator.md +++ b/content/pages/support/repository/moderator-guide.md @@ -1,5 +1,3 @@ -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. @@ -27,7 +25,7 @@ Click the title of a preprint to go to the preprint dashboard. Here, you can vie - 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. + Lets you send the preprint to a journal on the Janeway press. Select the licence, section (article type), and the stage to send it to. ## Unpublished preprints diff --git a/content/support/repository/repositories-settings.md b/content/pages/support/repository/repository-settings.md similarity index 67% rename from content/support/repository/repositories-settings.md rename to content/pages/support/repository/repository-settings.md index 1ab9d7f3..b4329afb 100644 --- a/content/support/repository/repositories-settings.md +++ b/content/pages/support/repository/repository-settings.md @@ -1,5 +1,3 @@ -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. @@ -18,28 +16,24 @@ The wizard has five steps: 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. 5. **Live** Sets the repository as live. -The section below will briefly outline the the other pages which lets you configure youre repository. For information on additional settings, including licenses, submission fields, and subjects, see Additional repository settings. +The section below will briefly outline the the other pages which lets you configure youre repository. For information on additional settings, including licences, submission fields, and subjects, see [Additional repository settings](). -## Licenses +## Licences -!["The repository licenses page."](../images/repositories/repo-licences.png) +!["The repository licences 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. +This page lets you choose which licences are made available for preprints in this repository. The available licences 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. +This page lets you set the subjects that preprints can fall into. ## Additional submission fields diff --git a/content/support/repository/repositories-setup-placeholder.md b/content/pages/support/repository/setting-up-a-repository-with-janeway.md similarity index 66% rename from content/support/repository/repositories-setup-placeholder.md rename to content/pages/support/repository/setting-up-a-repository-with-janeway.md index 39f9ce67..28ef0d7b 100644 --- a/content/support/repository/repositories-setup-placeholder.md +++ b/content/pages/support/repository/setting-up-a-repository-with-janeway.md @@ -1,5 +1,3 @@ -title: Setting up a repository with Janeway - # Setting up a repository with Janeway ## About Janeway repositories @@ -31,11 +29,19 @@ settings: 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 +There are also pages outlining how to configure and use [open peer review](./open-peer-review.md), [triple anonymous peer review](./triple-anonymous-peer-review.md), and [sharing peer reviews](./sharing-reviews.md). diff --git a/content/support/review/open-peer-review.md b/content/pages/support/review/open-peer-review.md similarity index 88% rename from content/support/review/open-peer-review.md rename to content/pages/support/review/open-peer-review.md index 0c4114d1..0181026d 100644 --- a/content/support/review/open-peer-review.md +++ b/content/pages/support/review/open-peer-review.md @@ -1,10 +1,8 @@ -title: Open peer review - # Open peer review This feature allows peer reviews to be made public. This requires both the consent of the reviewer and public display to be enabled by the editor. This feature is off by default. Peer reviews will remain confidential until you turn this on. -Open peer reviews that have been made public only show text that is typed into the peer review assignment box, and exclude comments made through uploaded files. This is for accessibility and display purposes. Accordingly, if you enable open peer review, we recommend encouraging reviewers to use the text box rather than commenting directly on a copy of the manuscript or uploading a file with their comments. +Open peer reviews that have been made public only show text that is typed into the peer review assignment box, and exclude comments made through uploaded files. This is for accessibility and display purposes. Accordingly, if you enable open peer review, it is recommended to encourage reviewers to use the text box rather than commenting directly on a copy of the manuscript or uploading a file with their comments. To enable open peer review, configure the settings found in **Review settings**. diff --git a/content/support/review/review-forms.md b/content/pages/support/review/review-forms.md similarity index 59% rename from content/support/review/review-forms.md rename to content/pages/support/review/review-forms.md index 49967adf..b40f3108 100644 --- a/content/support/review/review-forms.md +++ b/content/pages/support/review/review-forms.md @@ -1,5 +1,3 @@ -title: Review forms - # Review forms Review forms can be found in the manager dashboard, under **Review**: @@ -10,9 +8,9 @@ When a new journal is set up, Janeway automatically generates a default review f ## Deleting review forms -Existing forms can be deleted clicking **Delete**. If a form is set as the default review form, it cannot be deleted. Deleting forms will not affect current or past reviews using the form, but it will prevent users from selecting it for future reviews. +Existing forms can be deleted clicking **Delete**. If a form is set as the default review form, it cannot be deleted. Deleting forms will not affect current or past reviews using the form, but it will prevent users from selecting it for future reviews. -> [!Warning] +> [!WARNING] > Deleting a review form can't be undone. Only delete forms if you are certain you will not need them again. !["Deleting a review form."](../../support/images/review-forms-edit-delete.png) @@ -21,16 +19,16 @@ Existing forms can be deleted clicking **Edit**. You can then add various review form elements by clicking **Add element**. +You can add review questions to review forms by clicking **Edit**. You can then add various review form elements by clicking **Add element**. In addition to this, you can edit the form name, form introduction and thank you message. -Read more about creating custom forms and form elements here. +Read more about creating custom forms and form elements [here](../journal-management/form-elements.md). ## Preview review forms diff --git a/content/support/review/review-settings.md b/content/pages/support/review/review-settings.md similarity index 89% rename from content/support/review/review-settings.md rename to content/pages/support/review/review-settings.md index e027479e..089ab20e 100644 --- a/content/support/review/review-settings.md +++ b/content/pages/support/review/review-settings.md @@ -1,5 +1,3 @@ -title: Review settings - # Review settings Review settings can be found under **Review** on the manager dashboard. @@ -12,7 +10,7 @@ Review settings control how the peer review process operates. The settings found 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-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. + 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](../review/triple-anonymous-peer-review.md). - 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. @@ -24,7 +22,7 @@ Review settings control how the peer review process operates. The settings found 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](./open-peer-review.md) feature. - Default review form This setting controls the default review form displayed when assigning a reviewer. @@ -33,7 +31,7 @@ Review settings control how the peer review process operates. The settings found 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. It is recommended to only use 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. diff --git a/content/support/review/sharing-review.md b/content/pages/support/review/sharing-reviews.md similarity index 99% rename from content/support/review/sharing-review.md rename to content/pages/support/review/sharing-reviews.md index cb108174..22a04114 100644 --- a/content/support/review/sharing-review.md +++ b/content/pages/support/review/sharing-reviews.md @@ -1,5 +1,3 @@ -title: Sharing review - # Sharing reviews Completed peer reviews can be shared with authors and between reviewers, both within the same review round and between different review rounds. diff --git a/content/support/review/triple-anonymous-peer-review.md b/content/pages/support/review/triple-anonymous-peer-review.md similarity index 87% rename from content/support/review/triple-anonymous-peer-review.md rename to content/pages/support/review/triple-anonymous-peer-review.md index e1c8a593..9617cb8d 100644 --- a/content/support/review/triple-anonymous-peer-review.md +++ b/content/pages/support/review/triple-anonymous-peer-review.md @@ -1,5 +1,3 @@ -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 process is slightly more complex than other forms of anonymous review. @@ -11,12 +9,12 @@ Using triple anonymous review requires at least one member of the journal team t 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. + 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. - 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. + 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. !["All settings page with the Section editor personally identifiable information filter."](../../support/images/see-filter.png) !["All settings page with the reply-to address setting."](../../support/images/reply-to.png) @@ -31,7 +29,7 @@ To make triple anonymous peer review possible, the main journal editor must firs 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. -On Janeway, where a section editor would usually see the author’s personal details (name, email, or institution), those fields will now show as ‘[Anonymised data]’ for the duration of the review process. After the full process is completed, these fields will return to showing an author’s personal details. +On Janeway, where a section editor would usually see the author's personal details (name, email, or institution), those fields will now show as '[Anonymised data]' for the duration of the review process. After the full process is completed, these fields will return to showing an author's personal details. ## Areas with anonymisation diff --git a/content/support/submission/submission-webpage.md b/content/pages/support/submission/configuring-the-submission-page.md similarity index 88% rename from content/support/submission/submission-webpage.md rename to content/pages/support/submission/configuring-the-submission-page.md index fb9e0a82..afc164e5 100644 --- a/content/support/submission/submission-webpage.md +++ b/content/pages/support/submission/configuring-the-submission-page.md @@ -1,5 +1,3 @@ -title: Configuring the submission page - # Configuring the submission page ![" "](../../support/images/manager-submission-page-items.png) @@ -10,7 +8,7 @@ The option to configure the submission information page for authors can be found ## Crosslinked submission page items -Some aspects of the submission page can also be edited through **Submission settings** +Some aspects of the submission page can also be edited through [**Submission settings**](./submission-settings.md). The reason these can be accessed and edited from two places is that submission information is displayed in two places: on the submissions webpage and as part of the submission process. Changing the content in one location will automatically change it in the other, so you do not have to update each one individually. @@ -26,7 +24,7 @@ Here, you can see the same text as it appears in the submission process: If an edit was made to this copyright notice through the **Submission page items**, it would change on both pages. -In the **Submission page items list**, you can see all the areas that function like this. All of the options displayed as ‘Linked to’ can be edited through either **Submission page items** or **Submission settings**. +In the **Submission page items list**, you can see all the areas that function like this. All of the options displayed as 'Linked to' can be edited through either **Submission page items** or **Submission settings**. ![" "](../../support/images/submission-page-item-list.png) @@ -42,7 +40,7 @@ There are three types of custom submission page items you can create using this. ![" "](../../support/images/custom-submission-page-item.png) - **Special displays** - There are two types of special displays, Licences and Sections. These will display the license and article type (section) information for your journal. It will take the information supplied through the License manager and Sections (article types) . + There are two types of special displays, Licences and Sections. These will display the licence and article type (section) information for your journal. It will take the information supplied through the [Licence manager](./licence-manager.md) and [Sections (article types)](../article-management/article-sections.md). - **Setting-based displays** You can also set a title and select a setting to display. This will then display the text / information set as part of the setting - this will allow consistency and ensures text only needs to be updated in one place. If you wish to check the content of the setting, the best way to do so is: diff --git a/content/support/submission/submission-index.md b/content/pages/support/submission/index.md similarity index 72% rename from content/support/submission/submission-index.md rename to content/pages/support/submission/index.md index d646f921..47181c5e 100644 --- a/content/support/submission/submission-index.md +++ b/content/pages/support/submission/index.md @@ -1,21 +1,19 @@ -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 +- [The submission page items](./configuring-the-submission-page.md) This configures the text on the submission page, visible at `[yourjournalwebsite]/submissions`. -- Submission settings +- [Submission settings](./submission-settings.md) 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. +- [Submission fields configurator](./managing-submission-fields.md) + 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 licence, 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 +- [Additional submission fields](./managing-submission-fields.md#custom-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. +Other relevant settings you may configure related to submissions are the [**Licence manager**](./licence-manager.md), which configures the licences available for your journal, and [**Sections**](../article-management/article-sections.md), which sets the article types available for the journal and submissions. diff --git a/content/support/submission/article-licence-manager.md b/content/pages/support/submission/licence-manager.md similarity index 68% rename from content/support/submission/article-licence-manager.md rename to content/pages/support/submission/licence-manager.md index cf9aa64b..2ec525f8 100644 --- a/content/support/submission/article-licence-manager.md +++ b/content/pages/support/submission/licence-manager.md @@ -1,10 +1,8 @@ -title: Licence manager - # Licence manager -![" The manager dashboard with the License manager button highlighted."](../../support/images/manager-licence-manager.png) +![" The manager dashboard with the Licence manager button highlighted."](../../support/images/manager-licence-manager.png) -The licence manager allows you to define what licenses are available for submissions to your journal. By default, Janeway provides all CC 4.0 licences and an All Rights Reserved licence. You can edit the list to fit your journal's needs and licence requirements. +The licence manager allows you to define what licences are available for submissions to your journal. By default, Janeway provides all CC 4.0 licences and an All Rights Reserved licence. You can edit the list to fit your journal's needs and licence requirements. When people submit to your journal, they have to select a licence from this list. If you want to make more licences available to them, you need to provide the following information to add them: @@ -21,11 +19,11 @@ When people submit to your journal, they have to select a licence from this list The text of the licence, detailing the permissions and the restrictions associated with it. - **Order** - The order in which the licence should appear in the list. This can be set here through numerical ordering (e.g., “1” denotes that it should be first in the list) or changed via drag and dropping the licences on the **Current licences** list view. + The order in which the licence will appear in the list. This can be set here through numerical ordering (e.g., “1” denotes that it will be first in the list) or changed via drag and dropping the licences on the **Current licences** list view. - **Available for submission** If this box is checked, this licence can be selected when people submit to your journal. ![Licence manager](../../support/images/licence-manager.png) -If the journal uses only one licence type, you can disable the licence selection field using the **Submission configurator**. +If the journal uses only one licence type, you can disable the licence selection field using the [**Submission configurator**](./configuring-the-submission-page.md). diff --git a/content/pages/support/submission/managing-submission-fields.md b/content/pages/support/submission/managing-submission-fields.md new file mode 100644 index 00000000..d5cbeb22 --- /dev/null +++ b/content/pages/support/submission/managing-submission-fields.md @@ -0,0 +1,33 @@ +# Managing submission fields + +There are two parts to managing submission fields on Janeway: standard fields and custom fields. The standard fields are the preexisting submission fields on Janeway, whereas the custom ones are any you create. + +## Standard submission items + +![" "](../../support/images/manager-submission-fields-configurator.png) + +There are a set of default submission fields within Janeway, the **Submission fields configurator** allows you to configure which one of these will appear during the submission process. The fields you have checked will display, while any of those which are unchecked will not. The default submission fields include: + +- Publication fees +- Submission checklist +- Copyright notice +- Competing interests +- Comments to editor +- Abstract +- Language +- Licence +- Keywords +- Section +- Funding +- Figures and data files + +If you choose not to use the licence, language and section fields as a part of the submission process, it is recommended to set a default value for those. E.g. if you only accept submissions in English, you could remove the language selection from the submission process. If you do so, it is recommended you set English as the default language. If nothing is set, the language will be absent from the article metadata (or licence or article type, respectively). + +If you are using Janeway in languages other than English, you can also set the label for the submission file. This is what the 'main text' the author uploads will be labelled within the system. + +![" "](../../support/images/manuscript-label.png) + +## Custom submission fields + +Under the same header, you will also find **Additional submission fields**. This lets you add custom fields to the submission process. +See [form elements](../journal-management/form-elements.md) for more information about the types of fields you can create. diff --git a/content/support/submission/submission-notifications.md b/content/pages/support/submission/submission-notifications.md similarity index 92% rename from content/support/submission/submission-notifications.md rename to content/pages/support/submission/submission-notifications.md index 678d0eac..5fb7f553 100644 --- a/content/support/submission/submission-notifications.md +++ b/content/pages/support/submission/submission-notifications.md @@ -1,5 +1,3 @@ -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, as they will will receive no submission notifications if not manually assigned to relevant sections. @@ -12,7 +10,7 @@ Submission notifications are configured on the **Submission settings** page, und ### By section -To set up submission notifications per section (also referred to as article types), you must first set up the submission sections. See [page title] for more information on setting up sections. +To set up submission notifications per section (also referred to as article types), you must first set up the submission sections. See [page title] for more information on setting up [sections](../article-management/article-sections.md). On **Sections** click on the **Edit** button on the section for which you want to set up submission notifications. diff --git a/content/support/submission/submission-settings.md b/content/pages/support/submission/submission-settings.md similarity index 84% rename from content/support/submission/submission-settings.md rename to content/pages/support/submission/submission-settings.md index 7a97a859..5ec7ae99 100644 --- a/content/support/submission/submission-settings.md +++ b/content/pages/support/submission/submission-settings.md @@ -1,5 +1,3 @@ -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. @@ -8,21 +6,21 @@ The submission settings are accessed through the manager dashboard under **Submi **Submission settings** provides access to five blocks of settings: -- **Submission control** +- [**Submission control**](#submission-control) This block controls settings relating to whether submission is turned on or off. -- **Editors notified on submission** + +- [**Editors notified on submission**](#editors-notified-on-submission) This controls who is notified of new submissions. -- **System settings** + +- [**System settings**](#submission-settings) This controls a small set of settings related to authors and abstracts. -- **Submission page text** +- [**Submission page text**](#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** +- [**Submission files**](#submission-files) This controls settings around the manuscript files. - - ## Submission control The settings found here are: @@ -36,7 +34,7 @@ You can also limit access to submission by requiring users to create an account 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. + This sets the address to whom submission access requests will be sent. ## Editors notified on submission @@ -62,7 +60,7 @@ You can also limit access to submission by requiring users to create an account ## 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** . +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**](./configuring-the-submission-page.md). - **Submission page text** This sets the introductory text displayed at the head of the **Submission** page. @@ -71,13 +69,13 @@ These settings make up the **Submission** page as well as the **Submission agree - **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. + This is where you can provide the information on copyright, licences 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. + If there are any fees associated with submitting or publishing the paper, these can 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. + 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. diff --git a/content/pages/support2.html b/content/pages/support2.html new file mode 100644 index 00000000..6922ffa6 --- /dev/null +++ b/content/pages/support2.html @@ -0,0 +1,12 @@ +{% from "components/page_h1.html" import page_h1 %} +{% from "components/page_section.html" import page_section %} +{% from "components/page_section_group.html" import page_section_group %} + + + Support + + + +

Support

+
This is the support landing page. Layout TBC.
+ 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 deleted file mode 100644 index 23982a24..00000000 --- a/content/support/accounts-and-roles/accounts-and-roles-index-placeholder.md +++ /dev/null @@ -1,25 +0,0 @@ -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 - - - -## 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. - - diff --git a/content/support/accounts-and-roles/activating-accounts.md b/content/support/accounts-and-roles/activating-accounts.md deleted file mode 100644 index 5d68afdf..00000000 --- a/content/support/accounts-and-roles/activating-accounts.md +++ /dev/null @@ -1,57 +0,0 @@ -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. - - - -## 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. diff --git a/content/support/accounts-and-roles/orcid-login-placeholder.md b/content/support/accounts-and-roles/orcid-login-placeholder.md deleted file mode 100644 index 63451363..00000000 --- a/content/support/accounts-and-roles/orcid-login-placeholder.md +++ /dev/null @@ -1,24 +0,0 @@ -title: ORCID login - -# ORCID login - -_Coming soon_ - -Janeway supports ORCID login. - -- How to register -- How to login - - - - diff --git a/content/support/analytics/google-analytics-placeholder.md b/content/support/analytics/google-analytics-placeholder.md deleted file mode 100644 index a58822c9..00000000 --- a/content/support/analytics/google-analytics-placeholder.md +++ /dev/null @@ -1,20 +0,0 @@ -title: Google analytics - -# Google analytics - -_Coming soon_ - - diff --git a/content/support/analytics/janeway-statistics-and-index-placeholder.md b/content/support/analytics/janeway-statistics-and-index-placeholder.md deleted file mode 100644 index d2ebbb1b..00000000 --- a/content/support/analytics/janeway-statistics-and-index-placeholder.md +++ /dev/null @@ -1,36 +0,0 @@ -title: Janeway analytics - -# Janeway analytics - -_Coming soon_ - - diff --git a/content/support/article-management/article-management-landing-placeholder.md b/content/support/article-management/article-management-landing-placeholder.md deleted file mode 100644 index 7d618282..00000000 --- a/content/support/article-management/article-management-landing-placeholder.md +++ /dev/null @@ -1,19 +0,0 @@ -title: Article management - -# Article management - -There are various aspects to article management within Janeway and various interfaces to manage them from. This section contains documentation on the following: - -- Article galleys -- Article images -- Article metadata -- Article sections -- Managing archived and rejected articles - -Additionally, there's a page to manage the publication schedule: - -## Publication schedule - -Any articles that are currently set to publish on a future date will appear in a list on this page. It will list the title, section, DOI and scheduled publication date. - -![Article listed for publication in the future](/content/support/images//pub-schedule.png) diff --git a/content/support/article-management/image.png b/content/support/article-management/image.png deleted file mode 100644 index 498d2aaf..00000000 Binary files a/content/support/article-management/image.png and /dev/null differ diff --git a/content/support/article-management/publication-scheduling-placeholder.md b/content/support/article-management/publication-scheduling-placeholder.md deleted file mode 100644 index ce8c9c85..00000000 --- a/content/support/article-management/publication-scheduling-placeholder.md +++ /dev/null @@ -1,10 +0,0 @@ -title: Publication schedule - -# Publication schedule - -**WIP** -Any articles that you publish with a publication date in the future will appear in a list on this page. - - - - diff --git a/content/support/email-and-reminders/email-index-placeholder.md b/content/support/email-and-reminders/email-index-placeholder.md deleted file mode 100644 index b5259109..00000000 --- a/content/support/email-and-reminders/email-index-placeholder.md +++ /dev/null @@ -1,43 +0,0 @@ -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. diff --git a/content/support/email-and-reminders/email-settings-placeholder.md b/content/support/email-and-reminders/email-settings-placeholder.md deleted file mode 100644 index 0ad2ce83..00000000 --- a/content/support/email-and-reminders/email-settings-placeholder.md +++ /dev/null @@ -1,3 +0,0 @@ -title: Email settings - -# Email settings diff --git a/content/support/email-and-reminders/email-template-variables.md b/content/support/email-and-reminders/email-template-variables.md deleted file mode 100644 index 6e4c7397..00000000 --- a/content/support/email-and-reminders/email-template-variables.md +++ /dev/null @@ -1,217 +0,0 @@ -title: Email template variables - -# Email template variables - -Email template variables allow Janeway to automatically insert information into emails, such as article titles, reviewer names or due dates. - -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. - -This page explains: - -- What variables are. -- Which variables are available in common templates. -- How to use them safely. - -For general guidance on editing templates, see Email templates . - -## 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. -- review_assignment, a ReviewAssignment object. -- review_url, a reversed URL with FQDN. -- article_details, a string with article and review information in it, inc. Title, due date etc. - -## 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. - -KEY - -- Str is plain text. -- Int is a number. -- FK is Foreign Key, this means the attribute is a link to another - object. -- M2M is Many to Many, this means the attribute links to multiple other - objects of the given type. -- 121 is One to One, it means these two objects are linked. -- Bool is a Boolean value and will return True or False. -- DateTime is a field that stores a internationalised date and time. -- Email is a validated email address. - -### Account object reference - -The account object stores information about users. - -- email (Email, unique) -- username (Str) -- first_name (Str) -- middle_name (Str) -- last_name (Str) -- salutation (Str) -- biography (Str) -- orcid (Str) -- institution (Str) -- department (Str) -- twitter (Str) -- facebook (Str) -- linkedin (Str) -- website (Str) -- interest (M2M Interest) -- country (FK Country) -- preferred_timezone (Str, valid timezone) -- is_active (Bool) -- is_staff (Bool) -- date_joined (DateTime) - -### Article object reference - -The article object contains the following attributes: - -- journal (FK `Object Journal`) -- title (Str) -- abstract (Str) -- owner (FK `Object Account`) -- keywords (FK Keyword) -- language (Str) -- section (FK Section) -- license (FK License) -- publisher_notes (M2M PublisherNote) -- is_remote (Bool) -- remote_url (Str) -- authors (M2M Account) -- correspondence_author (FK `Object Account`) -- rights (Str) -- article_number (Int) - -### Journal object reference - -The journal object contains the following attributes: - -- code (Str) -- name (Str) -- current_issue (FK Issue) -- carousel (121 Carousel) -- thumbnail_image (FK File) -- press_image_override (FK File) -- default_cover_image (ImageField) -- default_large_image (ImageField) -- header_image (ImageField) -- favicon (ImageField) -- description (Str) -- contact_info (Str) -- Keywords (Keyword) -- is_conference (Bool) -- is_archived (Bool) -- is_remote (Bool) -- remote_view_url (URLField) -- remote_submit_url (URLField) -- hide_from_press (Bool) -- sequence (Int) -- disable_front_end (Bool) - -### ReviewAssignment object reference - -- article (FK `Object Article`) -- reviewer (FK `Object Account`) -- editor (FK `Object Account`) -- form (FK ReviewForm) -- review_round (FK ReviewRound) -- date_due (DateTime) -- date_requested (DateTime) -- date_accepted (DateTime) -- date_complete (DateTime) -- decision (Str) -- visibility (Bool) -- access_code (Str, UUID format, though not enforced) -- is_complete (Bool) -- for_author_consumption (Bool) -- comments_for_editor (Str) -- review_file (FK File) -- display_review_file (Bool) diff --git a/content/support/guides/janeway-guides.md b/content/support/guides/janeway-guides.md deleted file mode 100644 index e0eea347..00000000 --- a/content/support/guides/janeway-guides.md +++ /dev/null @@ -1,88 +0,0 @@ -title: Janeway guides - -# Janeway guides - -This is a landing page for guides available. -_Coming soon_ - - diff --git a/content/support/guides/navigating-janeway-placeholder.md b/content/support/guides/navigating-janeway-placeholder.md deleted file mode 100644 index f07d4549..00000000 --- a/content/support/guides/navigating-janeway-placeholder.md +++ /dev/null @@ -1,26 +0,0 @@ -title: Navigating Janeway - -# Navigating Janeway - -## Journal and press website - -The journal and / or press website (also called 'frontend') can be navigated through the navigation bar ('navbar') at the top of the website. In addition, the privacy policy, accessibility and similar items can also be linked in the footer. -To setup your navbar, see this section on customing the navbar - -To access Janeway, the dashboard and/or manager interface (back office): - -1. Log in to the press or journal. -2. Click on your name in the top-right corner. -3. Select **Dashboard** (or **Manager** if you have the appropriate permissions). - -## Navigating Janeway - -Also called the 'backoffice' - -Dashboard - -Manager interface - -## Admin area - -Ordered by the underlying database - cannot be changed. diff --git a/content/support/guides/workflow-editor-overview.md b/content/support/guides/workflow-editor-overview.md deleted file mode 100644 index 0a6bc13a..00000000 --- a/content/support/guides/workflow-editor-overview.md +++ /dev/null @@ -1,9 +0,0 @@ -title: Editor guide - overview - -# Editor guide - overview - -This page will provide editors with an overview of the workflow, the different parts of the guide (and maybe a flowchart). Probably also some direct links to common sections / some other relevant bits. - -The exact content of this will depend a bit on a) how we handle nav, b) some UX things I will need to ask Katherine. - -As such, this is a placeholder for now. But rest assured, it will exist as a 'landing page'. diff --git a/content/support/guides/workflow-proofreader-placeholder.md b/content/support/guides/workflow-proofreader-placeholder.md deleted file mode 100644 index b186db9c..00000000 --- a/content/support/guides/workflow-proofreader-placeholder.md +++ /dev/null @@ -1,92 +0,0 @@ -title: Proofreader guide - -# Proofreader guide - - - -As a proofreader you may be assigned proofing tasks for a paper. When a -new assignment is made you will receive and email and be able to see the -requests from the journal dashboard. The list of potential proofreaders -for a paper is made up of: - -- Authors of the paper -- Editors -- Users with the Proofreader role - -From the dashboard you will be able to see a list of New, In Progress -and Completed proofing requests. Once you have accepted a new task you -can use the View button to begin proofing. - -
- -
A proofing task that has been accepted
-
- -
- -
- -Tip - -
- -Hover over the initials/pictures to see the names and roles of those -involved in the paper. PM means Proofing Manager - -
- -## Proofing task - -The proofing task page is broken down into three sections - -- Task Definition -- Galleys -- File Upload - -
- -
A proofing task that has been accepted
-
- -### Task definition - -The task definition is a note written by the Proofing Manager when they -create the proofing task. - -### Galleys - -This section lists the galleys that the proofing manager has assigned -you. Common galley types are: - -- PDF -- HTML -- XML - -For HTML and XML galleys Janeway has a **Preview** button that will render -the galley into a viewable block so you don't need to understand the -underlying markup to proof them. - -Each of the galleys has an accordian-type drop-down so if you click on -its name you will see a new section appear with more information. - -
- -
An XML galley expanded
-
- -You now have the option to **Download** or **View** the galley, this will open -in a new tab in your browser. You can then use the notes box to write -notes on the galley file. - -> [!TIP] -> You can write as many notes as you like, press **Save Note** to create a new -> one and the box will reset. - -In addition, you can download and annotate the galley documents and then -upload them again if you require. - -When you have proofed _all_ of the galley files you can mark the task as -complete, it will be moved to the completed task list. diff --git a/content/support/identifiers/datacite-dois-placeholder.md b/content/support/identifiers/datacite-dois-placeholder.md deleted file mode 100644 index 0f480d8f..00000000 --- a/content/support/identifiers/datacite-dois-placeholder.md +++ /dev/null @@ -1,5 +0,0 @@ -title: DataCite DOIs - -# DataCite DOIs - - diff --git a/content/support/images/merge-users.gif b/content/support/images/merge-users.gif deleted file mode 100644 index 21677c32..00000000 Binary files a/content/support/images/merge-users.gif and /dev/null differ diff --git a/content/support/images/news-manager.png b/content/support/images/news-manager.png deleted file mode 100644 index a92016e0..00000000 Binary files a/content/support/images/news-manager.png and /dev/null differ diff --git a/content/support/issues-volumes-and-collections/iss-vol-coll-index.md b/content/support/issues-volumes-and-collections/iss-vol-coll-index.md deleted file mode 100644 index 64244d47..00000000 --- a/content/support/issues-volumes-and-collections/iss-vol-coll-index.md +++ /dev/null @@ -1,3 +0,0 @@ -title: Issues, volumes and collections on Janeway - -# Issues, volumes and collections on Janeway diff --git a/content/support/issues-volumes-and-collections/organising-publications-placeholder.md b/content/support/issues-volumes-and-collections/organising-publications-placeholder.md deleted file mode 100644 index 475037bc..00000000 --- a/content/support/issues-volumes-and-collections/organising-publications-placeholder.md +++ /dev/null @@ -1,25 +0,0 @@ -title: Organising publications - -# Organising publications - - diff --git a/content/support/journal-management/rich-text.md b/content/support/journal-management/rich-text.md deleted file mode 100644 index 133dea22..00000000 --- a/content/support/journal-management/rich-text.md +++ /dev/null @@ -1,11 +0,0 @@ -title: Managing rich text fields - -# Managing rich text fields - -- Something about us using TinyMCE -- Explaining what it currently does and doesn't preserve -- Do we want to outline common issues? - -Many people copy and paste from a word processor into Janeway when working on webpages, news items, and other fields such as abstracts. When a user attempts to paste text that carries over styling from another application, Janeway will prompt the user to ask if they want to retain the formatting or paste it as plain text. - -Additionally, Janeway removes any potentially harmful markup being pasted in or typed using the code view across rich-text fields, such as scripts that could lead to [Cross Site Scripting](https://owasp.org/www-community/attacks/xss/) attacks. diff --git a/content/support/plugins/adverts.md b/content/support/plugins/adverts.md deleted file mode 100644 index 4c5c6058..00000000 --- a/content/support/plugins/adverts.md +++ /dev/null @@ -1,11 +0,0 @@ -title: Adverts on Janeway - -# 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, contact Support. - -Recommended image dimensions : - -[GitHub adverts plugin repository](https://github.com/openlibhums/adverts) diff --git a/content/support/plugins/annotator-plugins-placeholder.md b/content/support/plugins/annotator-plugins-placeholder.md deleted file mode 100644 index 2bc73a55..00000000 --- a/content/support/plugins/annotator-plugins-placeholder.md +++ /dev/null @@ -1,12 +0,0 @@ -title: Annotators overview - -# Annotator overview - -- Hypothesis - [GitHub Repo](https://github.com/openlibhums/annotators) -- Disqus (inactive) - [GitHub Repo](https://github.com/openlibhums/disqus) -- I swear there was more? Check with Dev - -We no longer recommend the use of Disqus due to GDPR. - -> [!NOTE] -> Janeway no longer supports Annotran. diff --git a/content/support/plugins/books.md b/content/support/plugins/books.md deleted file mode 100644 index a294e492..00000000 --- a/content/support/plugins/books.md +++ /dev/null @@ -1,385 +0,0 @@ -title: Books plugin - -# Books plugin - -[GitHub Repo](https://github.com/openlibhums/books) - -Through this plugin, all book-related tasks and metadata are managed. -This plugin has three key functionalities: - -- Adding new books through either individual uploads or a bulk import. -- Metrics for reporting (overall or monthly) -- Categories - this can be used for imprints, series or other types of - categorisation you may wish to use for published materials. - -## Main dashboard - - - -From the books dashboard, you can manage all tasks and data related to -monographs (or similar items). It also provides an overview of all items -published through this plug-in and the following information for all of -them (they can also be sorted by any of these): - -- ID -- Title -- Subtitle -- First Author -- ISBN -- DOI -- Date Published -- Reads -- Downloads - - - -The bar on top represents access to the key functions of the books plugin: - -- Metrics by Month -- (General) Metrics -- Import Books -- Categories -- Add New Book - -## Categories - -This is where categories can be created that books can be assigned to;such as imprints, collections or even record labels. - -All current categories are displayed on the right-hand side, with a link -to the live website where you can view all monographs currently present -in a category. - -Whilst books can be assigned to a category at any moment, it is -necessary to create the category before a book can be assigned. -Categories cannot be created through the ‘Add a new book’ interface. - - - -When adding a new category, the following fields are available: - -- Name - - This is a required field. - -- Description - -- Display title - - Leave this unchecked if you want to hide the category title. - -- Chapter name - - This is where the ‘Chapter’ label can be edited, in case the - individual components of publications assigned to this category - are not chapters. This is a required field. - -- Chapter name plural - - This is where the plural for the ‘Chapter’ label can be edited - to ensure the label is pluralised correctly. This is a required - field. - -- Buy button text - - This defaults to “Buy this Book”. If the item is not a book, you - will need to update this field. This is a required field. - - - -> [!NOTE] -> This field is case-sensitive. If you do not wish for these words to be -> capitalised by default (and thus mid-sentence), you need to enter them -> in lowercase. See the image above for an example of how this label -> displays when it is capitalised. Janeway will automatically capitalise -> the words when they appear at the start of a sentence. - -## Adding a new book - -New monographs are added through the ‘Add new book’ option, which is -positioned rightmost in the topbar of the main dashboard. - - - -Before the manuscript files can be uploaded, various metadata fields -need to be completed first, displayed on the left-hand side of the page -under ‘Book details’. - - - -This section contains the following fields: - -- Prefix - -- Title - - This is a required field. - -- Subtitle - -- Category - - This is where a publication can be assigned to an imprint, if - applicable. - -- Description - - The book’s description can be provided here. - -- Pages - - This is the total number of pages. - -- Edited volume? - - If this is an edited volume, tick this box. This will ensure the - citation is adjusted to match. - -- Open Access? - - If this monograph is Open Access, tick this box. This will - ensure the monograph is marked as open access and made available - on the website. - -- Date embargo - - This will specify the date until which the title is embargoed. - -- Date published - - This will specify the date of publication (this can be before - the upload date for example if the official publication date - precedes the date on which the digital edition was made - available). - -- Publisher name - - This is a required field. - -- Publisher location - - This is a required field. - -- Cover - -- DOI - - DOIs for monographs and chapters cannot be minted directly - through Janeway, but if a DOI has been chosen, it can be added - here. To mint a DOI for a monograph or chapter after it has been - uploaded, you can do so through the [Crossref - website](https://apps.crossref.org/webDeposit/) - -- ISBN - -- Purchase URL - - If this book has an option for physical purchase, this is where - this can be linked. It will show as an option next to the ‘Read’ - and ‘Download’ buttons on the book’s page. - -- Remote URL - - If this monograph is not hosted on Janeway but you would like it - linked on the website, this is where to provide the link. If the - monograph is hosted on Janeway (if you are uploading manuscript - files), there is no need for this. - -- Remote label - - This will set the label for the link above. If not set, it will - display the domain name. - -- Licence information - - Add copyright and/or licence information here. - -- Custom how-to-cite - - To be used only if the citation block generated by Janeway is - not suitable. - -After the required fields above have been filled in and you have pressed -‘Save Book’, you can now move onto the following steps (displayed on the -right-hand side in Janeway): - -### Contributors - -All contributors to a volume can be entered here. If you are uploading -individual chapters in addition to the full manuscript, the respective -authors and/or contributors for these chapters will need to be entered -here. If they are not entered here, they can not be selected as -contributors when uploading individual chapters. - - - -This page contains the following fields: - -- First name - - This is a required field. - -- Middle name - -- Last name - - This is a required field. - -- Affiliation - - This is a required field. - -- Email - -- Sequence - - This determines the order in which contributors are displayed - and will be auto-filled (but can be edited). This is a required - field. - -### Formats - -This is where manuscript files are uploaded. Various file types can be -used, such as PDF, EPUB and Mobi. - - - -This page contains the following fields: - -- Title - - The title field is where you specify the format. This will be - displayed on the website as ‘Download \[title\]’ (see image - below). This field is case-sensitive, so you may wish to be - consistent with capitalisation. This is a required field. - -- Sequence - - The sequence field will determine in what order the respective - ‘Read’ and ‘Download’ options will be displayed. This is useful - to ensure consistency in order of the options across books. - -When an .ePub is uploaded, Janeway will generate a ‘Read this book’ -option on the book page. This allows users to read the book using an -online reader, without requiring a download. This can be disabled on -request. - - - -Make sure that the filename of the file uploaded is consistent and -correct. Whilst Janeway will change the filename to the title -internally, depending on the application used to open the document after -download, the original filename might still be visible. Google Chrome is -an example of an application that might still display the original -filename in its reader toolbar, as displayed in the image below. - - - -> [!Note] -> ‘Read this book’ will always follow the ePub download option and ‘Buy -> this book’ will always be the last one in the sequence. - -### Chapters - - - -If uploading individual chapters, this is where they are uploaded and -the metadata is entered. This might be of particular interest if the -book is an edited volume with multiple contributors; individual chapter -uploads with their respective metadata allow for higher discoverability. - -> [!Note] -> The chapter-level uploads are limited to one file, so only one file type -> can be used here. - -This page contains the following fields: - -- Title - - This is a required field. - -- Description - - This is a required field. - -- Pages - -- DOI - - Janeway will not automatically generate a DOI for individual - chapters, these will need to be registered with Crossref - manually. This can be done through the [Crossref - website](https://apps.crossref.org/webDeposit/) - -- Number - - This is where the chapter number is set; this can be zero for - prelims, appendices etc. - -- Date embargo - -- Date published - -- Sequence - - This will determine in what order the chapters are displayed. - This field will autofill and chapters will appear in the order - they were added to Janeway, but this can be edited through this - field. This is a required field. - -- Contributors - - This is where contributors to chapters can be selected, for them - to appear their details need to have been entered in the - ‘Contributors’ fields through the Book Details dashboard. - -- Licence information - -- Keywords - - This is currently a list from which keywords can be selected. - This will be updated in the future. - -## Importing books - -You can import the metadata for multiple monographs into Janeway at once -using the ‘import books’ option. This is commonly used for migrations. - -Metadata can be imported using a .csv file encoded in UTF-8 [^1] with -certain headers. An example import with pre-prepared headers is coming soon. - -These headers are: - -| Field | Notes | Required? | -| ------------------ | -------------------------------------------------- | --------- | -| Prefix | | No | -| Title | | Yes | -| Subtitle | | No | -| Description | | No | -| Pages | | Yes [^2] | -| Edited volume | If this is an edited volume, set this field to '1' | No | -| Date published | | No | -| Publisher name | | No | -| Publisher location | | No | -| DOI | | No | -| ISBN | | No | -| Purchase URL | | No | - -Books import headers - -> [!Warning] -> Due to a bug, UTF-8 does not seem to be properly recognised when 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, 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 -the files themselves and to make any further edits. - -[^1]: Using a character encoding other than UTF-8 can cause bugs during imports or updates. See “[What is character encoding?](https://www.w3.org/International/questions/qa-what-is-encoding)” These apps save .csvs with UTF-8 by default: OpenRefine, LibreOffice, Google Sheets, and Apple Numbers. However! If you use Microsoft Excel, keep in mind some versions don’t automatically create .csv files with UTF-8 character encoding. This may cause punctuation and special characters to be garbled on import. So, when saving, look for the ‘.csv (UTF-8)’ option in the drop-down box. - -[^2]: Required due to a bug - we aim to fix this in the near future. - -## Reporting metrics for books - -Reporting for books does not run through the reporting plug-in, instead -it is done separately through the books plug-in. - - - -On this page, you can view the general access metrics for monographs, as -well as for each format of a monograph. On this page, date ranges can be -selected per day, rather than per month as in the ‘Metrics by month’ -page. The date range affects both the Book Metrics field and the Format -Metrics field. - -> [!Note] -> If a monograph is not available for open-access downloading/reading, no -> data will be collected and the metrics will remain at 0. - -### Books metrics - -The first section of this dashboard displays the total views and -downloads (each in their respective column) per book. The columns can be -sorted by ID,, Subtitle, First Author name, Date published, Reads -and Downloads. - - - -### Format Metrics - -This section sorts the data by format, providing insights into how -specific formats are performing. This section can be sorted by Format, -Title, Views and Downloads. - -![""](images/books-format-metrics.png) - -> [!Note] -> The total views and downloads in this report may differ slightly from -> the amounts listed in the monthly report discussed above. This is due to -> an issue with time zones and the cutoff points used for the calculation. diff --git a/content/support/plugins/commission-placeholder.md b/content/support/plugins/commission-placeholder.md deleted file mode 100644 index 4f937aa9..00000000 --- a/content/support/plugins/commission-placeholder.md +++ /dev/null @@ -1,7 +0,0 @@ -title: Commissioning content - -# Commissioning content - -Adds functionality for editors to commission articles. - -[GitHub Repo](https://github.com/openlibhums/commission) diff --git a/content/support/plugins/imports-article-images.md b/content/support/plugins/imports-article-images.md deleted file mode 100644 index 9dc18793..00000000 --- a/content/support/plugins/imports-article-images.md +++ /dev/null @@ -1,28 +0,0 @@ -title: Article images import - -# Article images import - -The article images import tool allows you to supply an article -identifier and a URL for an image. Janeway will download the image and -set it as the articles large image file (also known as the hero image). - -> [!WARNING] -> You MUST ensure you have a license/permission to download and use the image. We recommend Unsplash, where Images are licensed similar to CC0. The URL **MUST** be directly to the image, not the landing page. On Unsplash you can get this by right-clicking on the "Download free" button and selecting "Copy link address". - -1. Download the [article image import template](../support/downloadables/article-images-import-template.csv). -2. Fill in the details, you can add on article per line. -3. On the Imports Plugin main page select **Article Images** and click - **Start Import**. -4. Select your CSV and **Upload it**. -5. Click **Import** to complete the process. - -> [!TIP] -> Download the [article image import sample](../support/downloadables/article-images-import-sample.csv) CSV to see example data. - -## Metadata field reference - -| Field | Notes | -| --------------- | ---------------------------------------- | -| Identifier Type | Should be either id, doi or pub-id | -| Identifier | The corresponding ID, DOI or Pub-ID | -| URL | A URL leading directly to an image file. | diff --git a/content/support/plugins/imports-contacts.md b/content/support/plugins/imports-contacts.md deleted file mode 100644 index 9a2d9466..00000000 --- a/content/support/plugins/imports-contacts.md +++ /dev/null @@ -1,18 +0,0 @@ -title: Contact import - -# Contact import - -The contact import tool allows you to create contacts by uploading a CSV (Comma Seperated Value) file. - -> [!WARNING] -> This importer is site-specific. You should be accessing the import tool from the press or journal you want it import the contacts into. - -1. Download the [contact import template](../support/downloadables/contact-import-template.csv). -2. Enter your press or journal contact details, one per row. -3. On the Imports Plugin main page select **Contact Import** and click - **Start Import**. -4. Select your CSV and **Upload it**. -5. Click **Import** to complete the process. - -> [!TIP] -> Download the [contact import sample](../support/downloadables/contact-import-sample.csv) CSV to see example data. diff --git a/content/support/plugins/imports-editorial-team.md b/content/support/plugins/imports-editorial-team.md deleted file mode 100644 index afa7c3ad..00000000 --- a/content/support/plugins/imports-editorial-team.md +++ /dev/null @@ -1,32 +0,0 @@ -title: Editorial team import - -# Editorial team import - -The Editorial Team Import allows you to create your editorial team by -uploading a CSV (Comma Separated Value) file. - -> [!NOTE] -> If you include a user in your editorial team CSV that does not yet have -> an account one will be created for them. If an account already exists -> that account will be added as a group member. Accounts created during -> this import are not assigned any roles. - -To import your editorial team: - -1. Download the - [editorial team template](../support/downloadables/editor-import-template.csv). -2. Enter the details of your editorial team members, one per row. -3. The last field "group name" should match for all the members you - want to be in the same group eg. "Editor" or "Reviews Editors". -4. On the Imports Plugin main page select **Editorial Team Import** and - click **Start Import**. -5. Upload your file. -6. Click **Import** to complete the process. - -If you have enabled the Editorial Team page these groups and members -will be live. If not you can view them from the Editorial Team page on -the Journal Manager. - -> [!TIP] -> Download the [editorial team sample](../support/downloadables/editorial-team-sample.csv) -> CSV to see example data. diff --git a/content/support/plugins/imports-plugin.md b/content/support/plugins/imports-plugin.md deleted file mode 100644 index 6c6be31d..00000000 --- a/content/support/plugins/imports-plugin.md +++ /dev/null @@ -1,34 +0,0 @@ -title: Imports - -# Imports - -[GitHub Repo](https://github.com/openlibhums/imports) - -> [!WARNING] -> Users in the European Union should ensure that the data they are -> importing is done so in line with the General Data Protection -> Regulation. - -The Imports Plugin contains several toolsets for getting content into -and out of Janeway. The main one for publishers using Janeway is the -**Import / Export / Update** toolset. - -## Features - -- [Import, Export, Update](import-export-update) - - Importing - - Exporting - - Updating - - Metadata Field Reference - - Custom Submission Fields -- [Editorial Team Import](editorial-team-import) -- [Reviewer Import](reviewer-import) -- [Article Review Import](peer-review-import) - - Metadata Field Reference -- [Editors Import](editor-import) -- [Contact Import](contact-import) -- [Copyright, Submission, Publication Fees & Reviewer Guidelines Import](copyright-submission-publication-reviewer) -- [Article Images Import](article-images) - - Metadata Field Reference -- [JATS Import](jats-import) -- [Wordpress Import](wordpress) diff --git a/content/support/plugins/migrations-overview-placeholder.md b/content/support/plugins/migrations-overview-placeholder.md deleted file mode 100644 index 01a4c2b7..00000000 --- a/content/support/plugins/migrations-overview-placeholder.md +++ /dev/null @@ -1,39 +0,0 @@ -title: Migrations plugins - -# Migrations plugins - -- Wordpress - - [GitHub Repo](https://github.com/openlibhums/imports) - - This tool allows you to import posts from a Wordpress site into a Janeway journal's news system. -- JATS - - [GitHub Repo](https://github.com/openlibhums/imports) - - See JATS import documentation -- OJS import - - [GitHub Repo](https://github.com/openlibhums/imports) - - See OJS import documentation -- OJS export - - An OJS plugin for exporting data for ingest into Janeway, in a custom JSON format - - [GitHub Repo](https://github.com/openlibhums/ojs-janeway) -- ePrints - - [GitHub Repo](https://github.com/openlibhums/eprints) - - This is a plugin for importing ePrints articles into Janeway. -- BePress - - This plugin allows you to import an export of a bepress Digital Commons publication into a Janeway instance. - - [GitHub Repo](https://github.com/openlibhums/bepress) -- Ingenta - - This is a plugin for ingesting back content from the Ingenta platform into Janeway It requires an SGML dump from the publication to be migrated. - - [GitHub Repo](https://github.com/openlibhums/ingenta) - -- Back content plugin - [GitHub Repo](https://github.com/openlibhums/back_content) - This plugin allows for fast loading of articles into Janeway. - - ## WordPress - - > [!WARNING] - > This importer is site-specific. You should be accessing the import tool from the press or journal you want it import the reviewers into. - -To import Wordpress posts: - -1. Start the import process -2. Enter the base url, username and password for your Wordpress site -3. Select a user to be the owner of the news imports -4. Click the **Import** button. diff --git a/content/support/press-management/footer.md b/content/support/press-management/footer.md deleted file mode 100644 index da4696a2..00000000 --- a/content/support/press-management/footer.md +++ /dev/null @@ -1,21 +0,0 @@ -title: Journal footer - -# Journal footer - -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 a postal address and similar contact information by clicking **Edit press details** and then editing the **Journal footer text** setting. - - - - - - - -## 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. - - - - diff --git a/content/support/press-management/press-management-placeholder.md b/content/support/press-management/press-management-placeholder.md deleted file mode 100644 index 0b8f16b2..00000000 --- a/content/support/press-management/press-management-placeholder.md +++ /dev/null @@ -1,16 +0,0 @@ -title: Press management - -# Press management - -_Coming soon_ - - diff --git a/content/support/submission/submission-fields.md b/content/support/submission/submission-fields.md deleted file mode 100644 index d302e3e9..00000000 --- a/content/support/submission/submission-fields.md +++ /dev/null @@ -1,101 +0,0 @@ -title: Managing submission fields - -# Managing submission fields - -There are two parts to managing submission fields on Janeway: standard fields and custom fields. The standard fields are the preexisting submission fields on Janeway, whereas the custom ones are any you create. - -## Standard submission items - -![" "](../../support/images/manager-submission-fields-configurator.png) - -There are a set of default submission fields within Janeway, the **Submission fields configurator** allows you to configure which one of these will appear during the submission process. The fields you have checked will display, while any of those which are unchecked will not. The default submission fields include: - -- Publication fees -- Submission checklist -- Copyright notice -- Competing interests -- Comments to editor -- Abstract -- Language -- License -- Keywords -- Section -- Funding -- Figures and data files - -If you choose not to use the license, language and section fields as a part of the submission process, we recommend setting a default value for those. E.g. if you only accept submissions in English, you could remove the language selection from the submission process. If you do so, it is recommended you set English as the default language. If nothing is set, the language will be absent from the article metadata (or license or article type, respectively). - -If you are using Janeway in languages other than English, you can also set the label for the submission file. This is what the ‘main text’ the author uploads will be labelled within the system. - -![" "](../../support/images/manuscript-label.png) - -## Custom submission fields - -Under the same header, you will also find **Additional submission fields**. This lets you add custom fields to the submission process. It works similarly to the Review form editor. - -Submission fields are made up of multiple elements. Each element asks for some kind of input from a user by either typing, clicking, or selecting something. - -To add a new field, must provide the following: - -### Name - -For each element, you will need to set a name. That name will display as text above the part which the user fills in or interacts with. -Short questions or prompts such as “Is this your first submission?” or “Upload” should be put in this field. If you have a longer question or need to provide more details, you may wish to use a more generic header and include additional information in the help text. - -### Kind - -A submission form can have the following types of form elements: - -- **Text field** - This creates a single-line input area for short text answers such as names, keywords or subjects. It does not allow for formatting. - -![" "](../../support/images/element-text-field.png) - -- **Text area** - This provides a larger, multi-line input area for longer texts such as comments and descriptions. It allows for formatting and line breaks. - -![" "](../../support/images/element-text-area.png) - -- **Checkbox** - This allows you to ask users to tick a box. These can be used to declare no competing interests or agree to terms and conditions. - -![" "](../../support/images/element-check-box.png) - -- **Select (dropdown)** - This lets you provide a set of options to be displayed in a dropdown list, allowing users to select one. - -To add these options, use the **Choices** field. The options should be separated by the bar (" | ") character. This should look like this: "choice 1|choice 2|choice 2". - -![" "](../../support/images/element-select.png) - -- **Email** - This is a specific text field for emails. It checks if an email address is correctly formatted before a user submits the form and prompts them to edit it if it is not. - -- **Upload** - This lets a user upload a file from their device. - -![" "](../../support/images/element-file-upload.png) - -- **Date** - This asks the user to provide a date. - -### Choices - -The **Choices** field used in the dropdown element will appear for all of these fields. However, it can be ignored in all other cases as it only applies to **Select (dropdown)**. - -### Required - -Checking this box will make it obligatory for users to complete that specific field. This means that they cannot submit the form without doing so. Unchecking it means that it will become optional. - -### Order - -This determines the order of the elements on the submission form. This is expressed numerically, so “1” means that the element will be displayed first, “2” means that it will be displayed second, etc. - -You also have the option to click and drag elements from the full form view to reorder them. - - - -### Help text - -Here you have the option to add text that will display under the submission element. This can be used to provide additional information or guidance. diff --git a/pelicanconf.py b/pelicanconf.py index 2f2f278e..f6392c62 100644 --- a/pelicanconf.py +++ b/pelicanconf.py @@ -1,11 +1,12 @@ -import json from datetime import datetime +import json import logging +TESTING = False AUTHOR = 'Open Library of Humanities' SITENAME = 'Janeway' -SITEURL = "https://janeway.systems" +SITEURL = "http://localhost:8000" if TESTING else "https://janeway.systems" PATH = "content" @@ -49,16 +50,25 @@ # via the GitHub user interface, using the Preview tab in the markdown editor # to check the content is rendering as expected. PATH_METADATA = r'(?P.*)\..*' -ARTICLE_URL = ARTICLE_SAVE_AS = '{path_no_ext}.html' +ARTICLE_URL = ARTICLE_SAVE_AS = PAGE_URL = PAGE_SAVE_AS = '{path_no_ext}.html' + +# Default metadata for all pages and articles +DEFAULT_METADATA = { + # The default alpha_site is support so that we do + # not have to specify it in every docs Markdown file. + "alpha_site": "support", +} + +PLUGIN_PATHS = ["plugins"] +PLUGINS = ["janeway"] -# Where to put and serve pages -# PAGE_URL = '{slug}.html' -# PAGE_SAVE_AS = '{slug}.html' +# Custom settings used in tests/conftest.py +SUPPORT_CONTENT_PATH = "content/pages/support" # Static STATIC_PATHS = [ - 'support/images', - 'support/downloadables', + 'pages/support/images', + 'pages/support/downloadables', # Legacy paths from old docs # that we will eventually remove @@ -80,15 +90,11 @@ DISPLAY_CATEGORIES_ON_MENU = False LEFT_NAV_ITEMS = [ ('Our story', '/pages/our-story.html', ""), - # ('Explore', '#', ''), Not in scope for MVP ('Hosting', '/pages/hosting.html', ""), ('Support', '/pages/support.html', ""), - # ('People', '#', ''), Not in scope for MVP ] RIGHT_NAV_ITEMS = [ - # ('Book a Demo', '#', '') Not in scope for MVP ('Symposium', 'https://thelowerdecks.janeway.systems/', "_blank"), - # ('Support', '/support/under-construction.html', "_blank"), ('Source code', 'https://github.com/openlibhums/janeway', "_blank"), ] FOOTER_LINKS = [ @@ -101,20 +107,9 @@ ('Home', '/', ""), ] + LEFT_NAV_ITEMS + RIGHT_NAV_ITEMS + FOOTER_LINKS -# jinja2content plugin -JINJA2CONTENT_TEMPLATES = [ - 'pages', - 'support', - 'old-docs', # temporary until new docs are complete -] - # Use mtime of files as date in webpage metadata DEFAULT_DATE = 'fs' -# Take the 'categories' feature and temporarily -# mis-use it to create a working contents tree for docs -CATEGORIES_SAVE_AS = 'support/under-construction.html' - JINJA_ENVIRONMENT = { 'extensions': ['jinja2.ext.do'], } @@ -129,9 +124,6 @@ "installation_map_json": json.loads(installation_json), } -GH_MAIN_CONTENT_URL = 'https://github.com/BirkbeckCTP/memory-alpha/edit/main/content' -GH_COPYEDIT_CONTENT_URL = 'https://github.com/BirkbeckCTP/memory-alpha/edit/copyediting/content' - # Filter out empty alt warnings, which do not account for the primary method of # marking images as decorative, which is alt="" LOG_FILTER = [(logging.WARN, 'Empty alt attribute for image %s in %s')] diff --git a/plugins/janeway.py b/plugins/janeway.py new file mode 100644 index 00000000..d8a148a2 --- /dev/null +++ b/plugins/janeway.py @@ -0,0 +1,188 @@ +import os +import re +from tempfile import NamedTemporaryFile + +from jinja2 import ChoiceLoader, Environment, FileSystemLoader + +from pelican import signals, DEFAULT_CONFIG_NAME +from pelican.readers import HTMLReader, BaseReader +from pelican.settings import read_settings +from pelican.utils import pelican_open +from marko import Markdown +from marko.ast_renderer import ASTRenderer +from marko.ext.gfm import GFM +from marko.helpers import MarkoExtension +from marko.ext.toc import slugify + + +SETTINGS = read_settings(DEFAULT_CONFIG_NAME) + + +def load_jinja_environment(settings): + + # This function is partially adapted from the pelican-jinja2content plugin. + # We copy and adapt it rather than using it + # so that we can use Marko for Markdown processing. + # https://github.com/pelican-plugins/jinja2content + + content_dir = settings["PATH"] + theme_dir = os.path.join(settings["THEME"], "templates") + loaders = [ + FileSystemLoader(_dir) for _dir in [content_dir, theme_dir] + ] + + jinja_environment_settings = settings["JINJA_ENVIRONMENT"] + environment = Environment( + loader=ChoiceLoader(loaders), + **jinja_environment_settings + ) + if "JINJA_FILTERS" in settings: + environment.filters.update(settings["JINJA_FILTERS"]) + if "JINJA_GLOBALS" in settings: + environment.globals.update(settings["JINJA_GLOBALS"]) + if "JINJA_TEST" in settings: + environment.tests.update(settings["JINJA_TESTS"]) + return environment + + +JINJA_ENV = load_jinja_environment(SETTINGS) + +MD_FILE_ENDING_RE = re.compile(r"\.md$") +MD_FILE_ENDING_FRAGMENT_RE = re.compile(r"\.md\#") + + +class JanewayRendererMixin: + # This is a Marko mixin + # https://marko-py.readthedocs.io/en/latest/extend.html#create-an-extension-object + + def render_heading(self, element): + # From overwritten function + children = self.render_children(element) + level = element.level + if level > 1: + section_id = slugify(JINJA_ENV.filters["striptags"](children)) + else: + section_id = "" + + # New behaviour + context = { + "level": level, + "children": children, + "section_id": section_id, + } + template = JINJA_ENV.get_template("components/rendered_heading.html") + return template.render(context) + + def render_alert(self, element): + # From overwritten function + header = self.escape_html(element.alert_type) + children = self.render_children(element) + + # New behavior + alert_type = element.alert_type.lower() + if alert_type == "note": + icon = "info-circle" + elif alert_type == "tip": + icon = "bulb" + elif alert_type == "important": + icon = "message-report" + elif alert_type == "warning": + icon = "alert-triangle" + elif alert_type == "caution": + icon = "alert-octagon" + else: + icon = "info-circle" + context = { + "alert_type": alert_type, + "icon_file": f"svg/tabler/{ icon }.svg", + "header_title": header.title(), + "children": children, + } + template = JINJA_ENV.get_template("components/rendered_alert.html") + return template.render(context) + + def render_link(self, element): + # From overwritten function + title = f' title="{self.escape_html(element.title)}"' if element.title else "" + url = self.escape_url(element.dest) + body = self.render_children(element) + + # New behavior + url = re.sub(MD_FILE_ENDING_RE, "", url) + url = re.sub(MD_FILE_ENDING_FRAGMENT_RE, "#", url) + context = { + "title": title, + "url": url, + "body": body, + } + template = JINJA_ENV.get_template("components/rendered_link.html") + return template.render(context) + + +JanewayMarkoExtension = MarkoExtension( + renderer_mixins=[JanewayRendererMixin], +) + + +class MarkoMarkdownReader(BaseReader): + enabled = True + file_extensions = ['md'] + + def read(self, source_path): + """Parse using Marko""" + + self._source_path = source_path + markdown = Markdown(extensions=[GFM, JanewayMarkoExtension]) + ast = Markdown(extensions=[GFM, JanewayMarkoExtension], renderer=ASTRenderer) + with pelican_open(source_path) as text: + # Render to AST to pull some content out as metadata + parsed_ast = ast(text) + content = markdown(text) + + metadata = {} + # Use the h1 as the title + for line in parsed_ast["children"]: + if line["element"] == "heading" and line["level"] == 1: + h1 = line["children"][0]["children"] + metadata["title"] = h1 + break + + return content, metadata + + +class JinjaContentMixin: + # This mixin is adapted from the pelican-jinja2content plugin. + # We copy and adapt it rather than using it + # so that we can use Marko for Markdown processing. + # https://github.com/pelican-plugins/jinja2content + + def read(self, source_path): + with pelican_open(source_path) as text: + text = JINJA_ENV.from_string(text).render() + + with NamedTemporaryFile(delete=False) as f: + f.write(text.encode()) + f.close() + content, metadata = super().read(f.name) + os.unlink(f.name) + return content, metadata + + +class JinjaMarkdownReader(JinjaContentMixin, MarkoMarkdownReader): + pass + + +class JinjaHTMLReader(JinjaContentMixin, HTMLReader): + pass + + +def add_reader(readers): + """Add Jinja readers.""" + for Reader in [JinjaMarkdownReader, JinjaHTMLReader]: + for ext in Reader.file_extensions: + readers.reader_classes[ext] = Reader + + +def register(): + """Register the plugin.""" + signals.readers_init.connect(add_reader) diff --git a/requirements.in b/requirements.in index 0e2bb308..94590d59 100644 --- a/requirements.in +++ b/requirements.in @@ -1,3 +1,3 @@ -pelican[markdown] -pelican-jinja2content +marko +pelican tzdata diff --git a/requirements.txt b/requirements.txt index fc8db07e..ec33656d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,8 +1,8 @@ # -# This file is autogenerated by pip-compile with Python 3.10 +# This file is autogenerated by pip-compile with Python 3.11 # by the following command: # -# pip-compile +# pip-compile requirements.in # anyio==4.3.0 # via watchfiles @@ -10,29 +10,23 @@ blinker==1.7.0 # via pelican docutils==0.21.2 # via pelican -exceptiongroup==1.3.1 - # via anyio feedgenerator==2.1.0 # via pelican idna==3.7 # via anyio jinja2==3.1.3 # via pelican -markdown==3.6 - # via pelican markdown-it-py==3.0.0 # via rich +marko==2.2.3 + # via -r requirements.in markupsafe==2.1.5 # via jinja2 mdurl==0.1.2 # via markdown-it-py ordered-set==4.1.0 # via pelican -pelican[markdown]==4.9.1 - # via - # -r requirements.in - # pelican-jinja2content -pelican-jinja2content==1.0.1 +pelican==4.9.1 # via -r requirements.in pygments==2.17.2 # via @@ -48,10 +42,6 @@ six==1.16.0 # via python-dateutil sniffio==1.3.1 # via anyio -typing-extensions==4.15.0 - # via - # anyio - # exceptiongroup tzdata==2024.1 # via -r requirements.in unidecode==1.3.8 diff --git a/test-requirements.in b/test-requirements.in index 8d89346e..03c79aea 100644 --- a/test-requirements.in +++ b/test-requirements.in @@ -1,3 +1,4 @@ axe-playwright-python==0.1.7 -playwright==1.45.0 -pytest-playwright==0.5.1 +pytest==9.1.1 +playwright==1.48.0 +pytest-playwright==0.8.0 diff --git a/test-requirements.txt b/test-requirements.txt index 7cf68957..eb8e231a 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,5 +1,5 @@ # -# This file is autogenerated by pip-compile with Python 3.10 +# This file is autogenerated by pip-compile with Python 3.11 # by the following command: # # pip-compile test-requirements.in @@ -10,9 +10,7 @@ certifi==2024.8.30 # via requests charset-normalizer==3.3.2 # via requests -exceptiongroup==1.3.1 - # via pytest -greenlet==3.0.3 +greenlet==3.1.1 # via playwright idna==3.10 # via requests @@ -20,22 +18,25 @@ iniconfig==2.0.0 # via pytest packaging==24.1 # via pytest -playwright==1.45.0 +playwright==1.48.0 # via # -r test-requirements.in # axe-playwright-python # pytest-playwright pluggy==1.5.0 # via pytest -pyee==11.1.0 +pyee==12.0.0 # via playwright -pytest==8.3.3 +pygments==2.20.0 + # via pytest +pytest==9.1.1 # via + # -r test-requirements.in # pytest-base-url # pytest-playwright pytest-base-url==2.1.0 # via pytest-playwright -pytest-playwright==0.5.1 +pytest-playwright==0.8.0 # via -r test-requirements.in python-slugify==8.0.4 # via pytest-playwright @@ -43,11 +44,7 @@ requests==2.32.3 # via pytest-base-url text-unidecode==1.3 # via python-slugify -tomli==2.4.1 - # via pytest typing-extensions==4.12.2 - # via - # exceptiongroup - # pyee + # via pyee urllib3==2.2.3 # via requests diff --git a/tests/conftest.py b/tests/conftest.py index 781b4326..cd75acc0 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -2,16 +2,9 @@ import re import pytest from pytest_server import PytestPelicanServer -from pelican import get_instance, parse_arguments from axe_playwright_python.sync_playwright import Axe -pelican, settings = get_instance(parse_arguments()) -ALL_PAGES = [ - path for _label, path, target in settings.get('ALL_PAGES') if not target -] - - @pytest.fixture(scope="session") def live_server(base_url: str): """Run a live Pelican server in the background during tests @@ -38,11 +31,6 @@ def axe(): return Axe() -@pytest.fixture(scope="module", params=ALL_PAGES) -def site_page(request): - yield request.param - - @pytest.fixture(scope="module") def html_ending_regex(): return re.compile(r".html") diff --git a/tests/pytest_server.py b/tests/pytest_server.py index 1c5b493b..6a08a100 100644 --- a/tests/pytest_server.py +++ b/tests/pytest_server.py @@ -1,8 +1,16 @@ +import logging +import os import threading from urllib.parse import urlparse from pelican.server import ComplexHTTPRequestHandler, RootedHTTPServer -from pelican import get_instance, parse_arguments +from pelican import ( + get_instance as get_pelican_instance, + parse_arguments as parse_pelican_arguments +) + + +logger = logging.getLogger(__name__) class LiveServerThread(threading.Thread): @@ -42,7 +50,7 @@ def terminate(self): class PytestPelicanServer: """The liveserver fixture - Adapted from the live server helper in django-pytest. + Adapted from the live server helper in pytest-django. This is the object that the ``live_server`` fixture returns. The ``live_server`` fixture handles creation and stopping. @@ -62,7 +70,11 @@ def __init__( output=output, ) self.thread.daemon = True - self.pelican, self.settings = get_instance(parse_arguments()) + self.pelican, self.pelican_settings = get_pelican_instance( + parse_pelican_arguments(["--listen"]) + ) + self.pelican_settings["TESTING"] = True + if start: self.start() @@ -81,6 +93,30 @@ def stop(self) -> None: """Stop the server""" self.thread.terminate() + def get_main_pages(self): + main_pages = [] + for _label, path, target in self.pelican_settings.get('ALL_PAGES'): + if not target: + main_pages.append(path) + return main_pages + + def get_support_pages(self): + support_pages = [] + support_content_path = self.pelican_settings.get("SUPPORT_CONTENT_PATH") + for dirpath, dirnames, filenames in os.walk(support_content_path): + for filename in filenames: + if filename.endswith(".md"): + filename = filename[:-3] + ".html" + content_path = os.path.join(dirpath, filename) + pelican_path = self.pelican_settings.get("PATH") + rel_path = os.path.relpath(content_path, start=pelican_path) + support_pages.append("/" + rel_path) + return support_pages + + @property + def all_pages(self): + return self.get_main_pages() + self.get_support_pages() + @property def url(self) -> str: return f"http://{self.thread.host}:{self.thread.port}" diff --git a/tests/test_accessibility.py b/tests/test_accessibility.py index d62298e3..2671bf12 100644 --- a/tests/test_accessibility.py +++ b/tests/test_accessibility.py @@ -1,9 +1,104 @@ +import logging +from urllib.parse import urlsplit, urljoin + from playwright.sync_api import Page -def test_main_site_pages_against_wcag(page: Page, live_server, axe, site_page): - page.goto(live_server + site_page) - results = axe.run(page) - if results.violations_count: - print(results.generate_report()) - assert results.violations_count == 0 +logger = logging.getLogger(__name__) + + +def normalize_path(page_being_tested, path): + resource = urljoin(page_being_tested, path) + if urlsplit(resource).netloc in ["localhost:8000", "127.0.0.1:8000"]: + return resource + else: + return "" + + +def test_all_pages(page: Page, live_server, axe, subtests): + visited = {} + for i, site_page in enumerate(live_server.all_pages): + page_being_tested = live_server + site_page + + # Test WCAG + page.goto(page_being_tested) + msg = f"WCAG failure: {site_page}" + with subtests.test(msg=msg, i=i): + results = axe.run(page) + if results.violations_count: + logger.warning(results.generate_report()) + assert results.violations_count == 0 + + # Prepare to test image paths and links. + # We do not want to test the nav and footer links + # on every page, just landing pages for each site type + # (i.e. main and support). So for most pages, + # we limit the test area to the `main` element. + alpha_site = page.locator('body').get_attribute("data-alpha-site") + title = page.locator("title") + prefix = "" + if alpha_site == "support" and title.inner_text != "Support": + prefix = "main " + elif alpha_site == "main" and title.inner_text != "Janeway": + prefix = "main " + + # Test broken images + test_locator = f'{prefix}img' + for locator in page.locator(test_locator).all(): + src = locator.get_attribute("src") + alt = locator.get_attribute("alt") + img = normalize_path(page_being_tested, src) + if not img: + continue + + if img in visited: + ok, msg = visited[img] + with subtests.test(msg=msg, i=i): + assert ok + else: + msg = f"Broken image: {site_page} -> {alt} {src}" + with subtests.test(msg=msg, i=i): + response = page.request.get(img) + visited[img] = response.ok, msg + assert response.ok + + # Test links + test_locator = f'{prefix}a:not([target="_blank"]):not([href^="mailto"])' + for locator in page.locator(test_locator).all(): + href = locator.get_attribute("href") + text = locator.inner_text() + fragment = urlsplit(href).fragment + link = normalize_path(page_being_tested, href) + if not link: + continue + + if link in visited: + ok, msg = visited[link] + with subtests.test(msg=msg, i=i): + assert ok + + elif fragment: + separate_page = bool(urlsplit(href).path) + if separate_page: + page.goto(link) + + target = page.locator(f'#{fragment}') + target_count = target.count() + if target_count > 1: + msg = f"Link to duplicate headings: {site_page} -> {text} {href}" + elif target_count < 1: + msg = f"Broken heading link: {site_page} -> {text} {href}" + with subtests.test(msg=msg, i=i): + one_target = target_count == 1 + assert one_target + visited[link] = one_target, msg + + if separate_page: + page.goto(page_being_tested) + + else: + msg = f"Broken page link: {site_page} -> {text} {href}" + with subtests.test(msg=msg, i=i): + response = page.request.get(link) + assert response.ok + visited[link] = response.ok, msg diff --git a/tests/test_links.py b/tests/test_links.py index bedc3bc8..bdef57ba 100644 --- a/tests/test_links.py +++ b/tests/test_links.py @@ -1,11 +1,11 @@ +import logging + + from playwright.sync_api import Page, expect -from pelican import get_instance, parse_arguments -pelican, settings = get_instance(parse_arguments()) -ALL_PAGES = [ - path for _label, path, target in settings.get('ALL_PAGES') if not target -] +logger = logging.getLogger(__name__) + def test_landing_page_internal_links_end_with_html(page: Page, live_server, html_ending_regex): page.goto(live_server + "/") diff --git a/themes/alpha/static/components/laser_link.css b/themes/alpha/static/components/laser_link.css index ec398ae9..3f8e2d6d 100644 --- a/themes/alpha/static/components/laser_link.css +++ b/themes/alpha/static/components/laser_link.css @@ -1,5 +1,6 @@ .laser-link { text-decoration: none; + text-wrap: nowrap; &::before { content: ""; diff --git a/themes/alpha/static/components/licensing_line.css b/themes/alpha/static/components/licensing_line.css new file mode 100644 index 00000000..89fe7a20 --- /dev/null +++ b/themes/alpha/static/components/licensing_line.css @@ -0,0 +1,12 @@ +.licensing-line { + font-family: var(--ff-poppins-regular); + font-size: var(--step-1); + + .cc-by svg { + display: inline-block; + height: 1em; + margin-inline-end: 0.25em; + margin-block-end: 0.25em; + vertical-align: middle; + } +} diff --git a/themes/alpha/static/components/licensing_line.html b/themes/alpha/static/components/licensing_line.html new file mode 100644 index 00000000..00efbc77 --- /dev/null +++ b/themes/alpha/static/components/licensing_line.html @@ -0,0 +1,27 @@ +
+ + Copyright © 2017–{{ current_year }} + + Birkbeck, University of London + + + + Software + + AGPLv3 + + + + Content + + CC BY 4.0 + + +
diff --git a/themes/alpha/static/components/footer.css b/themes/alpha/static/components/main_footer.css similarity index 82% rename from themes/alpha/static/components/footer.css rename to themes/alpha/static/components/main_footer.css index 34c2b1dd..c606156e 100644 --- a/themes/alpha/static/components/footer.css +++ b/themes/alpha/static/components/main_footer.css @@ -1,4 +1,4 @@ -.footer { +.main-footer { a { color: var(--clr-alpha-white); position: relative; @@ -64,17 +64,5 @@ display: flex; justify-content: center; } - - .licensing-line { - font-family: var(--ff-poppins-regular); - font-size: var(--step-1); - } - .cc-by svg { - display: inline-block; - height: 1em; - margin-inline-end: 0.25em; - margin-block-end: 0.25em; - vertical-align: middle; - } margin-block-end: var(--space-xl); } diff --git a/themes/alpha/static/components/footer.html b/themes/alpha/static/components/main_footer.html similarity index 69% rename from themes/alpha/static/components/footer.html rename to themes/alpha/static/components/main_footer.html index 030f861c..e9699f32 100644 --- a/themes/alpha/static/components/footer.html +++ b/themes/alpha/static/components/main_footer.html @@ -3,7 +3,7 @@ {% from "components/link_list.html" import link_list %} {% from "components/button.html" import button %} - + {% include "components/licensing_line.html" %} +
diff --git a/themes/alpha/static/components/main_nav.css b/themes/alpha/static/components/main_header.css similarity index 84% rename from themes/alpha/static/components/main_nav.css rename to themes/alpha/static/components/main_header.css index 607a3570..ba5263f1 100644 --- a/themes/alpha/static/components/main_nav.css +++ b/themes/alpha/static/components/main_header.css @@ -1,4 +1,21 @@ -.main-nav { +.main-header { + --clr-background: var(--clr-alpha-black); + --clr-foreground: var(--clr-alpha-white); + position: relative; + .background-pane-left, + .background-pane-right { + top: 0px; + bottom: 0px; + width: 50vw; + position: absolute; + } + .background-pane-left { + right: 50%; + } + .background-pane-right { + left: 50%; + } + .nav-container { display: flex; justify-content: space-between; @@ -14,7 +31,7 @@ padding: 0; margin: 0; display: flex; - column-gap: 1rem; + column-gap: var(--space-2xs); row-gap: 1rem; } @@ -36,7 +53,7 @@ color: var(--clr-alpha-white); font-family: var(--ff-poppins-medium); position: relative; - padding: 0.7rem 0; + padding: 0.7rem var(--space-3xs); } .left, @@ -84,6 +101,8 @@ .combined-menu { display: none; flex-direction: column; + --clr-foreground: var(--clr-alpha-white); + color: var(--clr-foreground); --clr-background: var(--clr-alpha-black); background: var(--clr-background); align-items: flex-start; @@ -134,7 +153,7 @@ /* Mobile view: Hide left and right UL, display slide-drawer */ @media (width <= 50rem) { - .main-nav { + .main-header { .left ul, .right ul { display: none; @@ -153,7 +172,7 @@ /* Desktop view: Always display left and right UL, hide slide-drawer */ @media (width > 50rem) { - .main-nav { + .main-header { .left ul, .right ul { display: flex; diff --git a/themes/alpha/static/components/main_nav.html b/themes/alpha/static/components/main_header.html similarity index 71% rename from themes/alpha/static/components/main_nav.html rename to themes/alpha/static/components/main_header.html index a075c67f..8218f650 100644 --- a/themes/alpha/static/components/main_nav.html +++ b/themes/alpha/static/components/main_header.html @@ -1,8 +1,18 @@ {# A component to display the main navigation. #} {% from "components/laser_link.html" import laser_link %} -{% macro main_nav(LEFT_NAV_ITEMS, RIGHT_NAV_ITEMS, output_file) -%} -