You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: DevDocs/DeveloperNotes/GettingStarted/NewEditorPlugin.md
+6-7Lines changed: 6 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ the user to search, filter, and select, and finally inserts the generated HTML
32
32
into the document.
33
33
34
34
## 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
36
36
- Pick a colour based on the branding of the organisation that provides the service
37
37
- Even if no authentication is required and plugin is not supported by ResearchSpace,
38
38
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
82
82
calls, and having the user make a selection before generating HTML to display,
83
83
but before we get to that there are a few more initialisation steps to take care
84
84
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.
86
86
We load the plugin through a separate entry point so that it is only downloaded
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),
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).
107
107
108
108
### Step 2.2: Rendering a react component
109
109
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
180
180
to be able to style all of the possible UI elements. There are five colours
181
181
which need defining `main`, `darker`, `contrastText`, `background`, and
182
182
`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
184
184
this defining as a template, setting the hue to the same value used on the apps
185
185
page, above.
186
186
```
@@ -217,11 +217,10 @@ Once we've implemented the dialog and any UI elements within you may need to
217
217
tweak the saturation and lightness values to ensure there is sufficient contrast
218
218
between all textual elements and the background they are shown on. To find out
219
219
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
221
221
pointing out that by using an accented theme, we automatically get a high
222
222
contrast mode that stips out all of the superfluous colour, should the user wish
223
223
to enable it (this is mentioned in the section titled "Accented Theme").
224
224
225
-
226
225
## Step 3: Testing
227
226
- How will we know if the plugin stops working e.g. due to API changes/services being down?
0 commit comments