From 20fe598be76ec53977d2ac18cba35bfa31990c17 2012-08-31 21:42:21
From: Greg Caporaso <gregcaporaso@gmail.com>
Date: 2012-08-31 21:42:21
Subject: [PATCH] updated the documentation to describe the FileLink and FileLinks objects. skipping DirectoryLink right now as I don't think this will be widely used

---

diff --git a/docs/examples/notebooks/00_notebook_tour.ipynb b/docs/examples/notebooks/00_notebook_tour.ipynb
index e8f2602..fdc26f0 100644
--- a/docs/examples/notebooks/00_notebook_tour.ipynb
+++ b/docs/examples/notebooks/00_notebook_tour.ipynb
@@ -981,6 +981,118 @@
      "cell_type": "markdown",
      "metadata": {},
      "source": [
+      "## Linking to files and directories for viewing in the browser\n",
+      "\n",
+      "It is also possible to link directly to files or directories so they can be opened in browser. This is especially convenient if you're interacting with a tool within IPython that generates HTML pages, and you'd like to easily be able to open those in a new browser window. Alternatively, if your IPython notebook server is on a remote system, creating links provides an easy way to download any files that get generated.\n",
+      "\n",
+      "As we saw above, there are a bunch of `.ipynb` files in our current directory."
+     ]
+    },
+    {
+     "cell_type": "code",
+     "collapsed": false,
+     "input": [
+      "!ls"
+     ],
+     "language": "python",
+     "metadata": {},
+     "outputs": [
+      {
+       "output_type": "stream",
+       "stream": "stdout",
+       "text": [
+        "00_notebook_tour.ipynb         formatting.ipynb\r\n",
+        "01_notebook_introduction.ipynb octavemagic_extension.ipynb\r\n",
+        "Animations_and_Progress.ipynb  publish_data.ipynb\r\n",
+        "Capturing Output.ipynb         python-logo.svg\r\n",
+        "Script Magics.ipynb            rmagic_extension.ipynb\r\n",
+        "animation.m4v                  sympy.ipynb\r\n",
+        "cython_extension.ipynb         sympy_quantum_computing.ipynb\r\n",
+        "display_protocol.ipynb         trapezoid_rule.ipynb\r\n"
+       ]
+      }
+     ],
+     "prompt_number": 6
+    },
+    {
+     "cell_type": "markdown",
+     "metadata": {},
+     "source": [
+      "If we want to create a link to one of them, we can call use the `FileLink` object."
+     ]
+    },
+    {
+     "cell_type": "code",
+     "collapsed": false,
+     "input": [
+      "from IPython.display import FileLink\n",
+      "FileLink('00_notebook_tour.ipynb')"
+     ],
+     "language": "python",
+     "metadata": {},
+     "outputs": [
+      {
+       "html": [
+        "<a href='files/00_notebook_tour.ipynb' target='_blank'>00_notebook_tour.ipynb</a><br>"
+       ],
+       "output_type": "pyout",
+       "prompt_number": 2,
+       "text": [
+        "<IPython.lib.display.FileLink at 0x10f7ea3d0>"
+       ]
+      }
+     ],
+     "prompt_number": 2
+    },
+    {
+     "cell_type": "markdown",
+     "metadata": {},
+     "source": [
+      "Alternatively, if we want to link to all of them, we can use the `FileLinks` object, passing `'.'` to indicate that we want links generated for the current working directory. Note that if there were other directories under the current directory, `FileLinks` would work in a recursive manner creating links to files in all sub-directories as well."
+     ]
+    },
+    {
+     "cell_type": "code",
+     "collapsed": false,
+     "input": [
+      "from IPython.display import FileLink\n",
+      "FileLinks('.')"
+     ],
+     "language": "python",
+     "metadata": {},
+     "outputs": [
+      {
+       "html": [
+        "<a href='files/./00_notebook_tour.ipynb' target='_blank'>00_notebook_tour.ipynb</a><br>\n",
+        "<a href='files/./01_notebook_introduction.ipynb' target='_blank'>01_notebook_introduction.ipynb</a><br>\n",
+        "<a href='files/./animation.m4v' target='_blank'>animation.m4v</a><br>\n",
+        "<a href='files/./Animations_and_Progress.ipynb' target='_blank'>Animations_and_Progress.ipynb</a><br>\n",
+        "<a href='files/./Capturing Output.ipynb' target='_blank'>Capturing Output.ipynb</a><br>\n",
+        "<a href='files/./cython_extension.ipynb' target='_blank'>cython_extension.ipynb</a><br>\n",
+        "<a href='files/./display_protocol.ipynb' target='_blank'>display_protocol.ipynb</a><br>\n",
+        "<a href='files/./formatting.ipynb' target='_blank'>formatting.ipynb</a><br>\n",
+        "<a href='files/./octavemagic_extension.ipynb' target='_blank'>octavemagic_extension.ipynb</a><br>\n",
+        "<a href='files/./publish_data.ipynb' target='_blank'>publish_data.ipynb</a><br>\n",
+        "<a href='files/./python-logo.svg' target='_blank'>python-logo.svg</a><br>\n",
+        "<a href='files/./rmagic_extension.ipynb' target='_blank'>rmagic_extension.ipynb</a><br>\n",
+        "<a href='files/./Script Magics.ipynb' target='_blank'>Script Magics.ipynb</a><br>\n",
+        "<a href='files/./sympy.ipynb' target='_blank'>sympy.ipynb</a><br>\n",
+        "<a href='files/./sympy_quantum_computing.ipynb' target='_blank'>sympy_quantum_computing.ipynb</a><br>\n",
+        "<a href='files/./trapezoid_rule.ipynb' target='_blank'>trapezoid_rule.ipynb</a><br>"
+       ],
+       "output_type": "pyout",
+       "prompt_number": 7,
+       "text": [
+        "<IPython.lib.display.FileLinks at 0x10f7eaad0>"
+       ]
+      }
+     ],
+     "prompt_number": 7
+    },
+    {
+     "cell_type": "markdown",
+     "metadata": {},
+     "source": [
       "### External sites\n",
       "\n",
       "You can even embed an entire page from another site in an iframe; for example this is today's Wikipedia\n",