Steve Losh avatar Steve Losh committed 6d7c137

Rename the text files to play nicely with BitBucket and Github.

Comments (0)

Files changed (4)

LICENSE

-Copyright (c) 2010 Dumbwaiter Design
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+Copyright (c) 2010 Dumbwaiter Design
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README

-django-ckeditor
-===============
-
-`django-ckeditor` makes it easy to use CKEditor with your Django text fields.
-
-Setup
------
-
-Install the package:
-
-    pip install -e hg+ssh://hg@codebasehq.com/dwaiter/util/django-ckeditor.hg#egg=django-ckeditor
-
-Symlink the necessary media and templates:
-
-    ln -s [/full/path/to]/django-ckeditor/ckeditor/media/ckeditor media/ckeditor
-    ln -s [/full/path/to]/django-ckeditor/ckeditor/templates/ckeditor templates/ckeditor
-
-Add `ckeditor` to your `INSTALLED_APPS`.
-
-Add a `CKEDITOR_CONFIGS` variable to your `settings.py` with at least a
-`default` config:
-
-    CKEDITOR_CONFIGS = {
-        'default': {
-            'toolbar': [
-                [      'Undo', 'Redo',
-                  '-', 'Bold', 'Italic', 'Underline',
-                  '-', 'Link', 'Unlink', 'Anchor',
-                  '-', 'Format',
-                  '-', 'SpellChecker', 'Scayt',
-                  '-', 'Maximize',
-                ],
-                [      'HorizontalRule',
-                  '-', 'Table',
-                  '-', 'BulletedList', 'NumberedList',
-                  '-', 'Cut','Copy','Paste','PasteText','PasteFromWord',
-                  '-', 'SpecialChar',
-                  '-', 'Source',
-                  '-', 'About',
-                ]
-            ],
-            'width': 840,
-            'height': 300,
-            'toolbarCanCollapse': False,
-        }
-    }
-
-Usage
------
-
-To use CKEditor for a particular field in a form, set its widget to an
-instance of `ckeditor.widgets.CKEditor` like this:
-
-    from ckeditor.widgets import CKEditor
-    
-    class SampleForm(forms.Form):
-        body = forms.CharField(
-            widget=CKEditor()
-        )
-    
-
-As a shortcut you can use a `ckeditor.fields.HTMLField` instead of
-`django.db.models.TextField` in a model to automatically use the CKEditor
-widget, like so:
-
-    from django.db import models
-    from ckeditor.fields import HTMLField
-    
-    class Sample(models.Model):
-        # This will use a normal <textarea> when rendered in a (Model)Form
-        plain_body = models.TextField(blank=True, verbose_name='plain version')
-        
-        # This will use CKEditor when rendered in a (Model)Form
-        html_body = HTMLField(blank=True, verbose_name='HTML version')
-
-Custom Configurations
----------------------
-
-Sometimes it's nice to be able to configure each CKEditor widget separately.
-For example, you may want one field to have all the buttons on the toolbar,
-but another field to only show bold/italic/underline buttons.
-
-To do this, add additional configurations to your `CKEDITOR_CONFIGS` setting
-like this:
-
-    CKEDITOR_CONFIGS = {
-        'default': {
-            'toolbar': [
-                [      'Undo', 'Redo',
-                  '-', 'Bold', 'Italic', 'Underline',
-                  '-', 'Link', 'Unlink', 'Anchor',
-                  '-', 'Format',
-                  '-', 'SpellChecker', 'Scayt',
-                  '-', 'Maximize',
-                ],
-            ],
-            'width': 840,
-            'height': 300,
-            'toolbarCanCollapse': False,
-        },
-        
-        'simple_toolbar': {
-            'toolbar': [
-                [ 'Bold', 'Italic', 'Underline' ],
-            ],
-            'width': 840,
-            'height': 300,
-        },
-    }
-
-When setting up the `CKEditor` widget in your `Form` class you can pass a
-`ckeditor_config` keyword argument to specify the config to use:
-
-    class BlogPostForm(forms.Form):
-        title = forms.CharField()
-        
-        # This field will render as a CKEditor with the 'simple_toolbar' config.
-        subtitle = forms.CharField(
-            widget=CKEditor(ckeditor_config='simple_toolbar')
-        )
-        
-        # This field will render as a CKEditor with the 'default' config.
-        body = forms.CharField(
-            widget=CKEditor()
-        )
-    
-
-You cannot use the `HTMLField` shortcut if you want to specify a custom config
--- you *must* create a form.
+django-ckeditor
+===============
+
+`django-ckeditor` makes it easy to use CKEditor with your Django text fields.
+
+Setup
+-----
+
+Install the package:
+
+    pip install -e hg+ssh://hg@codebasehq.com/dwaiter/util/django-ckeditor.hg#egg=django-ckeditor
+
+Symlink the necessary media and templates:
+
+    ln -s [/full/path/to]/django-ckeditor/ckeditor/media/ckeditor media/ckeditor
+    ln -s [/full/path/to]/django-ckeditor/ckeditor/templates/ckeditor templates/ckeditor
+
+Add `ckeditor` to your `INSTALLED_APPS`.
+
+Add a `CKEDITOR_CONFIGS` variable to your `settings.py` with at least a
+`default` config:
+
+    CKEDITOR_CONFIGS = {
+        'default': {
+            'toolbar': [
+                [      'Undo', 'Redo',
+                  '-', 'Bold', 'Italic', 'Underline',
+                  '-', 'Link', 'Unlink', 'Anchor',
+                  '-', 'Format',
+                  '-', 'SpellChecker', 'Scayt',
+                  '-', 'Maximize',
+                ],
+                [      'HorizontalRule',
+                  '-', 'Table',
+                  '-', 'BulletedList', 'NumberedList',
+                  '-', 'Cut','Copy','Paste','PasteText','PasteFromWord',
+                  '-', 'SpecialChar',
+                  '-', 'Source',
+                  '-', 'About',
+                ]
+            ],
+            'width': 840,
+            'height': 300,
+            'toolbarCanCollapse': False,
+        }
+    }
+
+Usage
+-----
+
+To use CKEditor for a particular field in a form, set its widget to an
+instance of `ckeditor.widgets.CKEditor` like this:
+
+    from ckeditor.widgets import CKEditor
+    
+    class SampleForm(forms.Form):
+        body = forms.CharField(
+            widget=CKEditor()
+        )
+    
+
+As a shortcut you can use a `ckeditor.fields.HTMLField` instead of
+`django.db.models.TextField` in a model to automatically use the CKEditor
+widget, like so:
+
+    from django.db import models
+    from ckeditor.fields import HTMLField
+    
+    class Sample(models.Model):
+        # This will use a normal <textarea> when rendered in a (Model)Form
+        plain_body = models.TextField(blank=True, verbose_name='plain version')
+        
+        # This will use CKEditor when rendered in a (Model)Form
+        html_body = HTMLField(blank=True, verbose_name='HTML version')
+
+Custom Configurations
+---------------------
+
+Sometimes it's nice to be able to configure each CKEditor widget separately.
+For example, you may want one field to have all the buttons on the toolbar,
+but another field to only show bold/italic/underline buttons.
+
+To do this, add additional configurations to your `CKEDITOR_CONFIGS` setting
+like this:
+
+    CKEDITOR_CONFIGS = {
+        'default': {
+            'toolbar': [
+                [      'Undo', 'Redo',
+                  '-', 'Bold', 'Italic', 'Underline',
+                  '-', 'Link', 'Unlink', 'Anchor',
+                  '-', 'Format',
+                  '-', 'SpellChecker', 'Scayt',
+                  '-', 'Maximize',
+                ],
+            ],
+            'width': 840,
+            'height': 300,
+            'toolbarCanCollapse': False,
+        },
+        
+        'simple_toolbar': {
+            'toolbar': [
+                [ 'Bold', 'Italic', 'Underline' ],
+            ],
+            'width': 840,
+            'height': 300,
+        },
+    }
+
+When setting up the `CKEditor` widget in your `Form` class you can pass a
+`ckeditor_config` keyword argument to specify the config to use:
+
+    class BlogPostForm(forms.Form):
+        title = forms.CharField()
+        
+        # This field will render as a CKEditor with the 'simple_toolbar' config.
+        subtitle = forms.CharField(
+            widget=CKEditor(ckeditor_config='simple_toolbar')
+        )
+        
+        # This field will render as a CKEditor with the 'default' config.
+        body = forms.CharField(
+            widget=CKEditor()
+        )
+    
+
+You cannot use the `HTMLField` shortcut if you want to specify a custom config
+-- you *must* create a form.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.