Skip to main content

Include the contents of external URLs and other Trac objects in a wiki page.

Project description


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.


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.


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


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

To enable the plugin:

includemacro.* = enabled


Include another wiki page:


Include a section of a page (the section heading must have an explicit id):


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)]]

Include only a subpart of file from the repository (use named arguments : start, end, lineno):

[[Include(source:trunk/docs/README@5, text/x-rst, start=5, end=15)]]
[[Include(source:trunk/docs/README@5, text/x-rst, start=5, end=15, lineno=yes)]]

It’s possible to use regular expressions in start and/or end parameters

[[Include(source:trunk/docs/README, start=”[a-z]+”, end=15, lineno=yes)]] [[Include(source:trunk/docs/README, start=”[a-z]+”, end=”[.+]”, lineno=yes)]]


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

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

TracIncludeMacro-3.2.0.tar.gz (7.4 kB view hashes)

Uploaded source

Built Distributions

TracIncludeMacro-3.2.0-py2.7.egg (6.6 kB view hashes)

Uploaded 2 7

TracIncludeMacro-3.2.0-py2-none-any.whl (7.9 kB view hashes)

Uploaded py2

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page