Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
Column
width20%
Excerpt Include
pluglib:Advanced Macros Plugin
pluglib:Advanced Macros Plugin
nopaneltrue
Column
width60%
Wiki Markup
{deck:id=Basic Macro Plugin}
{card:label=Overview}

h4. Basic Macros

This plugin includes basic macros for linking and formatting content.

h5. This plugin includes the following macros:

* *anchor* \- Create an anchor that allows people to link to a specific point in a page.
* *quote* \- Generate blockquotes that may contain multiple paragraphs or complex markup.
* *noformat* \- Create blocks of text where other wiki formatting is not applied.
* *panel* \- Draws a panel with an optional title and border.
* *color* \- Change the colour of the contained text.
* *loremipsum* \- Insert paragraphs of "lorem ipsum" space-filler text.
* *nolink* and {nl} \- Suppress rendering of a CamelCase link.
{card}

{card:label=Documentation}
{deck:id=basicm}

{card:label=anchor}
{anchor:My Anchor}
Create an anchor that allows peopleusers to link to a specific point in a page. An anchor is composed of the link and the content you are linking to (anchor). 
h3.The Code :
The anchor :
{code}
{anchor:My Anchor}
{code}
The link:
{code}
[#My Anchor]
{code}
h3.What you will get :
The anchor itself is invisible, but the link will be displayed. Try clicking the link:

[#My Anchor]

h3.ParametersIt brings the top of the screen to the line where the anchor is placed. In this case, the anchor is located above the sentence, "Create an anchor that allows users...". 
{note:Title=All headings ARE anchors}
{card}

{card:label=qoute}
Generate blockquotes that may contain multiple paragraphs or complex markup.

h3.The Code :
{code}
{quote}
Some quoted content}
{quote}
{code}

h3.What you will get :
Some 'unqouted' content
{quote}
Some quoted content
{quote}
Some more 'unqouted' content.
{card}

{card:label=noformat}
The Noformat Macro displays a block of text in monospace font with no other formatting.

h3.The Code :
{code}
{noformat}
Some non-formatted text.
{noformat}
{code}

h3.What you will get :
Some formatted text.
{noformat}
Some non-formatted text.
{noformat}
Some more formatted text.
h3.Parameters
||*Name*||*Required?*||*Default*||*Description*||
|nopanel|(x)|false|Removes the bordering panel. |
{card}

{card:label=panel}
Draws a panel with an optional title and border.

h3.The Code :

Default Panel:
{code}
{panel}
Some content.
{panel}
{code}

Panel with a dashed, colored border:
{code}
{panel:borderStyle=dashed|borderColor=red}
Some content.
{panel}
{code}

Panel with a title and solid, colored border:
{code}
{panel:title=My Panel|borderStyle=solid|borderColor=blue}
Some content.
{panel}
{code}

Panel with a colored background and title:
{code}
{panel:bgColor=#FFCCFF|title=My Title|titleBGColor=yellow }
Some content.
{panel}
{code}

h3.What you will get :
Default Panel:
{panel}
Some content.
{panel}

Panel with a dashed, colored border:
{panel:borderStyle=dashed|borderColor=red}
Some content.
{panel}


Panel with a title and solid, colored border:
{panel:title=My Panel|borderStyle=solid|borderColor=blue}
Some content.
{panel}

Panel with a colored background and title:
{panel:bgColor=#FFCCFF|title=My Title|titleBGColor=yellow }
Some content.
{panel}

h3.Parameters
||*Name*||*Required?*||*Default*||*Description*||
|title|(x)|none|The title of the panel. If specified, this title will be displayed in its own title-row.|
|boderStyle|(x)|none|The style of the panel's border. Valid values are 'solid', 'dashed' and other valid CSS border styles.|
|borderColor|(x)|Grey|The colour of the panel's border. Accepts color name and hexadecimal color codes. |
|borderWidth|(x)| |The width of the panel's border (in pixels).|
|bgColor|(x)|Grey| The background colour of the panel. Accepts color name and hexadecimal color codes.|
|titleBGColor|(x)| | The background colour of the title-row of the panel. Accepts color name and hexadecimal color codes.|
{card}

{card:label=color}
Change the color of the contained text. You specify the color using the color name or hexadecimal code.
h3.The code :
{code}
{color:red}
Some colored text.
{color}

{color:#00FF00}
Some more colored text.
{color}
{code}
h3.What you will get :
{color:red}
Some colored text.
{color}

{color:#00FF00}
Some more colored text.
{color}
{card}

{card:label=loremipsum}
Insert paragraphs of "lorem ipsum" space-filler text.
h3.The Code :
Three paragraghs:
{code}
{loremipsum}
{code}
One paragraph:
{code}
{loremipsum:1}
{code}
h3.What you will get :
*Three paragraphs:*
{loremipsum}
*One paragragh:*
{loremipsum:1}
h3.Parameters
||*Name*||*Required?*||*Default*||*Description*||
|N/A|(x)|3|Determines the number of paragraphs generated|
|
{card}

{card:label=nolink}
The Nolink macro allows you to enter a web address or URL, without the browser automatically hyperlinking the URL.
h3.The Code :
{code}
{nolink:https://wikis.mit.edu/confluence/display/MITDASHBOARD/Wikis}
{code}
h3.What you will get :
{nolink:https://wikis.mit.edu/confluence/display/MITDASHBOARD/Wikis}

{card}
{card}
{deck}
{deck}
{roundrect:bgcolor=#828282|width=907px|height=50px|corners=false,false,true,true}
{roundrect}

Column
width20%