[[PageOutline(2-5,Contents,pullout)]]

= Partial includes of files in wiki pages

== Description

This is a modified version of the [http://trac.edgewall.org/wiki/MacroBazaar#IncludeSource IncludeSource macro] to allow for partial includes of files in Trac wiki pages.  

This was originally done as a modification to the !IncludeSource macro, but has been brought forward to Trac version 0.11.

Note that the macro in the file is still named !IncludeSource because it provides the existing functionality, but titled differently to not conflict with the original. If people like this, it can be merged into the original !IncludeSource to minimize confusion. 

== Bugs/Feature Requests

Existing bugs and feature requests for IncludeSourcePartialPlugin are 
[report:9?COMPONENT=IncludeSourcePartialPlugin here].

If you have any issues, create a 
[/newticket?component=IncludeSourcePartialPlugin new ticket].

[[TicketQuery(component=IncludeSourcePartialPlugin&group=type,format=progress)]]

== Download

Download the zipped source from [export:includesourcepartialplugin here].

== Source

You can check out IncludeSourcePartialPlugin from [/svn/includesourcepartialplugin here] using Subversion, or [source:includesourcepartialplugin browse the source] with Trac.

== Installation

General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.

== Configuration

In your `trac.ini` file, edit the components section to add the entry as follows:
{{{#!ini
[components]
includesource.* = enabled
}}}

== Example

{{{
# include entire file
[[IncludeSource(trunk/proj/file.py)]]

# includes line 20-50 inclusive
[[IncludeSource(trunk/proj/file.py, start=20, end=50)]]

# includes last 30 lines of file at revision 1200
[[IncludeSource(trunk/proj/file.py, start=-30, rev=1200)]]

# include entire file but formatted plain
[[IncludeSource(trunk/proj/file.py, mimetype=text/plain)]]
}}}

== Recent Changes

[[ChangeLog(includesourcepartialplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:chrisheller] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''