Skip to main content

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

Project description

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 a section of a page (the section heading must have an explicit id):

[[Include(PageName#section)]]

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.

Project details


Download files

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

Files for TracIncludeMacro, version 3.1.0
Filename, size & hash File type Python version Upload date
TracIncludeMacro-3.1.0-py2-none-any.whl (7.6 kB) View hashes Wheel py2
TracIncludeMacro-3.1.0.tar.gz (6.7 kB) View hashes Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page