Skip to content

Commit

Permalink
pkp/pkp-lib#1479 Update help panels for OJS 3, add missing issue mana…
Browse files Browse the repository at this point in the history
…gement details

Conflicts:
	en/editorial-workflow.md
	en/issue-management.md
	en/settings.md
  • Loading branch information
NateWr authored and asmecher committed Aug 31, 2016
1 parent 3cd76e8 commit 9d3a60c
Show file tree
Hide file tree
Showing 9 changed files with 83 additions and 60 deletions.
7 changes: 4 additions & 3 deletions en/editorial-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

1. Introduction
2. [Managing Submission Details](editorial-workflow.md#manage-submission-details)
3. Editorial Actions
3. [Editorial Actions](editorial-workflow.md#editorial-actions)
4. [Participants](editorial-workflow.md#participants)

The editorial workflow allows you to usher a submission from initial evaluation through peer review, copyediting and production, where the item is prepared for publication.
Expand All @@ -23,14 +23,16 @@ Publication includes information about which issue will contain the article, as

Identifies provides a space to add any public URL identifiers.

### <a name="editorial-history"></a>Editorial History
### <a name="editorial-history"></a>History

Add notes for record-keeping and view a log of all events associated with this submission. Only editorial and administrative staff have access to the Editorial History.

### <a name="submission-library"></a>Submission Library

A quick-access repository for any files that you'd like to track along with the submission. This is useful for files that aren't specific to any stage, such as signed contracts, marketing files, or guidelines you'd like to share with copyeditors or other assistants.

You can quickly add files from your [Publisher Library](settings.md#workflow-library) by clicking on **View Document Library**.

## <a name="editorial-actions"></a> Editorial Actions

At the top right of each stage of the workflow, you'll see the editorial actions available to you. These decisions change with each stage. But in most cases, they complete the current stage and forward the submission onto the next stage.
Expand All @@ -44,4 +46,3 @@ On the right of each stage of the workflow, you'll find a list of users who have
*When you add a user, that user will have access to any stages allowed by their user role*. For example, an Editor added to the Participants grid will have access to every stage. But a Copyeditor will only have access to the Copyediting stage.

*You won't need to add Reviewers to the Participants panel.* Once you get to the [review stages](editorial-workflow/review.md), you'll be able to manage the reviewers in a more convenient panel.

25 changes: 5 additions & 20 deletions en/editorial-workflow/production.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,9 @@

1. Introduction
2. [Orientation](production.md#orientation)
3. [Understanding Publication Formats](production.md#understanding-publication-formats)
3. [Publishing the Submission](production.md#publish)

During the Production stage, the editor assigns production assistants who will help prepare the final publication files.

Common publication formats include PDF and ePub, but you may also prepare a number of other formats, such as HTML files or an eLens reader, depending on what formats your administrator has enabled.
During the Production stage, the editor assigns production assistants who will help prepare the final publication files, known as galleys.

## <a name="orientation"></a>Orientation

Expand All @@ -23,26 +20,14 @@ Editors and production assistants can use this panel to initiate conversations,

### <a name="publication-formats"></a>Galleys

Editors and production assistants can create galleys and upload files for each format type (e.g., PDF, HTML, etc.). Learn more about [publication formats](production.md#understanding-publication-formats).

Once galleys have been created and files have been uploaded, you can begin the approval process to [publish the submission](production.md#publish).
Editors and production assistants can create galleys and upload a file for each galley. These typically represent separate publication formats, such as PDF and HTML.

### <a name="participants"></a>Participants

Editors can add production assistants or layout editors from this panel. [Learn more](../editorial-workflow.md#participants).

## <a name="understanding-galleys"></a>Understanding Galleys

Each galley represents one type of file (HTML, PDF), and may have multiple files attached to it, such as separate image files.

### Organizing Your Galleys

How you choose to organise your galleys is up to you. But that flexibility may be confusing as you're just getting used to the publishing platform. Here are a couple of simple examples.

A typical journal might have one galley format named PDF with a single `.pdf` file uploaded to it. It might have another galley format named HTML with separate `.html` files uploaded.

In this case, you'd create two galleys, PDF and HTML, and upload the files separately under each.

## <a name="publish"></a>Publishing the Submission

Once you are ready to publish the submission, you must schedule it to an issue.
Once you are ready to publish the submission, you must schedule it for publication in an issue.

The **Schedule for Publication** button will allow you to select an forthcoming issue, set a publication date, attach licensing permissions and add page numbers if desired.
5 changes: 2 additions & 3 deletions en/editorial-workflow/review.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# Review Stages

1. Introduction
2. [Internal or External Review?](review.md#internal-or-external)
3. [Orientation](review.md#orientation)
4. [Editorial Actions](review.md#editorial-actions)
2. [Orientation](review.md#orientation)
3. [Editorial Actions](review.md#editorial-actions)

During the Review stage, the editor assigns reviewers to the submission.

Expand Down
1 change: 0 additions & 1 deletion en/editorial-workflow/submission.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ The editor can assign a sub-editor to assist by using the **Participants** panel

Send the submission on to the [Review stage](review.md), where it will be reviewed by peer reviewers.


### Send to Copyediting

Send the submission forward to the [Copyediting stage](copyediting.md) if you'd like to skip the peer review process completely.
Expand Down
55 changes: 48 additions & 7 deletions en/issue-management.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,56 @@
# Issues

1. Introduction
2. [Future Issues](issue-management.md#future-issues)
3. [Back Issues](issue-management.md#back-issues)
4. [Edit an Issue](issue-management.md#edit-issue)

Manage your journal's issues from this page.
Set up forthcoming issues and manage existing issues from this page.

## Future Issues
These are your unpublished issues.
Each issue listed on these pages can be expanded using the small arrow on the left to reveal options.

## Back Issues
These are your published issues.
**Edit** - [Manage](issue-management.md#edit-issue) the contents and metadata for this issue.

## Create Issues
**View/Preview** - Jump to the issue on your site or see a preview of the issue if it's not yet been published.

Use this link to create a new issue for your journal.
**Publish/Unpublish Issue** - Publishing an issue will make it publicly available on your site.

**Delete** - Removing an issue can not be undone.

## <a name="future-issues"></a>Future Issues

View forthcoming issues and create a new issue from this section.

Issues should be created well in advance of their release date so that you can begin to schedule articles for publication. Once you have [scheduled articles](editorial-workflow/production.md#publish) for an issue you will be able to manage the table of contents.

## <a name="back-issues"></a>Back Issues

View all published issues in this section.

## <a name="edit-issue"></a>Edit an Issue

Issue details can be edited including the table of contents, publication date, title and volume details. If you're using any public identifiers, like DOI, they can also be edited here.

### <a name="edit-issue-toc"></a>Table of Contents

Re-order articles scheduled for publication in this issue. You can also re-order entire sections, if you want one section to appear above another.

Before an article can appear here, you'll need to [schedule it for publication](editorial-workflow/production.md#publish).

### <a name="edit-issue-data"></a>Issue Data

Key data such as the publication date, title, volume number and year can be set here. If you don't want to display any volume details on your site, you can deselect the checkboxes which appear here.

If you'd like, you can also give each issue a description and cover image.

### <a name="edit-issue-galley"></a>Issue Galley

Some journals may wish to publish a galley of the entire issue alongside the galleys for each individual article. If you have a PDF or other format containing your entire issue's contents, you can add it here.

### <a name="edit-issue-identifiers"></a>Identifiers

The "Public URL Identifier" is a text slug which is used in the URL for this issue. By default, issues are given a URL based on their numeric ID. But you may want to give them human-readable names, like "50th-anniversary-issue", which creates prettier URLs.

If you have additional public ID plugins activated, you will see them here if they support issue public IDs.

The most popular public ID is the [DOI](https://www.doi.org/). If you have configured this plugin to use DOIs for issues, you'll be able to preview and assign a DOI here.
18 changes: 10 additions & 8 deletions en/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ There's a lot to be uncovered here. While we're improving this documentation, we

## <a name="context"></a>Journal

Configure basic details about the journal, including the masthead, contact information, and sections.
Enter basic details about the journal, including the journal name, a short description, the masthead, contact information, and the sections the journal publishes.

**Sections** allow journals to publish submissions to different sections of the journal, such as Reviews and Articles.

## <a name="website"></a>Website

Expand All @@ -32,7 +34,7 @@ Some of the key settings are broken down in detail below.

### <a name="workflow-components"></a>Components

Your publication files may consist of a number of components, including a book-length manuscript or a chapter-length manuscript, as well as illustrations, glossary, index, and more.
Your publication files may consist of a number of components, including a article text, research materials, data sets and more.

When authors and editors upload files to a submission, they will be asked to identify the component of this file.

Expand All @@ -41,28 +43,28 @@ The Components tab provides a list of common components by default. You are enco
Delete those that aren't appropriate for your journal. This will reduce the options faced by authors struggling through their first submission.

### <a name="workflow-submission"></a>Submission
Set your submission guidelines here. You can also modify the submission checklist, which all authors must agree to for their submission.
Set your submission guidelines here. You can also modify the submission checklist, which all authors must agree to for their submission.

Submission Metadata allows you to select which types of metadata you wish to track in your journal, and which metadata fields you wish to present to authors upon their submission.

### <a name="workflow-review"></a>Review
From here, you can set all of your review policies and procedures, including deadlines, notifications, guidelines, etc.

### <a name="workflow-publisher-library"></a>Publisher Library
### <a name="workflow-library"></a>Publisher Library

The Publisher Library provides a file repository for storing and quickly sharing common files, such as writing guidelines, author contracts and release forms, and marketing materials.

Items that are stored in the Journal Library can be quickly retrieved and added into a [Submission Library](editorial-workflow.md#submission-library) to be shared with authors or assistants.
Items that are stored in the Publisher Library can be quickly retrieved and added into a [Submission Library](editorial-workflow.md#submission-library) to be shared with authors or assistants.

### <a name="workflow-emails"></a>Emails

OJS sends a number of emails during various stages of the [Editorial Workflow](editorial-workflow.md), as well as other actions such as registration and submission acknowledgement.

The settings in this section allow you to tailor the common header and signature that accompany those emails, as well as update the email defaults for each type of email that's sent out.
The settings in this section allow you to edit the signature attached to each email, as well as change the default messages sent for each type of email.

If you're unsure what a particular email is for, spin out it's context menu by clicking the toggle to the left of the email, and then click **Edit Email**. Most emails include a short description of when they're sent.

*If you want to restore an email template to it's default, use the __Reset__ link to restore defaults.*
*If you want to restore an email template to it's default, use the __Reset__ link to restore the default message.*

## <a name="distribution"></a>Distribution

Expand All @@ -74,4 +76,4 @@ In the Permissions tab, you'll find settings for asserting copyright and author

The copyright identifies the author or owner of copyright for a published work. For example, Copyright (c) 2016 by Jane Smith.

The license attached to a work will determine the usage rights for the published work. For example, CC-By 4.0 allows the work to be copied, redistributed and adapted for any purpose, even commercially, as long as attribution is given to the copyright holder.
The license attached to a work will determine the usage rights for the published work. For example, CC-By 4.0 allows the work to be copied, redistributed and adapted for any purpose, even commercially, as long as attribution is given to the copyright holder.
2 changes: 1 addition & 1 deletion en/submissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Other editorial or administrative staff can view the **My Assigned** panel, whic

All users can view the **My Authored** panel, which includes only your own submissions.

## <a name="active"></a>All Active
## <a name="active"></a>Active

Find any submission in the system that hasn't been published or declined. Only editorial and administrative users have access to this tab.

Expand Down
Empty file removed en/users-and-roles
Empty file.
30 changes: 13 additions & 17 deletions en/users-and-roles.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,27 @@
# Users and Roles

1. Introduction
2. Users
3. Roles
4. Site Access
2. [Users](users-users)
3. [Roles](users-roles)
4. [Site Access](users-site-access)

## Introduction

Use this section to manager your journal's users and their roles.
Manager your journal's users, assign them to roles and create or edit existing roles.

## <a name="users-users"></a> Users
From this page, you can see the full list of your users.

Use the Add User link to create a new user account.
Journal Managers and Administrators can view a list of all users in the journal. You can add users, disable a user, send them email, edit their profile or delete them completely.

Use the Search link to find a user.
The easiest way to find a user is to use the search button, which will allow you to search by name or role.

*Tip: To find a list of all authors, use the Search feature, leave the search field empty, and select Author from the dropdown menu. Hit the Search button.
*To find a list of all authors, use the Search feature, leave the search field empty and select Author from the dropdown menu. Then click the Search button.*

## <a name="users-roles"></a> Roles

OJS offers a flexible user role system that allows you to tailor the roles to your needs. On the Roles tab, you'll see a list of default roles created by the system.
User roles govern who can access what in the editorial worfklow.

A flexible user role system is provided so that you can tailor the roles to your needs. On the Roles tab, you'll see a list of default roles created by the system.

There are many roles and most journals won't need all them. Feel free to delete roles you won't use in your workflow.
There are many roles and most journals won't need all of them. Feel free to delete roles you won't use in your workflow.

You can edit or remove existing roles, or add new roles. All roles are given one of a few permission levels which allow them to perform various actions in the system:

Expand All @@ -32,11 +31,8 @@ You can edit or remove existing roles, or add new roles. All roles are given one
- *Journal Managers* have access to the entire [Editorial Workflow](editorial-workflow.md), as well as most of the settings.
- *Series Editors* and *Journal Assistants* can access only those parts of the [Editorial Workflow](editorial-workflow.md) assigned to their role (see below).

In addition to the permission levels, you can restrict some roles to particular stages of the [Editorial Workflow](editorial-workflow.md). This is useful for professional assistants such as copyeditors or layout managers, who may assist during one or two stages of the workflow.

## <a name="users-site-access-options"></a> Site Access Options
In addition to the permission levels, you can restrict some roles to particular stages of the [Editorial Workflow](editorial-workflow.md). This is useful for professional assistants such as copyeditors or layout managers who may assist during one or two stages of the workflow.

## <a name="users-site-access"></a> Site Access Options

Under the Site Access tab, you can turn off public user registration, or event limit access to the reader-facing site to registered users.


0 comments on commit 9d3a60c

Please sign in to comment.