About the "include" plugin

(The include Plugin is new since PyLucid v0.9.0.0810)

With the include Plugin, you can include local and remote files into a cms page.

The included content can be:

• highlighted with pygments
• appled markup (all existing markups)
• striped html tags

↑ include a local file  #

Basic example:

1

{% lucidTag include.local_file filepath="/path/to/file.txt" %}

Note:
You can only include a file which is stored in the path specified with settings.PYLUCID_INCLUDE_BASEPATH
The default PYLUCID_INCLUDE_BASEPATH is settings.MEDIA_ROOT

Be careful for setup this basepath!

↑ Local file highlighted  #

Highlight a file with pygments:

1

{% lucidTag include.local_file filepath="/path/to/sourcecode.py" hightlight="py" %}

↑ Local file with Markup  #

Apply markup to a file:

1

{% lucidTag include.local_file filepath="/path/to/README.creole" markup="creole" %}

↑ include a remote file  #

Basic example:

1

{% lucidTag include.remote url="http://www.domain.tld/path/to/file.txt" %}

↑ Remote file highlighted  #

Highlight a file with pygments:

1

{% lucidTag include.remote url="http://www.google.com" hightlight="html" %}

↑ Remote file with Markup  #

Apply markup to a file:

1

{% lucidTag include.remote url="https://raw.github.com/jedie/PyLucid/master/README.creole" markup="creole" %}

↑ Available Parameters  #

Shared arguments for include.local_file and include.remote:

You can combine markup and highlight. Result is pygmentised html code ;)
if not markup and not highlight, the result would be strip_html (optional) and then escaped.

Optional arguments for include.remote to overwrite preferences:

permalink