##// END OF EJS Templates
Clarify that the MathJax comment is Notebook specific.
Jonathan Frederic -
Show More
@@ -1,55 +1,57 b''
1 """Simple magics for display formats"""
1 """Simple magics for display formats"""
2 #-----------------------------------------------------------------------------
2 #-----------------------------------------------------------------------------
3 # Copyright (c) 2012 The IPython Development Team.
3 # Copyright (c) 2012 The IPython Development Team.
4 #
4 #
5 # Distributed under the terms of the Modified BSD License.
5 # Distributed under the terms of the Modified BSD License.
6 #
6 #
7 # The full license is in the file COPYING.txt, distributed with this software.
7 # The full license is in the file COPYING.txt, distributed with this software.
8 #-----------------------------------------------------------------------------
8 #-----------------------------------------------------------------------------
9
9
10 #-----------------------------------------------------------------------------
10 #-----------------------------------------------------------------------------
11 # Imports
11 # Imports
12 #-----------------------------------------------------------------------------
12 #-----------------------------------------------------------------------------
13
13
14 # Our own packages
14 # Our own packages
15 from IPython.core.display import display, Javascript, Latex, SVG, HTML
15 from IPython.core.display import display, Javascript, Latex, SVG, HTML
16 from IPython.core.magic import (
16 from IPython.core.magic import (
17 Magics, magics_class, cell_magic
17 Magics, magics_class, cell_magic
18 )
18 )
19
19
20 #-----------------------------------------------------------------------------
20 #-----------------------------------------------------------------------------
21 # Magic implementation classes
21 # Magic implementation classes
22 #-----------------------------------------------------------------------------
22 #-----------------------------------------------------------------------------
23
23
24
24
25 @magics_class
25 @magics_class
26 class DisplayMagics(Magics):
26 class DisplayMagics(Magics):
27 """Magics for displaying various output types with literals
27 """Magics for displaying various output types with literals
28
28
29 Defines javascript/latex/svg/html cell magics for writing
29 Defines javascript/latex/svg/html cell magics for writing
30 blocks in those languages, to be rendered in the frontend.
30 blocks in those languages, to be rendered in the frontend.
31 """
31 """
32
32
33 @cell_magic
33 @cell_magic
34 def javascript(self, line, cell):
34 def javascript(self, line, cell):
35 """Run the cell block of Javascript code"""
35 """Run the cell block of Javascript code"""
36 display(Javascript(cell))
36 display(Javascript(cell))
37
37
38
38
39 @cell_magic
39 @cell_magic
40 def latex(self, line, cell):
40 def latex(self, line, cell):
41 """Render the cell as a block of latex
41 """Render the cell as a block of latex
42
42
43 This magic only renders the subset of latex defined by MathJax
43 The subset of latex which is support depends on the implementation in
44 the client. In the Jupyter Notebook, this magic only renders the subset
45 of latex defined by MathJax
44 [here](https://docs.mathjax.org/en/v2.5-latest/tex.html)."""
46 [here](https://docs.mathjax.org/en/v2.5-latest/tex.html)."""
45 display(Latex(cell))
47 display(Latex(cell))
46
48
47 @cell_magic
49 @cell_magic
48 def svg(self, line, cell):
50 def svg(self, line, cell):
49 """Render the cell as an SVG literal"""
51 """Render the cell as an SVG literal"""
50 display(SVG(cell))
52 display(SVG(cell))
51
53
52 @cell_magic
54 @cell_magic
53 def html(self, line, cell):
55 def html(self, line, cell):
54 """Render the cell as a block of HTML"""
56 """Render the cell as a block of HTML"""
55 display(HTML(cell))
57 display(HTML(cell))
General Comments 0
You need to be logged in to leave comments. Login now