Skip to end of metadata
Go to start of metadata


Description

This macro creates a link to a specific Confluence feature or page relative to the current location in the wiki.

The macro combines the features of the menuitem macro, menulink macro and menuicon macro resulting in cleaner syntax and a three fold performance increase.

Each link destination abides by all applicable permissions - should the user not have sufficient permission to use the link, or simply be in a location where the link is not applicable, the body of the macro is returned un-linked (which is then usually hidden by the menuitem macro).

Requirements

This macro requires Theme Builder 3.0 or above.

Usage

{compound-menuitem:linktype|caption=text|icon=icon_name}

Parameters

Property

Required

Default

Notes

Ver

default

(tick)

 

The destination to link to (see list below)

3.0

caption

(error)

 

The link text to be displayed to the user.

3.0

space

(error)

current space

Optionally set the space to which the link relates.

3.0

page

(error)

current page

Optionally set the page to which the link relates, eg. when using the "newpage" destination you can define the parent page with this parameter.

3.0

parent

(error)

space homepage

When using the "exportMail" destination, this defines the page that will be the parent of the new page containing the exported mail message.

3.0

link

(error)

 

When using the "custom" destination (see examples) this is the URL to link to.

3.0

toggle

(error)

 

When using the "toggleVisibility" destination (see examples) this is the HTML id of the tag to show/hide.

3.0

tooltip

(error)

 

The tooltip to display when the mouse hovers over the link (max: 77 chars for cross-platform compatibility)

3.0

accesskey

(error)

 

An optional shortcut key for the link which can be any alphanumeric character

3.0

target

(error)

current browser window

An optional target window or frame in which to load the link destination.

3.0

class

(error)

 

Optional HTML classes to associated with the hyperlink.

3.0

hideanon

(error)

false

Whether to hide the link from anonymous users:

  • false - don't hide from anonymous users (default)
  • true - always hide from anonymous users, even if they have privileges to use the link

3.0

rel

(error)

automatic

The "rel" attribute to assign to the link. Many links get an automatic rel attribute (eg. rel="index" for the index link) and also "nofollow" rels to prevent search engines following links that alter content, etc.

3.0

icon

(error)

none

the icon to use as one of SPACEKEY:pagename^filename.ext/custom url/inbuilt icon (use 'noicon' to prevent an icon being displayed)

3.0

imginside

(error)

false

Defines whether the icon (if present) should be within the link tag or outside it. This is useful when displaying just an icon link on the main menu bar.

  • false - icon is outside the link tag (default)
  • true - icon is inside the link tag

3.0

size

(error)

16

When used with the compound-menuitem macro, defines the pixel size (same for width and height) of the icon if shown.

3.0

layout

(error)

 

When using the use-layout location, defines the layout ID to use.

3.0

latch

(error)

false

When using the use-layout location, determines whether the layout should be used temporarily for the resulting page view or latched for all subsequent page views.

  • false - don't latch the layout (default)
  • true - latch the layout so it's used for subsequent page views

3.0

item

(error)

 

 

3.0

flag

(error)

 

The macro is rendered only if one or more of the specified flags are set. See Working with Flags for more details.

3.3.6

notflag

(error)

 

The macro is rendered only if none of the specified flags are set. See Working with Flags for more details.

3.3.6

Caption Fields

Some link locations provide fields for captions which get automatically replaced when the links are displayed based on the state of the link location.

For example, the %page% field will be replaced with either "page" or "news" depending on whether you're looking at a page or a blog post.

 Click for example
{compound-menuitem:edit|caption=Edit this %page%}

Field

Link Destinations

Notes

%page%

information, edit, remove, favourite, favouritespace, watch, watchspace, watchpage

Displays either "page", "news" or "space" as applicable to the content you are currently viewing.

%count%

spaceattachments, children, comments, pageattachments, viewattachments

Displays the number of attachments, children or comments as applicable to the link location.

%user%

profile, userspace

Displays the users full name.

%space%, %Space%

activity

Displays "space" or "site" - the %Space% field capitalises the first letter, eg. "Space" or "Site".

%add%

favourite, favouritespace, watch, watchspace, watchpage

Displays "Add" or "Remove" depending on whether the content is in your favourites or watched.

%watching%, %watch%

watch, watchspace, watchpage

Displays "Watching" or "Watch" (%watching%), "Watch" or "Unwatch" (%watch) depending on whether you are watching the content.

Link Destinations

The following link destinations can be used in the compound-menuitem macro.

The Ver column denotes which version of Theme Builder is required.

 Account management

Destination

Default Location

Notes

Builder Ver

Feature Of

login

View > Account > Login

If the user is logged out, this will take them to the login screen

3.0

Confluence

logout

View > Account > Logout

If the user is logged in, this will take them to the logout screen

3.0

Confluence

profile

View > Account > Preferences: <name>

If the user is logged in, this will take them to their personal profile screen

3.0

Confluence

userspace

View > Account > Personal Space

