Skip to content

Commit e1aadaa

Browse files
author
Nelson
committed
initial commit
0 parents  commit e1aadaa

21 files changed

+1204
-0
lines changed

‎LICENSE.txt

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Copyright (c) 2008 Joost Cassee
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
copies of the Software, and to permit persons to whom the Software is
8+
furnished to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in
11+
all copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19+
THE SOFTWARE.

‎PKG-INFO

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
Metadata-Version: 1.0
2+
Name: django-tinymce
3+
Version: 1.5
4+
Summary: A Django application that contains a widget to render a form field as a TinyMCE editor.
5+
Home-page: http://code.google.com/p/django-tinymce/
6+
Author: Joost Cassee
7+
Author-email: [email protected]
8+
License: MIT License
9+
Download-URL: http://code.google.com/p/django-tinymce/downloads/list
10+
Description:
11+
Use the TinyMCE editor for your form textareas.
12+
13+
Features:
14+
15+
* Use as a form widget or with a view.
16+
* Enhanced support for content languages.
17+
* Integration with the TinyMCE spellchecker.
18+
* Enables predefined link and image lists for dialogs.
19+
* Can compress the TinyMCE javascript files.
20+
* Integration with django-filebrowser.
21+
22+
Keywords: django widget tinymce
23+
Platform: any
24+
Classifier: Development Status :: 5 - Production/Stable
25+
Classifier: Environment :: Web Environment
26+
Classifier: Framework :: Django
27+
Classifier: Intended Audience :: Developers
28+
Classifier: License :: OSI Approved :: MIT License
29+
Classifier: Operating System :: OS Independent
30+
Classifier: Programming Language :: Python
31+
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
32+
Classifier: Topic :: Software Development :: Libraries :: Python Modules

‎README.txt

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
This Django application provides a TinyMCE widget.
2+
3+
Copyright (C) 2008 Joost Cassee
4+
This program is licensed under the MIT License (see LICENSE.txt)
5+
6+
See http://django-tinymce.googlecode.com for docs.
7+
8+
--
9+
Joost Cassee
10+
[email protected]

‎docs/history.rst

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
=========
2+
History
3+
=========
4+
5+
Changelog
6+
---------
7+
8+
Release 1.5 (2009-02-13):
9+
* Updated Google Code CSS location.
10+
* Fixed a compressor crash when 'theme' configuration was omitted.
11+
* Added a note in the documentation about Python-JSON type conversion.
12+
* Fixed the filebrowser integration when serving media from a different
13+
domain.
14+
* Fixed flatpages example code in documentation.
15+
* Added support for the preview plugin.
16+
* Added "'relative_urls': False" to the default settings to fix integration
17+
with django-filebrowser.
18+
19+
Release 1.4 (2009-01-28):
20+
* Fixed bugs in compressor code causing it not to load.
21+
* Fixed widget media property.
22+
23+
Release 1.3 (2009-01-15):
24+
* Added integration with `django-filebrowser`_.
25+
* Added templates to source distribution.
26+
* Updated TinyMCE compressor support: copying media files no longer required.
27+
28+
.. _`django-filebrowser`: http://code.google.com/p/django-filebrowser/
29+
30+
Release 1.2 (2008-11-26):
31+
* Moved documentation from Wiki into repository.
32+
33+
Release 1.1 (2008-11-20):
34+
* Added TinyMCE compressor support by Jason Davies.
35+
* Added HTMLField.
36+
37+
Release 1.0 (2008-09-10):
38+
* Added link and image list support.
39+
* Moved from private repository to Google Code.
40+
41+
42+
Credits
43+
-------
44+
45+
tinymce was written by `Joost Cassee`_ based on the work by John D'Agostino. It
46+
was partly taken from `his code at the Django code wiki`_. The TinyMCE_
47+
Javascript WYSIWYG editor is made by Moxiecode_.
48+
49+
The TinyMCE compressor was written by `Jason Davies`_ based on the `PHP TinyMCE
50+
compressor`_ from Moxiecode.
51+
52+
53+
.. _`Joost Cassee`: http://joost.cassee.net/
54+
.. _TinyMCE: http://tinymce.moxiecode.com/
55+
.. _Moxiecode: http://www.moxiecode.com/
56+
.. _`his code at the Django code wiki`: http://code.djangoproject.com/wiki/CustomWidgetsTinyMCE
57+
.. _`Jason Davies`: http://www.jasondavies.com
58+
.. _`PHP TinyMCE compressor`: http://wiki.moxiecode.com/index.php/TinyMCE:Compressor

‎docs/index.rst

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
Welcome to the tinymce documentation
2+
====================================
3+
4+
tinymce is a Django_ application that contains a widget to render a form field
5+
as a TinyMCE_ editor.
6+
7+
Features:
8+
* Use as a form widget or with a view.
9+
* Enhanced support for content languages.
10+
* Integration with the TinyMCE spellchecker.
11+
* Enables predefined link and image lists for dialogs.
12+
* Can compress the TinyMCE Javascript code.
13+
* Integration with `django-filebrowser`_.
14+
15+
The tinymce code is licensed under the `MIT License`_. See the ``LICENSE.txt``
16+
file in the distribution. Note that the TinyMCE editor is distributed under
17+
`its own license`_.
18+
19+
.. _Django: http://www.djangoproject.com/
20+
.. _TinyMCE: http://tinymce.moxiecode.com/
21+
.. _`django-filebrowser`: http://code.google.com/p/django-filebrowser/
22+
.. _`MIT License`: http://www.opensource.org/licenses/mit-license.php
23+
.. _`its own license`: http://tinymce.moxiecode.com/license.php
24+
25+
Documentation
26+
-------------
27+
28+
.. toctree::
29+
:maxdepth: 2
30+
31+
installation
32+
usage
33+
history
34+

