From a5bcda20c9a01ae83797624501d8ac70c824efd7 2012-05-31 20:08:26
From: Matthias BUSSONNIER <bussonniermatthias@gmail.com>
Date: 2012-05-31 20:08:26
Subject: [PATCH] Notification + tooltip demo

Use notification to quicky remind use of the tooltip

Use javascript in notebook to make a live demo in
01_notebook_introduction

tooltip docstring is remplaceid for the first use by a live tutorial

---

diff --git a/IPython/frontend/html/notebook/static/js/tooltip.js b/IPython/frontend/html/notebook/static/js/tooltip.js
index bb28532..20f49dc 100644
--- a/IPython/frontend/html/notebook/static/js/tooltip.js
+++ b/IPython/frontend/html/notebook/static/js/tooltip.js
@@ -123,9 +123,18 @@ var IPython = (function (IPython) {
         this.tooltip.append(this.text);
 
         // function that will be called if you press tab 1, 2, 3... times in a row
-        this.tabs_functions = [  function(cell,text){that._request_tooltip(cell,text)},
-                                 function(){that.expand()},
-                                 function(){that.stick()},
+        this.tabs_functions = [  function(cell,text){
+                                    that._request_tooltip(cell,text);
+                                    IPython.notification_widget.set_message('tab again to expand pager',2500);
+                                    },
+                                 function(){
+                                    that.expand();
+                                    IPython.notification_widget.set_message('tab again to make pager sticky for 10s',2500);
+                                 },
+                                 function(){
+                                     that.stick();
+                                     IPython.notification_widget.set_message('tab again to open help in pager',2500);
+                                 },
                                  function(cell){
                                     that.cancel_stick();
                                     that.showInPager(cell);
diff --git a/docs/examples/notebooks/01_notebook_introduction.ipynb b/docs/examples/notebooks/01_notebook_introduction.ipynb
index d0d4d3d..4d6425a 100644
--- a/docs/examples/notebooks/01_notebook_introduction.ipynb
+++ b/docs/examples/notebooks/01_notebook_introduction.ipynb
@@ -35,7 +35,6 @@
     },
     {
      "cell_type": "code",
-     "collapsed": false,
      "input": [
       "\"This is the new IPython notebook\""
      ],
@@ -66,7 +65,6 @@
     },
     {
      "cell_type": "code",
-     "collapsed": false,
      "input": [
       "ls"
      ],
@@ -93,7 +91,6 @@
     },
     {
      "cell_type": "code",
-     "collapsed": false,
      "input": [
       "def f(x):",
       "    \"\"\"My function",
@@ -180,10 +177,7 @@
       "closely related to IPython as well as the minimal keybindings you need to",
       "know.  But you should use `Ctrl-m h` (or click the `QuickHelp` button at",
       "the top) and learn some of the other keybindings, as it will make your ",
-      "workflow much more fluid and efficient.",
-      "",
-      "The *Configuration* section at the bottom lets you change some values",
-      "related to the display of tooltips and the behavior of the tab completer."
+      "workflow much more fluid and efficient."
      ]
     },
     {
@@ -231,10 +225,9 @@
     },
     {
      "cell_type": "code",
-     "collapsed": true,
      "input": [
       "# Position your cursor after the ( and hit the Tab key:",
-      "list("
+      "range("
      ],
      "language": "python",
      "outputs": []
@@ -242,6 +235,77 @@
     {
      "cell_type": "markdown",
      "source": [
+      "More over pressing tab several time in a row allows you change the behaviour of the tooltip.",
+      "",
+      "* firt `tab` press, you get a classical tooltip",
+      "* second time, the tooltip grow vertically, and allow you to scroll the docstring",
+      "* third tab press, tooltip, will be made sticky for 10 seconds, allowing you to carry on typing while it stays open.",
+      "* forth time press, the tooltip help is sent to the pager at the bottom of the screen , and is dismiss.",
+      "<script>",
+      "    IPython.tooltip.tabs_functions = [  function(cell,text){",
+      "                                    IPython.tooltip._request_tooltip(cell,text);",
+      "                                    IPython.notification_widget.set_message('tab again to expand pager',2500);",
+      "                                    setTimeout(function(){",
+      "                                        $('.tooltiptext pre').text(\"function signture : You've invoked a tooltip !\\n\\nWell done! Here usualy lies the current function *call signature* and it's *docstring*. You can now expand the tooltip pressing <tab> a second time...\")},400);",
+      "                                    },",
+      "                                 function(){",
+      "                                    IPython.tooltip.expand();",
+      "                                    IPython.notification_widget.set_message('tab again to make pager sticky for 10s',2500);",
+      "                                    setTimeout(function(){",
+      "                                        $('.tooltiptext pre').text(\"Now the tooltip is expanded !\\",
+      "                                          \\n\\nThis is really usefull if you have long docstring and if you want to be able to scroll them. \\",
+      "For example, I can give you many information about the tooltip:\\n - The tooltip is smart, and \\",
+      "you don't always need to press tab to invoke it, if you press an opening bracket `(` then nothing \\",
+      "for some time, tooltip will be invoked by itself.\\",
+      "\\n - Also you can hoover over the icon on the top right to know what they are dooing...\\",
+      "\\n\\nBack to the next lesson.\\n\\nSometime you need to the tooltip to stay on screen while\\",
+      "you type. That's the reason for the sticky mode (indicated by a small clock on the top left of the tooltip),\\",
+      "\\n\\nNow press <tab> a 3rd time and continue typing some text to test it...\")",
+      "                                            },400);",
+      "                                 },",
+      "                                 function(){",
+      "                                     var time = 35;",
+      "                                     IPython.tooltip.stick(time);",
+      "                                     $('.tooltiptext pre').text(\"Type more text !...\\n\\n range(7,125,3)\\n\\n The tooltip is in sticky mode, it won't be dismissed for at least 10 secondes \",400);",
+      "                                     setTimeout(function(){",
+      "                                         $('.tooltiptext pre').text(\"That was sticky mode...\\nI'll keep it on 15 more seconds just for you.\\n\\nLast thing you can do is send the current help displayed in the tooltip to the pager at the bottom of the screen. To do that, press tab 4 time in a row after a parenthesis. \\n\\n Now I'll stop bothering you and let you Play with the tooltip !\");",
+      "                                         reset_tooltip()",
+      "                                            },15000);",
+      "                                 },",
+      "                                 function(cell){",
+      "                                    IPython.tooltip.cancel_stick();",
+      "                                    reset_tooltip()",
+      "                                    IPython.tooltip.showInPager(cell);",
+      "                                    IPython.tooltip._cmfocus();",
+      "                                    }",
+      "                                ];",
+      "    ",
+      "    reset_tooltip = function(){",
+      "    IPython.tooltip.tabs_functions = [  function(cell,text){",
+      "                                    IPython.tooltip._request_tooltip(cell,text);",
+      "                                    IPython.notification_widget.set_message('tab again to expand pager',2500);",
+      "                                    },",
+      "                                 function(){",
+      "                                    IPython.tooltip.expand();",
+      "                                    IPython.notification_widget.set_message('tab again to make pager sticky for 10s',2500);",
+      "                                 },",
+      "                                 function(){",
+      "                                     IPython.tooltip.stick();",
+      "                                     IPython.notification_widget.set_message('tab again to open help in pager',2500);",
+      "                                 },",
+      "                                 function(cell){",
+      "                                    IPython.tooltip.cancel_stick();",
+      "                                    IPython.tooltip.showInPager(cell);",
+      "                                    IPython.tooltip._cmfocus();",
+      "                                    }",
+      "                                ];",
+      "    }",
+      "</script>"
+     ]
+    },
+    {
+     "cell_type": "markdown",
+     "source": [
       "## The frontend/kernel model",
       "",
       "The IPython notebook works on a client/server model where an *IPython kernel*",
@@ -265,7 +329,6 @@
     },
     {
      "cell_type": "code",
-     "collapsed": false,
      "input": [
       "%connect_info"
      ],
@@ -347,7 +410,6 @@
     },
     {
      "cell_type": "code",
-     "collapsed": false,
      "input": [
       "%pylab inline",
       "plot(rand(100))"
@@ -408,8 +470,9 @@
     },
     {
      "cell_type": "code",
-     "collapsed": true,
-     "input": [],
+     "input": [
+      ""
+     ],
      "language": "python",
      "outputs": []
     }