##// END OF EJS Templates
Remove escape ansi
Jonathan Frederic -
Show More
@@ -1,124 +1,123 b''
1 """Latex filters.
1 """Latex filters.
2
2
3 Module of useful filters for processing Latex within Jinja latex templates.
3 Module of useful filters for processing Latex within Jinja latex templates.
4 """
4 """
5 #-----------------------------------------------------------------------------
5 #-----------------------------------------------------------------------------
6 # Copyright (c) 2013, the IPython Development Team.
6 # Copyright (c) 2013, the IPython Development Team.
7 #
7 #
8 # Distributed under the terms of the Modified BSD License.
8 # Distributed under the terms of the Modified BSD License.
9 #
9 #
10 # The full license is in the file COPYING.txt, distributed with this software.
10 # The full license is in the file COPYING.txt, distributed with this software.
11 #-----------------------------------------------------------------------------
11 #-----------------------------------------------------------------------------
12
12
13 #-----------------------------------------------------------------------------
13 #-----------------------------------------------------------------------------
14 # Imports
14 # Imports
15 #-----------------------------------------------------------------------------
15 #-----------------------------------------------------------------------------
16 import re
16 import re
17
17
18 #-----------------------------------------------------------------------------
18 #-----------------------------------------------------------------------------
19 # Globals and constants
19 # Globals and constants
20 #-----------------------------------------------------------------------------
20 #-----------------------------------------------------------------------------
21
21
22 LATEX_RE_SUBS = (
22 LATEX_RE_SUBS = (
23 (re.compile('\033\[[0-9;]+m'), ''), # handle console escapes
24 (re.compile(r'\.\.\.+'), r'\\ldots'),
23 (re.compile(r'\.\.\.+'), r'\\ldots'),
25 )
24 )
26
25
27 # Latex substitutions for escaping latex.
26 # Latex substitutions for escaping latex.
28 # see: http://stackoverflow.com/questions/16259923/how-can-i-escape-latex-special-characters-inside-django-templates
27 # see: http://stackoverflow.com/questions/16259923/how-can-i-escape-latex-special-characters-inside-django-templates
29
28
30 LATEX_SUBS = {
29 LATEX_SUBS = {
31 '&': r'\&',
30 '&': r'\&',
32 '%': r'\%',
31 '%': r'\%',
33 '$': r'\$',
32 '$': r'\$',
34 '#': r'\#',
33 '#': r'\#',
35 '_': r'\_',
34 '_': r'\_',
36 '{': r'\{',
35 '{': r'\{',
37 '}': r'\}',
36 '}': r'\}',
38 '~': r'\textasciitilde{}',
37 '~': r'\textasciitilde{}',
39 '^': r'\^{}',
38 '^': r'\^{}',
40 '\\': r'\textbackslash{}',
39 '\\': r'\textbackslash{}',
41 }
40 }
42
41
43
42
44 #-----------------------------------------------------------------------------
43 #-----------------------------------------------------------------------------
45 # Functions
44 # Functions
46 #-----------------------------------------------------------------------------
45 #-----------------------------------------------------------------------------
47
46
48 __all__ = ['escape_latex',
47 __all__ = ['escape_latex',
49 'strip_math_space']
48 'strip_math_space']
50
49
51 def escape_latex(text):
50 def escape_latex(text):
52 """
51 """
53 Remove ansi codes and escape characters that may conflict with latex.
52 Remove ansi codes and escape characters that may conflict with latex.
54
53
55 Parameters
54 Parameters
56 ----------
55 ----------
57 text : str
56 text : str
58 Text containing characters that may conflict with Latex
57 Text containing characters that may conflict with Latex
59 """
58 """
60 text = ''.join(LATEX_SUBS.get(c, c) for c in text)
59 text = ''.join(LATEX_SUBS.get(c, c) for c in text)
61 for pattern, replacement in LATEX_RE_SUBS:
60 for pattern, replacement in LATEX_RE_SUBS:
62 text = pattern.sub(replacement, text)
61 text = pattern.sub(replacement, text)
63
62
64 return text
63 return text
65
64
66
65
67 def strip_math_space(text):
66 def strip_math_space(text):
68 """
67 """
69 Remove the space between latex math commands and enclosing $ symbols.
68 Remove the space between latex math commands and enclosing $ symbols.
70 This filter is important because latex isn't as flexible as the notebook
69 This filter is important because latex isn't as flexible as the notebook
71 front end when it comes to flagging math using ampersand symbols.
70 front end when it comes to flagging math using ampersand symbols.
72
71
73 Parameters
72 Parameters
74 ----------
73 ----------
75 text : str
74 text : str
76 Text to filter.
75 Text to filter.
77 """
76 """
78
77
79 # First, scan through the markdown looking for $. If
78 # First, scan through the markdown looking for $. If
80 # a $ symbol is found, without a preceding \, assume
79 # a $ symbol is found, without a preceding \, assume
81 # it is the start of a math block. UNLESS that $ is
80 # it is the start of a math block. UNLESS that $ is
82 # not followed by another within two math_lines.
81 # not followed by another within two math_lines.
83 math_regions = []
82 math_regions = []
84 math_lines = 0
83 math_lines = 0
85 within_math = False
84 within_math = False
86 math_start_index = 0
85 math_start_index = 0
87 ptext = ''
86 ptext = ''
88 last_character = ""
87 last_character = ""
89 skip = False
88 skip = False
90 for index, char in enumerate(text):
89 for index, char in enumerate(text):
91
90
92 #Make sure the character isn't preceeded by a backslash
91 #Make sure the character isn't preceeded by a backslash
93 if (char == "$" and last_character != "\\"):
92 if (char == "$" and last_character != "\\"):
94
93
95 # Close the math region if this is an ending $
94 # Close the math region if this is an ending $
96 if within_math:
95 if within_math:
97 within_math = False
96 within_math = False
98 skip = True
97 skip = True
99 ptext = ptext+'$'+text[math_start_index+1:index].strip()+'$'
98 ptext = ptext+'$'+text[math_start_index+1:index].strip()+'$'
100 math_regions.append([math_start_index, index+1])
99 math_regions.append([math_start_index, index+1])
101 else:
100 else:
102
101
103 # Start a new math region
102 # Start a new math region
104 within_math = True
103 within_math = True
105 math_start_index = index
104 math_start_index = index
106 math_lines = 0
105 math_lines = 0
107
106
108 # If we are in a math region, count the number of lines parsed.
107 # If we are in a math region, count the number of lines parsed.
109 # Cancel the math region if we find two line breaks!
108 # Cancel the math region if we find two line breaks!
110 elif char == "\n":
109 elif char == "\n":
111 if within_math:
110 if within_math:
112 math_lines += 1
111 math_lines += 1
113 if math_lines > 1:
112 if math_lines > 1:
114 within_math = False
113 within_math = False
115 ptext = ptext+text[math_start_index:index]
114 ptext = ptext+text[math_start_index:index]
116
115
117 # Remember the last character so we can easily watch
116 # Remember the last character so we can easily watch
118 # for backslashes
117 # for backslashes
119 last_character = char
118 last_character = char
120 if not within_math and not skip:
119 if not within_math and not skip:
121 ptext = ptext+char
120 ptext = ptext+char
122 if skip:
121 if skip:
123 skip = False
122 skip = False
124 return ptext
123 return ptext
General Comments 0
You need to be logged in to leave comments. Login now