Back office colour system

docs/md/back-office-colours.md

@@ -0,0 +1,29 @@
+# Back office colours
+
+The Janeway back office has a minimal colour system with a primary colour, a secondary colour, an alert colour, and warm white and black shades for backgrounds and text.
+
+The colours are set up in `src/static/admin/css/settings.css`. That file contains both named colours (e.g. `--clr-red`) and semantic variables (e.g. `--clr-alert`). Other files in `src/static/admin/css/` should call the semantic variables.
+
+## Text and icons
+
+Text and icons should generally be in black, or blue for links. Text on buttons should use the `-on-dark` semantic colour.
+
+## Buttons
+
+Primary buttons (blue) are the most important action on the page, like saving a form, creating an assignment when an article has arrived in a new workflow stage, or completing an action. There should only be one primary button per screen, in general.
+
+Secondary buttons (dark tan) are other actions the user can take, but they are not the expected main action. Sometimes a page only contains secondary buttons, if there is no clear action that we want to emphasize over the others.
+
+Warning or alert buttons (red) should be used only for destructive actions, like deleting a file or data. They should not be used for non-destructive actions like declining a request, rejecting a proposal, or cancelling an action, since these are often the normal business of running a journal, and belong to the secondary colour category. The warning/alert style is intentionally less vibrant, since the red colour would otherwise draw too much attention. There is no separation between warning and alert--they use the same colour.
+
+For common use cases like saving, deleting, or sending, there are includable button templates in `templates/admin/elements`. These should be used wherever possible to keep the codebase smaller and more maintainable.
+
+Some buttons have no style as such. For example, buttons within a `div.title-area` wrapper do not have any style applied. Links in the workflow actions box also just appear as black text with their respective icons. Icon-based links within tables are also not styled as buttons, but eventually these elements should be expanded to be more accessible with both icon and text.
+
+## Callouts
+
+The Bootstrap set of callouts should be used when a callout is desired (e.g. `bs-callout bs-callout-warning`). These have the most accessible style, with a single thick bar of colour down the left-hand side, and no change to the background that could affect text contrast.
+
+## Toasts
+
+The toastr widget that displays Django messages in the bottom right uses just two colours: primary and alert/warning.

docs/md/manual-ui-testing.md

@@ -0,0 +1,26 @@
+# Manual user interface testing
+
+This guide offers tips for testing Janeway manually during development.
+
+## Using multiple accounts and roles
+
+When testing a user interface manually, you often need to be logged in with several different accounts that have different roles.
+
+You can use Firefox container tabs to switch quickly between roles.
+
+## Testing on a phone or other device at home
+
+When you are on secure local network, you can run the Janeway local server in such a way that you can test it on other devices.
+
+1. Run your development server with an additional argument to specify an IP of four zeroes, and the same port as normal: `python src/manage.py 0.0.0.0:8000`.
+
+2. Find out the IP address of your development machine on your local network. On Linux this can be done with the `ip` utility by running `ip r`. An example: `192.168.68.121`.
+
+3. Create a Domain Alias record in the Janeway admin interface (go to `localhost:8000/admin/core/domainalias`).
+  - Enter the IP address from the previous step in the **Domain** field. An example: `192.168.68.121`.
+  - Leave the **Is secure** field unticked.
+  - Untick the **301** field, since you do not want Janeway to redirect devices that access this IP.
+  - Select the journal or press site that you want to access.
+  - Save the domain alias.
+
+4. Visit this IP and port on your other device(s). For example, go to `192.168.68.121:8000`.

src/core/janeway_global_settings.py

@@ -666,6 +666,8 @@ def __len__(self):
     "branding": False,
     "convert_urls": False,
     "menubar": "edit view insert format tools table help",
+    "skin": "tinymce-alpha",
+    "skin_url": STATIC_URL + "/common/css/tinymce-alpha",
     "content_css": STATIC_URL + "/admin/css/admin.css",
     "plugins": "advlist autolink lists link image charmap preview anchor searchreplace visualblocks code"
     " fullscreen insertdatetime media table code help wordcount spellchecker help",

src/core/views.py

@@ -2493,6 +2493,7 @@ def pinned_articles(request):
     Allows an Editor to pin articles to the top of the article page.
     :param request: HttpRequest object
     """
+    warnings.warn("The pinned articles feature is deprecated.")
     pinned_articles = journal_models.PinnedArticle.objects.filter(
         journal=request.journal
     )

src/install/views.py

@@ -3,6 +3,8 @@
 __license__ = "AGPL v3"
 __maintainer__ = "Birkbeck Centre for Technology and Publishing"
 
+import warnings
+
 from django.shortcuts import render, redirect
 from django.contrib.admin.views.decorators import staff_member_required
 from django.urls import reverse
@@ -18,6 +20,7 @@ def index(request):
     :param request: HttpRequest object
     :return: HttpResponse or if request.POST: HttpRedirect
     """
+    warnings.warn("The GUI install process is deprecated.")
     if request.POST:
         file = request.FILES.get("press_logo")
         file = files.save_file_to_press(request, file, "Press Logo", "")
@@ -39,6 +42,7 @@ def journal(request):
     :param request: HttpRequest object
     :return: HttpResponse object
     """
+    warnings.warn("The GUI install process is deprecated.")
     settings_to_get = [
         "journal_name",
         "journal_issn",
@@ -75,6 +79,7 @@ def next(request):
     :param request: HttpRequest object
     :return: HttpResponse object
     """
+    warnings.warn("The GUI install process is deprecated.")
     template = "install/next.html"
     context = {}
 

src/repository/views.py

@@ -1574,7 +1574,7 @@ def repository_wizard(request, short_name=None, step="1"):
         if form.is_valid():
             updated_repository = form.save()
 
-            # If we reach step 4, redirect to the Repo home page.
+            # If we reach step 5, redirect to the Repo home page.
             if step == "5":
                 messages.add_message(
                     request,

src/review/models.py

@@ -346,39 +346,34 @@ def status(self):
             return {
                 "code": "withdrawn",
                 "display": "Withdrawn",
-                "span_class": "red",
                 "date": "",
                 "reminder": None,
             }
         elif self.date_complete and self.date_accepted:
             return {
                 "code": "complete",
                 "display": "Complete",
-                "span_class": "light-green",
                 "date": shared.day_month(self.date_complete),
                 "reminder": None,
             }
         elif self.date_accepted:
             return {
                 "code": "accept",
                 "display": "Yes",
-                "span_class": "green",
                 "date": shared.day_month(self.date_accepted),
                 "reminder": "accepted",
             }
         elif self.date_declined:
             return {
                 "code": "declined",
                 "display": "No",
-                "span_class": "red",
                 "date": shared.day_month(self.date_declined),
                 "reminder": None,
             }
         else:
             return {
                 "code": "wait",
                 "display": "Wait",
-                "span_class": "amber",
                 "date": "",
                 "reminder": "request",
             }