Initial fork from OMP manual

LANGS.md

@@ -0,0 +1,4 @@
+* [English](en/)
+* [Español](es/)
+* [French](fr/)
+* [German](de/)

README.md

@@ -0,0 +1,4 @@
+OJS 3.0 User Guide
+=======
+
+The OJS 3.0 User Guide provides context-sensitive help from within the application.

book.json

@@ -0,0 +1 @@
+{}

en/README.md

@@ -0,0 +1,7 @@
+#OJS 3.0 User Guide
+
+This guide will help you publish journals and issues with Open Journal Systems.
+
+It provides an introductory overview for each stage of the workflow from submission to production. It also provides further background information on some of the configuration options.
+
+When you see **Help** links within the application, they'll open a help panel with the most useful information for that section.

en/SUMMARY.md

@@ -0,0 +1,17 @@
+# Summary
+
+* [Introduction](README.md)
+* [User Profile](user-profile.md)
+* [Authoring](authoring.md)
+* [Reviewing](reviewing.md)
+* [Managing Submissions](submissions.md)
+* [Editorial Workflow](editorial-workflow.md)
+   * [Submission Stage](editorial-workflow/submission.md)
+   * [Review Stages](editorial-workflow/review.md)
+   * [Copyediting](editorial-workflow/copyediting.md)
+   * [Production](editorial-workflow/production.md)
+* [Issue Management](issue-management.md)
+* [Tasks](tasks.md)
+* [Settings](settings.md)
+* [Tools](tools.md)
+* [Administration](administration.md)

en/administration.md

