Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 245 lines (177 sloc) 5.503 kB
ebbc566 @ojii Changed documentation section styles to be consistent (and to the sec…
ojii authored
1 #######
8ce3b3e @digi604 plugin docs
digi604 authored
2 Plugins
ebbc566 @ojii Changed documentation section styles to be consistent (and to the sec…
ojii authored
3 #######
8ce3b3e @digi604 plugin docs
digi604 authored
4
ebbc566 @ojii Changed documentation section styles to be consistent (and to the sec…
ojii authored
5 ****
8ce3b3e @digi604 plugin docs
digi604 authored
6 File
ebbc566 @ojii Changed documentation section styles to be consistent (and to the sec…
ojii authored
7 ****
8ce3b3e @digi604 plugin docs
digi604 authored
8
faf5537 @cortextual a few minor changes to the plugin documentation
cortextual authored
9 Allows you to upload a file. A filetype icon will be assigned based on the file extension.
8ce3b3e @digi604 plugin docs
digi604 authored
10
c516c1c @digi604 documentation is now 100% sphinx compatible
digi604 authored
11 For installation be sure you have the following in the ``INSTALLED_APPS`` setting
12 in your project's ``settings.py`` file::
8ce3b3e @digi604 plugin docs
digi604 authored
13
14 INSTALLED_APPS = (
faf5537 @cortextual a few minor changes to the plugin documentation
cortextual authored
15 # ...
8ce3b3e @digi604 plugin docs
digi604 authored
16 'cms.plugins.file',
faf5537 @cortextual a few minor changes to the plugin documentation
cortextual authored
17 # ...
8ce3b3e @digi604 plugin docs
digi604 authored
18 )
19
ebbc566 @ojii Changed documentation section styles to be consistent (and to the sec…
ojii authored
20
21 *****
8ce3b3e @digi604 plugin docs
digi604 authored
22 Flash
ebbc566 @ojii Changed documentation section styles to be consistent (and to the sec…
ojii authored
23 *****
8ce3b3e @digi604 plugin docs
digi604 authored
24
faf5537 @cortextual a few minor changes to the plugin documentation
cortextual authored
25 Allows you to upload and display a Flash SWF file on your page.
8ce3b3e @digi604 plugin docs
digi604 authored
26
0299f9d @ssteinerx Cleaned up 80 col wrapping in most docs, fixed *all* Sphinx build err…
ssteinerx authored
27 For installation be sure you have the following in the ``INSTALLED_APPS``
28 setting in your project's ``settings.py`` file::
8ce3b3e @digi604 plugin docs
digi604 authored
29
30 INSTALLED_APPS = (
faf5537 @cortextual a few minor changes to the plugin documentation
cortextual authored
31 # ...
8ce3b3e @digi604 plugin docs
digi604 authored
32 'cms.plugins.flash',
faf5537 @cortextual a few minor changes to the plugin documentation
cortextual authored
33 # ...
8ce3b3e @digi604 plugin docs
digi604 authored
34 )
0299f9d @ssteinerx Cleaned up 80 col wrapping in most docs, fixed *all* Sphinx build err…
ssteinerx authored
35
8ce3b3e @digi604 plugin docs
digi604 authored
36
ebbc566 @ojii Changed documentation section styles to be consistent (and to the sec…
ojii authored
37 *********
8ce3b3e @digi604 plugin docs
digi604 authored
38 GoogleMap
ebbc566 @ojii Changed documentation section styles to be consistent (and to the sec…
ojii authored
39 *********
8ce3b3e @digi604 plugin docs
digi604 authored
40
41 Displays a map of an address on your page.
42
c516c1c @digi604 documentation is now 100% sphinx compatible
digi604 authored
43 For installation be sure you have the following in the ``INSTALLED_APPS``
44 setting in your project's ``settings.py`` file::
8ce3b3e @digi604 plugin docs
digi604 authored
45
46 INSTALLED_APPS = (
faf5537 @cortextual a few minor changes to the plugin documentation
cortextual authored
47 # ...
8ce3b3e @digi604 plugin docs
digi604 authored
48 'cms.plugins.googlemap',
faf5537 @cortextual a few minor changes to the plugin documentation
cortextual authored
49 # ...
8ce3b3e @digi604 plugin docs
digi604 authored
50 )
0299f9d @ssteinerx Cleaned up 80 col wrapping in most docs, fixed *all* Sphinx build err…
ssteinerx authored
51
52 The Google Maps API key is also required. You can either put this in a project
53 setting called ``GOOGLE_MAPS_API_KEY`` or be sure the template context has a
54 variable with the same name.
8ce3b3e @digi604 plugin docs
digi604 authored
55
ebbc566 @ojii Changed documentation section styles to be consistent (and to the sec…
ojii authored
56
57 ****
8ce3b3e @digi604 plugin docs
digi604 authored
58 Link
ebbc566 @ojii Changed documentation section styles to be consistent (and to the sec…
ojii authored
59 ****
8ce3b3e @digi604 plugin docs
digi604 authored
60
0299f9d @ssteinerx Cleaned up 80 col wrapping in most docs, fixed *all* Sphinx build err…
ssteinerx authored
61 Displays a link to an arbitrary URL or to a page. If a page is moved the URL
62 will still be correct.
8ce3b3e @digi604 plugin docs
digi604 authored
63
c516c1c @digi604 documentation is now 100% sphinx compatible
digi604 authored
64 For installation be sure to have the following in the ``INSTALLED_APPS``
65 setting in your project's ``settings.py`` file::
8ce3b3e @digi604 plugin docs
digi604 authored
66
67 INSTALLED_APPS = (
faf5537 @cortextual a few minor changes to the plugin documentation
cortextual authored
68 # ...
8ce3b3e @digi604 plugin docs
digi604 authored
69 'cms.plugins.link',
faf5537 @cortextual a few minor changes to the plugin documentation
cortextual authored
70 # ...
8ce3b3e @digi604 plugin docs
digi604 authored
71 )
72
ebbc566 @ojii Changed documentation section styles to be consistent (and to the sec…
ojii authored
73
74 *******
8ce3b3e @digi604 plugin docs
digi604 authored
75 Picture
ebbc566 @ojii Changed documentation section styles to be consistent (and to the sec…
ojii authored
76 *******
8ce3b3e @digi604 plugin docs
digi604 authored
77
faf5537 @cortextual a few minor changes to the plugin documentation
cortextual authored
78 Displays a picture in a page.
8ce3b3e @digi604 plugin docs
digi604 authored
79
c516c1c @digi604 documentation is now 100% sphinx compatible
digi604 authored
80 For installation be sure you have the following in the ``INSTALLED_APPS``
81 setting in your project's ``settings.py`` file::
8ce3b3e @digi604 plugin docs
digi604 authored
82
83 INSTALLED_APPS = (
faf5537 @cortextual a few minor changes to the plugin documentation
cortextual authored
84 # ...
8ce3b3e @digi604 plugin docs
digi604 authored
85 'cms.plugins.picture',
faf5537 @cortextual a few minor changes to the plugin documentation
cortextual authored
86 # ...
8ce3b3e @digi604 plugin docs
digi604 authored
87 )
0299f9d @ssteinerx Cleaned up 80 col wrapping in most docs, fixed *all* Sphinx build err…
ssteinerx authored
88
89 If you want to resize the picture you can get a thumbnail library. We
90 recommend `sorl.thumbnail <http://code.google.com/p/sorl-thumbnail/>`_.
91
92 In your project template directory create a folder called ``cms/plugins`` and
93 create a file called ``picture.html`` in there. Here is an example
94 ``picture.html`` template::
8ce3b3e @digi604 plugin docs
digi604 authored
95
96 {% load i18n thumbnail %}
97 {% spaceless %}
0299f9d @ssteinerx Cleaned up 80 col wrapping in most docs, fixed *all* Sphinx build err…
ssteinerx authored
98
8ce3b3e @digi604 plugin docs
digi604 authored
99 {% if picture.url %}<a href="{{ picture.url }}">{% endif %}
100 {% ifequal placeholder "content" %}
1a6c33d @digi604 fixes #14 login required & menu login required options added
digi604 authored
101 <img src="{% thumbnail picture.image.name 484x1500 upscale %}" {% if picture.alt %}alt="{{ picture.alt }}" {% endif %}/>
8ce3b3e @digi604 plugin docs
digi604 authored
102 {% endifequal %}
103 {% ifequal placeholder "teaser" %}
1a6c33d @digi604 fixes #14 login required & menu login required options added
digi604 authored
104 <img src="{% thumbnail picture.image.name 484x1500 upscale %}" {% if picture.alt %}alt="{{ picture.alt }}" {% endif %}/>
8ce3b3e @digi604 plugin docs
digi604 authored
105 {% endifequal %}
106 {% if picture.url %}</a>{% endif %}
0299f9d @ssteinerx Cleaned up 80 col wrapping in most docs, fixed *all* Sphinx build err…
ssteinerx authored
107
8ce3b3e @digi604 plugin docs
digi604 authored
108 {% endspaceless %}
109
0299f9d @ssteinerx Cleaned up 80 col wrapping in most docs, fixed *all* Sphinx build err…
ssteinerx authored
110 In this template the picture is scaled differently based on which placeholder
111 it was placed in.
8ce3b3e @digi604 plugin docs
digi604 authored
112
ebbc566 @ojii Changed documentation section styles to be consistent (and to the sec…
ojii authored
113
114 *******
8ce3b3e @digi604 plugin docs
digi604 authored
115 Snippet
ebbc566 @ojii Changed documentation section styles to be consistent (and to the sec…
ojii authored
116 *******
8ce3b3e @digi604 plugin docs
digi604 authored
117
faf5537 @cortextual a few minor changes to the plugin documentation
cortextual authored
118 Just renders some HTML snippet. Mostly used for development or hackery.
8ce3b3e @digi604 plugin docs
digi604 authored
119
c516c1c @digi604 documentation is now 100% sphinx compatible
digi604 authored
120 For installation be sure you have the following in the ``INSTALLED_APPS``
121 setting in your project's ``settings.py`` file::
8ce3b3e @digi604 plugin docs
digi604 authored
122
123 INSTALLED_APPS = (
faf5537 @cortextual a few minor changes to the plugin documentation
cortextual authored
124 # ...
8ce3b3e @digi604 plugin docs
digi604 authored
125 'cms.plugins.snippet',
faf5537 @cortextual a few minor changes to the plugin documentation
cortextual authored
126 # ...
8ce3b3e @digi604 plugin docs
digi604 authored
127 )
128
ebbc566 @ojii Changed documentation section styles to be consistent (and to the sec…
ojii authored
129
130 ******
8ce3b3e @digi604 plugin docs
digi604 authored
131 Teaser
ebbc566 @ojii Changed documentation section styles to be consistent (and to the sec…
ojii authored
132 ******
8ce3b3e @digi604 plugin docs
digi604 authored
133
0299f9d @ssteinerx Cleaned up 80 col wrapping in most docs, fixed *all* Sphinx build err…
ssteinerx authored
134 Displays a teaser box for another page or a URL. A picture and a description
135 can be added.
8ce3b3e @digi604 plugin docs
digi604 authored
136
0299f9d @ssteinerx Cleaned up 80 col wrapping in most docs, fixed *all* Sphinx build err…
ssteinerx authored
137 For installation be sure you have the following in the ``INSTALLED_APPS``
138 settings in your project's ``settings.py`` file::
8ce3b3e @digi604 plugin docs
digi604 authored
139
140 INSTALLED_APPS = (
faf5537 @cortextual a few minor changes to the plugin documentation
cortextual authored
141 # ...
8ce3b3e @digi604 plugin docs
digi604 authored
142 'cms.plugins.teaser',
faf5537 @cortextual a few minor changes to the plugin documentation
cortextual authored
143 # ...
8ce3b3e @digi604 plugin docs
digi604 authored
144 )
145
ebbc566 @ojii Changed documentation section styles to be consistent (and to the sec…
ojii authored
146
147 ****
8ce3b3e @digi604 plugin docs
digi604 authored
148 Text
ebbc566 @ojii Changed documentation section styles to be consistent (and to the sec…
ojii authored
149 ****
8ce3b3e @digi604 plugin docs
digi604 authored
150
0299f9d @ssteinerx Cleaned up 80 col wrapping in most docs, fixed *all* Sphinx build err…
ssteinerx authored
151 Displays text. If plugins are text-enabled they can be placed inside the
152 text-flow. At this moment the following plugins are text-enabled:
8ce3b3e @digi604 plugin docs
digi604 authored
153
154 - link
155 - picture
156 - file
157 - snippet
158
0299f9d @ssteinerx Cleaned up 80 col wrapping in most docs, fixed *all* Sphinx build err…
ssteinerx authored
159 The current editor is `Wymeditor <http://www.wymeditor.org/>`_. If you want to
160 use TinyMce you need to install `django-tinymce
161 <http://code.google.com/p/django-tinymce/>`_. If ``tinymce`` is in your
162 ``INSTALLED_APPS`` it will be automatically enabled. If you have tinymce
163 installed but don't want to use it in the cms put the following in your
164 ``settings.py``::
8ce3b3e @digi604 plugin docs
digi604 authored
165
c516c1c @digi604 documentation is now 100% sphinx compatible
digi604 authored
166 CMS_USE_TINYMCE = False
8ce3b3e @digi604 plugin docs
digi604 authored
167
0299f9d @ssteinerx Cleaned up 80 col wrapping in most docs, fixed *all* Sphinx build err…
ssteinerx authored
168 For installation be sure you have the following in your project's
169 ``INSTALLED_APPS`` setting::
8ce3b3e @digi604 plugin docs
digi604 authored
170
171 INSTALLED_APPS = (
faf5537 @cortextual a few minor changes to the plugin documentation
cortextual authored
172 # ...
8ce3b3e @digi604 plugin docs
digi604 authored
173 'cms.plugins.text',
faf5537 @cortextual a few minor changes to the plugin documentation
cortextual authored
174 # ...
175 )
0299f9d @ssteinerx Cleaned up 80 col wrapping in most docs, fixed *all* Sphinx build err…
ssteinerx authored
176
ebbc566 @ojii Changed documentation section styles to be consistent (and to the sec…
ojii authored
177
178 *****
bcaa32a @digi604 fixes #293 plugin docs updated
digi604 authored
179 Video
ebbc566 @ojii Changed documentation section styles to be consistent (and to the sec…
ojii authored
180 *****
bcaa32a @digi604 fixes #293 plugin docs updated
digi604 authored
181
0299f9d @ssteinerx Cleaned up 80 col wrapping in most docs, fixed *all* Sphinx build err…
ssteinerx authored
182 Plays Video Files or Youtube / Vimeo Videos. Uses the `OSFlashVideoPlayer
183 <http://github.com/FlashJunior/OSFlashVideoPlayer>`_. If you upload a file use
184 .flv files or h264 encoded video files.
185
bcaa32a @digi604 fixes #293 plugin docs updated
digi604 authored
186 For installation be sure you have the following in your project's ``INSTALLED_APPS`` setting::
187
188 INSTALLED_APPS = (
189 # ...
190 'cms.plugins.video',
191 # ...
192 )
0299f9d @ssteinerx Cleaned up 80 col wrapping in most docs, fixed *all* Sphinx build err…
ssteinerx authored
193
194 There are some settings you can set in your settings.py to overwrite some
195 default behavior:
506b28d @digi604 video plugin settings docs added
digi604 authored
196
197 - VIDEO_AUTOPLAY default=False
198 - VIDEO_AUTOHIDE default=False
199 - VIDEO_FULLSCREEN default=True
200 - VIDEO_LOOP default=False
201 - VIDEO_AUTOPLAY default=False
202 - VIDEO_AUTOPLAY default=False
203
204 - VIDEO_BG_COLOR default="000000"
205 - VIDEO_TEXT_COLOR default="FFFFFF"
206 - VIDEO_SEEKBAR_COLOR default="13ABEC"
207 - VIDEO_SEEKBARBG_COLOR default="333333"
208 - VIDEO_LOADINGBAR_COLOR default="828282"
209 - VIDEO_BUTTON_OUT_COLOR default="333333"
210 - VIDEO_BUTTON_OVER_COLOR default="000000"
211 - VIDEO_BUTTON_HIGHLIGHT_COLOR default="FFFFFF"
0299f9d @ssteinerx Cleaned up 80 col wrapping in most docs, fixed *all* Sphinx build err…
ssteinerx authored
212
506b28d @digi604 video plugin settings docs added
digi604 authored
213
ebbc566 @ojii Changed documentation section styles to be consistent (and to the sec…
ojii authored
214 *******
bcaa32a @digi604 fixes #293 plugin docs updated
digi604 authored
215 Twitter
ebbc566 @ojii Changed documentation section styles to be consistent (and to the sec…
ojii authored
216 *******
bcaa32a @digi604 fixes #293 plugin docs updated
digi604 authored
217
218 Displays the last number of post of a twitter user.
219
220 For installation be sure you have the following in your project's ``INSTALLED_APPS`` setting::
221
222 INSTALLED_APPS = (
223 # ...
224 'cms.plugins.twitter',
225 # ...
226 )
0299f9d @ssteinerx Cleaned up 80 col wrapping in most docs, fixed *all* Sphinx build err…
ssteinerx authored
227
ebbc566 @ojii Changed documentation section styles to be consistent (and to the sec…
ojii authored
228
229 *******
bcaa32a @digi604 fixes #293 plugin docs updated
digi604 authored
230 Inherit
ebbc566 @ojii Changed documentation section styles to be consistent (and to the sec…
ojii authored
231 *******
bcaa32a @digi604 fixes #293 plugin docs updated
digi604 authored
232
0299f9d @ssteinerx Cleaned up 80 col wrapping in most docs, fixed *all* Sphinx build err…
ssteinerx authored
233 Displays all plugins of an other page or an other language. Great if you need always the same
bcaa32a @digi604 fixes #293 plugin docs updated
digi604 authored
234 plugins on a lot of pages.
235
236 For installation be sure you have the following in your project's ``INSTALLED_APPS`` setting::
237
238 INSTALLED_APPS = (
239 # ...
240 'cms.plugins.inherit',
241 # ...
242 )
243
a6e63f6 @ojii Misc doc improvements
ojii authored
244 .. warning:: The inherit plugin is currently the only core-plugin which can
245 **not** be used in non-cms placeholders.
Something went wrong with that request. Please try again.