Skip to content

Commit 5d28d65

Browse files
committed
Copyedit building the GUI
1 parent 52e6cea commit 5d28d65

22 files changed

+50
-839
lines changed

doc/Client.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
:glob:
77
:titlesonly:
88
9-
client/GUI-Getting-Started
9+
client/GUI-Building
1010
client/GUI-Coding
1111
client/GUI-Testing
1212
client/GUI-Eclipse

doc/Script-Generator.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ script_generator/*
2222
| Standalone app build directories | `base/uk.ac.isis.scriptgenerator/*` |
2323

2424
## Eclipse build
25-
To build and run the app through eclipse, the script generator product is found in `base\uk.ac.stfc.isis.scriptgenerator.client.product`. The instructions for setting up eclipse and loading the target platform (necessary for the script generator) are found in the instructions for the [main IBEX GUI setup](/client/getting_started/Building-the-GUI)
25+
To build and run the app through eclipse, the script generator product is found in `base\uk.ac.stfc.isis.scriptgenerator.client.product`. The instructions for setting up eclipse and loading the target platform (necessary for the script generator) are found in the instructions for the [main IBEX GUI setup](/client/build/Building-the-GUI)
2626

2727
{#scriptgenerator_enable_perspective}
2828
### Adding the perspective into the client

doc/client/GUI-Building.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Building
2+
3+
```{toctree}
4+
:glob:
5+
:titlesonly:
6+
7+
build/*
8+
```

doc/client/GUI-Getting-Started.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

doc/client/GUI-Troubleshooting.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,15 @@ The following pages also contain GUI troubleshooting information for specific pr
1111
troubleshooting/*
1212
```
1313

14+
## Display resolution & scaling
15+
16+
If the GUI loads up but items are the wrong size, you may need to change your display settings. The exact settings that
17+
you need may vary from computer to computer. This is a common issue on Windows 10 machines due to the OS' scaling
18+
setting for text, icons etc. that is meant to ensure they do not look too small on high screen resolutions.
19+
20+
Generally a resolution of 1920 x 1080 with a scaling factor of 100% should look correct on standard screens. You can
21+
increase both of those settings slightly if you feel like the display elements look uncomfortably small.
22+
1423
## IBEX appears fullscreen with top menu items hidden
1524

1625
Solution: right click inside any OPI and select "exit full screen".
@@ -95,7 +104,6 @@ Add `Eclipse-BundleShape: dir` in the `MANIFEST.MF`; see the `.opis` `MANIFEST.M
95104
This makes the maven build build the directory into a directory rather than a jar, which is sometimes necessary to let eclipse then "see" the files natively on the filesystem. If you look in the `plugins/` folder of a built client you should see a folder for `.opis` but a `.jar` for most other ibex modules - except for a few that need to be built as directories, as you may be finding.
96105

97106

98-
99107
## Other issues
100108
### Remote debugging with Eclipse
101109
The following has been done to ensure that it is possible to debug the IBEX GUI running on any particular instrument:

doc/client/eclipse/Common-Eclipse-Issues.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,13 @@ Sometimes when you check out a new branch in the ibex GUI repository, you won't
122122

123123
1. In Eclipse, remove all the projects from the workspace and close Eclipse.
124124
1. Then, while checked out to the branch you want to see the changes on, perform a `git clean -fdx && git reset HEAD --hard` to reset the git repository. This will remove any changes you have made to the branch.
125-
1. Restart Eclipse and repeat the steps to get the GUI working from [Building the GUI](../getting_started/Building-the-GUI).
125+
1. Restart Eclipse and repeat the steps to get the GUI working from [Building the GUI](../build/Building-the-GUI).
126126

127127
## Build fails with `[ERROR] Failed to resolve target definition ... targetplatform.target: Could not find "org.eclipse.e4.tools.spies.feature.feature.group..." in the repositories of the current location`
128128

129129
This probably means that our pinned target has gone out of date and needs updating. Open the Eclipse IDE and click on `org.eclipse.tools/latest` and click `update` this should fail and show `Unable to locate installable unit ...`. To fix this remove the plugin and then add it from the `software site `, work with `org.eclipse.e4.core.tools.update - http://download.eclipse.org/e4/snapshots/org.eclipse.e4.tools/latest` then you add `Eclipse E4 - All Spies`.
130+
131+
## Validation error in target platform `jython` manifests
132+
133+
Make sure that `-Djdk.util.zip.disableZip64ExtraFieldValidation=true` is included in `eclipse.ini` (located right next
134+
to the `eclipse.exe` executable).

doc/client/getting_started/Building-the-GUI.md

Lines changed: 0 additions & 94 deletions
This file was deleted.

0 commit comments

Comments
 (0)