Skip to content

Commit 05067c8

Browse files
docs: update with toc and images
1 parent 2be87b1 commit 05067c8

File tree

1 file changed

+92
-16
lines changed

1 file changed

+92
-16
lines changed

README.md

Lines changed: 92 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,24 @@
44
[![OJS](https://img.shields.io/badge/OJS-3.5.0.1+-green.svg)](https://pkp.sfu.ca/ojs/)
55
[![License](https://img.shields.io/badge/license-GPL--3.0-blue.svg)](LICENSE)
66

7+
## Table of Contents
8+
9+
- [Overview](#overview)
10+
- [Features](#features)
11+
- [Requirements](#requirements)
12+
- [Installation](#installation)
13+
- [Configuration](#configuration)
14+
- [Setting Up Issues](#setting-up-issues)
15+
- [Author Submission Workflow](#author-submission-workflow)
16+
- [Technical Details](#technical-details)
17+
- [Development](#development)
18+
- [Support](#support)
19+
- [Contributing](#contributing)
20+
- [License](#license)
21+
722
## Overview
823

9-
The Issue Preselection Plugin allows authors to select which journal issue their submission should be assigned to during
10-
the submission process. Editors can configure which issues are open for submissions and pre-assign guest editors who
11-
will automatically be assigned to incoming submissions.
24+
The Issue Preselection Plugin allows authors to select which journal issue their submission should be assigned to during the submission process. Editors can configure which issues are open for submissions and pre-assign guest editors who will automatically be assigned to incoming submissions.
1225

1326
## Features
1427

@@ -55,23 +68,86 @@ Then enable via the OJS admin interface as described above.
5568

5669
### Setting Up Issues
5770

58-
1. Navigate to **Issues > Future Issues**
59-
2. Click **Edit** on an issue you want to configure
60-
3. You'll see two new fields:
61-
- **Enable for Submission**: Check to make this issue available for author selection
62-
- **Assigned Editors**: Select one or more editors to automatically assign to submissions
71+
**Step 1: Navigate to Future Issues**
72+
73+
Navigate to **Issues > Future Issues**
74+
75+
<img width="800" alt="Issues Future Issues" src="https://github.com/user-attachments/assets/4272ef1f-99c8-41a2-82b8-6635df05a892" />
76+
77+
**Step 2: Create or Edit an Issue**
78+
79+
Click **Create** or **Edit** on an issue you want to configure
80+
81+
<img width="800" alt="Create or Edit Issue" src="https://github.com/user-attachments/assets/87174d46-2cea-44f8-a2a1-17da128cb721" />
82+
83+
**Edit** is shown after expanding the view by clicking on the triangular bullet to the left of the issue. You can also click on the name directly.
84+
85+
<img width="800" alt="Issue Options" src="https://github.com/user-attachments/assets/a5bb768d-a66b-4de7-861f-681eea1ec99f" />
86+
87+
**Step 3: Configure Issue Data**
88+
89+
You'll see two new fields under **Issue Data**
6390

64-
4. Click **Save**
91+
<img width="800" alt="Issue Data Fields" src="https://github.com/user-attachments/assets/cfa5bb5e-c359-44a3-bddd-73e04fbc0d60" />
92+
93+
- **Enable for Submission**: Check to make this issue available for author selection
94+
- **Assigned Editors (Optional)**: Select one or more editors to automatically assign to submissions
95+
96+
**Step 4: Save Changes**
97+
98+
Click **Save**
6599

66100
### Author Submission Workflow
67101

68-
1. Author clicks "New Submission"
69-
2. In the "For the Editors" step, they see an "Issue Selection" dropdown
70-
3. Author selects the target issue
71-
4. Upon submission:
72-
- Publication is scheduled to the selected issue
73-
- All pre-assigned editors are added as Guest Editors
74-
- Editors receive notifications
102+
**Step 1: Start New Submission**
103+
104+
Author clicks "New Submission"
105+
106+
**Step 2: View Issue Selection**
107+
108+
In the "For the Editors" step, they see an "Issue Selection" dropdown
109+
110+
<img width="800" alt="Issue Selection Dropdown" src="https://github.com/user-attachments/assets/d7190468-beb8-4302-9964-9a888f5b724d" />
111+
112+
**Step 3: Select Target Issue**
113+
114+
Author selects the target issue
115+
116+
<img width="800" alt="Target Issue Selection" src="https://github.com/user-attachments/assets/c76d480b-bb46-473d-8630-ddae10c78fff" />
117+
118+
**Step 4: Validation - Missing Issue Selection**
119+
120+
If the author does not select an issue, an error notification appears
121+
122+
<img width="800" alt="Error Notification" src="https://github.com/user-attachments/assets/49c0a0f2-5e78-4fe5-a8cd-9f3ec14c86fe" />
123+
124+
**Step 5: Navigation - Back Button**
125+
126+
On clicking Back
127+
128+
<img width="800" alt="Back Navigation" src="https://github.com/user-attachments/assets/d0625957-06c3-440f-95b4-f1f995dc5694" />
129+
130+
**Step 6: Validation - Success**
131+
132+
Successful validation
133+
134+
<img width="800" alt="Successful Validation" src="https://github.com/user-attachments/assets/472fce93-b549-48bb-a47d-4b903e253fef" />
135+
136+
**Step 7: Publication Scheduled**
137+
138+
Upon submission, publication is scheduled to the selected issue
139+
140+
<img width="800" alt="Publication Scheduled" src="https://github.com/user-attachments/assets/d540f744-3ccc-418a-8002-76e59a6566d2" />
141+
142+
**Step 8: Guest Editors Added**
143+
144+
All pre-assigned editors are added as Guest Editors
145+
146+
<img width="400" alt="Guest Editors Added" src="https://github.com/user-attachments/assets/8fd7ef5b-319c-4dc8-8e43-e9d94a763523" />
147+
148+
**Step 9: Notifications Sent**
149+
150+
Editors receive notifications
75151

76152
## Technical Details
77153

0 commit comments

Comments
 (0)