Include external resources in a wiki page
The following documentation is for the latest development version.
Notes
This macro lets you include various things.
Currently supported sources:
- HTTP - http: and https:
- FTP - ftp:
- Wiki pages - wiki:
- Repository files - source:
- Ticket comments - ticket:N:comment:M (3.0dev, syntax may be changed before release)
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 the HEAD revision of a reStructuredText file from the repository:
[[Include(source:trunk/docs/README, text/x-rst)]]
Include a specific revision of a file from the repository:
[[Include(source:trunk/docs/README@5, text/x-rst)]]
Tip
If you set the svn:mime-type property on the file, you can leave off the explicit MIME type.
See also: IncludePagesPlugin
Bugs/Feature Requests
Existing bugs and feature requests for IncludeMacro are here.
If you have any issues, create a new ticket.
| defect |
23 / 34 |
||
|---|---|---|---|
| enhancement |
13 / 28 |
||
| task |
1 / 1 |
Download
Download the zipped source from here.
The macro is also hosted on PyPi.
Source
Get the appropriate version for your Trac installation:
| Final version for Trac 0.10 | 1.1.0 | Browse the source or checkout from here using Subversion |
| Latest stable for Trac 0.11 | 2.1.0 | Browse the source or checkout from here using Subversion |
| Development version for Trac 0.11 through 1.0 | 3.0.0dev | Browse the source or checkout from here using Subversion |
Recent Changes
Author/Contributors
Author: coderanger
Maintainer: Ryan J Ollos
Contributors: hasienda
