Adding a help plugin and extra markdown extensions

testproject/testproject/settings.py

@@ -109,6 +109,7 @@ INSTALLED_APPS = (
     'sorl.thumbnail',
     'wiki',
     'wiki.plugins.images',
+    'wiki.plugins.help',
     'wiki.plugins.attachments',
     'wiki.plugins.notifications',
     'mptt',

wiki/conf/settings.py

@@ -13,6 +13,24 @@ WIKI_LANGUAGE = 'markdown'
 # extend the built-in editor and customize it....
 EDITOR = getattr(django_settings, 'WIKI_EDITOR', 'wiki.editors.markitup.MarkItUp')
 
+# If you want to write an extension, you should use the plugin API as you
+# will get an article model instance to play with. These are just the
+# builtin markdown extensions
+# Notice that this should be a callable which accepts the article as an argument
+def get_extensions(article):
+    from wiki.models import URLPath
+    try:
+        urlpath = URLPath.objects.get(article=article)
+        url = reverse_lazy('wiki:get', kwargs={'path': urlpath.path})
+    except URLPath.DoesNotExist:
+        url = reverse_lazy('wiki:get', kwargs={'article_id': article.id})
+    return ['extra', 'wikilinks(base_url=%s)' % url, 'codehilite(force_linenos=True)', 'toc']
+MARKDOWN_EXTENSIONS = getattr(
+    django_settings, 
+    'WIKI_MARKDOWN_EXTENSIONS',
+    get_extensions 
+)
+
 # 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
 # and all their content.

wiki/models/article.py

@@ -161,6 +161,7 @@ class Article(models.Model):
         else:
             content = self.current_revision.content
         extensions = plugin_registry.get_markdown_extensions()
+        extensions += settings.MARKDOWN_EXTENSIONS(self)
         return mark_safe(article_markdown(content, self, extensions=extensions))
         
     

wiki/plugins/help/models.py

+from django.db import models
+
+# Create your models here.

wiki/plugins/help/templates/wiki/plugins/help/sidebar.html

+{% load i18n %}<h4>{% trans "Adding new articles" %}</h4>
+<p>
+  {% trans "To create a new wiki article, create a link to it. Clicking the link gives you the creation page." %}
+</p>
+<pre>[Article Name](wiki:ArticleName)</pre>
+<h4>{% trans "An external link" %}</h4>
+<pre>[Link](http://google.com)</pre>
+
+<h4>{% trans "Headers" %}</h4>
+<p>{% trans "Use these codes for headers and to automatically generate Tables of Contents." %}</p>
+<pre>Hugest header
+===========
+
+Huger header
+------------
+
+# Hugest Header
+## Huger header
+### Huge header
+#### Small header
+
+[[ TOC ]]
+</pre>
+
+<h4>{% trans "Typography" %}</h4>
+
+<pre>*emphasis* or _emphasis_</pre>
+<pre>**strong** or __strong__</pre>
+
+<h4>{% trans "Lists" %}</h4>
+
+<pre>- Unordered List
+ - Sub Item 1
+ - Sub Item 2</pre>
+<pre>1. Ordered
+2. List</pre>

wiki/plugins/help/tests.py

+"""
+This file demonstrates writing tests using the unittest module. These will pass
+when you run "manage.py test".
+
+Replace this with more appropriate tests for your application.
+"""
+
+from django.test import TestCase
+
+
+class SimpleTest(TestCase):
+    def test_basic_addition(self):
+        """
+        Tests that 1 + 1 always equals 2.
+        """
+        self.assertEqual(1 + 1, 2)

wiki/plugins/help/views.py

+# Create your views here.

wiki/plugins/help/wiki_plugin.py

+# -*- coding: utf-8 -*-
+from django.conf.urls.defaults import patterns
+from django.utils.translation import ugettext as _
+
+from wiki.core.plugins import registry
+from wiki.core.plugins.base import BasePlugin
+
+class HelpPlugin(BasePlugin):
+    
+    slug = 'help'
+    urlpatterns = patterns('',)
+    
+    sidebar = {'headline': _('Help'),
+               'icon_class': 'icon-question-sign',
+               'template': 'wiki/plugins/help/sidebar.html',
+               'form_class': None,
+               'get_form_kwargs': (lambda a: {})}
+    
+    markdown_extensions = []
+    
+    def __init__(self):
+        pass
+    
+registry.register(HelpPlugin)
+

wiki/plugins/images/wiki_plugin.py

@@ -10,13 +10,7 @@ from wiki.plugins.images.markdown_extensions import ImageExtension
 
 class ImagePlugin(BasePlugin):
     
-    #settings_form = 'wiki.plugins.notifications.forms.SubscriptionForm'
-    
     slug = settings.SLUG
-    urlpatterns = patterns('',
-        url('^$', views.ImageView.as_view(), name='images_index'),
-    )
-    
     sidebar = {'headline': _('Images'),
                'icon_class': 'icon-picture',
                'template': 'wiki/plugins/images/sidebar.html',

wiki/templates/wiki/base.html

@@ -27,6 +27,14 @@
       #attachment_form #id_description
       { width: 95% }
       
+      .wiki-article div.toc {
+        margin: 10px 0;
+        background: #f9f9f9;
+        padding: 10px;
+        width: 300px;
+        border: 1px solid #CCC;
+      }
+      
       input[type=file] {float: none; width: auto;}
       .asteriskField { font-size: 20px; margin-left: 5px;}
       

wiki/views/article.py

@@ -252,8 +252,11 @@ class Edit(FormView, ArticleMixin):
         # Generate sidebar forms
         self.sidebar_forms = []
         for form_id, Form in self.get_sidebar_form_classes().items():
-            form = Form(self.article, self.request.user)
-            setattr(form, 'form_id', form_id)
+            if Form:
+                form = Form(self.article, self.request.user)
+                setattr(form, 'form_id', form_id)
+            else:
+                form = None
             self.sidebar_forms.append(form)
         return super(Edit, self).get(request, *args, **kwargs)
     
@@ -261,21 +264,24 @@ class Edit(FormView, ArticleMixin):
         # Generate sidebar forms
         self.sidebar_forms = []
         for form_id, Form in self.get_sidebar_form_classes().items():
-            if form_id == self.request.GET.get('f', None):
-                form = Form(self.article, self.request, data=self.request.POST, files=self.request.FILES)
-                if form.is_valid():
-                    form.save()
-                    usermessage = form.get_usermessage()
-                    if usermessage:
-                        messages.success(self.request, usermessage)
-                    else:
-                        messages.success(self.request, _(u'Your changes were saved.'))
-                    if self.urlpath:
-                        return redirect('wiki:edit', path=self.urlpath.path)
-                    return redirect('wiki:edit', article_id=self.article.id)
+            if Form:
+                if form_id == self.request.GET.get('f', None):
+                    form = Form(self.article, self.request, data=self.request.POST, files=self.request.FILES)
+                    if form.is_valid():
+                        form.save()
+                        usermessage = form.get_usermessage()
+                        if usermessage:
+                            messages.success(self.request, usermessage)
+                        else:
+                            messages.success(self.request, _(u'Your changes were saved.'))
+                        if self.urlpath:
+                            return redirect('wiki:edit', path=self.urlpath.path)
+                        return redirect('wiki:edit', article_id=self.article.id)
+                else:
+                    form = Form(self.article, self.request)
+                setattr(form, 'form_id', form_id)
             else:
-                form = Form(self.article, self.request)
-            setattr(form, 'form_id', form_id)
+                form = None
             self.sidebar_forms.append(form)
         return super(Edit, self).post(request, *args, **kwargs)