Changes between Version 39 and Version 40 of WikiMacros

Timestamp:

May 11, 2011, 10:51:18 AM (13 years ago)

Author:

Christian Boos

Comment:

don't use [[MacroList]] here, rather use content matching version 0.12 (taken from babel.e.o)

WikiMacros

@@ -1 @@
-** Note: this page documents the 0.12 version of Trac, see [[0.11/WikiMacros]] if you need the previous version **
+** Note: this page documents the 0.12 version of Trac, see [[0.11/WikiMacros]] if you need the previous version and [[0.13/WikiMacros]] if you need the next version**
 = Trac Macros =
 
@@ -55 +55 @@
 <h3><code>[[Image]]</code></h3>Embed an image in wiki-formatted text.
 
-The first argument is the file …
+The first argument is the file …
 <h3><code>[[InterTrac]]</code></h3>Provide a list of known <a class="wiki" href="/wiki/InterTrac">InterTrac</a> prefixes.
 <h3><code>[[InterWiki]]</code></h3>Provide a description list for the known <a class="wiki" href="/wiki/InterWiki">InterWiki</a> prefixes.
 <h3><code>[[KnownMimeTypes]]</code></h3>List all known mime-types which can be used as <a class="wiki" href="/wiki/WikiProcessors">WikiProcessors</a>.
-Can be …</div>
+Can be …</div>
 }}}
 etc.
@@ -68 +68 @@
 ''Note that the following list will only contain the macro documentation if you've not enabled `-OO` optimizations, or not set the `PythonOptimize` option for [wiki:TracModPython mod_python].''
 
