upstream/ipython Commit - r8816:bb682703

1

from converters.markdown import ConverterMarkdown

1

from converters.markdown import ConverterMarkdown

2

import io

2

import io

3

import os

3

import os

4

5

class ConverterSlider(ConverterMarkdown):

5

class ConverterSlider(ConverterMarkdown):

6

"""Convert a notebook to html suitable for ~~easy pasting into Blogger~~.

6

"""Convert a notebook to a html slideshow suitable for oral presentations.

7

8

It generates an html file that has *only* the pure HTML contents, and a

8

It generates a static html slideshow based in markdown and reveal.js.

9

separate file with `_header` appended to the name with all header contents.

10

Typically, the header file only needs to be used once when setting up a

11

blog, as the CSS for all posts is stored in a single location in Blogger.

12

"""

9

"""

13

10

14

def __init__(self, infile, highlight_source=False, show_prompts=True,

11

def __init__(self, infile, highlight_source=False, show_prompts=True,

15

inline_prompt=True):

12

inline_prompt=True):

16

super(ConverterMarkdown, self).__init__(infile)

13

super(ConverterMarkdown, self).__init__(infile)

17

self.highlight_source = highlight_source

14

self.highlight_source = highlight_source

18

self.show_prompts = show_prompts

15

self.show_prompts = show_prompts

19

self.inline_prompt = inline_prompt

16

self.inline_prompt = inline_prompt

20

17

21

def convert(self, cell_separator='\n'):

18

def convert(self, cell_separator='\n'):

22

"""

19

"""

23

Generic method to converts notebook to a string representation.

20

Generic method to converts notebook to a string representation.

24

21

25

This is accomplished by dispatching on the cell_type, so subclasses of

22

This is accomplished by dispatching on the cell_type, so subclasses of

26

Convereter class do not need to re-implement this method, but just

23

Convereter class do not need to re-implement this method, but just

27

need implementation for the methods that will be dispatched.

24

need implementation for the methods that will be dispatched.

28

25

29

Parameters

26

Parameters

30

----------

27

----------

31

cell_separator : string

28

cell_separator : string

32

Character or string to join cells with. Default is "\n"

29

Character or string to join cells with. Default is "\n"

33

30

34

Returns

31

Returns

35

-------

32

-------

36

out : string

33

out : string

37

"""

34

"""

38

lines = []

35

lines = []

39

lines.extend(self.optional_header())

36

lines.extend(self.optional_header())

40

top = '<section data-markdown><script type="text/template">'

37

top = '<section data-markdown><script type="text/template">'

41

bottom = '</script></section>'

38

bottom = '</script></section>'

42

text = self.main_body(cell_separator)

39

text = self.main_body(cell_separator)

43

for i,j in enumerate(text):

40

for i,j in enumerate(text):

44

if j == u'---':

41

if j == u'---':

45

text[i] = bottom + top

42

text[i] = bottom + top

46

lines.extend(text)

43

lines.extend(text)

47

lines.extend(self.optional_footer())

44

lines.extend(self.optional_footer())

48

return u'\n'.join(lines)

45

return u'\n'.join(lines)

49

46

50

def save(self, outfile=None, encoding=None):

47

def save(self, outfile=None, encoding=None):

51

"read and parse notebook into self.nb"

48

"read and parse notebook into self.nb"

52

if outfile is None:

49

if outfile is None:

53

outfile = self.outbase + '_slides.' + 'html'

50

outfile = self.outbase + '_slides.' + 'html'

54

if encoding is None:

51

if encoding is None:

55

encoding = self.default_encoding

52

encoding = self.default_encoding

56

with io.open(outfile, 'w', encoding=encoding) as f:

53

with io.open(outfile, 'w', encoding=encoding) as f:

57

f.write(self.output)

54

f.write(self.output)

58

return os.path.abspath(outfile)

55

return os.path.abspath(outfile)

59

56

60

def optional_header(self):

57

def optional_header(self):

61

