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

= List project components with descriptions

== Description

This Trac macro {{{[[Components]]}}} lists and describes the project's components, and adds links to wiki pages describing the components in more detail, as well as any tickets for the components. For more information on what components are and how they can serve your workflow, see [t:TicketComponent].

=== Example 1: List all components

This wiki page content:

{{{
This project has these components:

[[Components]]
}}}

The formatted output:

[[Image(Example1.png, border=2)]]

=== 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, border=2)]]

== Bugs/Feature Requests

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

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

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

== Download

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

== Source

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

== Installation

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

Enable the macro in `trac.ini`:

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

You may have to restart your Web server.

== Recent Changes

[[ChangeLog(componentsprocessormacro, 3)]]

== Author/Contributors

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