diff --git a/docs/settings.txt b/docs/settings.txt index a79a6a2..6bf4c19 100644 --- a/docs/settings.txt +++ b/docs/settings.txt @@ -62,12 +62,97 @@ COMPRESS_CSS_FILTERS A list of filters that will be applied to CSS. +Possible options are: + +``compressor.filters.css_default.CssAbsoluteFilter`` +"""""""""""""""""""""""""""""""""""""""""""""""""""" + +A filter that normalizes the URLs used in ``url()`` CSS statements. + +``compressor.filters.csstidy.CSSTidyFilter`` +"""""""""""""""""""""""""""""""""""""""""""" + +A filter that passes the CSS content to the CSSTidy_ tool. + +- ``COMPRESS_CSSTIDY_BINARY`` -- The CSSTidy binary filesystem path. + +- ``COMPRESS_CSSTIDY_ARGUMENTS`` -- The arguments passed to CSSTidy. + +``compressor.filters.datauri.DataUriFilter`` +"""""""""""""""""""""""""""""""""""""""""""" + +A filter for embedding media as `data: URIs`_ in the CSS. + +- ``COMPRESS_DATA_URI_MIN_SIZE`` -- Only files that are smaller than + this value will be embedded. In bytes. + +``compressor.filters.yui.YUICSSFilter`` +""""""""""""""""""""""""""""""""""""""" + +A filter that passes the CSS content to the `YUI compressor`_. + +- ``COMPRESS_YUI_BINARY`` -- The YUI compressor filesystem path. + +- ``COMPRESS_YUI_CSS_ARGUMENTS``-- The arguments passed to the compressor. + +``compressor.filters.cssmin.CSSMinFilter`` +"""""""""""""""""""""""""""""""""""""""""" + +A filter that uses Zachary Voase's Python port of the YUI CSS compression +algorithm cssmin_. + +``compressor.filters.compass.CompassFilter`` +"""""""""""""""""""""""""""""""""""""""""""" + +A filter that runs Compass_'s compile command. **(BETA)** + +- ``COMPRESS_COMPASS_BINARY`` -- The compass CLI tool filesystem path. + +- ``COMPRESS_COMPASS_ARGUMENTS`` -- The arguments passed to the compass CLI tool. + +- ``COMPRESS_COMPASS_PLUGINS`` -- A list of plugins names that are passed to + compass' require option e.g. ``['my_plugin']`` leads to passing + ``--require my_plugin``. + +.. _CSSTidy: http://csstidy.sourceforge.net/ +.. _`data: URIs`: http://en.wikipedia.org/wiki/Data_URI_scheme +.. _cssmin: http://pypi.python.org/pypi/cssmin/ +.. _Compass: http://compass-style.org/ + + COMPRESS_JS_FILTERS ^^^^^^^^^^^^^^^^^^^ :Default: ``['compressor.filters.jsmin.JSMinFilter']`` -A list of filters that will be applied to javascript. +A list of filters that will be applied to javascript. Possible options are: + +``compressor.filters.jsmin.JSMinFilter`` +""""""""""""""""""""""""""""""""""""""""" + +A filter that uses the jsmin implementation rJSmin_ to compess JavaScript code. + +``compressor.filters.closure.ClosureCompilerFilter`` +"""""""""""""""""""""""""""""""""""""""""""""""""""" + +A filter that uses `Google Closure compiler`_. + +- ``COMPRESS_CLOSURE_COMPILER_BINARY`` -- The Closure compiler filesystem path. + +- ``COMPRESS_CLOSURE_COMPILER_ARGUMENTS`` -- The arguments passed to the compiler. + +``compressor.filters.yui.YUIJSFilter`` +"""""""""""""""""""""""""""""""""""""" + +A filter that passes the JavaScript code to the `YUI compressor`_. + +- ``COMPRESS_YUI_BINARY`` -- The YUI compressor filesystem path. + +- ``COMPRESS_YUI_JS_ARGUMENTS`` -- The arguments passed to the compressor. + +.. _rJSmin: http://opensource.perlig.de/rjsmin/ +.. _`Google Closure compiler`: http://code.google.com/closure/compiler/ +.. _`YUI compressor`: http://developer.yahoo.com/yui/compressor/ .. _compress_precompilers: