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

= Display inline sanitized XHTML markup

== Description

This plugin returns raw, inline XHTML markup that has been validated and sanitized.

=== Validation

Markup that doesn't follow these requirements will be rejected with an error message:

 * Elements must be [WikiPedia:Well-formed_element well-formed].
 * Tags and attribute names must be in lowercase, attribute values are required and must be enclosed in quotes.
 * Empty elements must be self-closing with a space before the forward slash, e.g. <img ... />.

=== Sanitization

Dangerous constructs such as <script> elements will be removed.

=== Use Cases

`Inline` is useful for creating "phrase" elements not supported by WikiFormatting, or for including attributes such as titles. The `#!html` [WikiProcessors WikiProcessor] works well for creating larger chunks of markup, and in particular block-level elements such as an <address> that are also not supported. A [http://microformats.org/ Microformat] is an excellent example. However, `Inline` is designed to be embedded directly in another construct, typically a paragraph of text.

=== Examples

{{{
...is now a [[Inline(<acronym title="Python Enhancement Proposal">PEP</acronym>)]].
Visit [[Inline(<a href="..." title="My Link">my link</a>)]].
}}}

== Bugs/Feature Requests

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

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

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

== Source

 * Browse the source at: [http://github.com/dwclifton/tracinlinemacro/tree/master GitHub].
 * Public clone URL:
{{{#!sh
git clone git://github.com/dwclifton/tracinlinemacro.git
}}}

== Installation

Download the attached [export:inlinemacro zipfile], unpack to a temporary location, visit the `0.11`
directory and run:

{{{#!sh
python setup.py bdist_egg
cp dist/*.egg /trac/env/Project/plugins
}}}

== Configuration

Enable the macro in `/trac/env/Project/conf/trac.ini`:

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

You may have to restart your Web server.

== Recent Changes

[[ChangeLog(inlinemacro, 3)]]

== Author/Contributors

'''Author:''' [wiki:dwclifton] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:''' The Python and Trac development community.