heckyel/mediagoblin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Tweak the trim whitespace plugin documentation.

Browse Source 
- Fix code highlighting
- Wrap all lines to 80 chars
- Add more markup (eg. Response() to ``Response()``)
This commit is contained in:
Berker Peksag 2014-02-21 10:20:03 +02:00 committed by Christopher Allan Webber
parent 2edd6b0b91
commit f4a5325e67
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
mediagoblin/plugins/trim_whitespace/README.rst
View File

@ -3,17 +3,22 @@
======================= =======================
Mediagoblin templates are written with 80 char limit for better Mediagoblin templates are written with 80 char limit for better
readability. However that means that the html output is very verbose readability. However that means that the HTML output is very verbose
containing LOTS of whitespace. This plugin inserts a Middleware that containing *lots* of whitespace. This plugin inserts a middleware that
filters out whitespace from the returned HTML in the Response() objects. filters out whitespace from the returned HTML in the ``Response()``
objects.
Simply enable this plugin by putting it somewhere where python can reach it and put it's path into the [plugins] section of your mediagoblin.ini or mediagoblin_local.ini like for example this: Simply enable this plugin by putting it somewhere where Python can reach
it and put it's path into the ``[plugins]`` section of your
``mediagoblin.ini`` or ``mediagoblin_local.ini`` like for example this:
.. code-block:: ini
[plugins] [plugins]
[[mediagoblin.plugins.trim_whitespace]] [[mediagoblin.plugins.trim_whitespace]]
There is no further configuration required. If this plugin is enabled, There is no further configuration required. If this plugin is enabled,
all text/html documents should not have lots of whitespace in between all *text/html* documents should not have lots of whitespace in between
elements, although it does a very naive filtering right now (just keep elements, although it does a very naive filtering right now (just keep
the first whitespace and delete all subsequent ones). the first whitespace and delete all subsequent ones).