This page describes user-defined macros and short-cut notations defined in this Wiki.

User macros

comment

You can use the {comment}...{comment} macro to surround Wiki markups that you don't want to render. This macro still allows you to keep such text in Wiki.

advanced-plugin-topic

The {advanced-plugin-topic} macro will render the boiler-plate header for advanced topics for plugin developers, as shown below:

jenkins-plugin-info

The {jenkins-plugin-info:pluginId=XXXX} macro will render basic information about a plugin like:

Shortcut Links

Issue

[1234@issue] points to issue #1234 in the issue tracker.

Javadoc

[Jenkins@javadoc] points to the javadoc of jenkins.model.Jenkins. As long as the short class name is unique, that's sufficient, but you can also use a fully-qualified class name, like [jenkins.model.Jenkins@javadoc]

Suggestions?

For additional suggestions, please send e-mails to the dev list.