Skip to content

Commit eea85a7

Browse files
authored
Merge pull request #3586 from ControlSystemStudio/CSSTUDIO-3461
CSSTUDIO-3461 Add configuration option 'org.phoebus.ui/phoebus_documentation_location' for configuring the location of the Phoebus documentation.
2 parents e1f1ff2 + c417830 commit eea85a7

File tree

3 files changed

+12
-1
lines changed

3 files changed

+12
-1
lines changed

core/ui/src/main/java/org/phoebus/ui/Preferences.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,8 @@ public class Preferences
9393
/** cache_hint_for_picture_and_symbol_widgets */
9494
@Preference public static String cache_hint_for_picture_and_symbol_widgets;
9595
@Preference public static boolean save_credentials;
96+
/** documentation_location */
97+
@Preference public static String documentation_location;
9698

9799
static
98100
{

core/ui/src/main/java/org/phoebus/ui/help/OpenHelp.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
package org.phoebus.ui.help;
99

1010
import org.phoebus.framework.workbench.Locations;
11+
import org.phoebus.ui.Preferences;
1112
import org.phoebus.ui.application.Messages;
1213
import org.phoebus.ui.javafx.ImageCache;
1314
import org.phoebus.ui.spi.MenuEntry;
@@ -61,6 +62,11 @@ public Void call()
6162

6263
public static String determineHelpLocation()
6364
{
65+
if (!Preferences.documentation_location.isEmpty()) {
66+
String suffix = Preferences.documentation_location.endsWith("/") ? "index.html" : "/index.html";
67+
return Preferences.documentation_location + suffix;
68+
}
69+
6470
final File phoenix_install = Locations.install();
6571

6672
// The distribution includes a lib/ and a doc/ folder.

core/ui/src/main/resources/phoebus_ui_preferences.properties

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,4 +175,7 @@ cache_hint_for_picture_and_symbol_widgets=
175175
# Whether or not to save user credentials to file or memory so they only have to be entered once. Note that this
176176
# applies to all scopes/applications prompting for credentials.
177177
# See also setting org.phoebus.security/secure_store_target
178-
save_credentials=false
178+
save_credentials=false
179+
180+
# Location of the Phoebus documentation
181+
documentation_location=

0 commit comments

Comments
 (0)