Creating editors package with markitup module

wiki/conf/settings.py

@@ -11,7 +11,7 @@ WIKI_LANGUAGE = 'markdown'
 
 # The editor class to use -- maybe a 3rd party or your own...? You can always
 # extend the built-in editor and customize it....
-EDITOR = getattr(django_settings, 'WIKI_EDITOR', 'wiki.plugins.MarkItUp')
+EDITOR = getattr(django_settings, 'WIKI_EDITOR', 'wiki.editors.markitup.MarkItUp')
 
 # This slug is used in URLPath if an article has been deleted. The children of the
 # URLPath of that article are moved to lost and found. They keep their permissions

wiki/editors.py → wiki/editors/__init__.py

-from conf import settings
+from wiki.conf import settings
 from django.core.urlresolvers import get_callable
 
 EditorClass = get_callable(settings.EDITOR)

wiki/editors/base.py

+from django import forms
+
+class BaseEditor():
+    """Editors should inherit from this. See wiki.editors for examples."""
+    
+    # The editor id can be used for conditional testing. If you write your
+    # own editor class, you can use the same editor_id as some editor 
+    editor_id = 'plaintext'
+    media_admin = ()
+    media_frontend = ()
+    
+    def __init__(self, instance=None):
+        self.instance = instance
+    
+    def get_admin_widget(self):
+        return forms.Textarea()
+
+    class AdminMedia:
+        css = {}
+        js = ()
+
+    class Media:
+        css = {}
+        js = ()
+
+

wiki/editors/markitup.py

+from django import forms
+from django.forms.util import flatatt
+from django.utils.encoding import force_unicode
+from django.utils.html import conditional_escape
+from django.utils.safestring import mark_safe
+
+from wiki.editors.base import BaseEditor
+
+class MarkItUpAdminWidget(forms.Widget):
+    """A simplified more fail-safe widget for the backend"""
+    def __init__(self, attrs=None):
+        # The 'rows' and 'cols' attributes are required for HTML correctness.
+        default_attrs = {'class': 'markItUp',
+                         'rows': '10', 'cols': '40',}
+        if attrs:
+            default_attrs.update(attrs)
+        super(MarkItUpAdminWidget, self).__init__(default_attrs)
+    
+    def render(self, name, value, attrs=None):
+        if value is None: value = ''
+        final_attrs = self.build_attrs(attrs, name=name)
+        return mark_safe(u'<textarea%s>%s</textarea>' % (flatatt(final_attrs),
+                conditional_escape(force_unicode(value))))
+
+class MarkItUpWidget(forms.Widget):
+    def __init__(self, attrs=None):
+        # The 'rows' and 'cols' attributes are required for HTML correctness.
+        default_attrs = {'class': 'markItUp',
+                         'rows': '10', 'cols': '40',}
+        if attrs:
+            default_attrs.update(attrs)
+        super(MarkItUpWidget, self).__init__(default_attrs)
+    
+    def render(self, name, value, attrs=None):
+        if value is None: value = ''
+        final_attrs = self.build_attrs(attrs, name=name)
+        return mark_safe(u'<div><textarea%s>%s</textarea></div>' % (flatatt(final_attrs),
+                conditional_escape(force_unicode(value))))
+
+class MarkItUp(BaseEditor):
+    editor_id = 'markitup'
+    
+    def get_admin_widget(self, instance=None):
+        return MarkItUpAdminWidget()
+    
+    def get_widget(self, instance=None):
+        return MarkItUpWidget()
+
+    class AdminMedia:
+        css = {
+            'all': ("wiki/markitup/skins/simple/style.css",
+                    "wiki/markitup/sets/admin/style.css",)
+        }
+        js = ("wiki/markitup/admin.init.js",
+              "wiki/markitup/jquery.markitup.js",
+              "wiki/markitup/sets/admin/set.js",
+              )
+
+    class Media:
+        css = {
+            'all': ("wiki/markitup/skins/simple/style.css",
+                    "wiki/markitup/sets/frontend/style.css",)
+        }
+        js = ("wiki/markitup/frontend.init.js",
+              "wiki/markitup/jquery.markitup.js",
+              "wiki/markitup/sets/frontend/set.js",
+              )
+

wiki/plugins/__init__.py

-from django.utils.translation import ugettext as _
 from django import forms
-from django.utils.safestring import mark_safe
-from django.utils.html import conditional_escape
-from django.utils.encoding import force_unicode
-from django.forms.util import flatatt
+from django.utils.translation import ugettext as _
 
 """Base classes for different plugin objects.
 
@@ -51,87 +47,3 @@ class PluginSettingsFormMixin(object):
     def get_usermessage(self):
         pass
 
-class BaseEditor():
-    """Editors should inherit from this. See wiki.editors for examples."""
-    
-    # The editor id can be used for conditional testing. If you write your
-    # own editor class, you can use the same editor_id as some editor 
-    editor_id = 'plaintext'
-    media_admin = ()
-    media_frontend = ()
-    
-    def __init__(self, instance=None):
-        self.instance = instance
-    
-    def get_admin_widget(self):
-        return forms.Textarea()
-
-    class AdminMedia:
-        css = {}
-        js = ()
-
-    class Media:
-        css = {}
-        js = ()
-
-
-class MarkItUpAdminWidget(forms.Widget):
-    """A simplified more fail-safe widget for the backend"""
-    def __init__(self, attrs=None):
-        # The 'rows' and 'cols' attributes are required for HTML correctness.
-        default_attrs = {'class': 'markItUp',
-                         'rows': '10', 'cols': '40',}
-        if attrs:
-            default_attrs.update(attrs)
-        super(MarkItUpAdminWidget, self).__init__(default_attrs)
-    
-    def render(self, name, value, attrs=None):
-        if value is None: value = ''
-        final_attrs = self.build_attrs(attrs, name=name)
-        return mark_safe(u'<textarea%s>%s</textarea>' % (flatatt(final_attrs),
-                conditional_escape(force_unicode(value))))
-
-class MarkItUpWidget(forms.Widget):
-    def __init__(self, attrs=None):
-        # The 'rows' and 'cols' attributes are required for HTML correctness.
-        default_attrs = {'class': 'markItUp',
-                         'rows': '10', 'cols': '40',}
-        if attrs:
-            default_attrs.update(attrs)
-        super(MarkItUpWidget, self).__init__(default_attrs)
-    
-    def render(self, name, value, attrs=None):
-        if value is None: value = ''
-        final_attrs = self.build_attrs(attrs, name=name)
-        return mark_safe(u'<div><textarea%s>%s</textarea></div>' % (flatatt(final_attrs),
-                conditional_escape(force_unicode(value))))
-
-class MarkItUp(BaseEditor):
-    editor_id = 'markitup'
-    
-    def get_admin_widget(self, instance=None):
-        return MarkItUpAdminWidget()
-    
-    def get_widget(self, instance=None):
-        return MarkItUpWidget()
-
-    class AdminMedia:
-        css = {
-            'all': ("wiki/markitup/skins/simple/style.css",
-                    "wiki/markitup/sets/admin/style.css",)
-        }
-        js = ("wiki/markitup/admin.init.js",
-              "wiki/markitup/jquery.markitup.js",
-              "wiki/markitup/sets/admin/set.js",
-              )
-
-    class Media:
-        css = {
-            'all': ("wiki/markitup/skins/simple/style.css",
-                    "wiki/markitup/sets/frontend/style.css",)
-        }
-        js = ("wiki/markitup/frontend.init.js",
-              "wiki/markitup/jquery.markitup.js",
-              "wiki/markitup/sets/frontend/set.js",
-              )
-