Added markdown extensions from 6.002x

lms/djangoapps/course_wiki/plugins/markdownedx/__init__.py

+# Make sure wiki_plugin.py gets run.
+from course_wiki.plugins.markdownedx.wiki_plugin import ExtendMarkdownPlugin
\ No newline at end of file

lms/djangoapps/course_wiki/plugins/markdownedx/mdx_circuit.py

+#!/usr/bin/env python
+'''
+Image Circuit Extension for Python-Markdown
+======================================
+
+
+Any single line beginning with circuit-schematic: and followed by data (which should be json data, but this
+is not enforced at this level) will be displayed as a circuit schematic. This is simply an input element with
+the value set to the data. It is left to javascript on the page to render that input as a circuit schematic.
+
+ex:
+circuit-schematic:[["r",[128,48,0],{"r":"1","_json_":0},["2","1"]],["view",0,0,2,null,null,null,null,null,null,null],["dc",{"0":0,"1":1,"I(_3)":-1}]]
+
+(This is a schematic with a single one-ohm resistor. Note that this data is not meant to be user-editable.)
+
+'''
+import markdown
+import re
+
+from django.utils.html import escape
+
+try:
+    # Markdown 2.1.0 changed from 2.0.3. We try importing the new version first,
+    # but import the 2.0.3 version if it fails
+    from markdown.util import etree
+except:
+    from markdown import etree
+
+
+class CircuitExtension(markdown.Extension):
+    def __init__(self, configs):
+        for key, value in configs:
+            self.setConfig(key, value)
+
+    def extendMarkdown(self, md, md_globals):
+        ## Because Markdown treats contigous lines as one block of text, it is hard to match
+        ## a regex that must occupy the whole line (like the circuit regex). This is why we have
+        ## a preprocessor that inspects the lines and replaces the matched lines with text that is
+        ## easier to match
+        md.preprocessors.add('circuit', CircuitPreprocessor(md), "_begin")
+
+        pattern = CircuitLink(r'processed-schematic:(?P<data>.*?)processed-schematic-end')
+        pattern.md = md
+        pattern.ext = self
+        md.inlinePatterns.add('circuit', pattern, "<reference")
+
+
+class CircuitPreprocessor(markdown.preprocessors.Preprocessor):
+    preRegex = re.compile(r'^circuit-schematic:(?P<data>.*)$')
+
+    def run(self, lines):
+        print "running circuit preprocessor"
+        def convertLine(line):
+            m = self.preRegex.match(line)
+            if m:
+                return 'processed-schematic:{0}processed-schematic-end'.format(m.group('data'))
+            else:
+                return line
+
+        return [convertLine(line) for line in lines]
+
+
+class CircuitLink(markdown.inlinepatterns.Pattern):
+    def handleMatch(self, m):
+        data = m.group('data')
+        data = escape(data)
+        return etree.fromstring("<div align='center'><input type='hidden' parts='' value='" + data + "' analyses='' class='schematic ctrls' width='400' height='220'/></div>")
+
+
+def makeExtension(configs=None):
+    to_return = CircuitExtension(configs=configs)
+    print "circuit returning ", to_return
+    return to_return

lms/djangoapps/course_wiki/plugins/markdownedx/mdx_image.py

+#!/usr/bin/env python
+'''
+Image Embedding Extension for Python-Markdown
+======================================
+
+Converts lone links to embedded images, provided the file extension is allowed.
+
+Ex:
+    http://www.ericfehse.net/media/img/ef/blog/django-pony.jpg
+    becomes
+    <img src="http://www.ericfehse.net/media/img/ef/blog/django-pony.jpg">
+
+    mypic.jpg   becomes    <img src="/MEDIA_PATH/mypic.jpg">
+
+Requires Python-Markdown 1.6+
+'''
+
+import simplewiki.settings as settings
+
+import markdown
+try:
+    # Markdown 2.1.0 changed from 2.0.3. We try importing the new version first,
+    # but import the 2.0.3 version if it fails
+    from markdown.util import etree
+except:
+    from markdown import etree
+
+
+class ImageExtension(markdown.Extension):
+    def __init__(self, configs):
+        for key, value in configs:
+            self.setConfig(key, value)
+
+    def add_inline(self, md, name, klass, re):
+        pattern = klass(re)
+        pattern.md = md
+        pattern.ext = self
+        md.inlinePatterns.add(name, pattern, "<reference")
+
+    def extendMarkdown(self, md, md_globals):
+        self.add_inline(md, 'image', ImageLink,
+        r'^(?P<proto>([^:/?#])+://)?(?P<domain>([^/?#]*)/)?(?P<path>[^?#]*\.(?P<ext>[^?#]{3,4}))(?:\?([^#]*))?(?:#(.*))?$')
+
+
+class ImageLink(markdown.inlinepatterns.Pattern):
+    def handleMatch(self, m):
+        img = etree.Element('img')
+        proto = m.group('proto') or "http://"
+        domain = m.group('domain')
+        path = m.group('path')
+        ext = m.group('ext')
+
+        # A fixer upper
+        if ext.lower() in settings.WIKI_IMAGE_EXTENSIONS:
+            if domain:
+                src = proto + domain + path
+            elif path:
+                # We need a nice way to source local attachments...
+                src = "/wiki/media/" + path + ".upload"
+            else:
+                src = ''
+            img.set('src', src)
+        return img
+
+
+def makeExtension(configs=None):
+    return ImageExtension(configs=configs)
+
+if __name__ == "__main__":
+    import doctest
+    doctest.testmod()

lms/djangoapps/course_wiki/plugins/markdownedx/mdx_mathjax.py