@@ -0,0 +1,37 @@
+# Administration
+
+1. Introduction
+2. [Hosted Presses](administration.md#hosted-journals)
+3. [Administrative Functions](administration.md#admin-functions)
+
+Site administration is limited to users with full system permissions. Administration tasks are infrequent and may be carried out by a journal manager, senior editor, or a dedicated site administrator.
+
+## <a name="hosted-journals"></a>Hosted Presses
+
+Add, edit or remove journals hosted on this installation. There will only be one journal in most cases, but you can host multiple journals with a single installation.
+
+Administrators, journal managers or senior editors can access a **Settings Wizard** for each hosted journal, which will walk you through the basic journal setup steps. These include setting up the masthead, contact details, site appearance, submission parameters, indexing details and users.
+
+## <a name="admin-functions"></a>Administrative Functions
+
+Several administrative functions are available in the site administration area. These should be used with caution by technical administrators. Improper use could lead to unexpected results.
+
+### System Information
+
+Detailed information about the software version and server configuration. These details are useful for receiving support on the PKP Forums.
+
+### Expire User Sessions
+
+This link will log all users out of the system immediately. This can be useful just before conducting a software upgrade.
+
+### Clear Data Caches
+
+Clears all cached data, including locale information, help cache, and search cache.
+
+### Clear Template Cache
+
+Clears all cached versions of HTML templates. This function may be useful to force templates to be reloaded after customizations have been made.
+
+### Clear Scheduled Task Execution Logs
+
+Remove log files generated automatically by some scheduled maintenance tasks, such as the processing of statistics.

en/authoring.md

@@ -0,0 +1,63 @@
+# Authoring
+
+1. Introduction
+2. [Make a Submission](authoring.md#make-submission)
+3. [Track your Submission](authoring.md#track-submission)
+
+This chapter will help authors make a new submission and participate in the editorial workflow as it is reviewed, edited and eventually published.
+
+Before you can begin a new submission, you'll need to register for a user account with the site and login.
+
+## <a name="make-submission"></a>Make a Submission
+
+To start a new submission, click the **Submission** link from the left-hand navigation menu and then click the **New Submission** button on the right.
+
+*If you're logged in, but you don't see the editorial interface, you may be viewing the reader-facing website. If that's the case, find your user profile link and click on the Submissions link which appears below it. Each website may be different.*
+
+Making a new submission is an easy-to-follow 5-step process. Follow along with the on-screen instructions to complete the process.
+
+### <a name="prepare"></a>Prepare
+
+Provide initial information and confirm that you've followed the requirements before beginning your submission.
+
+### <a name="upload"></a>Upload
+
+Upload your submission files. Each file needs to be assigned a particular component, which helps organize the files for large projects.
+
+You'll upload each of your files one at a time, naming each one before moving onto the next file. If you have chapter-specific files, rather than one large manuscript, you can hold onto those files for now. You'll have an opportunity later to upload them and associate them with each chapter.
+
+ You can go back at any time during the submission to add more files, and you'll have a separate opportunity to upload chapter-specific files if you have separate
+
+*When asked to name the file, it's recommended that you do not include your name. Otherwise, editors will have to strip this out before sharing it with reviewers.*
+
+### <a name="catalog"></a>Catalog
+
+Add your submission details, such as title and abstract. You'll also have an opportunity to define chapters for your book and, if there are multiple authors, add contributors.
+
+If you're submitting an edited volume with different authors for each chapter, you can associate contributors with each chapter from the chapter editing screen.
+
+### <a name="confirmation"></a>Confirmation
+
+Take a moment to confirm the details you've entered. At this point, you can jump back to any of the previous steps to change the details you've entered.
+
+### <a name="next-steps"></a>Next Steps
+
+You've done it! If you want to read more about tracking your submission, read the next section.
+
+## <a name="track-submission"></a>Track your Submission
+
+When your submission is under consideration, you can keep an eye on it's status by logging into the website and going to the [Submissions](submissions.md) page.
+
+Here you'll find you submissions listed with the current stage of the editorial workflow it is in. Click the stage name to interact with that stage.
+
+### <a name="track-submission-discussions"></a>Discussion Panels
+
+In each stage you'll have access to a discussion area. If an editor or editorial assistant needs more information from you, they'll be able to open a discussion. When that happens, you'll be notified by email so that you can respond.
+
+*You won't be able to initiate discussions on most stages, but they'll appear if one has been initiated by the editors.*
+
+### <a name="track-submission-review"></a>Review Stages
+
+During the review stages, you'll see a status update at the top, which will keep you informed as reviewers are recruited, assigned and submit their reviews.
+
+Dyring the review stages, you may be asked to submit revisions which address any concerns raised. If needed, you'll find a Revisions panel where you can upload new files for the editor.

en/editorial-workflow.md

@@ -0,0 +1,48 @@
+# Editorial Workflow
+
+1. Introduction
+2. [Managing Submission Details](editorial-workflow.md#manage-submission-details)
+3. [Participants](editorial-workflow.md#participants)
+4. [Editorial Actions](editorial-workflow.md#editorial-actions)
+
+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.
+
+Each tab on the workflow page provides you with the information, tools and discussion panels you'll need to complete the tasks for that stage. You can [add participants](editorial-workflow.md#participants) to help you. And when your ready, you'll be presented with a range of [editorial actions](editorial-workflow.md#editorial-actions) appropriate to each stage.
+
+## <a name="manage-submission-details"></a>Managing Submission Details
+
+Submission details appear at the top of the page. In this area, you'll also find tools to help you manage the submission's metadata and editorial history. The data attached to the submission from these tools persists across all stages.
+
+### <a name="catalog-entry"></a>Catalog Entry
+
+List a submission in your catalog and manage key data about the submission, including the Title and Abstract, assigned categories and series, and any metadata that's been enabled by the administrator.
+
+The **Submission** tab covers the metadata that is used for indexing your content in discovery services like Google Scholar. And the **Publication** tab will allow you to enter sales and marketing information.
+
+**FIXME** When you're ready to display a submission in your catalog, visit **Catalog Entry > Catalog** and check the box labeled *Add this book to the public catalog*.
+
+Once you've [added publication formats](editorial-workflow/production.md), you'll see new tabs for each format which will allow you to enter format-specific metadata.
+
+### <a name="editorial-history"></a>Editorial 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 [Journal Library](settings.md#workflow-journal-library) by clicking on **View Document Library**.
+
+## <a name="participants"></a>Participants
+
+On the right of each stage of the workflow, you'll find a list of users who have access to this stage. You can add editorial assistants, copyeditors, layout editors or other users you'd like to have access to the current stage.
+
+*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.
+
+## <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.
+
+Read the help guide for each stage to learn more about the editorial actions.

en/editorial-workflow/copyediting.md

@@ -0,0 +1,43 @@
+# Copyediting
+
+1. Introduction
+2. [Orientation](copyediting.md#orientation)
+3. [Editorial Actions](copyediting.md#editorial-actions)
+
+During the Copyediting stage, the editor assigns a copyeditor to edit the submission files.
+
+The copyeditor, who is often a professional, will align the writing style with your editorial guidelines, improve the quality and clarity of the writing, fix any grammar, and get the submission ready for conversion to a [publication format](production.md).
+
+This is the last stage before you generate publication-ready formats such as PDFs and ePubs. If you do not have the resources to hire a professional copyeditor, use this stage to take a close look at the material, check any facts, correct any errors and communicate with the author to clarify any points of confusion.
+
+Add copyeditors from the [participants panel](../editorial-workflow.md#participants).
+
+## <a name="orientation"></a>Orientation
+
+The Copyediting stage provides three panels for managing the copyediting process.
+
+### <a name="draft-files"></a>Draft Files
+
+All files selected by the editor for copyediting. These are typically files that have been revised as a result of the review process.
+
+### <a name="copyediting-discussions"></a>Copyediting Discussions
+
+Editors and copyeditors can use this panel to initiate discussions with the author(s), or communicate between themselves. This can be used to clarify points of confusion, request further information from the author, or request approval for any changes.
+
+### <a name="copyedited"></a>Copyedited
+
+Copyeditors can upload final edited files to this panel. These should be completed files that are ready to be [sent to production](copyediting.md#editorial-actions).
+
+*Editors can upload files here, too.*
+
+### <a name="participants"></a>Participants
+
+Editors can add copyeditors from this panel. [Learn more](../editorial-workflow.md#participants).
+
+## <a name="editorial-actions"></a>Editorial Actions
+
+There's only one editorial decision available to editors at this stage. If you decide to decline a submission at this late stage, you can do so by going back to a previous stage.
+
+### <a name="production"></a>Send to Production
+
+The editor can send the submission to the [Production stage](production.md) when final, copyedited files are ready. Any files in the [Copyedited](copyediting.md#copyedited) panel will automatically be forwarded unless the editor chooses not to send them.

en/editorial-workflow/production.md

@@ -0,0 +1,86 @@
+# Production
+
+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.
+
+## <a name="orientation"></a>Orientation
+
+The Production stage provides three panels to create files ready for publication.
+
+### <a name="production-ready"></a>Production Ready Files
+
+All files selected by the editor for production will appear here. These typically include files that have been prepared during the [Copyediting stage](copyediting.md). Production assistants will use these files to generate the final publication formats.
+
+### <a name="production-discussions"></a>Production Discussions
+
+Editors and production assistants can use this panel to initiate conversations, if there are any details that need to be clarified before the final publication formats can be created.
+
+### <a name="publication-formats"></a>Publication Formats
+
+Editors and production assistants can create publication formats and upload files to each format. Learn more about [publication formats](production.md#understanding-publication-formats).
+
+Once publication formats have been created and files have been uploaded, you can begin the approval process to [publish the submission](production.md#publish).
+
+### <a name="participants"></a>Participants
+
+Editors can add copyeditors from this panel. [Learn more](../editorial-workflow.md#participants).
+
+## <a name="understanding-publication-formats"></a>Understanding Publication Formats
+
+Each format represents one type of file (PDF, ePub), and may have multiple files attached to it, such as separate chapter files or supplementary data.
+
+### Organizing Your Publication Formats
+
+How you choose to organise your publication formats 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 monograph might have one publication format named ePub with a single `.epub` file uploaded to it. It might have another publication format named PDF with separate `.pdf` files uploaded to it for each chapter and supplementary data.
+
+In this case, you'd create two Publication Formats, ePub and PDF, and upload the files separately under each Publication Format.
+
+If you publish physical volumes alongside your digital offering, you can create entries for these as well. You can upload files to these publication formats if you'd like and they will be displayed for download. This is not common, but might be used for a printable order form if you do not have an online sales platform.
+
+### <a name="publication-format-metadata"></a>Managing Your Publication Format Metadata
+
+Each publication format has it's own set of metadata, including DOIs, to comply with indexing services like Google Scholar. You're encouraged to complete the metadata relevant to your needs.
+
+Once you've created a publication format, you'll find a new tab in the [Catalog Entry](../editorial-workflow.md#catalog-entry) panel. To access this panel, look above the stages in the editorial workflow and find the submission title and author.
+
+Click the **Catalog Entry** link in this area and you'll find a tab for each of your publication formats.
+
+## <a name="publish"></a>Publishing the Submission
+
+OMP offers a flexible publishing workflow which allows you to publish just the parts you want, when you want. That means there are separate levels of control for the catalog entry, each publication format, and even each file within a publication format.
+
+To help guide you through the last steps of the publishing process, each of these levels is described below.
+
+### Catalog Entry
+
+An entry can be created for this submission in the catalog at any time during the editorial workflow. This is often used to list forthcoming publications before they've made it through the final publication process.
+
+To add an entry, go to the **Catalog Entry > Catalog** panel and check the box labeled *Add this book to the public catalog*. You'll find the **Catalog Entry** link at the top, near the submission title and author.
+
+*Nothing will appear in your catalog until you've created a catalog entry, even if you've approved publication formats.*
+
+### Publication Formats
+
+Each publication format will have a two-step approval process.
+
+The first checkbox, which says "Awaiting Approval", is for editors to sign off when the [publication format's metadata](production.md#publication-format-metadata) is ready for publication.
+
+The second checkbox, which says "Not Available", is for approving the publication format for display to readers. Once this checkbox is toggled, any approved files will be shown to the user.
+
+*If a publication format has no approved files, it will not appear in the catalog.*
+
+### Publication Format Files
+
+Files are uploaded to each publication format and need to be approved separately.
+
+The first checkbox, which says "Awaiting Approval", is for editors to sign off on the file's readiness for publication.
+
+The second checkbox, which says "Set Terms", controls the terms under which the file is displayed to readers. You'll need to set this to something other than "No Access" before the file will be shown in the catalog entry.