optional_header_body = [\

58

optional_header_body = [\

62

'''

59

'''

63

<!DOCTYPE html>

60

<!DOCTYPE html>

64

<html>

61

<html>

65

<head>

62

<head>

66

63

67

64

68

65

69

66

70

67

71

68

72

69

73

70

74

71

75

72

76

73

77

74

78

75

79

76

80

document.write( '<link rel="stylesheet" href="reveal/css/print/' + ( window.location.search.match( /print-pdf/gi ) ? 'pdf' : 'paper' ) + '.css" type="text/css" media="print">' );

77

document.write( '<link rel="stylesheet" href="reveal/css/print/' + ( window.location.search.match( /print-pdf/gi ) ? 'pdf' : 'paper' ) + '.css" type="text/css" media="print">' );

81

</script>

78

</script>

82

79

83

<!--[if lt IE 9]>

80

<!--[if lt IE 9]>

84

81

85

<![endif]-->

82

<![endif]-->

86

83

87

</head>

84

</head>

88

85

89

86

90

''']

87

''']

91

return optional_header_body

88

return optional_header_body

92

89

93

def optional_footer(self):

90

def optional_footer(self):

94

optional_footer_body = [\

91

optional_footer_body = [\

95

'''

92

'''

96

</script></section>

93

</script></section>

97

</div></div>

94

</div></div>

98

95

99

96

100

97

101

98

102

99

103

100

104

101

105

// Full list of configuration options available here: https://github.com/hakimel/reveal.js#configuration

102

// Full list of configuration options available here: https://github.com/hakimel/reveal.js#configuration

106

Reveal.initialize({

103

Reveal.initialize({

107

controls: true,

104

controls: true,

108

progress: true,

105

progress: true,

109

history: true,

106

history: true,

110

107

111

theme: Reveal.getQueryHash().theme, // available themes are in /css/theme

108

theme: Reveal.getQueryHash().theme, // available themes are in /css/theme

112

transition: Reveal.getQueryHash().transition || 'page', // default/cube/page/concave/zoom/linear/none

109

transition: Reveal.getQueryHash().transition || 'page', // default/cube/page/concave/zoom/linear/none

113

110

114

// Optional libraries used to extend on reveal.js

111

// Optional libraries used to extend on reveal.js

115

dependencies: [

112

dependencies: [

116

{ src: 'reveal/lib/js/classList.js', condition: function() { return !document.body.classList; } },

113

{ src: 'reveal/lib/js/classList.js', condition: function() { return !document.body.classList; } },

117

{ src: 'reveal/plugin/markdown/showdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },

114

{ src: 'reveal/plugin/markdown/showdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },

118

{ src: 'reveal/plugin/markdown/markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },

115

{ src: 'reveal/plugin/markdown/markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },

119

{ src: 'reveal/plugin/highlight/highlight.js', async: true, callback: function() { hljs.initHighlightingOnLoad(); } },

116

{ src: 'reveal/plugin/highlight/highlight.js', async: true, callback: function() { hljs.initHighlightingOnLoad(); } },

120

{ src: 'reveal/plugin/zoom-js/zoom.js', async: true, condition: function() { return !!document.body.classList; } },

117

{ src: 'reveal/plugin/zoom-js/zoom.js', async: true, condition: function() { return !!document.body.classList; } },

121

{ src: 'reveal/plugin/notes/notes.js', async: true, condition: function() { return !!document.body.classList; } },

118

{ src: 'reveal/plugin/notes/notes.js', async: true, condition: function() { return !!document.body.classList; } },

122

{ src: 'https://c328740.ssl.cf1.rackcdn.com/mathjax/latest/MathJax.js?config=TeX-AMS_HTML', async: true },

119

{ src: 'https://c328740.ssl.cf1.rackcdn.com/mathjax/latest/MathJax.js?config=TeX-AMS_HTML', async: true },

123

{ src: 'js/initmathjax.js', async: true}

120

{ src: 'js/initmathjax.js', async: true}

124

]

121

]

125

});

122

});

126

</script>

123

</script>

127

124

128

125

129

Reveal.addEventListener( 'slidechanged', function( event ) {

126

Reveal.addEventListener( 'slidechanged', function( event ) {

130

MathJax.Hub.Rerender();

127

MathJax.Hub.Rerender();

131

});

128

});

132

</script>

129

</script>

133

130

134

</body>

131

</body>

135

</html>

132

</html>

136

''']

133

''']

137

return optional_footer_body

134

return optional_footer_body

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

             from converters.markdown import ConverterMarkdown
             import io
             import os
             class ConverterSlider(ConverterMarkdown):
-                """Convert a notebook to html suitable for easy pasting into Blogger.
+                """Convert a notebook to a html slideshow suitable for oral presentations.
-                It generates an html file that has *only* the pure HTML contents, and a
+                It generates a static html slideshow based in markdown and reveal.js.
-                separate file with `_header` appended to the name with all header contents.
-                Typically, the header file only needs to be used once when setting up a
-                blog, as the CSS for all posts is stored in a single location in Blogger.
                 """
                 def __init__(self, infile, highlight_source=False, show_prompts=True,
                              inline_prompt=True):
                     super(ConverterMarkdown, self).__init__(infile)
                     self.highlight_source = highlight_source
                     self.show_prompts = show_prompts
                     self.inline_prompt = inline_prompt
                 def convert(self, cell_separator='\n'):
                     """
                     Generic method to converts notebook to a string representation.
                     This is accomplished by dispatching on the cell_type, so subclasses of
                     Convereter class do not need to re-implement this method, but just
                     need implementation for the methods that will be dispatched.
                     Parameters
                     ----------
                     cell_separator : string
                       Character or string to join cells with. Default is "\n"
                     Returns
                     -------
                     out : string
                     """
                     lines = []
                     lines.extend(self.optional_header())
                     top = '<section data-markdown><script type="text/template">'
                     bottom = '</script></section>'
                     text = self.main_body(cell_separator)
                     for i,j in enumerate(text):
                         if j == u'---':
                             text[i] = bottom + top
                     lines.extend(text)
                     lines.extend(self.optional_footer())
                     return u'\n'.join(lines)
                 def save(self, outfile=None, encoding=None):
                     "read and parse notebook into self.nb"
                     if outfile is None:
                         outfile = self.outbase + '_slides.' + 'html'
                     if encoding is None:
                         encoding = self.default_encoding
                     with io.open(outfile, 'w', encoding=encoding) as f:
                         f.write(self.output)
                     return os.path.abspath(outfile)
                 def optional_header(self):
                     optional_header_body = [\
             '''
             <!DOCTYPE html>
             <html>
             <head>
                 <meta charset="utf-8" />
                 <meta http-equiv="X-UA-Compatible" content="chrome=1">
                 <meta name="apple-mobile-web-app-capable" content="yes" />
                 <meta name="apple-mobile-web-app-status-bar-style" content="black-translucent" />
                 <link rel="stylesheet" href="reveal/css/reveal.css">
                 <link rel="stylesheet" href="reveal/css/theme/default.css" id="theme">
                 <!-- For syntax highlighting -->
                 <link rel="stylesheet" href="reveal/lib/css/zenburn.css">
                 <!-- If the query includes 'print-pdf', use the PDF print sheet -->
                 <script>
                     document.write( '<link rel="stylesheet" href="reveal/css/print/' + ( window.location.search.match( /print-pdf/gi ) ? 'pdf' : 'paper' ) + '.css" type="text/css" media="print">' );
                 </script>
                 <!--[if lt IE 9]>
                 <script src="reveal/lib/js/html5shiv.js"></script>
                 <![endif]-->
             </head>
             <body><div class="reveal"><div class="slides">
             <section data-markdown><script type="text/template">
             ''']
                     return optional_header_body
                 def optional_footer(self):
                     optional_footer_body = [\
             '''
             </script></section>
             </div></div>
                 <script src="reveal/lib/js/head.min.js"></script>
                 <script src="reveal/js/reveal.min.js"></script>
                 <script>
                     // Full list of configuration options available here: https://github.com/hakimel/reveal.js#configuration
                     Reveal.initialize({
                         controls: true,
                         progress: true,
                         history: true,
                         theme: Reveal.getQueryHash().theme, // available themes are in /css/theme
                         transition: Reveal.getQueryHash().transition || 'page', // default/cube/page/concave/zoom/linear/none
                         // Optional libraries used to extend on reveal.js
                         dependencies: [
                             { src: 'reveal/lib/js/classList.js', condition: function() { return !document.body.classList; } },
                             { src: 'reveal/plugin/markdown/showdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
                             { src: 'reveal/plugin/markdown/markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
                             { src: 'reveal/plugin/highlight/highlight.js', async: true, callback: function() { hljs.initHighlightingOnLoad(); } },
                             { src: 'reveal/plugin/zoom-js/zoom.js', async: true, condition: function() { return !!document.body.classList; } },
                             { src: 'reveal/plugin/notes/notes.js', async: true, condition: function() { return !!document.body.classList; } },
                             { src: 'https://c328740.ssl.cf1.rackcdn.com/mathjax/latest/MathJax.js?config=TeX-AMS_HTML', async: true },
                             { src: 'js/initmathjax.js', async: true}
                             ]
                             });
                 </script>
                 <script>
                     Reveal.addEventListener( 'slidechanged', function( event ) {
                     MathJax.Hub.Rerender();
                     });
                 </script>
             </body>
             </html>
             ''']
                     return optional_footer_body