Displays the users' personal space if they have one, otherwise it displays their personal profile

3.0

Confluence

signup

View > Account > Sign-up

Displays the user sign-up screen (if public sign-up is enabled in General Configuration)

3.0

Confluence

 Community Features

Destination

Default Location

Notes

Builder Ver

Feature Of

inviteothers

 

 

3.0

Invite Plugin

invitelist

 

 

3.0

Invite Plugin

invite

View > Invite Friends

 

3.0

Invite Plugin

customusermanagement

Edit > Administration > User Management...

Displays screen for editing the user group associated with current space.

3.0

Custom Space User Management

space-socialbookmarks

View > Other Pages > Bookmarks

Displays a list of bookmarks for the current space.

3.0

Social Bookmarking Plugin

review

Edit > New > Review...

Adds a new review for the current page.

3.0

Mark for Review Plugin

 Web Feeds

Destination

Default Location

Notes

Builder Ver

Feature Of

podcastpage

Edit > Podcast Settings...

Configures Podcast settings for a page.

3.0

Podcast Plugin

podcastnews

Edit > Podcast Settings...

Configures Podcast settings for a blog post (news).

3.0

Podcast Plugin

podcastchannels

View > Other Pages > Podcasts

Displays Podcast channels screen for a space (which also allows channels to be edited).

3.0

Podcast Plugin

RSS

View > Other Pages > RSS Feed Builder

Displays the RSS Feed Builder

3.0

Confluence

 Folksonomy (Labels/Tags)

Destination

Default Location

Notes

Builder Ver

Feature Of

labels

View > Other Pages > Labels

Displays the labels within a space or global labels if used outside a Space

3.0

Confluence

label
globalLabel

 Interest Management

Destination

Default Location

Notes

Builder Ver

Feature Of

favourite

View > This Page > Add/remove favourite

Adds or removes the current page/news/space to or from personal favourites. See also: builder-favicon macro

3.0

Confluence

watch

View > This Page > Watch this page/news/space

Toggles email notifications when current page/news/space is changed

3.0

Confluence

pagewatcher

View > This Page > Watchers

Displays a list of people watching the current page, editable by admins.

3.0

Community Bubbles

newswatcher

View > This Page > Watchers

Displays a list of people watching the current blogpost, editable by admins.

3.0

Community Bubbles

pagefavourites

View > This Page > Favourites

Displays a list of people who have marked the page as their favourite, editable by admins.

3.0

Community Bubbles

newsfavourites

View > This Page > Favourites

Displays a list of people who have marked the blogpost as their favourite.

3.0

Community Bubbles

favouritespace

 

Adds or removes the current space from the logged in users' favourites.

3.0

Confluence

watchspace

 

Toggles email notifications for the space for the logged in user.

3.0

Confluence

watchpage

 

Toggles email notifications for the current page or blogpost for the logged in user. See also: builder-watchicon macro

3.0

Confluence

activity

View > Other Pages > Usage Statistics

Links to the activity graphs for the current space or entire site (depending on current location in wiki).

 

Activity Plugin

 Content Creation

Destination

Default Location

Notes

Builder Ver

Feature Of

newcomment

Edit > New > Comment...

Creates a new comment on a page or news item (blog post) within a Space

3.0

Confluence

newnews

Edit > New > News...

Creates a new news item (blog post) within a Space

3.0

Confluence

newpage

Edit > New > Page...

Creates a new page within a Space

3.0

Confluence

newspace

Edit > New > Space...

Creates a new Space

2.0.0

Confluence

addbookmark

Edit > New > Bookmark...

Links to the "Add Bookmark" screen.

3.0

Social Bookmarking Plugin

editgridaddbook

Edit > New > Spreadsheet...

Adds a new editable spreadsheet to the page.

3.0

Edit Grid

 Content Management

Destination

Default Location

Notes

Builder Ver

Feature Of

copy

Edit > Copy this Page...

Creates an editable copy of a page

3.0

Confluence

edit

Edit > Edit this Page/News...

Edits the current page or news item

3.0

Confluence

remove

Edit > Remove this Page/News...

Deletes (after confirmation) the current page or news item

3.0

Confluence

editinword

Edit > Edit in Word

Edits the current page in MS Word.

3.0

WordDAV Plugin

addgliffydiagram

Edit > New > Diagram...

Adds a new Gliffy diagram to a wiki page.

3.0

Gliffy Plugin

pageattachments

Edit > Attachments

Displays the attachments for a page or news item if you have add-attachment permission

3.0

Confluence

viewattachments

 

Displays the attachments for a page or news item

3.0

Confluence

 Content Exporting

These options allow you to export content in different formats.

Destination

Default Location

Notes

Builder Ver

Feature Of

emailpage

View > This Page > Email to a friend...

Allows the user to email the page to a friend.

3.0

Mail Page Plugin

exportMail

View > This Page > Export to Wiki Page

When viewing a mail message in the space mail archive, this will export that message (including attachments) to a new, editable wiki page

3.0

