[All Adaptavist Apps]
Page History
{menu} Macro
Description
The {menu}, {submenu}, {sub-submenu} and {menuitem} macros are all the same macro! The different names are merely to aid legibility of menu definitions by allowing semantically/heirarchically correct structures to be built in the following form:
...
Requirements
This macro requires Theme Builder 2.0 or above.
Usage
To recreate the hierarchical structure shown above, use the following notation:
| Code Block |
|---|
{menu}Menu
{submenu}Submenu
{sub-submenu}Sub-Submenu
{menuitem}Menuitem{menuitem}
{sub-submenu}
{submenu}
{menu}
|
...
Property | Required | Default | Notes | |
|---|---|---|---|---|
class |
|
| The CSS class name to assign to an item in a menu | |
subclass |
|
| The CSS class name to assign to a pop-up menu that's associated with an item in a menu | |
id |
|
| The HTML ID (must be unique for the entire web page) associated with an item in the menu | |
subid |
|
| The HTML ID (must be unique for entire web page) associated to a pop-up menu that's associated with an item in a menu | |
autohide |
| true | The following values are permitted:
| |
custom |
| false | The following values are permitted:
| |
flat |
| false | The following values are permitted:
| |
hideanon |
| false | Hide the contents of the menu from anonymous users |
|
flag |
|
| 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 |
|
| The macro is rendered only if none of the specified flags are set. See Working with Flags for more details. | 3.3.6 |
Examples
Basic Use
unmigrated-wiki-markup
The
most
basic
use
of
these
macros
is
to
output
a
single
menu
item:
{
Code Block We've
used
a
wiki
notation
link
in
the
example
above
to
create
a
link
to
the
Home
page
within
the
current
space.
You
can
use
any
valid
wiki
notation
link
inside
a
menu
item
so
you
could,
for
example,
link
to
a
news
item,
different
space
or
even
a
user
profile.
It
should
be
noted
that
if
you
link
to
a
page
in
a
menu
item,
and
then
rename
that
page,
the
menu
item
will
not
update
itself
to
use
the
new
name
of
the
page.
You
can
get
round
this
problem
by
using
the
[ ]which
allows
you
to
create
a
normal
bullet
list
of
links
on
a
page
(which
_will
_be
updated
if
you
rename
pages)
and
then
import
them
in
to
your
menu.
For
all
common
locations
within
Confluence,
we
recommend
using
the
[ ]as
it
will
be
more
reliable,
especially
if
any
of
the
common
locations
are
changed
in
a
later
version
of
Confluence.
For
example,
to
create
an
ultra-reliable
link
to
a
home
page,
use:
{
Code Block This
might
seem
like
overkill,
but
it
really
is
far,
far
more
reliable
to
link
to
common
Confluence
locations
this
way.
Anyway...
You
can
have
several
items
at
the
same
level,
for
example:
{
Code Block As you can see, the items are merely output as an unordered list. To put them in to an actual menu bar, simply wrap them in the menubar macro
as shown below:
Footnote Remember to specify a unique ID for the menubar macro, otherwise it won't work!
Code Block
Footnotes Display As you can see, the items are shown next to each other because they are at the same hierarchical level. To create pop-up sub menus, you need to create a hierarchical structure...
Hierarchical Menus
unmigrated-wiki-markup
To
create
hierarchical
structures,
you
wrap
menu
items
in
the
other
macros
as
shown
earlier,
for
example:
{
Code Block Here's another quick example to show that you can "indent" the menu structure at any point, not just the last item in a level:
Code Block
CSS Customisation
To follow.
Hints and Tips
None at present.
Frequently Asked Questions
CSS Customisation
See Customising Menu StylesNone at present.
Overview
Community Forums
Content Tools
Apps