add property show_web_tours (cBioPortal#10333)

pughlab · Nov 8, 2023 · 76c7f0a · 76c7f0a
1 parent 4c03004
commit 76c7f0a
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 0 deletions.
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
@@ -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
@@ -145,6 +145,12 @@ Below you can find the complete list of all the available skin properties.
 			<td>Text for public cBioPortal.org.</td>
 			<td>Any HTML text</td>
 		</tr>
+        <tr>
+			<td>skin.right_nav.show_web_tours</td>
+			<td>set the "Interactive Tours" section in the right navigation bar</td>
+			<td>true</td>
+			<td>true / false</td>
+		</tr>
 		<tr>
 			<td>skin.show_about_tab</td>
 			<td>show the "ABOUT" tab in the header</td>

diff --git 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
@@ -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
@@ -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",