Theme Builder

exportPDF

View > This Page > Export to Adobe Acrobat (PDF)

Exports the page (and in some versions of Confluence, a blog post) to a PDF file

3.0

Confluence

exportWord

View > This Page > Export to Microsoft Word

Exports the page (and in some versions of Confluence, a blog post) to a Word document

3.0

Confluence

 Display Mode

Destination

Default Location

Notes

Builder Ver

Feature Of

information

View > This Page > Page Information

Displays information for a page or blog post

3.0

Confluence

normalView

View > This Page > Normal view

The normal view of a page.

3.0

Confluence

printableView

View > This Page > Printable view

The print preview of any page. If a sidebar is set to be "collapsed by default" it will not appear in the print preview.

3.0

Confluence

pageView

View > This Page > View Page

When viewing attachments or page information, this will return you to the normal view of the page.

3.0

Confluence

information

View > This Page > Page Information

Displays page information such as recent changes, author, incoming links, etc.

3.0

Confluence

 Visibility Settings

Destination

Default Location

Notes

Builder Ver

Feature Of

children

View > Show Children

Toggle the display of the builder-children macro

3.0

Theme Builder

comments

View > Show Comments

Toggle the display of the builder-comments macro

3.0

Theme Builder

toggleVisibility

 

Shows or hides a HTML tag (and it's contents) based on it's HTML id (see examples).

3.0

toggleSidebar

 General Navigation

Destination

Default Location

Notes

Builder Ver

Feature Of

dashboard

View > Other Pages > Dashbaord

Site dashboard

3.0

Confluence

mail

View > Mail

If a Space has mail in it's mail archive, this will display the mail archive

3.0

Confluence

news

View > Other Pages > News

Displays the recent news within a Space

3.0

Confluence

recent

View > Other Pages > Recent Updates

Displays the list of recent updates within a Space

3.0

Confluence

history

View > Account > History

Displays the history of visited pages, for the current user, in a new window

3.0

Confluence

search

 

Links to the search screen (defaulting to searching the current space where applicable).

3.0

Confluence

index

View > Other Pages > Index

Displays the alphabetical index of content in a Space

3.0

Confluence

spaceattachments

View > Other Pages > Attachments

Displays the attachments index within a Space

3.0

Confluence

people

View > Other Pages > People Directory

Displays the people directory.

 

Confluence

 Hierarchical Navigation

Destination

Default Location

Notes

Builder Ver

Feature Of

home

View > Other Pages > Home Page

If used within a Space, this takes the user to the space home page. If used anywhere else, the site home page is shown. The site home page is either the user's homepage (if set in their profile), the site homepage (if set in General Configuration) or the Dashboard (default)

3.0

Confluence

next

 

Links to the next sibling page.

3.0

Theme Builder

prev

 

Links to the previous sibling page.

3.0

Theme Builder

parent

 

Links to the parent of the current page.

3.0

Theme Builder

first

 

Links to the first sibling page.

3.0

Theme Builder

last

 

Links to the last sibling page.

3.0

Theme Builder

firstchild

 

Links to the first child page.

3.0

Theme Builder

lastchild

 

Links to the last child page.

3.0

Theme Builder

map

View > Other Pages > Site Map

Displays the tree view of hierarchical pages (with current page selected if applicable) within a Space.

3.0

Confluence

 Custom Links

Destination

Default Location

Notes

Builder Ver

Feature Of

custom

 

Allows you to specify a custom URL. This is often useful if you want an external web page to launch in a new window because you can combine it with the "target" parameter.

3.0

Theme Builder

webui

 

Displays a "Web UI" link (some plugins use these to add additional navigation, etc). See Examples for more details. The next section (third-party) lists some inbuilt webui aliases for popular plugins.

3.0

Confluence

wikipage

 

Links to a wiki page, the page being defined using the page parameter (and optionally the space parameter if the page is in a different space.

3.0

Confluence

 Theme Configuration

Destination

Default Location

Notes

Builder Ver

Feature Of

configuretheme

Edit > Administration > Configure Theme

Displays the theme configuration page (Builder 2.x) or Layout Chooser (Builder 3.0 and above).

3.0

Theme Builder

colourscheme

Edit > Administration > Colour Scheme

Displays the space or global (as applicable to current location) colour scheme editor.

3.0

Confluence

chooselayout

Edit > Administration > Choose Layout

Displays the Layout Chooser.

3.0

Theme Builder

managelayouts

Edit > Administration > Manage Layouts

Displays the Layout Manager.

3.0

Theme Builder

themeadmin

Edit > Administration > Theme Administration

Displays the Theme Administration screen.

3.0

Theme Builder

use-layout

 

Allows selection of a different layout. See examples and also use-layout macro.

3.0

Theme Builder

 Administration

Destination

Default Location

Notes

Builder Ver

Feature Of

advanced

Edit > Administration > Advanced

Displays the "advanced" screen

3.0

Confluence

siteadmin

Edit > Administration > Site Administration

Displays the Administration Console

3.0

Confluence

spaceadmin

Edit > Administration > Space Administration

Displays teh Space administration screen

3.0

Confluence

admingliffy

Edit > Admiinstration > Gliffy...

Links to the Gliffy administration screen.

3.0

Gliffy

reviewreport

Edit > Administration > Reviews

Displays review report for the space.

3.0

Mark for Review Plugin

reviewspaceconfig

Edit > Administration > Review - Space Config

Space-level configuration for Reviews.

3.0

Mark for Review Plugin

reviewglobalconfig

Edit > Administration > Review - Admin Config

Global configuration for Reviews.

3.0

Mark for Review Plugin

inviteothersadmin

Edit > Administration > Invite Others

 

3.0

Invite Plugin

invitelistadmin

Edit > Administration > Invite List

 

3.0

Invite Plugin

globaltemplates

Edit > Administration > Global Templates

Displays the global templates

3.0

Confluence

spacetemplates

Edit > Administration > Space Templates

Displays the templates within a Space

3.0

Confluence

Examples

 Linking to a wikipage

A menu link to a wiki page can be created by setting the pagetyoe to wikipage and setting the page parameter to the destination page. Like this:

{compound-menuitem:wikipage|page=<your_page>}

if the page is in a different space include the space parameter.
Like so:

{compound-menuitem:wikipage|space=<your_space>|page=<your_page>}

 Basic use

You can create a link to the dashboard as follows:

{compound-menuitem:dashboard|caption=Go to the dashboard}
 Linking to a Space

You can link to a space by using a combination of the home location and the space parameter:

{compound-menuitem:home|space=foo|caption=Go to the home page of the foo space}

That will link to the home page of a Space with a key of "foo".

This is really useful because if someone renames the home page this link will still work!

 Links to features in other spaces

You can link to a feature in another space as follows:

{compound-menuitem:map|space=wibble|caption=Wibble Site Map}

This would show the site map in the Space with a key of "wibble", regardless of where you are in your site.

 Tooltips and Access Keys

To add tooltips and access keys, use the following notation:

{compound-menuitem:newcomment|accesskey=c|tooltip=Add comment|caption=Add a comment...}
 Hiding Inactive Links

(warning) this does not appear to be working at the momment

If a compound-menuitem is not applicable (eg. user doesn't have privilages or the link does not relate to the current location within your site, etc) then the body text of the link will be output unlinked.

For example, if a user does not have comment privileges, then they would see the link shown in the previous example as:

Add a comment...

Obviously, that's not very useful so you want to hide inactive menu links. To do this, use the menuitem macro which will hide it's body content if there are no links in it:

{compound-menuitem:newcomment|flat=true|caption=Add a comment...}

If the body of the menuitem macro doesn't contain a link, it will not be shown.

 Link Target

You can open the link destination in a specific frame or window using the target parameter:

{compound-menuitem:map|target=_blank|caption=Open site map in new window}

Which results in:

Unknown macro: {compound-menuitem}
 Toggle the Visibility of an on-screen element

There is a bug in Builder 2.0.1 - please don't use this link destination until further notice as it doesn't work.

You can toggle the visibility of any HTML tag with a unique id using the code below:

{div:id=visdemo}*This is a div tag with id of "visdemo" that you can show or hide using the link below.*{div}

{menulink:toggleVisibility|target=visdemo}Toggle the text above{menulink}

As you can see, the div tag has been given a HTML id - the raw HTML looks like this:

<div id="visdemo"> ... <div>

And the "target" parameter in the menulink macro states what id will be toggled.

The result:

Unknown macro: {div}

This is a div tag with id of "visdemo" that you can show or hide using the link below.

Unknown macro: {menulink}

Toggle the text above

If you want the tag to initially be hidden, use the "display:none" CSS style:

{div:id=visdemo1|style=display:none;}*This is a div tag with id of "visdemo1" that you can show or hide using the link below.*{div}

{menulink:toggleVisibility|target=visdemo1}Show/hide the text above{menulink}

The div tag will now be output with a style attribute like this:

<div id="visdemo1" style="display:none;"> ... <div>

Note that we've changed the id from "visdemo" to "visdemo1" - that's because a HTML id must be unique to the entire web page. If there are two or more occurrences of the same id, the results can be very unpredictable so make sure to use unique id's.

The result (it starts hidden so click the link to see it):

Unknown macro: {div}

This is a div tag with id of "visdemo1" that you can show or hide using the link below.

Unknown macro: {menulink}

Show/hide the text above

 Linking to other sites

To add tooltips and access keys, use the following notation:

{compound-menuitem:custom|link=http://www.domain.com/path/resource.file|caption=Other}
 How do I show Web UI links?

Web UI links are a feature of Confluence plugins that allow them to add additional navigation to the default themes.

However, because Theme Builder displays navigation in a significantly different format, we can't display those links by default otherwise we'd end up with duplicate and confusing navigation in the default menus.

(info) Web UI link support was added in Theme Builder 2.0.8 and above.

Before adding Web UI links as shown below, please check the table above the Examples section on this page which lists a number of aliases for popular third party plugins.

To add Web UI links to Theme Builder meuns, use the following syntax:

{compound-menuitem:webui|location=XXXX|key=YYYY|caption=webui link}

For example, here's the markup used for the podcasting plugin:

Podcast Page Tab

{compound-menuitem:webui|location=system.page|key=podcast-episode-page-webui|caption=Edit Podcast}

Podcast News Item Tab

{compound-menuitem:webui|location=system.news|key=podcast-episode-blogpost-webui|caption=Edit Podcast}

Podcast Channels Space Tab

{compound-menuitem:webui|location=system.space|key=space-podcast-channel-webui|caption=Podcast Channels}

Note: There are aliases for these links in the table further up the page, the links shown above are just to illustrate how to manually construct those links.

If you don't specify any link text (eg. "Edit Podcast") then the default text supplied by the plugins' Web UI link will be used.

(warning) Important
Many third party plugins don't do strict checking of the mode and context to determine whether a Web UI link should be displayed. Because Theme Builder can display Web UI links in any area of Confluence, you might need to use the builder-show macro or builder-hide macro to show/hide Web UI links that start appearing in too many places.

If you need a technical explanation as to why this is the case, or any help with working with Web UI links in third party plugins, please contact our support desk.

When using the menulink inside a menu, it needs to be wrapped in the menuitem macro, eg:

{compound-menuitem:webui|location=system.space|key=space-podcast-channel-webui|caption=Podcast Channels}

Hints and Tips

You can create keyboard shortcuts by adding empty menulinks to a panel in builder (eg. title or footnotes panel, etc), for example:

{compound-menuitem:edit|tooltip=Edit this content|accesskey=e|caption=Edit this %page%}

This would add the keyboard shortcut "Alt+E" to all screens that can be edited (eg. blogposts, pages, etc). The shortcut would only be available if the current user has sufficient privileges to edit the page, etc.

Share Menu

To include the Share menu, you can make a Link Alias called, say, sharepage for Share Page - Share then reference that in the macro e.g. {compound-menuitem:sharepage...}

52 Comments

  1. Unknown User (meredith.raymond@invitrogen.com)

    How do you add a ---- between menu items? I know it must be simple, but I can not find the syntax.

    1. Unknown User (jessica.britton)

      Try this:

      {menuseparator}
      
      1. Unknown User (meredith.raymond@invitrogen.com)

        Much appreciated!

  2. Unknown User (lalbert)

    Is it possible to link to an anchor? I can't get it to work.

    {compound-menuitem:wikipage|#anchor|caption=Link text}
    
    1. Unknown User (abbriste)

      This is what I tried. It didn't work either.

      {compound-menuitem:wikipage|space=rvt|page=modeling|link=#building assembly best known practices|caption=Modeling Techniques}
      

      Is it possible to link to a page anchor?

      1. No that's not possible.

        1. Unknown User (abbriste)

          grumble grumble mumble mumble. Okay. Thanks Alain. I figured as much. Although I could use regular wiki markup inside a menulink to get to the anchor, right?

          1. Sadly no (sad)

            One thing you might like to try ... is using the %currenturl% menulink replacement:

            {compound-menuitem:custom|link=%currenturl%#anchor|caption=blah}

            However if your current url contains an anchor then I suspect it will break, the only way to make this happen reliably is going to be the addition of an 'anchor' menulink type.

            That's not likely to happen any time soon though since we have our work cut out for us with getting builder 4 production ready.

            1. Unknown User (abbriste)

              Okay. Well, it's worth a try. Thanks Alain.

  3. Unknown User (jblazquez@elecnor.es)

    Hi!
    I would like to know how to insert the triangular arrows that expands and collapes which are used in this page (and in most pages of Adaptavist Web), i.e. : In Examples section in this page "Linking to a wikipage".

    It must be simple but I dont's find it!

    Thank you!

    1. Unknown User (hboer1965)

      Hi Jon,

      use the {expand} macro. See the documentation at Atlassian, here.

      Regards, Herman.

      1. Unknown User (jblazquez@elecnor.es)

        Thanks Herman!
        I knew It should be easy!

        Cheers,
        Jon

    2. Unknown User (jeff@lightspeedsystems.com)

      Jon –
      You can also use the Cloak and Toggle Cloak macros documented here on the Adaptavist site.

      Here to help,
      Jeff

      1. Unknown User (jblazquez@elecnor.es)

  4. Unknown User (macandron)

    Hi! Thanks for this great plugin - it makes building and modifying themes a breeze.

    However I am missing two locations/functions for compound-menuitem:

    • Notation Guide
    • Move page

    The latter function is rather central, but is for some reason blatantly absent from the list of functions! Have I missed something, or can it be replaced by something else?

    1. I think you are looking for 'notationguide' and 'move' (wink)

      1. Unknown User (macandron)

        Well I'll be.... I never thought of just trying them out! (big grin) However, the 'move' function doesn't display in the menu at all. Here's the code I'm using:

        {menubar:id=pageactions}
        {menu}{menuicon:gear}Tools
         {compound-menuitem:copy|icon=documents_new|caption=Copy this %page%}
         {compound-menuitem:move|caption=Move this %page%}
         {compound-menuitem:remove|icon=document_delete|caption=Remove this %page%}
        {menu}
        {menubar}
        

        For some reason, Copy and Remove are showing just fine. Move isn't.

        1. Unknown User (bowerjo1)

          I've tried the move option as well as the menu item does not show up on our Confluence instance either.

          We are using Confluence 3.0.1 and Theme Builder 3.3.6-M4-conf210-SNAPSHOT.

          The option is not a must have, but it would be nice as we had it with the default theme and some users have noticed it is now missing.

  5. Unknown User (orthonet)

    How can I remove the bullet added before the compound menu item.
    I have tried

    as the class for the li is menuitem but it does not appear to work.

    Regards
    CV

    1. see the documentation above (wink)

      flat=true

      1. Unknown User (orthonet)

        Thanks Alain
        That works
        I must be blind cause I do not see a flat parameter above. Browser find function did not either (smile)
        Regards
        CV

  6. Unknown User (jonnylyse)

    Hi, I'we tried searching to find the compund-menuitem for "User Status" update.
    In the default theme it's called "Update Status..."

    Tips? (smile)

    1. Use a menulink alias to point to the confluence web item

      1. Unknown User (jonnylyse)

        I was informed of the Menulink Aliases once before, it slipped my mind this time..
        Thanks for the reply (smile)

      2. Unknown User (jbrown@interthinx.com)

        Hi Alain-
        I too was trying to create a menu item for "Update Status". I went to the URL you linked to, but still didn't understand how you would go about creating that link? This is the menu I currently have, and I would want it to appear in the list. I'm very new to Confluence, so a little more detailed help would be perfect!

        {menu}%fullname%
        {compound-menuitem:profile|icon=id_card|caption=Preferences: %fullname%}
        {compound-menuitem:history|icon=clock|caption=History}
        {compound-menuitem:logout|icon=door2|caption=Log out}
        {menu}
        1. Unknown User (jbrown@interthinx.com)

          Can anyone please help me with this. I have been searching everywhere. I know it is possible because they have it as a menu option on this site.

          1. Sorry I've been busy with paid work, if you need support within any reasonable timescale please consider taking out a support contract.

            Create a 'plugin' menulink alias with 'User Status' as the plugin and 'Update user status menu item' as the link.

            When time permits (or when someone pays for it) we will be overhauling the menulink alias definition page to allow you to select the menulink by where it appears in the default confluence theme as well as the current plugin based route.

            1. Unknown User (jbrown@interthinx.com)

              Hi Alain-
              Thanks for the response. I tried doing that, but it wasn't working. It was just creating a duplicate emailpage alias instead. I figured out that the Plugin was 4.1.1 rather than the latest 4.1.3. I updated it and everything is working as expected now. Thanks for your help.

  7. Unknown User (daveneti)

    I am trying to add a user profile, login/logout to the navigate just in front of the standard icons/links, but I get some unexpected results. My navigator content is

    {table:width=100%|cellpadding=0|cellspacing=0|border=0}
    {tr}
    {td:valign=middle}
    {builder-breadcrumbs}
    {td}
    {td:align=right|valign=middle}
    {compound-menuitem:profile|icon=id_card|caption=%fullname%}
    {compound-menuitem:login|icon=user1_into|caption=Log in}
    {compound-menuitem:logout|icon=door2|caption=Log out}
    {builder-show:context=page,blogpost|mode=view}
    {builder-favicon}
    {builder-watchicon}
    {compound-menuitem:edit|flat=true|imginside=true|icon=document_edit|tooltip=Edit this %page%}
    {compound-menuitem:remove|flat=true|imginside=true|icon=document_delete|tooltip=Remove this %page%}
    {compound-menuitem:copy|flat=true|imginside=true|icon=documents_new|tooltip=Copy this %page%}
    {compound-menuitem:pageattachments|flat=true|imginside=true|icon=document_attachment|tooltip=View %page% attachments}
    {builder-show}
    {td}
    {tr}
    {table}
    

    The page is http://wiki.cimmyt.org/confluence/display/MBP/Home

    1. Unknown User (gfraser)

      You probably want to add flat=true to the compound-menuitems you added for login/etc (some of the items further down already have the param).

      1. Unknown User (daveneti)

        Yes, that worked. Thanks

  8. Unknown User (abbriste)

    {menubar:id=sitenav|class=siteNav}
    {compound-menuitem:home|space=rvt|caption=Revit|class=currentMenuItem}
    {compound-menuitem:home|space=edu|caption=Education}
    {menubar}
    

    Above is the simplified code I'm struggling with. The idea is that the entire menu is one color, except for the currentMenuItem.

    I have been able to get the menubar class to respond properly with my css. This is great, because I get to change the background color of the div associated with the class... My problem is the class in the compound-menuitem. I can't seem to get the class to respond in my css. I am sure I'm not doing it correctly. Here's my css...

    .currentMenuItem td {
     background-color: #F4F5ED;
    }
    

    The reason for using the td is because I found this in the html:

    <td style="-moz-user-select: none;" class="item explicit-action menuitem currentMenuItem" title=""><div unselectable="on">Revit</div></td>
    

    I know I've got something wrong. But I was under the impression that if you were to assign the class, it could be called out with the same format as the other classes. I think though compound-menuitems are different because they are sub"things".

    Anyway, I haven't been able to find any documentation on how to write the class for a compound-menuitem. Thanks in advance for the help. I can elaborate if needed.

    Thank you
    -AB

    1. Unknown User (macandron)

      Looks to me like you should instead write

      td.currentMenuItem {
       background-color: #F4F5ED;
      }
      

      in the css file. (smile)

      1. Unknown User (abbriste)

        Thank you. I'm still learning my way around css, and this is just one of those things. Thanks very much Jonas.

  9. Unknown User (melissa.wood@nitorgroup.com)

    I'm a bit stuck trying to resolve functional & style issue with my menubar and am hoping you can help. Everything worked perfectly on my local instance of Confluence while I was developing it, but now that I've migrated everything to our production server something has broken and I can't seem to resolve it.

    I have a menubar with embedded compound-menuitem and menu macros used for submenus. I need the links that make up the menu "tabs" to link to a wikipage (even if it has a submenu) and I need these same tabs to utilize a background image for the default state and a different background-image for the hover and active states.

    Here's part of my menubar code. "Home" and "About the Nite" should display as the menu "tabs".

    {menubar:id=nav1|class=nav1}
     {menuitem}[nite:Home]{menuitem}
     {menu}[nhin:About the Nite]
      {menuitem}[nite:Background]{menuitem}
      {menuitem}[nite:Benefits of the Nite]{menuitem}
      {menuitem}[nite:Nite Participants]{menuitem}
     {menu}
    {menubar}
    

    Here's the applicable CSS code. All of the images have been attached to a wikipage and then referenced via their confluence URL. The "nite_nav1BkgdUp.gif" image displays on all tabs but the I can't get the "nite_nav1BkgdDown.gif" to display on the hover and active states. I changed the "down" image to the "up" image and it displayed the "up" image for the hover & active states accordingly... but when I checked the URL of the "down" image and swapped it back into the hover & active states... nothing! Makes no sense!

    .nav1 div.dynarch-horiz-menu {
     border: 0px solid #FFFFFF;
     color: #1D305F;
     cursor:hand;
    }
    
    .nav1 div.dynarch-horiz-menu table tr td, .nav1 div.dynarch-horiz-menu table tr td.explicit-action {
     background-color: #E4E4E4;
     background-image: url(/download/attachments/1212420/nite_nav1BkgdUp.gif);
     background-position: top left;
     background-repeat:repeat-x;
     border-left: 2px solid #FFFFFF;
     border-right: 2px solid #FFFFFF;
     color: #1D305F;
     font-size: 1.1em;
     padding: 3px 10px;
     vertical-align: middle;
    }
    
    .nav1 div.dynarch-horiz-menu table tr td:hover, .nav1 div.dynarch-horiz-menu table tr td:active, .nav1 div.dynarch-horiz-menu table tr td.activesection {
     background-color:#538FB3;
     background-image: url(/download/attachments/1212420/nite_nav1BkgdDown.gif);
     background-position: top left;
     background-repeat:repeat-x;
     color: #FFFFFF; 
    }
    
    .nav1 div.dynarch-horiz-menu table tr td.explicit-action:hover, .nav1 div.dynarch-horiz-menu table tr td.explicit-action:active {
     background-color:#538FB3;
     background-image: url(/download/attachments/1212420/nite_nav1BkgdDown.gif);
     background-position: top left;
     background-repeat:repeat-x;
     color: #FFFFFF; 
    }
    
    div.dynarch-horiz-menu table tr td.hover table,
    div.dynarch-horiz-menu table tr td.active table { 
    }
    
    div.dynarch-horiz-menu table tr td.separator div {
    }
    
    div.dynarch-popup-menu {
     background-color: #FFFFFF;
     border: 1px solid #909090;
     color: #1D305F;
     margin: 1px 2px;
     padding: 0;
    }
    
    div.dynarch-popup-menu tr.item{
     color: #1D305F; 
     border-top: 1px solid #ABA79B;
     border-bottom: 1px solid #ABA79B;
     padding: 1px 3px;
    }
    
    div.dynarch-popup-menu tr.item.hover {
     background-color: #81C1E5;
    }
    
    div.dynarch-popup-menu tr.item.active {
     background-color: #81C1E5;
    }
    
    div.dynarch-popup-menu tr.separator td div {
     background-color: #ABA79B;
     margin: 0;
     padding: 0;
    }
    

    And I'm curious... can I build my CSS based on the HTML rendering output? Meaning, when I "View Page Source" in my browser, the styles listed above are nowhere to be found in the rendered output (except for "nav1"), thus making building an accurate stylesheet a bit difficult. Or could you please provide the source code w/in the builder scripts where these styles exist to help us troubleshoot our code?

    Thanks TONS for all the help!

  10. Unknown User (abbriste)

    When using the compound menu item with wikipage and page:

    {compound-menuitem:wikipage|page=Template Selector|icon=icon.png}
    

    How can I keep the words "Template Selector" (the name of the page I am linking to) from showing. All I want to see is the icon. I can't figure out why this would become the caption. Is there any way to remove this caption? I haven't defined a caption at all, and I'd like to keep it that way.

    Thank you.

    1. Unknown User (macandron)

      Try using the caption parameter without a value. Like so:

      {compound-menuitem:wikipage|page=Template Selector|icon=icon.png|caption=}
  11. Unknown User (nimsnims)

    Is it possible to use menuitem macro and newpage parameter to add a page based on a specific template? Actually, i'm looking for a parameter to force user to create a page with a specific template...

  12. Unknown User (utimpe)

    Why is the menuitem 'exportpdf' not visible for anonymous users? How can I configure this?
    Thanks
    Udo

    1. Unknown User (gfraser)

      You need to ensure they have 'Export' permission in Space Permissions.

      1. Unknown User (utimpe)

        Thanks, found it.

  13. Unknown User (frank.knobloch@sportics.net)

    exportMail and emailpage is not available (anon and authenticated). Do i miss some macros?

  14. Unknown User (tewolff)

    I think this is a new, unfortunate, behavior with "compound-menuitem:newpage" in the Title area since we recently upgraded to Confluence 3.1.2 and TB 4.0.2.

    With {compound-menuitem:newpage|flat=true|icon=document_add|caption=Add Topic}, the new page is now always added below the top level page in space rather than the below the current page as was and should be the default. This is particularly bothersome when people try to add a new topic to a Forum while viewing the top level Forum page, and the new entry then isn't added as a child of that Forum page. Either the user has to use the Location function on the add/edit page, something users don't even realize they now have to do, or as admin, I have to move the page to the forum hierarchy.

    Is there something I can do to fix this?

  15. Unknown User (jbrown@interthinx.com)

    I'm trying to create a menu item that links to create a child page of a specific parent. I was going to use the Linking Plugin from CustomWare. That would allow me to create links to all of the specific pages I want. The problem I am having is how do I combine the add-page macro with the compound-menuitem macro? I want it to appear in a dropdown menu with a bunch of other links that I have in there now.

    1. The linking plugin is often not compatible with the builder panels, it makes the assumption that it is being run from within a page & this can cause unexpected results ... the menulink/compound-menuitem links to everywhere that the linking plugin does (and more), you should use that instead.

  16. Unknown User (davef)

    Something that seems to be asked a lot, and I mean A LOT is how to make the notation guide appear, yet there is no official hand it to the users on a plate description/example code. Can someone please supply one, or link to a page that has it.

    Personally I'd like to see it as a configurable toggle in the Options tab of the layout editor. When selected it then should appear when ever someone is in the edit mode, especially in the wiki editor. Without it, inexperienced confluence users will find editing frustrating and may reject the product entirely.

    1. The Notation guide does have a URL which will make it appear in full screen mode http://<domain>/renderer/notationhelp.action

      In Theme Builder the Notation Guide will show if you use a Right Sidebar.

      The builder code is:

      {builder-infopanel}
      

      To make the Notation Guide appear when editing you can use this:

      {builder-show:mode=edit,create-page,create-blogpost}{builder-infopanel}{builder-show}
      

      One option we frequently use is to create a duplicate of your standard layout, called for example RSB (Right Side Bar), untick Left Sidebar, tick Right Sidebar.

      In your standard layout, in the Header area, use this code to switch to your RSB layout when using Edit Mode

      {builder-show:mode=edit,create-page,create-blogpost}{use-layout:RSB}{builder-show}
      
    2. You can add a link to the notation guide using the menulink/compound-menuitem macro (underneath the hood they are the same code), eg:

      {compound-menuitem:notationguide|caption=Notation Guide...|flat=true}
      
      Unknown macro: {compound-menuitem}

      However you are correct, a link to the guide from the content editing tab in the panel editor window would be useful. I will request internally that it gets added to a future release.

  17. Unknown User (davis.1114)

    Hi!

    Is there a compound-menuitem for exporting to excel?
    Something like:

    {compound-menuitem:exportXLS...}
    
    1. Create a menulink alias that points to the webui link from the default confluence theme.

  18. Unknown User (jsuever)

    Is there a way to create a "save page" link?

    Looks like I may be stuck with only the Save button that shows up in the content area of the page when editing.