-[[MacroList]]
+(the following is snapshot for Trac 0.12.2 - see [[0.13/WikiMacros]] for the documentation of macros in trunk / 0.13dev)
+{{{#!html
+<div class="trac-macrolist"><h3 id="Image-macro"><code>[[Image]]</code></h3><p> 
+Embed an image in wiki-formatted text.
+</p> 
+<p> 
+The first argument is the file specification. The file specification may
+reference attachments in three ways:
+</p> 
+<ul><li><tt>module:id:file</tt>, where module can be either <strong>wiki</strong> or <strong>ticket</strong>,
+to refer to the attachment named <em>file</em> of the specified wiki page or
+ticket.
+</li><li><tt>id:file</tt>: same as above, but id is either a ticket shorthand or a Wiki
+page name.
+</li><li><tt>file</tt> to refer to a local attachment named 'file'. This only works from
+within that wiki page or a ticket.
+</li></ul><p> 
+Also, the file specification may refer to repository files, using the
+<tt>source:file</tt> syntax (<tt>source:file@rev</tt> works also).
+</p> 
+<p> 
+Files can also be accessed with a direct URLs; <tt>/file</tt> for a
+project-relative, <tt>//file</tt> for a server-relative, or <tt>http://server/file</tt> 
+for absolute location of the file.
+</p> 
+<p> 
+The remaining arguments are optional and allow configuring the attributes
+and style of the rendered <tt>&lt;img&gt;</tt> element:
+</p> 
+<ul><li>digits and unit are interpreted as the size (ex. 120, 25%)
+for the image
+</li><li><tt>right</tt>, <tt>left</tt>, <tt>center</tt>, <tt>top</tt>, <tt>bottom</tt> and <tt>middle</tt> are interpreted 
+as the alignment for the image (alternatively, the first three can be
+specified using <tt>align=...</tt> and the last three using <tt>valign=...</tt>)
+</li><li><tt>link=some TracLinks...</tt> replaces the link to the image source by the
+one specified using a <a class="wiki" href="/wiki/TracLinks">TracLinks</a>. If no value is specified, the link is
+simply removed.
+</li><li><tt>nolink</tt> means without link to image source (deprecated, use <tt>link=</tt>)
+</li><li><tt>key=value</tt> style are interpreted as HTML attributes or CSS style
+indications for the image. Valid keys are:
+<ul><li>align, valign, border, width, height, alt, title, longdesc, class, 
+margin, margin-(left,right,top,bottom), id and usemap
+</li><li><tt>border</tt>, <tt>margin</tt>, and <tt>margin-</tt>* can only be a single number
+</li><li><tt>margin</tt> is superseded by <tt>center</tt> which uses auto margins 
+</li></ul></li></ul><p> 
+Examples:
+</p> 
+<pre class="wiki">    [[Image(photo.jpg)]]                           # simplest
+    [[Image(photo.jpg, 120px)]]                    # with image width size
+    [[Image(photo.jpg, right)]]                    # aligned by keyword
+    [[Image(photo.jpg, nolink)]]                   # without link to source
+    [[Image(photo.jpg, align=right)]]              # aligned by attribute
+</pre><p> 
+You can use image from other page, other ticket or other module.
+</p> 
+<pre class="wiki">    [[Image(OtherPage:foo.bmp)]]    # if current module is wiki
+    [[Image(base/sub:bar.bmp)]]     # from hierarchical wiki page
+    [[Image(#3:baz.bmp)]]           # if in a ticket, point to #3
+    [[Image(ticket:36:boo.jpg)]]
+    [[Image(source:/images/bee.jpg)]] # straight from the repository!
+    [[Image(htdocs:foo/bar.png)]]   # image file in project htdocs dir.
+</pre><p> 
+<em>Adapted from the Image.py macro created by Shun-ichi Goto
+&lt;gotoh@…&gt;</em> 
+</p> 
+<h3 id="InterTrac-macro"><code>[[InterTrac]]</code></h3><p> 
+Provide a list of known <a class="wiki" href="/wiki/InterTrac">InterTrac</a> prefixes.
+</p> 
+<h3 id="InterWiki-macro"><code>[[InterWiki]]</code></h3><p> 
+Provide a description list for the known <a class="wiki" href="/wiki/InterWiki">InterWiki</a> prefixes.
+</p> 
+<h3 id="KnownMimeTypes-macro"><code>[[KnownMimeTypes]]</code></h3><p> 
+List all known mime-types which can be used as <a class="wiki" href="/wiki/WikiProcessors">WikiProcessors</a>.
+</p> 
+<p> 
+Can be given an optional argument which is interpreted as mime-type filter.
+</p> 
+<h3 id="MacroList-macro"><code>[[MacroList]]</code></h3><p> 
+Display a list of all installed Wiki macros, including documentation if
+available.
+</p> 
+<p> 
+Optionally, the name of a specific macro can be provided as an argument. In
+that case, only the documentation for that macro will be rendered.
+</p> 
+<p> 
+Note that this macro will not be able to display the documentation of
+macros if the <tt>PythonOptimize</tt> option is enabled for mod_python!
+</p> 
+<h3 id="PageOutline-macro"><code>[[PageOutline]]</code></h3><p> 
+Display a structural outline of the current wiki page, each item in the
+outline being a link to the corresponding heading.
+</p> 
+<p> 
+This macro accepts three optional parameters:
+</p> 
+<ul><li>The first is a number or range that allows configuring the minimum and
+maximum level of headings that should be included in the outline. For
+example, specifying "1" here will result in only the top-level headings
+being included in the outline. Specifying "2-3" will make the outline
+include all headings of level 2 and 3, as a nested list. The default is
+to include all heading levels.
+</li><li>The second parameter can be used to specify a custom title (the default
+is no title).
+</li><li>The third parameter selects the style of the outline. This can be
+either <tt>inline</tt> or <tt>pullout</tt> (the latter being the default). The <tt>inline</tt> 
+style renders the outline as normal part of the content, while <tt>pullout</tt> 
+causes the outline to be rendered in a box that is by default floated to
+the right side of the other content.
+</li></ul><h3 id="RecentChanges-macro"><code>[[RecentChanges]]</code></h3><p> 
+List all pages that have recently been modified, grouping them by the
+day they were last modified.
+</p> 
+<p> 
+This macro accepts two parameters. The first is a prefix string: if
+provided, only pages with names that start with the prefix are included in
+the resulting list. If this parameter is omitted, all pages are listed.
+</p> 
+<p> 
+The second parameter is a number for limiting the number of pages returned.
+For example, specifying a limit of 5 will result in only the five most
+recently changed pages to be included in the list.
+</p> 
+<h3 id="RepositoryIndex-macro"><code>[[RepositoryIndex]]</code></h3><p> 
+Display the list of available repositories.
+</p> 
+<p> 
+Can be given the following named arguments:
+</p> 
+<dl class="wiki"><dt><em>format</em></dt><dd> 
+Select the rendering format:
+<ul><li><em>compact</em> produces a comma-separated list of repository prefix
+names (default)
+</li><li><em>list</em> produces a description list of repository prefix names 
+</li><li><em>table</em> produces a table view, similar to the one visible in
+the <em>Browse View</em> page
+</li></ul></dd><dt><em>glob</em></dt><dd> 
+Do a glob-style filtering on the repository names (defaults to '*')
+</dd><dt><em>order</em></dt><dd> 
+Order repositories by the given column (one of "name", "date" or
+"author")
+</dd><dt><em>desc</em></dt><dd> 
+When set to 1, order by descending order
+</dd></dl> 
+<p> 
+(<em>since 0.12</em>)
+</p> 
+<h3 id="TicketQuery-macro"><code>[[TicketQuery]]</code></h3><p> 
+Wiki macro listing tickets that match certain criteria.
+</p> 
+<p> 
+This macro accepts a comma-separated list of keyed parameters,
+in the form "key=value".
+</p> 
+<p> 
+If the key is the name of a field, the value must use the syntax 
+of a filter specifier as defined in <a class="wiki" href="/wiki/TracQuery#QueryLanguage">TracQuery#QueryLanguage</a>.
+Note that this is <em>not</em> the same as the simplified URL syntax 
+used for <tt>query:</tt> links starting with a <tt>?</tt> character. Commas (<tt>,</tt>)
+can be included in field values by escaping them with a backslash (<tt>\</tt>).
+</p> 
+<p> 
+Groups of field constraints to be OR-ed together can be separated by a
+litteral <tt>or</tt> argument.
+</p> 
+<p> 
+In addition to filters, several other named parameters can be used
+to control how the results are presented. All of them are optional.
+</p> 
+<p> 
+The <tt>format</tt> parameter determines how the list of tickets is
+presented: 
+</p> 
+<ul><li><strong>list</strong> -- the default presentation is to list the ticket ID next
+to the summary, with each ticket on a separate line.
+</li><li><strong>compact</strong> -- the tickets are presented as a comma-separated
+list of ticket IDs. 
+</li><li><strong>count</strong> -- only the count of matching tickets is displayed
+</li><li><strong>table</strong>  -- a view similar to the custom query view (but without
+the controls)
+</li></ul><p> 
+The <tt>max</tt> parameter can be used to limit the number of tickets shown
+(defaults to <strong>0</strong>, i.e. no maximum).
+</p> 
+<p> 
+The <tt>order</tt> parameter sets the field used for ordering tickets
+(defaults to <strong>id</strong>).
+</p> 
+<p> 
+The <tt>desc</tt> parameter indicates whether the order of the tickets
+should be reversed (defaults to <strong>false</strong>).
+</p> 
+<p> 
+The <tt>group</tt> parameter sets the field used for grouping tickets
+(defaults to not being set).
+</p> 
+<p> 
+The <tt>groupdesc</tt> parameter indicates whether the natural display
+order of the groups should be reversed (defaults to <strong>false</strong>).
+</p> 
+<p> 
+The <tt>verbose</tt> parameter can be set to a true value in order to
+get the description for the listed tickets. For <strong>table</strong> format only.
+<em>deprecated in favor of the <tt>rows</tt> parameter</em> 
+</p> 
+<p> 
+The <tt>rows</tt> parameter can be used to specify which field(s) should 
+be viewed as a row, e.g. <tt>rows=description|summary</tt> 
+</p> 
+<p> 
+For compatibility with Trac 0.10, if there's a last positional parameter
+given to the macro, it will be used to specify the <tt>format</tt>.
+Also, using "&amp;" as a field separator still works (except for <tt>order</tt>)
+but is deprecated.
+</p> 
+<h3 id="TitleIndex-macro"><code>[[TitleIndex]]</code></h3><p> 
+Insert an alphabetic list of all wiki pages into the output.
+</p> 
+<p> 
+Accepts a prefix string as parameter: if provided, only pages with names
+that start with the prefix are included in the resulting list. If this
+parameter is omitted, all pages are listed.
+If the prefix is specified, a second argument of value 'hideprefix'
+can be given as well, in order to remove that prefix from the output.
+</p> 
+<p> 
+Alternate <tt>format</tt> and <tt>depth</tt> named parameters can be specified:
+</p> 
+<ul><li><tt>format=compact</tt>: The pages are displayed as comma-separated links.
+</li><li><tt>format=group</tt>: The list of pages will be structured in groups
+according to common prefix. This format also supports a <tt>min=n</tt> 
+argument, where <tt>n</tt> is the minimal number of pages for a group.
+</li><li><tt>format=hierarchy</tt>: The list of pages will be structured according
+to the page name path hierarchy. This format also supports a <tt>min=n</tt> 
+argument, where higher <tt>n</tt> flatten the display hierarchy
+</li><li><tt>depth=n</tt>: limit the depth of the pages to list. If set to 0,
+only toplevel pages will be shown, if set to 1, only immediate
+children pages will be shown, etc. If not set, or set to -1,
+all pages in the hierarchy will be shown.
+</li></ul><h3 id="TracAdminHelp-macro"><code>[[TracAdminHelp]]</code></h3><p> 
+Display help for trac-admin commands.
+</p> 
+<p> 
+Examples:
+</p> 
+<pre class="wiki">[[TracAdminHelp]]               # all commands
+[[TracAdminHelp(wiki)]]         # all wiki commands
+[[TracAdminHelp(wiki export)]]  # the "wiki export" command
+[[TracAdminHelp(upgrade)]]      # the upgrade command
+</pre><h3 id="TracGuideToc-macro"><code>[[TracGuideToc]]</code></h3><p> 
+Display a table of content for the Trac guide.
+</p> 
+<p> 
+This macro shows a quick and dirty way to make a table-of-contents
+for the <a class="missing wiki">Help/Guide?</a>. The table of contents will contain the Trac* and 
+<a class="wiki" href="/wiki/WikiFormatting">WikiFormatting</a> pages, and can't be customized. Search for <a class="missing wiki">TocMacro?</a> for a
+a more customizable table of contents.
+</p> 
+<h3 id="TracIni-macro"><code>[[TracIni]]</code></h3><p> 
+Produce documentation for the Trac configuration file.
+</p> 
+<p> 
+Typically, this will be used in the <a class="wiki" href="/wiki/TracIni">TracIni</a> page.
+Optional arguments are a configuration section filter,
+and a configuration option name filter: only the configuration
+options whose section and name start with the filters are output.
+</p> 
+</div>
+}}}
 
 == Macros from around the world ==