Changes between Version 3 and Version 4 of TracDev/PluginDevelopment/ExtensionPoints/trac.wiki.api.IWikiMacroProvider

Timestamp:

Feb 26, 2012, 8:48:49 AM (12 years ago)

Author:

Peter Suter

Comment:

Inline macros

TracDev/PluginDevelopment/ExtensionPoints/trac.wiki.api.IWikiMacroProvider

@@ -45 +45 @@
 
 (The `render_macro` method is deprecated and can be ignored. It was used in macros for Trac 0.9 and 0.10.)
+
+=== Inline macros
+
+Many macros expand to content that can not appear inline in a line of text, so macros are usually
+replaced by a [[macro(...)]] indicator when used in ''outline'' or ''one line'' formatters.
+
+Since 0.13, macros implementing the optional `is_inline` method can appear in such inline content. They should of course produce inline XHTML in this case.
+
+Example:
+The ''Span'' macro implements `is_inline`, the ''Div'' macro does not:
+{{{
+==== This [[Span(title, style=background:#ff7)]] contains an inline macro
+==== This [[Div(title, style=background:#ff7)]] contains a non-inline macro
+}}}
+==== This [[Span(title, style=background:#ff7)]] contains an inline macro
+==== This [[Div(title, style=background:#ff7)]] contains a non-inline macro
 
 == Examples ==