Add documentation for quick select on homepage (#10452)

* Documentation for the 'Quick select' buttons on top of the query page of cBioPortal Co-authored-by: Sowmiyaa Kumar <sowmi97@SowmiyaaHYVE> Co-authored-by: Ino de Bruijn <[email protected]>
cBioPortal · Dec 31, 2024 · 7936c97 · 7936c97
1 parent 8e7fcea
commit 7936c97
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/docs/deployment/customization/application.properties-Reference.md b/docs/deployment/customization/application.properties-Reference.md
@@ -162,6 +162,18 @@ Prevent users from saving data by removing all Download tabs and download and co
 skin.hide_download_controls=
 ```
 
+### Quick select buttons
+
+This feature allows you to generate a Quick Select button on the top of your query page. The button, when clicked on, will automatically select the studies mentioned after the '#`.
+
+```
+skin.quick_select_buttons=
+```
+
+The format for the string should be ``<Button name>|<Mouse-over text>#study1a,study1b,....`` where:
+- `<Button name>` will be the label on the button (for e.g. TCGA PanCancer Atlas Studies, Curated set of non-redundant studies)
+- `<Mouse-over text>` will be the text that is displayed when you hover over the button (for e.g. 218 studies that are manually curated including TCGA and non-TCGA studies with no overlapping samples)
+- `study1a,study1b,....` are the study IDs of the loaded studies that should be selected when the button is clicked. (for e.g. acbc_mskcc_2015,acc_tcga_pan_can_atlas_2018)
 
 
 ### Control default setting for filtering of genes in mutation and CNA tables of patient view