48767d83b6b5cbba8bfa1bfada682effec74f83f dschmelt Wed May 8 14:35:15 2019 -0700 Adding defintions for URL params #23131 diff --git src/hg/htdocs/FAQ/FAQlink.html src/hg/htdocs/FAQ/FAQlink.html index e6ec771..8a3f17f 100755 --- src/hg/htdocs/FAQ/FAQlink.html +++ src/hg/htdocs/FAQ/FAQlink.html @@ -62,50 +62,54 @@ refers to the Feb. 2009 human genome release. For a list of db parameter values that correspond to UCSC assemblies, see the <a href="FAQreleases.html#release1">list of UCSC releases</a>.</li> <li><code>position</code> - can be any search term for the genome specified, including a position range or a gene identifier. This often takes the form of <code>position=chr1:35000-40000</code>.</li> </ul> <p>The following link is an example of a URL that declares assembly and position:</p> <p><code><a href="../cgi-bin/hgTracks?db=hg19&position=chr1:35000-40000">http://genome.ucsc.edu/cgi-bin/hgTracks?db=hg19&position=chr1:35000-40000</a></code></p> <a name="trackViz"></a> <h2>Setting Track Visibility via URL</h2> <h6>How do I create a custom URL to control the visibility of specific tracks?</h6> <p> You can control the visibility of tracks from the URL with the following parameters, -each linked by the "&" sign, similar to position parameters. For the full list, please see the -<a href="../../goldenPath/help/customTrack.html#optParams" target ="_blank">optional URL +each linked by the "&" sign, similar to position parameters. For more information, please see +the <a href="../../goldenPath/help/customTrack.html#optParams" target ="_blank">optional URL parameters</a> section of the Custom Tracks User's Guide. Note that <em>italic text</em> indicates a user choice, not a working example.</p> <ul> -<li>hideTracks=1</li> -<li><em>trackName</em>=hide|dense|pack|full</li> -<li>textSize=<em>number</em></li> -<li>ignoreCookie=1</li> +<li><code>hideTracks=1</code> - hides all tracks</li> +<li><code><em>trackName</em>=hide|dense|pack|full</code> - sets specified track or subtrack to a +chosen visibility</li> +<li><code>textSize=<em>number</em></code> - sets browser text size to a chosen number, default of +8 and maximum of 24.</li> +<li><code>ignoreCookie=1</code> - removes pre-existing user settings like track seletion, custom +tracks, and track hubs.</li> </ul> <p> For example, you can use the following command to hide every track (hideTracks=1) and set the knownGene track to the pack visibility (knownGene=pack):</p> <p><code><a href="../cgi-bin/hgTracks?db=hg38&hideTracks=1&knownGene=pack">http://genome.ucsc.edu/cgi-bin/hgTracks?db=hg38&hideTracks=1&knownGene=pack</a></code></p> <p>Composite tracks have additional URL parameters that encode options to hide, select, and display subtracks.</p> <ul> -<li><em>trackName</em>_hideKids=1</li> -<li><em>trackName</em>_sel=1</li> +<li><code><em>trackName</em>_hideKids=1</code> - hides a specific composite track's subtracks</li> +<li><code><em>trackName</em>_sel=1</code> - selects specific subtrack to be 'checked', allowing +display</li> </ul> <p>For example, the following URL hides all tracks (&hideTracks=1), hides a specific composite track's default subtracks (&refSeqComposite_hideKids=1), turns on one specific subtrack (&ncbiRefSeqCurated=full), and checks a box to display that subtrack (&ncbiRefSeqCurated_sel=1). <pre><a href="https://genome.ucsc.edu/cgi-bin/hgTracks?db=hg38&hideTracks=1&refSeqComposite_hideKids=1&ncbiRefSeqCurated=full&ncbiRefSeqCurated_sel=1">https://genome.ucsc.edu/cgi-bin/hgTracks?db=hg38&hideTracks=1&refSeqComposite_hideKids=1&ncbiRefSeqCurated=full&ncbiRefSeqCurated_sel=1</a></pre> <h2>Loading data with the URL</h2> <a name="ctUrl"></a> <h3>Loading Custom Track data with the URL</h3> <h6>How do I create a link to my custom track data?</h6> <p> You can combine the URL visibility settings with the <code>&hgct_customText=</code> parameter using