+# Source: https://github.com/mayoff/python-markdown-mathjax
+
+import markdown
+try:
+    # Markdown 2.1.0 changed from 2.0.3. We try importing the new version first,
+    # but import the 2.0.3 version if it fails
+    from markdown.util import etree, AtomicString
+except:
+    from markdown import etree, AtomicString
+
+
+class MathJaxPattern(markdown.inlinepatterns.Pattern):
+
+    def __init__(self):
+        markdown.inlinepatterns.Pattern.__init__(self, r'(?<!\\)(\$\$?)(.+?)\2')
+
+    def handleMatch(self, m):
+        el = etree.Element('span')
+        el.text = AtomicString(m.group(2) + m.group(3) + m.group(2))
+        return el
+
+
+class MathJaxExtension(markdown.Extension):
+    def extendMarkdown(self, md, md_globals):
+        # Needs to come before escape matching because \ is pretty important in LaTeX
+        md.inlinePatterns.add('mathjax', MathJaxPattern(), '<escape')
+
+
+def makeExtension(configs=None):
+    return MathJaxExtension(configs)
+

lms/djangoapps/course_wiki/plugins/markdownedx/mdx_wikipath.py

+#!/usr/bin/env python
+
+'''
+Wikipath Extension for Python-Markdown
+======================================
+
+Converts [Link Name](wiki:ArticleName) to relative links pointing to article.  Requires Python-Markdown 2.0+
+
+Basic usage:
+
+    >>> import markdown
+    >>> text = "Some text with a [Link Name](wiki:ArticleName)."
+    >>> html = markdown.markdown(text, ['wikipath(base_url="/wiki/view/")'])
+    >>> html
+    u'<p>Some text with a <a class="wikipath" href="/wiki/view/ArticleName/">Link Name</a>.</p>'
+
+Dependencies:
+* [Python 2.3+](http://python.org)
+* [Markdown 2.0+](http://www.freewisdom.org/projects/python-markdown/)
+'''
+
+
+import markdown
+try:
+    # Markdown 2.1.0 changed from 2.0.3. We try importing the new version first,
+    # but import the 2.0.3 version if it fails
+    from markdown.util import etree
+except:
+    from markdown import etree
+
+
+class WikiPathExtension(markdown.Extension):
+    def __init__(self, configs):
+        # set extension defaults
+        self.config = {
+                        'base_url' : ['/', 'String to append to beginning of URL.'],
+                        'html_class' : ['wikipath', 'CSS hook. Leave blank for none.']
+        }
+        
+        # Override defaults with user settings
+        for key, value in configs :
+            # self.config[key][0] = value
+            self.setConfig(key, value)
+                
+                
+    def extendMarkdown(self, md, md_globals):
+        self.md = md
+        
+        # append to end of inline patterns
+        WIKI_RE =  r'\[(?P<linkTitle>.+?)\]\(wiki:(?P<wikiTitle>[a-zA-Z\d/_-]*)\)'
+        wikiPathPattern = WikiPath(WIKI_RE, self.config)
+        wikiPathPattern.md = md
+        md.inlinePatterns.add('wikipath', wikiPathPattern, "<reference")
+
+class WikiPath(markdown.inlinepatterns.Pattern):
+    def __init__(self, pattern, config):
+        markdown.inlinepatterns.Pattern.__init__(self, pattern)
+        self.config = config
+    
+    def handleMatch(self, m) :
+        article_title = m.group('wikiTitle')
+        if article_title.startswith("/"):
+            article_title = article_title[1:]
+        
+        url = self.config['base_url'][0] + article_title
+        label = m.group('linkTitle')
+        a = etree.Element('a')
+        a.set('href', url)
+        a.text = label
+        
+        if self.config['html_class'][0]:
+            a.set('class', self.config['html_class'][0])
+            
+        return a
+        
+    def _getMeta(self):
+        """ Return meta data or config data. """
+        base_url = self.config['base_url'][0]
+        html_class = self.config['html_class'][0]
+        if hasattr(self.md, 'Meta'):
+            if self.md.Meta.has_key('wiki_base_url'):
+                base_url = self.md.Meta['wiki_base_url'][0]
+            if self.md.Meta.has_key('wiki_html_class'):
+                html_class = self.md.Meta['wiki_html_class'][0]
+        return base_url, html_class
+
+def makeExtension(configs=None) :
+    return WikiPathExtension(configs=configs)
+
+if __name__ == "__main__":
+    import doctest
+    doctest.testmod()

lms/djangoapps/course_wiki/plugins/markdownedx/wiki_plugin.py

+# -*- coding: utf-8 -*-
+
+from django.core.urlresolvers import reverse
+
+from wiki.core import plugins_registry
+from wiki import plugins
+
+from course_wiki.plugins.markdownedx import mdx_circuit, mdx_wikipath, mdx_mathjax, mdx_video
+
+class ExtendMarkdownPlugin(plugins.BasePlugin):
+    """
+    This plugin simply loads all of the markdown extensions we use in edX.
+    """
+    
+    wiki_base_url = reverse("wiki:get", kwargs={'path' : ""})
+    
+    markdown_extensions = [mdx_circuit.CircuitExtension(configs={}),
+                           #mdx_image.ImageExtension() , #This one doesn't work. Tries to import simplewiki.settings
+                           mdx_wikipath.WikiPathExtension(configs={'base_url' : wiki_base_url}.iteritems() ) ,
+                           mdx_mathjax.MathJaxExtension(configs={}) ,
+                           mdx_video.VideoExtension(configs={})]
+
+plugins_registry.register(ExtendMarkdownPlugin)
+

lms/envs/common.py

@@ -561,6 +561,7 @@ INSTALLED_APPS = (
     'sekizai',
     'wiki.plugins.attachments',
     'wiki.plugins.notifications',
+    'course_wiki.plugins.markdownedx',
 
     # For testing
     'django_jasmine',