Include external resources in a wiki page.

Notes

This macro lets you include various things.

Currently supported sources:

  • HTTP - http: and https:
  • FTP - ftp:
  • Wiki pages - wiki:
  • Repository files - source:

The default source is wiki if only a source path is given.

An optional second argument sets the output MIME type, though in most cases the default will be correct.

Permissions

The three remote sources (http, https, and ftp) require INCLUDE_URL to be rendered.

Anyone can add a call to these, however they will not be shown. This is not a replacement for render_unsafe_content, see below.

Configuration

If [wiki] render_unsafe_content is off (the default), any produced HTML will be sanitized.

Caution!

This is a potential security risk! Please review the implications render_unsafe_content before using this feature.

To enable the plugin:

[components]
includemacro.* = enabled

Example

Include another wiki page:

[[Include(PageName)]]

Include a reStructuredText file from the repository:

[[Include(source:trunk/docs/README, text/x-rst)]]

Tip

If you set the svn:mime-type property on the file, you can leave off the explicit MIME type.

Bugs/Feature Requests

Existing bugs and feature requests for IncludeMacro are here.

If you have any issues, create a new ticket.

Download

Download the zipped source from here.

Source

You can check out IncludeMacro from here using Subversion, or browse the source with Trac.

Recent Changes

[3693] by coderanger on 05/17/08 20:25:14

Fix typo in link. (closes #3044)

[3633] by coderanger on 05/08/08 07:29:49

Fix admonitions.

[3616] by coderanger on 05/06/08 09:57:12

Set MIME type.

[3615] by coderanger on 05/06/08 09:52:53

Escape include text. New README.

Author/Contributors

Author: coderanger
Contributors:

Attachments