From 76c7f0ad2377dfa66b9dacaa7045ef5b98e31970 Mon Sep 17 00:00:00 2001 From: Beking0912 <37431792+Beking0912@users.noreply.github.com> Date: Thu, 17 Aug 2023 15:45:51 -0400 Subject: [PATCH] add property show_web_tours (#10333) --- .../java/org/mskcc/cbio/portal/util/GlobalProperties.java | 7 +++++++ .../Customizing-your-instance-of-cBioPortal.md | 6 ++++++ .../customization/portal.properties-Reference.md | 3 +++ .../src/main/webapp/WEB-INF/jsp/global/frontend_config.jsp | 1 + portal/src/main/webapp/config_service.jsp | 1 + 5 files changed, 18 insertions(+) diff --git a/core/src/main/java/org/mskcc/cbio/portal/util/GlobalProperties.java b/core/src/main/java/org/mskcc/cbio/portal/util/GlobalProperties.java index f6905da3aec..88fbcf4a8ef 100644 --- a/core/src/main/java/org/mskcc/cbio/portal/util/GlobalProperties.java +++ b/core/src/main/java/org/mskcc/cbio/portal/util/GlobalProperties.java @@ -122,6 +122,7 @@ public class GlobalProperties { public static final String SKIN_RIGHT_NAV_SHOW_EXAMPLES = "skin.right_nav.show_examples"; public static final String SKIN_RIGHT_NAV_SHOW_TESTIMONIALS = "skin.right_nav.show_testimonials"; public static final String SKIN_RIGHT_NAV_SHOW_WHATS_NEW = "skin.right_nav.show_whats_new"; + public static final String SKIN_RIGHT_NAV_SHOW_WEB_TOURS = "skin.right_nav.show_web_tours"; private static String skinAuthorizationMessage; @Value("${skin.authorization_message:Access to this portal is only available to authorized users.}") public void setSkinAuthorizationMessage(String property) { skinAuthorizationMessage = property; } @@ -805,6 +806,12 @@ public static boolean showRightNavWhatsNew() return showFlag == null || Boolean.parseBoolean(showFlag); } + public static boolean showRightNavWebTours() + { + String showFlag = portalProperties.getProperty(SKIN_RIGHT_NAV_SHOW_WEB_TOURS); + return showFlag == null || Boolean.parseBoolean(showFlag); + } + public static String getAuthorizationMessage() { return skinAuthorizationMessage; diff --git a/docs/deployment/customization/Customizing-your-instance-of-cBioPortal.md b/docs/deployment/customization/Customizing-your-instance-of-cBioPortal.md index 7575ad63507..1f389f4159d 100644 --- a/docs/deployment/customization/Customizing-your-instance-of-cBioPortal.md +++ b/docs/deployment/customization/Customizing-your-instance-of-cBioPortal.md @@ -145,6 +145,12 @@ Below you can find the complete list of all the available skin properties. Text for public cBioPortal.org. Any HTML text + + skin.right_nav.show_web_tours + set the "Interactive Tours" section in the right navigation bar + true + true / false + skin.show_about_tab show the "ABOUT" tab in the header diff --git a/docs/deployment/customization/portal.properties-Reference.md b/docs/deployment/customization/portal.properties-Reference.md index 5eca5c5988b..89cadeee479 100644 --- a/docs/deployment/customization/portal.properties-Reference.md +++ b/docs/deployment/customization/portal.properties-Reference.md @@ -100,6 +100,9 @@ skin.right_nav.show_whats_new= skin.right_nav.show_twitter= ``` +#Interactive tours section +skin.right_nav.show_web_tours= + ### Control the content of specific sections Setting controlling the blurb: you can add any HTML code here that you want to visualize. This will be shown between the cBioPortal menu and the Query selector in the main page. diff --git a/portal/src/main/webapp/WEB-INF/jsp/global/frontend_config.jsp b/portal/src/main/webapp/WEB-INF/jsp/global/frontend_config.jsp index d1a118ff7f1..0d20e91ebde 100644 --- a/portal/src/main/webapp/WEB-INF/jsp/global/frontend_config.jsp +++ b/portal/src/main/webapp/WEB-INF/jsp/global/frontend_config.jsp @@ -30,6 +30,7 @@ window.legacySupportFrontendConfig = { skinRightNavShowExamples : <%=GlobalProperties.showRightNavExamples()%>, skinRightNavShowTestimonials : <%=GlobalProperties.showRightNavTestimonials()%>, skinRightNavShowWhatsNew : <%=GlobalProperties.showRightNavWhatsNew()%>, + skinRightNavShowWebTours: <%=GlobalProperties.showRightNavInteractiveTour()%>, skinRightNavExamplesHTML : '<%=GlobalProperties.getExamplesRightColumnHtml()%>', skinRightNavExamplesHTML : '<%=GlobalProperties.getExamplesRightColumnHtml()%>', skinRightNavWhatsNewBlurb : '<%=GlobalProperties.getRightNavWhatsNewBlurb()%>', diff --git a/portal/src/main/webapp/config_service.jsp b/portal/src/main/webapp/config_service.jsp index 3e7dc6ec00f..1fe5079ae3a 100644 --- a/portal/src/main/webapp/config_service.jsp +++ b/portal/src/main/webapp/config_service.jsp @@ -98,6 +98,7 @@ "skin.right_nav.show_whats_new", "skin.right_nav.show_twitter", "skin.right_nav.whats_new_blurb", + "skin.right_nav.show_web_tours", "skin.show_about_tab", "skin.show_data_tab", "skin.show_faqs_tab",