Commits

Carl Meyer committed 3be618c

Tweaked README, removed previewParserPath from MarkItUp! sets.

Comments (0)

Files changed (4)

 MarkItUp! allows the toolbar button-set to be customized in a
 Javascript settings file.  By default, django-markitup uses the
 "default" set (meant for HTML editing).  Django-markitup also includes
-basic "markdown" and "textile" sets (these are the sets available from
-`the MarkItUp site <http://markitup.jaysalvat.com>`_, modified only to
-add previewParserPath).
+basic "markdown" and "textile" sets (these are available from `the
+MarkItUp site <http://markitup.jaysalvat.com>`_), as well as a
+"restructuredtext" set.
 
 To use an alternate set, assign the ``MARKITUP_SET`` setting a URL path
 (absolute or relative to ``STATIC_URL``) to the set directory.  For
 can override this template in your project and customize the preview
 output.
 
-**Note:** If you use your own custom MarkItUp! set, be sure to set the
-  ``previewParserPath`` option to ``'/markitup/preview/'``.
+.. note::
 
-**Note:** Using the MarkItUpWidget or ``markitup_editor`` template tag will
-automatically set the ``previewParserPath`` to ``reverse('markitup_preview')``,
-if it is included in your URLconf. Otherwise, the default from set.js will be
-used.  
+    Using the MarkItUpWidget or ``markitup_editor`` template tag will
+    automatically set the ``previewParserPath`` in your MarkItUp! set
+    to ``reverse('markitup_preview')``, if ``markitup.urls`` is
+    included in your URLconf.
 
 The MARKITUP_FILTER setting
 ===========================

markitup/static/markitup/sets/markdown/set.js

 // Feel free to add more tags
 // -------------------------------------------------------------------
 mySettings = {
-	previewParserPath:	'/markitup/preview/',
 	onShiftEnter:		{keepDefault:false, openWith:'\n\n'},
 	markupSet: [
 		{name:'First Level Heading', key:'1', placeHolder:'Your title here...', closeWith:function(markItUp) { return miu.markdownTitle(markItUp, '=') } },

markitup/static/markitup/sets/restructuredtext/set.js

 // -------------------------------------------------------------------
 mySettings = {
 	nameSpace: 'ReST',
-	previewParserPath:	'/markitup/preview/',
 	onShiftEnter: {keepDefault:false, openWith:'\n\n'},
 	onTab: {keepDefault:false, replaceWith:'    '},
 	markupSet: [

markitup/static/markitup/sets/textile/set.js

 // Feel free to add more tags
 // -------------------------------------------------------------------
 mySettings = {
-	previewParserPath:	'/markitup/preview/',
 	onShiftEnter:		{keepDefault:false, replaceWith:'\n\n'},
 	markupSet: [
 		{name:'Heading 1', key:'1', openWith:'h1(!(([![Class]!]))!). ', placeHolder:'Your title here...' },