Macro Tutorial
Display macro parameters, macro body and macro renderer in a table format
Parameters
Title | Title to display before the table |
Using the Macro Tutorial Macro
To add the Macro Tutorial macro to a page:
- Edit the page and use autocomplete to add the Macro Tutorial macro. (Type '{macro-tutorial}')
- Add a macro in the body of the macro placeholder.
- Put some data in the body of the nested macro if required. (See Screenshot 1 below)
- Click the macro placeholder of the nested macro and choose Edit.
- Choose some parameter settings in the macro browser of the nested macro.
- Click Refresh in the 'Preview' area, to check that the nested macro content appears as you expect. (See Screenshot 2 below)
- Click Save to add the nested macro content to your page.
- Click the Macro Tutorial placeholder and choose Edit.
- Insert a text in the Title parameter.
- Click Refresh in the 'Preview' area, to check that the macro tutorial table appears as you expect. (See Screenshot 3 below)
- Click Save to add the macro tutorial table to your page.
- Click Save again when you are ready to save the page. (See Screenshot 4 below)
Screenshot 1: Code block macro inserted in the Macro Tutorial macro placeholder
Screenshot 2: Parameters and Preview of the Code Block macro
Screenshot 3: Parameters and Preview of the Macro Tutorial macro
Screenshot 4: The resulting documentation table of Code Block macro
| | |
---|
| |
---|
Syntax highlighting | java | Title | HELLO WORLD Syntax Highlighting | Show line numbers | true | Theme | Default |
| code public class HelloWorld { public static void main(String[] args) { System.out.println("Hello, World"); } } |
|
| HELLO WORLD Syntax Highlighting 1 2 3 4 5 | public class HelloWorld {
public static void main(String[] args) {
System.out.println( "Hello, World" );
}
}
|
|