Merge branch 'master' into gui_coding_copyedit

Author: KathrynBaker

doc/Editing-the-Wiki.md

@@ -100,6 +100,42 @@ You can then add the image in markdown using the URL `test.png`:
 
     ![alternative text](test.png)
 
+## Mermaid Diagrams
+Mermaid diagrams can be added using the following syntax (example):
+````
+```{mermaid}
+---
+title: Simple sample
+---
+stateDiagram-v2
+    [*] --> Document
+    Develop_software --> Document
+    Document --> Develop_software
+    Develop_software --> Test_software
+    Test_software --> Crash
+    Crash --> Develop_software
+    Test_software --> [*]
+```
+````
+
+will render as:
+```{mermaid}
+---
+title: Simple sample
+---
+stateDiagram-v2
+    [*] --> Document
+    Document --> Develop_software
+    Develop_software --> Document
+    Develop_software --> Test_software
+    Test_software --> Crash
+    Crash --> Develop_software
+    Test_software --> [*]
+```
+
+
+The Mermaid syntax is documented [here](https://mermaid.js.org/intro/syntax-reference.html).
+
 ## Spellchecking
 
 The wiki has a built-in spellchecker, which will automatically run when a commit

doc/Glossary.md

@@ -32,6 +32,11 @@ A method of changing the internal parameters of an emulator to mimic the behavio
 
 Slits used on each of the Muon instruments to control the neutron flux to the sample.  Each "jaw" pivots on one edge, much like a door on a hinge.
 
+## BDD
+
+Behaviour-driven development. See the [Agile Alliance definition of BDD](https://www.agilealliance.org/glossary/bdd/),
+and [how we use BDD for testing in Squish](/client/testing/System-Testing-with-Squish-BDD).
+
 ## Block
 
 ## Block Archive

doc/Providing-Support.md

@@ -132,7 +132,7 @@ There are a number of tips for [trouble shooting](#all_troubleshooting_links) al
   1. I can't use this button to get to more details/why doesn't this bit of the OPI work
       - Check they are in manager mode
   1. I need to add this device to my system
-      - Check [the user manual](https://github.com/ISISComputingGroup/ibex_user_manual/wiki) for IBEX, for SECI, if you don't know already ask someone else
+      - Check {external+ibex_user_manual:doc}`the user manual <index>` for IBEX, for SECI, if you don't know already ask someone else
   1. My motor won't move
       - Are both limits made?
           - Yes: Something has happened in the physical realm, refer it to EUSG via the MCR
@@ -178,7 +178,7 @@ There are a number of tips for [trouble shooting](#all_troubleshooting_links) al
   <summary>Script issues</summary>
 
   1. My script won't load
-     - If `g.load_script` is being used and you see errors of the form `E:  1: error description (error-name)`, these errors are coming from the linter. Detailed linter troubleshooting is available [here](https://github.com/ISISComputingGroup/ibex_user_manual/wiki/Error-Checking-Troubleshooting).
+     - If `g.load_script` is being used and you see errors of the form `E:  1: error description (error-name)`, these errors are coming from the linter. Detailed linter troubleshooting is available {external+ibex_user_manual:doc}`here <scripting/Error-Checking-Troubleshooting>`.
   1. My script isn't behaving in the way I expect it to
      - This is a best efforts, and not everyone can provide the same level of support
      - Look at it with respect to basic coding standards and obvious race condition points

doc/_static/css/custom.css

@@ -12,3 +12,16 @@ a:hover {
 .wy-nav-content {
     max-width: 1200px !important;
 }
+
+@keyframes highlight {
+    0% {
+        background: #01afec;
+    }
+    100% {
+        background: none;
+    }
+}
+
+:target {
+    animation: highlight 3s;
+}

doc/client/testing/Adding-Unit-Tests.md

@@ -1,33 +1,35 @@
 # Adding tests
 
-For more detailed information see [an_introduction_to_unit_testing.rst](An-Introduction-to-Unit-Testing).
+:::{seealso}
+- [Introduction to unit testing](An-Introduction-to-Unit-Testing)
+:::
 
-It is relatively simple to add unit tests for a plug-in in such a way that maven can run them as part of the build.
-
-Here are the steps required in Eclipse:
+The steps required to add unit tests for a plugin are:
 
 * Create a new Fragment Project
     * File > New > Project... > Plug-in Development > Fragment Project
-    * Set the project name to `\<the full name of the plug-in to test\>.tests`
-    * Change the location to the repository rather than the workspace: `xxx\ibex_gui\base\\\<project_name>` (don't forget the project name!!)
+    * Set the project name to `<the full name of the plug-in to test\>.tests`
+    * Change the location to the repository rather than the workspace: `ibex_gui\base\<project_name>` (don't 
+forget the project name!)
     * Click "Next"
-    * Make sure the Execution Environment points at the correct version of Java (currently JavaSE-11)
+    * Make sure the Execution Environment points at the correct version of Java
     * Click the "Browse" button next to "Plug-in ID" 
     * Select the plug-in to test and click "OK"
     * Finish
 
-* In the newly created plug-in, add a new Package with the same name as the plug-in or something equally sensible.
+* In the newly created plug-in, add a new Package with the same name or structure as the plug-in.
     * Select the plug-in
     * File > New > Package
     * Enter the name and click "Finish"
 
 * In the new Package create a class for adding test
     * Select the Package
     * File > New > Class
-    * The class name **must** end in Test to be picked up by the automated build
+    * The class name **must** end with `Test` to be picked up by the automated build
 
 * Add tests to the class
-    * Add `org.junit` and `org.mockito` (if required) to the 'Required Plug-ins', under the Dependencies tab for the manifest
+    * Add `org.junit` and `org.mockito` (if required) to the 'Required Plug-ins', under the Dependencies tab for the
+manifest (`MANIFEST.MF`)
 
 * Add the test plug-in to the Maven build by [following these steps](../coding/Adding-a-Plugin-or-Feature-to-Maven-Build)