Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Composition Setup
deck.tab.active.background = #6495ED
HELP
Section
Column
width20%15%
Excerpt Include
pluglib:Advanced Macros Pluginpluglib:
Advanced Macros Plugin
nopaneltrue
Column
width60%
Deck of Cards
width907px
idContent Formatting
Card
labelOverview

Content Formatting Macros

A set of macros that allow easy formatting of Wiki content.

This plugin includes the following macros:
  • lozenge - an attractive, customisable lozenge button
  • bgcolor - set content background color
  • highlight - highlight background of bits of content
  • Symbols
  • copyright - insert a copyright statement
  • sm
    • - insert a service
    mark
  • tm - insert a trade mark
  • reg-tm - insert a
    • , trade, or registered trademark
  • search-box - insert a search box (search current space, specified space or all spaces)
    • .
    • center - center content on screen (including tables, etc)
  • style - insert a style sheet (includes support for media specific styles and importing of external style sheets)
  • div - insert a div layer with custom class and style parameters
  • span - insert a span layer with custom class and style parameters
    • strike - a graphical strikeout effect
  • Private Policy Messages
    • privacy-mark - displays a privacy indicator on-screen, linked to a privacy-policy
    • privacy-policy - displays a note regarding your privacy policy on-screen
    • clickable - hyperlinks all contained content to a page or URL
    • roundrect - an attractive customisable round rectangle
    • align - allows you to left/right/center and justify-align your content
    table, tr, td - allows you to manually create html tables
    Disable the "Compatibility Macros" plugin which has a conflicting table macro
    • iframe - allows you to create iframes
    • rollover - allows you to create rollover effects
  • fancy-bullets - allows you to use images attached to a page as bullet points
  • Card
    labelDocumentation
    Deck of Cards
    width907px
    idcontentm
    Card
    labellozenge
    Card
    labelbgcolor
    Card
    labelhighlght
    Card
    labelSymbols
    Card
    labelsearch-box
    Card
    labelcenter
    Card
    labelstyle
    Card
    labeldiv
    Card
    labelspan
    Card
    labelstrike
    Card
    labelPrivacy Policy Messages
    Card
    labelclickable
    Card
    labelroundect
    Card
    labelalign
    Card
    labeltable, tr, td
    Card
    labeliframe
    Card
    labelrollover
    Card
    labelfancy bullets
    Card
    Deck of Cards
    Card
    labelDocumentation
    Deck of Cards
    idcontentm

    Card
    labellozenge

    This macro creates a professional lozenge effect that's ideal for creating professional looking buttons or simply highlighting important information.

    The Code

    With an icon:

    Code Block
    
    {lozenge:icon=!bell.png!|title=Announcement}Some important news here...{lozenge}
    

    Without an icon and with a custom color:

    Code Block
    
    {lozenge:title=Announcement|color=red}Some important news here...{lozenge}
    

    Toggle Cloak
    idcloak
    Result

    Cloak
    idcloak

    With an icon :

    !bell.png!AnnouncementSome important news here...

    Without an icon and with a custom color:

    AnnouncementredSome important news here...

    Toggle Cloak
    idcloak1
    Parameters

    Cloak
    idcloak1

    Name

    Required?

    Default

    Description

    link

     

    if specified, clicking the lozenge will go to the specified link.

    color

    silver

    The color of the left portion of the lozenge.

    arrow

    none or blue

    Defines which arrow to use on the left portion of the lozenge:

    • none (default if no "link" specified) - the arrow will not be displayed
    • blue (default if a link is specified) - a blue arrow will be displayed
    • green - a green arrow will be displayed.

    title

     

    The title to show at the top of the main panel.

    icon

     

    Attach an image (see above) or some text to the left of the lozenge.

    width

    347px

    The width of the entire lozenge in pixels or as a percentage. Specify auto to make the lozenge automatically stretch to fit it's contents.

    Card
    labelbgcolor

    Sets the background color for a section of content. You can specify a background color using color names or hexadecimal color codes.

    The Code

    Color names:

    Code Block
    
    {bgcolor:red}red{bgcolor}
    {bgcolor:yellow}yellow{bgcolor}
    {bgcolor:green}green (default){bgcolor}
    {bgcolor:cyan}cyan{bgcolor}
    {bgcolor:blue}blue{bgcolor}
    {bgcolor:purple}purple{bgcolor}
    

    Hexadecimal:

    Code Block
    
    {bgcolor:#E47833}mandarin orange{bgcolor}
    {bgcolor:#802A2A}brown{bgcolor}
    {bgcolor:#F08080}light coral{bgcolor}
    {bgcolor:#800000}maroon{bgcolor}
    {bgcolor:#D44942}chili{bgcolor}
    {bgcolor:#CDB7B5}misty rose{bgcolor}
    

    Toggle Cloak
    idcloak2
    Result

    Cloak
    idcloak2

    Color names:
    redred
    yellowyellow
    greengreen
    cyancyan
    blueblue
    purplepurple
    Hexadecimal:
    #E47833mandarin orange
    #802A2Abrown
    #F08080light coral
    #800000maroon
    #D44942chili
    #CDB7B5misty rose

    Toggle Cloak
    idcloak3
    Parameters

    Cloak
    idcloak3

    Name

    Required?

    Default

    Description

    default

    green

    The "myColor" default parameter defines the background colour for the content contained within the macro and can be either a common colour name (supported by most browsers) or a hexadecimal colour code (supported by all browsers).

    Card
    labelhighlght

    Allows you to highlight a portion of content. You can specify a color using color names or hexadecimal color codes.

    The Code

    Code Block
    
    {highlight:red}red{highlight}
    {highlight:yellow}yellow (default){highlight}
    {highlight:green}green{highlight}
    {highlight:cyan}cyan{highlight}
    {highlight:blue}blue{highlight}
    {highlight:purple}purple{highlight}
    

    Toggle Cloak
    idcloak4
    Result

    Cloak
    idcloak4

    redred
    yellowyellow
    greengreen
    cyancyan
    blueblue
    purplepurple

    Toggle Cloak
    idcloak5
    Parameters

    Cloak
    idcloak5

    Name

    Required?

    Default

    Description

    default

    yellow

    The "myColor" default parameter defines the background colour for the content contained within the macro and can be either a common colour name (supported by most browsers) or a hexadecimal colour code (supported by all browsers).

    Card
    labelSymbols

    Add a trademark, a service mark, copyright, or registered trademark

    The Code

    Trademark:

    Code Block
    
    {tm}Like a Rock{tm}
    

    Service Mark:

    Code Block
    
    {sm}My Service{sm}
    

    Copyright:

    Code Block
    
    {copyright}2010 Massachusetts Institute of Technology{copyright}
    

    Registered Trademark:

    Code Block
    
    {reg-tm}Registered Trademark{reg-tm}
    

    Toggle Cloak
    idcloak6
    Result

    Cloak
    idcloak6

    Trademark:
    Like a Rock
    Service Mark:
    My Service
    Copyright:
    2010 Massachusetts Institute of Technology
    Registered Trademark:
    Registered Trademark

    Card
    labelcenter

    Use this macro to center a portion of content.

    The Code

    Code Block
    
    {center}Some centered content.{center}
    

    Toggle Cloak
    idcloak7
    Result

    Cloak
    idcloak7
    Some centered content.
    Card
    labelstyle

    This macro is designed to allow a single page to have custom styles applied to it. The style sheet can optionally be restricted to specific media types and you can optionally import an external style sheet from a URL.

    The Code

    This style sheet will make citation text look pretty:

    Code Block
    
    {style}
    /* citation */
    cite:before {
     content: "\"";
    }
    cite:after {
     content: "\"";
    }
    cite, cite:before, cite:after {
     font-family: Georgia, "Times New Roman", serif;
     font-style: italic;
    }
    {style}
    

    Now enter some citation text:

    Code Block
    
    ??Some citation text??
    

    Toggle Cloak
    idcloak8
    Result

    Cloak
    idcloak8

    Some citation text

    Toggle Cloak
    idcloak9
    Parameters

    Cloak
    idcloak9

    Name

    Required?

    Default

    Description

    media

    All

    The media to apply this style sheet to, by default all media types are used.

    import

     

    Optionally specify a URL to import an external style sheet.

    Card
    labelstrike

    Adds a more graphical representation of deleted text.

    The Code

    Code Block
    
    {strike}deleted text{strike}
    

    Toggle Cloak
    idcloak10
    Result

    Cloak
    idcloak10

    deleted text

    Card
    labelclickable

    With this macro you can easily and cleanly link entire blocks of text, panels and just about anything else that appears on your Wiki pages.

    The Code

    Code Block
    
    Visit the {clickable:I NEED HELP!!|HELP:Home}*Wiki Help Pages*{clickable} for support.
    

    Toggle Cloak
    idcloak11
    Result

    Cloak
    idcloak11

    Visit the HELP:HomeI NEED HELP!!INLINEWiki Help Pages for support.

    Make sure you use a graphical marker to indicate the link otherwise the it will appear as normal text

    Toggle Cloak
    idcloak12
    Parameters

    Cloak
    idcloak12

    Name

    Required?

    Default

    Description

    default

     

    The default parameter should contain a tooltip and the page to link to (which can be an internal or external link as desired.

    Card
    labelroundrect

    Creates a round rectangle with text or content.

    The Code

    Without a custom color:

    Code Block
    
    {roundrect}Some Content{roundrect}
    

    With a custom color:

    Code Block
    
    {roundrect:bgcolor=#9966CC }Some Content{roundrect}
    

    With a custom color and title:

    Code Block
    
    {roundrect:bgcolor=#9966CC |title=Title}Some Content{roundrect}
    

    Toggle Cloak
    idcloak13
    Result

    Cloak
    idcloak13

    Without a custom color:

    Some Content

    With a custom color:

    #9966CCSome Content

    With a custom color and title:

    #9966CCTitleSome Content

    Toggle Cloak
    idcloak14
    Parameters

    Cloak
    idcloak14

    Name

    Required?

    Default

    Description

    bgcolor

    #C0FFC0

    The background colour of the rounded rectangle, this should be specified as a hex value.

    title

     

    The contents of the title cell, if required.

    footer

     

    The contents of the footer cell, if required.

    width

    fit contents

    By default, the panel width will stretch to fit it's contents, unless you specify a specific width.

    height

    fit contents

    By default, the panel height will stretch to fit it's contents, unless you specify a specific height

    cornersize

    25px

    The radius, in pixels, of the panel corners. This sets the defaults for the hSize and vSize parameters below.

    hSize

    cornersize

    This parameter, which defaults to the value defined by cornersize, defines the width of the panel corners.

    vSize

    cornersize

    This parameter, which defaults to the value defined by cornersize, defines the height of the panel corners.

    antialias

    false

    Setting the antialias parameter will result in much smoother corners and enable the cornercolor parameter.

    footerbgcolor

    bgcolor

    The background colour of the footer area (defaults to the same colour as the overall background colour bgcolor), this should be specified as a hex value.

    titlebgcolor

    bgcolor

    The background colour of the title area (defaults to the same colour as the overall background colour bgcolor), this should be specified as a hex value.

    corners

    true,true,true,true

    a comma separated list of flags stating which corners should be rounded: Top Left, Top Right, Bottom Left, Bottom Right.

    rows

    true, true, true

    a comma separated list of flags stating which rows should be displayed: Top, Middle, Bottom.

    Card
    labelalign

    Allows the aligning of text.

    The Code

    Justified:

    Code Block
    
    {align:justify}
    some content
    {align}
    

    Align right:

    Code Block
    
    {align:right}
    some content
    {align}
    

    Align left:

    Code Block
    
    {align:left}
    some content
    {align}
    

    Align center:

    Code Block
    
    {align:center}
    some content
    {align}
    

    Toggle Cloak
    idcloak14
    Result

    Cloak
    idcloak14

    Justified:

    justify

    Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam fermentum vestibulum est. Cras rhoncus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Sed quis tortor. Donec non ipsum. Mauris condimentum, odio nec porta tristique, ante neque malesuada massa, in dignissim eros velit at tellus. Donec et risus in ligula eleifend consectetuer. Donec volutpat eleifend augue. Integer gravida sodales leo. Nunc vehicula neque ac erat. Vivamus non nisl. Fusce ac magna. Suspendisse euismod libero eget mauris.

    Align right:

    right

    Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam fermentum vestibulum est. Cras rhoncus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Sed quis tortor. Donec non ipsum. Mauris condimentum, odio nec porta tristique, ante neque malesuada massa, in dignissim eros velit at tellus. Donec et risus in ligula eleifend consectetuer. Donec volutpat eleifend augue. Integer gravida sodales leo. Nunc vehicula neque ac erat. Vivamus non nisl. Fusce ac magna. Suspendisse euismod libero eget mauris.

    Align left:

    left

    Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam fermentum vestibulum est. Cras rhoncus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Sed quis tortor. Donec non ipsum. Mauris condimentum, odio nec porta tristique, ante neque malesuada massa, in dignissim eros velit at tellus. Donec et risus in ligula eleifend consectetuer. Donec volutpat eleifend augue. Integer gravida sodales leo. Nunc vehicula neque ac erat. Vivamus non nisl. Fusce ac magna. Suspendisse euismod libero eget mauris.

    Align center:

    center

    Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam fermentum vestibulum est. Cras rhoncus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Sed quis tortor. Donec non ipsum. Mauris condimentum, odio nec porta tristique, ante neque malesuada massa, in dignissim eros velit at tellus. Donec et risus in ligula eleifend consectetuer. Donec volutpat eleifend augue. Integer gravida sodales leo. Nunc vehicula neque ac erat. Vivamus non nisl. Fusce ac magna. Suspendisse euismod libero eget mauris.

    Toggle Cloak
    idcloak15
    Parameters

    Cloak
    idcloak15

    Name

    Required?

    Default

    Description

    default

    justify

    • left Aligns text and content to the left of the page
    • right Aligns text and content to the right of the page
    • center Aligns text and content to the center of the page
    • justify Justifies text and content to fit the width of the page (default)
    Card
    labeliframe

    Displays a web-page within a Wiki page.

    The Code

    Code Block
    
    {iframe:src=http://stellar.mit.edu/|width=500|height=500}Your browser does not support iframes{iframe}
    

    Toggle Cloak
    idcloak16
    Result

    Cloak
    idcloak16
    http://stellar.mit.edu/500500

    Your browser does not support iframes

    Toggle Cloak
    idcloak17
    Parameters

    Cloak
    idcloak17

    Name

    Required?

    Default

    Description

    class

     

    The class to associate with the tag. Multiple classes can be specified by separating them with spaces.

    title

     

    An optional inline style sheet to apply to the tag.

    style

     

    Optional extra information about the tag.

    id

     

    The html ID of the tag.

    align

     

    The alignment of the iframe (left/right/top/middle/bottom).

    frameborder

     

    Whether to display a border (0/1).

    height

     

    The iframe height in px/%.

    longdesc

     

    A url to a page which contains a long description of the content within the iframe.

    marginheight

     

    The size of the top/bottom margins of the iframe.

    marginwidth

     

    The size of the left/right margins of the iframe.

    name

     

    The name of the iframe.

    scrolling

     

    Whether to show scrollbars or not (yes/no/auto).

    src

     

    The url to be displayed within the iframe.

    width

     

    The width of the iframe in px/%.

    Card
    labelrollover

    Displays text when cursor hovers over designated area.

    The Code

    Basic rollover:

    Code Block
    
    {style}
    .test {
    background-color:#00AA00;
    color:#000000;
    }
    .test-rollover {
    background-color:#0000AA;
    color:#FFFFFF;
    }
    {style}
    {rollover:class=test}{div}Some Content{div}{rollover}
    

    Rollover with link:

    Code Block
    
    {rollover:class=test|link=ADAPTAVIST:home}{div}Link to main homepage{div}{rollover}
    

    Rollover with link and pointer:

    Code Block
    
    {style}
    .pointy-rollover {
    background-color:#0000AA;
    color:#FFFFFF;
    cursor:pointer;
    }
    {style}
    
    Code Block
    
    {rollover:class=test|over=pointy-rollover|link=MITDASHBOARD:home}{div}Link to MIT Wikis{div}{rollover}
    

    Outside webpages can also be linked to by entering the url in the 'link=' parameter.

    Toggle Cloak
    idcloak18
    Result

    Cloak
    idcloak18

    Basic rollover:

    testSome Content

    Rollover with link:

    testMITDASHBOARD:WikisLink to MIT Wikis

    Rollover with link and pointer:

    testpointy-rolloverMITDASHBOARD:WikisLink to MIT Wikis

    Toggle Cloak
    idcloak19
    Parameters

    Cloak
    idcloak19

    Name

    Required?

    Default

    Description

    class

     

    The name of the CSS class that contains the styles for the rollover when in it's default state.

    over

    class-over

    The name of the CSS class that contains the styles for the rollover when it is in the over state.

    link

     

    The page that the rollover should link to when clicked.

    target

     

    An optional external target to also modify.

    targetclass

     

    An optional class name to use solely for the external target (defaults to class).

    targetover

     

    An optional class name to use solely for the external target roll-over state(defaults to %targetclass%-rollover).

    Card

    Deck of Cards

    Round Rectangle
    cornersfalse,false,true,true
    bgcolor#828282
    width909px
    height50px

    Column
    width20%
    Column
    width20%
    Panel
    borderColor#828282
    bgColorwhite
    titleBGColor#828282
    borderWidth1
    titleTechnical Support
    borderStyleridge

    Help Desk
    If you have encountered a problem using Wikis or have a comment or question about Wikis, please contact the Computing Helpdesk via email or at 617-253-1101, Monday - Friday 8-6 EST

    Panel
    borderColor#828282
    bgColorwhite
    titleBGColor#828282
    borderWidth1
    titleSearch Wiki Help Pages
    borderStyleridge
    Livesearch
    spaceKey