Skip to content

Commit 02f1b91

Browse files
committed
Link to other files, rather than using inline code to refer to them
1 parent d0ba9ff commit 02f1b91

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

DevDocs/DeveloperNotes/GettingStarted/NewEditorPlugin.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ the user to search, filter, and select, and finally inserts the generated HTML
3232
into the document.
3333

3434
## Step 1: Apps page & Authentication
35-
- See .../../../src/main/webapp/ui/src/eln/apps/AddingANewIntegration.md for the front-end changes needed
35+
- See [/src/main/webapp/ui/src/eln/apps/AddingANewIntegration.md](/src/main/webapp/ui/src/eln/apps/AddingANewIntegration.md) for the front-end changes needed
3636
- Pick a colour based on the branding of the organisation that provides the service
3737
- Even if no authentication is required and plugin is not supported by ResearchSpace,
3838
adding it to the bottom section will make it visible to researchers
@@ -82,13 +82,13 @@ should go. In most cases, this will involve displaying a dialog, making some API
8282
calls, and having the user make a selection before generating HTML to display,
8383
but before we get to that there are a few more initialisation steps to take care
8484
of.
85-
1. In `src/main/webapp/ui/webpack.config.js` we need to add a new entry point for our new script.
85+
1. In [/src/main/webapp/ui/webpack.config.js](/src/main/webapp/ui/webpack.config.js) we need to add a new entry point for our new script.
8686
We load the plugin through a separate entry point so that it is only downloaded
8787
when the plugin is enabled.
8888
```
8989
tinymceNewPlugin: "./src/tinyMCE/newPlugin/index.js",
9090
```
91-
2. In `src/main/webapp/scripts/pages/workspace/editor/tinymce5_configuration.js`,
91+
2. In [/src/main/webapp/scripts/pages/workspace/editor/tinymce5_configuration.js](/src/main/webapp/scripts/pages/workspace/editor/tinymce5_configuration.js),
9292
we need to add the following code:
9393
* Check whether the plugin is enabled with
9494
```
@@ -103,7 +103,7 @@ of.
103103
addToMenuIfNotPresent(localTinymcesetup, " | optNewPlugin");
104104
}
105105
```
106-
3. A simple SVG needs to be added to `src/main/webapp/scripts/tinymce/tinymce516/icons/custom_icons/icons.js`
106+
3. A simple SVG needs to be added to [/src/main/webapp/scripts/tinymce/tinymce516/icons/custom_icons/icons.js](/src/main/webapp/scripts/tinymce/tinymce516/icons/custom_icons/icons.js).
107107
108108
### Step 2.2: Rendering a react component
109109
The three `onAction` handlers should render a react component. Whilst the
@@ -180,7 +180,7 @@ This is much the same colour as set on the apps page, but with a few variations
180180
to be able to style all of the possible UI elements. There are five colours
181181
which need defining `main`, `darker`, `contrastText`, `background`, and
182182
`backgroundContrastText`. To find out more about how each is used, check out
183-
`src/main/webapp/ui/src/accentedTheme.js`. For a initial value, start by using
183+
[/src/main/webapp/ui/src/accentedTheme.js](/src/main/webapp/ui/src/accentedTheme.js). For a initial value, start by using
184184
this defining as a template, setting the hue to the same value used on the apps
185185
page, above.
186186
```
@@ -217,11 +217,10 @@ Once we've implemented the dialog and any UI elements within you may need to
217217
tweak the saturation and lightness values to ensure there is sufficient contrast
218218
between all textual elements and the background they are shown on. To find out
219219
more about accessibility and contrast ratios, see the section titled "Colour
220-
Contrast" in `./Accessibility.md`. Whilst mentioning accessibility, it is worth
220+
Contrast" in [./Accessibility.md](./Accessibility.md). Whilst mentioning accessibility, it is worth
221221
pointing out that by using an accented theme, we automatically get a high
222222
contrast mode that stips out all of the superfluous colour, should the user wish
223223
to enable it (this is mentioned in the section titled "Accented Theme").
224224
225-
226225
## Step 3: Testing
227226
- How will we know if the plugin stops working e.g. due to API changes/services being down?

0 commit comments

Comments
 (0)