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

= List project components with descriptions

== Description

Adds a wiki macro {{{[[Components]]}}} which lists and describes the project's components, and links to wiki pages describing the components in more detail, and any tickets for the components.

== Bugs/Feature Requests

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

If you have any issues, create a 
[http://trac-hacks.org/newticket?component=ComponentsProcessorMacro&owner=TerryBrown new ticket].

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

== Download

Download the zipped source from [download:componentsprocessormacro here].

== Source

You can check out ComponentsProcessorMacro from [http://trac-hacks.org/svn/componentsprocessormacro here] using Subversion, or [source:componentsprocessormacro browse the source] with Trac.

== Installation

Enable the macro in `trac.ini`:

{{{
#!ini
[components]
componentsprocessor.* = enabled
}}}

You may have to restart your Web server.

== Example

=== Example 1

List all components.

This wiki page content:

{{{
This project has these components:

[[Components]]
}}}

The formatted output:

[[Image(Example1.png)]]

=== Example 2

List only components starting with "{{{Admin}}}".

This wiki page content:

{{{
The Admin related components are:

[[Components(Admin)]]
}}}

The formatted output:

[[Image(Example2.png)]]

== Recent Changes

[[ChangeLog(componentsprocessormacro, 3)]]

== Author/Contributors

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