Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions content/pages/support/about-the-docs-placeholder.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Title: Janeway Documentation
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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ After the [press accessibility information](#enter-press-accessibility-informati
> [!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**, through the**General**/**Journal settings** page.
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)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ title: 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.
Expand Down Expand Up @@ -61,11 +61,13 @@ Some changes are restricted by permission level. For more information, see the [

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.
- The destination account profile is retained.
- Any profile information from the source account is permanently lost. <!--check how much of this is the case -->
- Any profile information from the source account is permanently lost. <!--check how much of this is the case -->
2 changes: 1 addition & 1 deletion content/pages/support/accounts-and-roles/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ This section explains how user accounts and permissions work in Janeway, includi

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.
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.
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,21 @@ title: Janeway analytics

# Janeway analytics

_Coming soon_
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.

<!--
- Janeway counts views and downloads.
- Can get author data
- Review data
- Workflow data
- [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
_Coming soon_ — connecting Google Analytics to your journal for additional web traffic insights.

## How Janeway measures access
## Institutional statistics

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.

<!-- ## How Janeway measures access

Janeway VS COUNTER.

- How do we measure stats and how does meet COUNTER requirements.

This section needs dev input.

## Reporting

For in-depth information on various reports, see: Reporting

- How to find the reporting plugin.
- Who has access to the reporting plugin.

### Institutional statistics

OR ‘why we cannot tell you’ and info Janeway _can_ give you.

- Cannot provide institutional statistics
- No information on who from specific organisations -> no paywall.
- Can provide authors, reviewers, editor affiliation based on frozen author records / what is saved on the system. -->
This section needs dev input. ->
16 changes: 9 additions & 7 deletions content/pages/support/analytics/reporting.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
Title: Reporting
title: Reporting

## Reporting plugin
# Reporting plugin

The reporting plugin produces a range of reports for analytics within the Janeway publishing platform. These reports include:
The reporting plugin can be found by clicking **Plugins** in the right-hand sidebar and selecting **Reporting plugin**.

![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
Expand All @@ -18,11 +22,9 @@ The reporting plugin produces a range of reports for analytics within the Janewa
- 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.
Expand Down
10 changes: 5 additions & 5 deletions content/pages/support/article-management/article-images.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ 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<!-- missing hyperlink -->. The image will be resized smaller for display on the homepage.

Expand All @@ -22,22 +22,22 @@ 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.

## Meta image

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:

Expand All @@ -46,7 +46,7 @@ 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**.

Expand Down
16 changes: 9 additions & 7 deletions content/pages/support/article-management/article-metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,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.
Expand All @@ -21,15 +23,15 @@ 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

1. Find the published article on the journal front end.
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**.
Expand All @@ -40,19 +42,19 @@ 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.

Expand All @@ -62,7 +64,7 @@ Janeway can mint [CrossRef](../identifiers/crossref-article-doi.md) and [DataCit

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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ 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)
![" "](../images/manager-sections.png)

## Managing sections

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ Archived and rejected papers can be found under **Archived articles**. On either

> [!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.

<!-- ![Top of the article archive page](../nstatic/article-archive.png) -->
> ![Showing the edit metadata option on the front end.](../images/front-end-metadata.png)

## How to use the article archive page

Expand Down Expand Up @@ -48,7 +47,7 @@ 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.

Expand Down
Binary file removed content/pages/support/article-management/image.png
Binary file not shown.
3 changes: 2 additions & 1 deletion content/pages/support/article-management/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,9 @@ Additionally, there's a page to manage the 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)
![Article listed for publication in the future](../images//pub-schedule.png)
<--

<!--![Article listed for publication in the future](../nstatic/pub-schedule.png) -->

<!-- explain scheduling around end of year and why to avoid, explain where this is found. -->-->
6 changes: 3 additions & 3 deletions content/pages/support/contributing-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,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
Expand Down
2 changes: 1 addition & 1 deletion content/pages/support/email-and-reminders/email-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You can access this through:
- The archive (Dashboard -\> Left hand menu
-\> Back Content -\> Articles).

![Screenshot showing where to access Logs, docs and more](../images/email-logs-access.png)
![Screenshot showing where to access Logs, docs and more](../images/navigation-logs.png)

## Understanding the log entries

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,12 @@ Publication notifications can be enabled or disabled on a per-journal basis. Whe

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.](../../nstatic/publication-notifications.png) -->
![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.

<!-- ![Example of the subscribe to article notification button.](../../nstatic/register-for-reader-notifications.png) -->

Once enabled, users will be able to subscribe to notifications from their profile.

## Subscribing to notifications
Expand All @@ -31,13 +29,7 @@ Users can sign up for publication notifications by:

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**. <!--missing hyperlink-->

<!-- To check:
- Can staff/editors remove reader roles?
- Can we get a list of readers?
- Is the pub notif email template configurable per journal?
-->
For more information about roles, see [**Roles and permissions**](../accounts-and-roles/janeway-roles-and-permissions.md).

## How notification emails are sent

Expand Down
Loading