Skip to content

Describe "Documentation Menu" correctly #7720

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
labkey-adam wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Describe "Documentation Menu" correctly #7720

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions api/src/org/labkey/api/settings/LookAndFeelProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@
import static org.labkey.api.settings.LookAndFeelProperties.Properties.helpMenuEnabled;
import static org.labkey.api.settings.LookAndFeelProperties.Properties.logoHref;
import static org.labkey.api.settings.LookAndFeelProperties.Properties.reportAProblemPath;
import static org.labkey.api.settings.LookAndFeelProperties.Properties.restrictedColumnsEnabled;
import static org.labkey.api.settings.LookAndFeelProperties.Properties.supportEmail;
import static org.labkey.api.settings.LookAndFeelProperties.Properties.systemDescription;
import static org.labkey.api.settings.LookAndFeelProperties.Properties.systemEmailAddress;
Expand Down Expand Up @@ -68,7 +67,7 @@ public enum Properties implements StartupProperty, SafeToRenderEnum
themeName("Server color scheme. Valid values: " + Arrays.toString(Theme.values())),
folderDisplayMode("Show project and folder navigation. Valid values: " + Arrays.toString(FolderDisplayMode.values())),
applicationMenuDisplayMode("Show application selection menu. Valid values: " + Arrays.toString(FolderDisplayMode.values())),
helpMenuEnabled("Show LabKey Help menu item"),
helpMenuEnabled("Show LabKey Documentation menu item"),
logoHref("Logo link (specifies page to which header logo links)"),
reportAProblemPath("Support link (specifies page where users can request support)"),
supportEmail("Support email (shown to users if they don't have permission to see a page, or are having trouble logging in)"),
Expand Down Expand Up @@ -246,14 +245,14 @@ public FolderDisplayMode getApplicationMenuDisplayModeStored()
return displayMode != null ? FolderDisplayMode.fromString(lookupStringValue(applicationMenuDisplayMode, null)) : null;
}

public boolean isHelpMenuEnabled()
public boolean isDocumentationMenuEnabled()
{
return lookupBooleanValue(helpMenuEnabled, true);
}

public Boolean isHelpMenuEnabledStored()
public Boolean isDocumentationMenuEnabledStored()
{
String stored = getStoredValue(restrictedColumnsEnabled);
String stored = getStoredValue(helpMenuEnabled);
return null == stored ? null : "TRUE".equals(stored);
}

Expand Down
4 changes: 2 additions & 2 deletions api/src/org/labkey/api/settings/WriteableLookAndFeelProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,12 +139,12 @@ public void clearApplicationMenuDisplayMode()
remove(applicationMenuDisplayMode);
}

public void setHelpMenuEnabled(boolean enabled)
public void setDocumentationMenuEnabled(boolean enabled)
{
storeBooleanValue(helpMenuEnabled, enabled);
}

public void clearHelpMenuEnabled()
public void clearDocumentationMenuEnabled()
{
remove(helpMenuEnabled);
}
Expand Down
2 changes: 1 addition & 1 deletion api/src/org/labkey/api/view/PopupHelpView.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public static NavTree createNavTree(ViewContext context, HelpTopic topic)
menu.addChild("Support", reportAProblemPath);
}

if (laf.isHelpMenuEnabled())
if (laf.isDocumentationMenuEnabled())
menu.addChild(topic.getNavTree("LabKey Documentation"));

return menu;
Expand Down
2 changes: 1 addition & 1 deletion core/src/org/labkey/core/admin/AdminController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11722,7 +11722,7 @@ private static boolean saveProjectSettings(Container c, User user, ProjectSettin
setProperty(form.isThemeNameInherited(), props::clearThemeName, () -> props.setThemeName(form.getThemeName()));
setProperty(form.isFolderDisplayModeInherited(), props::clearFolderDisplayMode, () -> props.setFolderDisplayMode(FolderDisplayMode.fromString(form.getFolderDisplayMode())));
setProperty(form.isApplicationMenuDisplayModeInherited(), props::clearApplicationMenuDisplayMode, () -> props.setApplicationMenuDisplayMode(FolderDisplayMode.fromString(form.getApplicationMenuDisplayMode())));
setProperty(form.isHelpMenuEnabledInherited(), props::clearHelpMenuEnabled, () -> props.setHelpMenuEnabled(form.isHelpMenuEnabled()));
setProperty(form.isHelpMenuEnabledInherited(), props::clearDocumentationMenuEnabled, () -> props.setDocumentationMenuEnabled(form.isHelpMenuEnabled()));

// a few properties on this page should be restricted to operational permissions (i.e. site admin)
if (hasAdminOpsPerm)
Expand Down
6 changes: 3 additions & 3 deletions core/src/org/labkey/core/admin/lookAndFeelProperties.jsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,10 +198,10 @@
}
%>
<tr>
<td class="labkey-form-label"><label for="<%=helpMenuEnabled%>">Show LabKey Help menu item</label></td>
<% inherited = isInherited(laf.isHelpMenuEnabledStored()); %>
<td class="labkey-form-label"><label for="<%=helpMenuEnabled%>">Show LabKey Documentation menu item</label></td>
<% inherited = isInherited(laf.isDocumentationMenuEnabledStored()); %>
<%=inheritCheckbox(inherited, helpMenuEnabled)%>
<td><input type="checkbox" id="<%=helpMenuEnabled%>" name="<%=helpMenuEnabled%>" size="<%=standardInputWidth%>"<%=checked(laf.isHelpMenuEnabled())%><%=disabled(inherited)%>></td>
<td><input type="checkbox" id="<%=helpMenuEnabled%>" name="<%=helpMenuEnabled%>" size="<%=standardInputWidth%>"<%=checked(laf.isDocumentationMenuEnabled())%><%=disabled(inherited)%>></td>
</tr>
<tr>
<td class="labkey-form-label"><label for="<%=logoHref%>">Logo link (specifies page that header logo links to)</label></td>
Expand Down