‎docs/installation.rst

+111
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
============
2+
Installation
3+
============
4+
5+
This section describes how to install the tinymce application in your Django
6+
project.
7+
8+
9+
Prerequisites
10+
-------------
11+
12+
The tinymce application requires Django_ version 1.0 or higher. You will also
13+
need TinyMCE_ version 3.0 or higher and optionally a `language pack`_ for your
14+
projects languages. If you use the `django-filebrowser`_ application in your
15+
project, the tinymce application can use it as a browser when including media.
16+
17+
If you want to use the `spellchecker plugin`_ using the supplied view (no PHP
18+
needed) you must install the `PyEnchant`_ package and dictionaries for your
19+
project languages. Note that the Enchant needs a dictionary that exactly
20+
matches your language codes. For example, a dictionary for code ``'en-us'``
21+
will not automatically be used for ``'en'``. You can check the availability of
22+
the Enchant dictionary for the ``'en'`` language code using the following
23+
Python code::
24+
25+
import enchant
26+
enchant.dict_exists('en')
27+
28+
.. _Django: http://www.djangoproject.com/download/
29+
.. _TinyMCE: http://tinymce.moxiecode.com/download.php
30+
.. _`language pack`: http://tinymce.moxiecode.com/download_i18n.php
31+
.. _`spellchecker plugin`: http://wiki.moxiecode.com/index.php/TinyMCE:Plugins/spellchecker
32+
.. _`PyEnchant`: http://pyenchant.sourceforge.net/
33+
.. _`django-filebrowser`: http://code.google.com/p/django-filebrowser/
34+
35+
36+
Installation
37+
------------
38+
39+
#. Place the ``tinymce`` module in your Python path. You can put it into your
40+
Django project directory or run ``python setup.py install`` from a shell.
41+
42+
#. Copy the ``jscripts/tiny_mce`` directory from the TinyMCE distribution into
43+
a directory named ``js`` in your media root. You can override the location in
44+
your settings (see below).
45+
46+
#. If you want to use any of the views add tinymce your installed applications
47+
list and URLconf:
48+
49+
``settings.py``::
50+
51+
INSTALLED_APPS = (
52+
...
53+
'tinymce',
54+
...
55+
)
56+
57+
``urls.py``::
58+
59+
urlpatterns = patterns('',
60+
...
61+
(r'^tinymce/', include('tinymce.urls')),
62+
...
63+
)
64+
65+
66+
.. _configuration:
67+
68+
Configuration
69+
-------------
70+
71+
The application can be configured by editing the project's ``settings.py``
72+
file.
73+
74+
``TINYMCE_JS_URL`` (default: ``settings.MEDIA_URL + 'js/tiny_mce/tiny_mce.js'``)
75+
The URL of the TinyMCE javascript file.
76+
77+
``TINYMCE_JS_ROOT`` (default: ``settings.MEDIA_ROOT + 'js/tiny_mce'``)
78+
The filesystem location of the TinyMCE files.
79+
80+
``TINYMCE_DEFAULT_CONFIG`` (default: ``{'theme': "simple", 'relative_urls': False}``)
81+
The default TinyMCE configuration to use. See `the TinyMCE manual`_ for all
82+
options. To set the configuration for a specific TinyMCE editor, see the
83+
``mce_attrs`` parameter for the :ref:`widget <widget>`.
84+
85+
``TINYMCE_SPELLCHECKER`` (default: ``False``)
86+
Whether to use the spell checker through the supplied view. You must add
87+
``spellchecker`` to the TinyMCE plugin list yourself, it is not added
88+
automatically.
89+
90+
``TINYMCE_COMPRESSOR`` (default: ``False``)
91+
Whether to use the TinyMCE compressor, which gzips all Javascript files into
92+
a single stream. This makes the overall download size 75% smaller and also
93+
reduces the number of requests. The overall initialization time for TinyMCE
94+
will be reduced dramatically if you use this option.
95+
96+
``TINYMCE_FILEBROWSER`` (default: ``True`` if ``'filebrowser'`` is in ``INSTALLED_APPS``, else ``False``)
97+
Whether to use `django-filebrowser`_ as a custom filebrowser for media
98+
inclusion. See the `official TinyMCE documentation on custom filebrowsers`_.
99+
100+
Example::
101+
102+
TINYMCE_JS_URL = 'http://debug.example.org/tiny_mce/tiny_mce_src.js'
103+
TINYMCE_DEFAULT_CONFIG = {
104+
'plugins': "table,spellchecker,paste,searchreplace",
105+
'theme': "advanced",
106+
}
107+
TINYMCE_SPELLCHECKER = True
108+
TINYMCE_COMPRESSOR = True
109+
110+
.. _`the TinyMCE manual`: http://wiki.moxiecode.com/index.php/TinyMCE:Configuration
111+
.. _`official TinyMCE documentation on custom filebrowsers`: http://wiki.moxiecode.com/index.php/TinyMCE:Custom_filebrowser

0 commit comments

Comments
 (0)