added CKEDITOR_UPLOAD_MEDIA_URL docs

shaunsephton · shaunsephton · commit 135d3466b4fc · 2010-05-28T09:44:21.000+02:00
diff --git a/README.rst b/README.rst
@@ -1,11 +1,11 @@
-Django CKEditor:
+Django CKEditor
 ================
 **Django admin CKEditor integration.**
 
 Provides a ``RichTextField`` and ``CKEditorWidget`` utilizing CKEditor with image upload and browsing support included.
 
 
-Installation:
+Installation
 ------------
 
 #. Install or add django-ckeditor to your python path.
@@ -14,7 +14,7 @@ Installation:
 
 #. Copy the ``media/ckeditor`` directory into any directory within your media root. You can override the location in your settings (see below).
 
-#. Add a CKEDITOR_MEDIA_PREFIX setting to the project's ``settings.py`` file. This setting specifies a URL prefix to the ckeditor media. Make sure to use a trailing slash::
+#. Add a CKEDITOR_MEDIA_PREFIX setting to the project's ``settings.py`` file. This setting specifies a URL prefix to the ckeditor JS and CSS media (not uploaded media). Make sure to use a trailing slash::
 
     CKEDITOR_MEDIA_PREFIX = "/media/ckeditor/"
 
@@ -26,11 +26,17 @@ Installation:
     
     (r'^ckeditor/', include('ckeditor.urls')),    
 
-Usage:
-------
+#. Optionally, add a CKEDITOR_UPLOAD_MEDIA_URL setting to the project's ``settings.py`` file. This is the URL from which ckeditor uploaded media is served, i.e.::
 
-Field:
-~~~~~~
+    CKEDITOR_UPLOAD_MEDIA_URL = "http://media.lawrence.com/media/uploads/
+
+(If CKEDITOR_UPLOAD_MEDIA_URL is not provided, the media URL will fall back to MEDIA_URL with the difference of MEDIA_ROOT and CKEDITOR_UPLOAD_PATH appended.)
+
+Usage
+-----
+
+Field
+~~~~~
 The quickest way to add rich text editing capabilities to your models is to use the included ``RichTextField`` model field type. A CKEditor widget is rendered as the form field but in all other regards the field behaves as the standard Django ``TextField``. For example::
 
     from django.db import models
@@ -40,8 +46,8 @@ The quickest way to add rich text editing capabilities to your models is to use
         content = RichTextField()
 
 
-Widget:
-~~~~~~~
+Widget
+~~~~~~
 Alernatively you can use the included ``CKEditorWidget`` as the widget for a formfield. For example::
 
     from django import forms
@@ -59,3 +65,12 @@ Alernatively you can use the included ``CKEditorWidget`` as the widget for a for
         form = PostAdminForm
     
     admin.site.register(Post, PostAdmin)
+
+
+ChangeLog
+~~~~~~~~~
+
+0.0.1
++++++
+
+Added CKEDITOR_UPLOAD_MEDIA_URL setting. Thanks to chr15m for the input.
