| Name | Confluence Markup Comments Macro (CMCM) |
|---|---|
| Version | 1.0 |
| Product Versions | All |
| Author(s) | Gilad David Maayan and Shlomo Pariente Cohen, GigaSpaces |
| Price | Free |
| License | BSD |
| Download Source | See inside |
Description/Features
The Confluence Markup Comments Macro (CMCM) allows Confluence users, for the first time ever, to add "comments" in their wiki markup to make it more readable.
The Markup Comments (MCs) have exactly the same function as commenting in programming languages – to break up the markup into chunks, label the different chunks, and explain what different parts of the markup are doing.
 | MCs are particularly useful inside user macros that generate wiki markup. |
Usage
The syntax is simple:
{mc}--------------------------------
This is sample usage of a Confluence
Markup Comment (MC).
----------------------------------{mc}
Of course, the sample comment above is just a sample, you can doodle just about any comment you like!
| Starting and ending your comments with horizontal lines made up of dashes, equal signs, asterisks or whatever, helps break up your markup into chunks and makes it much easier to find what you need, particularly on long pages or complex user macros. |
Installation
- Click the Administration link at the top-right of the Confluence screen (in Confluence 2.8, click your name and from the drop-down menu, select Administration).
- Click User Macros.
- Click Create a new User Macro.
- Fill in the new macro fields as follows:
- Macro Name – mc
- Macro has a body – yes
- Use unprocessed macro body
- Output – macro generates wiki markup
- Template – leave this blank.
Wait a minute, are we sure we want to leave the macro template blank? Well, yes! That's the beauty of this macro – it's a macro that does nothing, allowing you to scribble whatever you want all over your wiki pages!
Comments (2)
May 04, 2008
Dan Hardiker says:
"for the first time ever" - I'm afraid not. See the {HTMLcomment} macro in th..."for the first time ever" - I'm afraid not.
Sorry to burst your bubble.
May 09, 2008
Guy Fraser says:
Super easy user macro version: create user macro called "mc" set "has body" ...Super easy user macro version: