9ad242daa0aeca97b583975f571641b416c6ee8b brianlee Tue Jun 14 07:37:48 2022 -0700 Adding a section in hgSessionHelp.html#NAR about Public Sessions, and the idea of a gallery for sesions related to a paper, and also more clearly documenting short links and the search term feature for Public Sessions. diff --git src/hg/htdocs/goldenPath/help/hgSessionHelp.html src/hg/htdocs/goldenPath/help/hgSessionHelp.html index 2c68a42..d601cff 100755 --- src/hg/htdocs/goldenPath/help/hgSessionHelp.html +++ src/hg/htdocs/goldenPath/help/hgSessionHelp.html @@ -400,31 +400,33 @@ them to load it using the Session tool.</li> <li> <strong>Share a web URL.</strong> If you have saved your settings to a file on a web server, you can provide a link like this to others: <pre><code>http://genome.ucsc.edu/cgi-bin/hgSession?hgS_doLoadUrl=submit&hgS_loadUrlName=<em>MyUrl</em></code></pre> <p> where <code><em>MyUrl</em></code> is the URL of your settings file, e.g., <code>http://www.mysite.edu/~me/mySession.txt</code>. In this type of link, you may replace "<code>hgSession</code>" with "<code>hgTracks</code>" to proceed directly to the Genome Browser.</li> <li> <strong>List it on the Public Sessions page.</strong> The "<a href="../../../cgi-bin/hgPublicSessions">Public Sessions</a>" tool allows you to post and share your exciting and interesting Browser snapshots with the world. After having saved your session, you can add it to this public listing by checking the box in the column under - "post in public listing?".</li> + "post in public listing?". People can then find your sesssion by entering a search term. + You can even create a <a href="sessions.html#lab" target="_blank">gallery of Public Sessions</a> + related to your search by using a unique string in your descriptions.</li> </ul> <!-- =====Opening a Shared Session======================= --> <a name="Open"></a> <h3>Opening a shared session</h3> <p> If you open a shared session while viewing the Genome Browser, it is possible to lose all of your own browser settings. That is, the settings for the newly-opened session will take precedence over your existing settings and will replace them. If you wish to preserve your original settings, you should first save your own settings as a session before opening a new session, or open a new tab or window in your internet browser before loading the new session.</p> <p> There are four ways to open a shared session, depending on what information you have about the session. The instructions below assume that you want to replace your current session the new session. Be sure to preserve your original session first if you don't want to overwrite it.</p> @@ -628,41 +630,59 @@ <ul> <li> Going to <em><strong>My Data</strong></em> -> <em><strong>My Sessions</strong></em> from the navigation bar.</li> <li> Using the "<em><strong>s</strong> then <strong>s</strong></em>" keyboard shortcut when viewing the main page of the <a href="../../cgi-bin/hgTracks">Genome Browser</a>.</li> </ul></li> <li> <strong>Login to the UCSC Genome Browser</strong><br> You must sign in to be able to save named sessions which will then be displayed with Browser and Email links.</li> <li> <strong>Save your session</strong><br> Go to the <strong>Save Settings</strong> section and in the - <em>Save current settings as named session</em> text box, enter a name for your session. When + <em>Save current settings as named session</em> text box, and enter a name for your session. When saving the session, be sure to have the "<em>allow this session to be loaded by others</em>" option checked and then click - <em><strong>submit</strong></em>.</li> + <em><strong>submit</strong></em>. + <ul> + <li>You should then be able to copy and share a link similar + to the following: <code>http://genome.ucsc.edu/s/YourUserName/YourSessionName</code></p></li> + </ul> <li> <strong>Edit the session description</strong><br> - Once the session is created, you can click the <em><strong>details</strong></em> button to add - a description to the session. If you eventually make a Public Session, and provide a detailed - description, anyone can find it by searching for terms you share. For example, navigate to the - <a href="../../cgi-bin/hgPublicSessions">Public Sessions</a> page and search "NAR" to - see some example sessions.</li> + Once the session is created, under the "view/edit details" column you can click + the <em><strong>view/edit</strong></em> button to add a description to the session.</li> + <hr> + <li> + <strong>Publish your session as a Public Session for public discovery</strong><br> + If you eventually make a Public Session of your session after your paper is published, and + provide a detailed description, anyone can find it by searching for terms you share. + <ul> + <li>For example, navigate to the <a href="../../cgi-bin/hgPublicSessions">Public Sessions</a> + page and search "NAR" to see some example sessions. Or click this link, which adds + <a href="../../cgi-bin/hgPublicSessions?search=NAR" target="_blank"><code>?search=NAR</code></a> + to the URL.</li> + <li>As a Public Session, your session can then be found by anyone entering a search term, where you + can even create a <a href="sessions.html#lab" target="_blank">gallery of Public Sessions</a> + related to your search by using a unique string in your descriptions.</li> + <li>Here is an example "gallery" of all sessions that have the word "sessionView" + in their descriptions: <a href="http://genome.ucsc.edu/cgi-bin/hgPublicSessions?search=sessionView" + target="_blank">http://genome.ucsc.edu/cgi-bin/hgPublicSessions?search=sessionView</a></li> + </ul> </ol> <!-- ====Sharing the session===================== --> <a name="NAR_sharing"></a> <h3>Sharing your session link</h3> <p> After saving your session, you will now be able to share your session link with others. There are three different ways that you can share your session: </p> <ol> <li> Immediately after creating a new session, the top of the page offers a <em>Browser</em> hyperlink that will allow you to view the newly saved session. You can right-click the <em><strong>Browser</strong></em> link to save the URL.</li> <li>