There are several parameter tags available to create the MuCow widget's On-Object UI (OOUI). This is the fly-out menu that allows the user to set certain settings about the widget.
Parameters can then be included in your code, and replaced
Specifies a parameter that will be user entered text. This text can be displayed as either a single-line or multi-line entry box in the OOUI. The maximum number of characters allowed in this field is 2048 starting with Muse 2014.0. Prior to this, the maximum was 1024.
<text name="myTextBox" defaultValue="The default value" />
<text name="myTextBox" defaultValue="The default value"
label="A Label" toolTip="This is the toolTip"
multiline="true" />
| Name | Values | Description | |---|---|---|---| | name | Unique String | The name of the value. | | defaultValue | String | The default value this item should have when first placed |
| Name | Values | Minimum Format | Description |
|---|---|---|---|
| label | String | Label to display in the OOUI | |
| toolTip | String | Tooltip to display in the OOUI when hovering over this option | |
| paramEncoding | URIComponent spaceToPlus |
The type of encoding to apply to the entered parameter | |
| multiline | Boolean | If set to true a multiline text control will be created in the UI instead of a single line text box. | |
| defaultIllegalForOutput | Boolean | 2 | Will warn the user if the default value is used when exporting or publishing the site |
Specifies a parameter that a user can select from a set of given options. Options are given using <value> tags, which are children of the <list> tag. See Child Tags section.
<list name="myList" defaultValue="Second Value" label="My List">
<value name="first" label="First Value"/>
<value name="Second Value"/>
<value name="third_value" label="Last One" disableOptions="myTextBox,myURL"/>
</list>
| Name | Values | Description |
|---|---|---|---|
| name | Unique String | The name of the value. |
| defaultValue | String | The default value this item should have when first placed. This must match one of the name attributes of a child <value> element. |
| Name | Values | Description |
|---|---|---|
| label | String | Label to display in the OOUI |
| toolTip | String | Tooltip to display in the OOUI when hovering over this option |
Specifies a user-selectable value. NOTE: <value> tags can contain Content Tags which will modify the output.
| Name | Values | Description | |---|---|---|---| | name | Unique String | REQUIRED Value that will be passed to the final code. | | label | String | A label to display to the user | | disableOptions | List | A comma separated list of name values for options that are disabled when the selected item is this
Specifies the user should enter either a partial or full URL.
<url name="myURL" label="My URL"
defaultValue="http://muse.adobe.com/" />
<url name="myURL" label="My URL"
defaultValue="http://muse.adobe.com/"
currentPageOrURL="true" />
| Name | Values | Description |
|---|---|---|---|
| name | Unique String | The name of the value. |
| defaultValue | String | The default value this item should have when first placed. This must match one of the name attributes of a child <value> element. |
| Name | Values | Minimum Format | Description |
|---|---|---|---|
| label | String | Label to display in the OOUI | |
| toolTip | String | Tooltip to display in the OOUI when hovering over this option | |
| urlStart | String | A comma separated list of URL prefixes. all entered URLs must start with one of these, or be incomplete URLs. | |
| currentPageOrURL | Boolean | If set to 'true', user will be able to enter an arbitrary URL, or choose the URL for the current Muse Page. | |
| dummyDomainPrefix | String | If the user hasn't yet entered a domain name, when generating HTML for the current page, this dummy prefix will be used, along with a GUID. | |
| defaultIllegalForOutput | Boolean | 2 | Will warn the user if the default value is used when exporting or publishing the site |
Specifies an option that the user will be able to toggle on/off. Must include the values to use for true & false. One or both values may disable other options. Multiple bool UI elements will be arranged in columns
<bool name="toggleOption" label="Toggle Option" defaultValue="foo">
<trueVal value="foo"/>
<falseVal value="bar" disableOptions="myTextBox,myURL"/>
</bool>
| Name | Values | Description |
|---|---|---|---|
| name | Unique String | The name of the value. |
| defaultValue | String | The default value this item should have when first placed. This must match one of the name attributes of a child element. |
| Name | Values | Description |
|---|---|---|
| label | String | Label to display in the OOUI |
| toolTip | String | Tooltip to display in the OOUI when hovering over this option |
Specifies a value to pass when user turns on this option. NOTE: <trueVal> tags can contain Content Tags which will modify the output.
| Name | Values | Description | |---|---|---|---| | value | String | Required. Value that will be passed to the final code. | | disableOptions | List | A comma separated list of name values for options that are disabled when the item is in this state. |
Specifies a value to pass when user turns off this option. NOTE: <falseVal> tags can contain Content Tags which will modify the output.
| Name | Values | Description | |---|---|---|---| | value | String | Required. Value that will be passed to the final code. | | disableOptions | List | A comma separated list of name values for options that are disabled when the item is in this state. |
Specifies the user entered value should be a number
<number name="myNumber" min="1" max="100" step="1"
snap="0.1" defaultValue="1" label="Number: "/>
| Name | Values | Description | |---|---|---|---| | name | Unique String | The name of the value. | | defaultValue | String | The default value this item should have when first placed | | min | Number | The minimum allowed value | | max | Number | The maximum allowed value |
| Name | Values | Description |
|---|---|---|
| label | String | Label to display in the OOUI |
| toolTip | String | Tooltip to display in the OOUI when hovering over this option |
| step | Number | How large a step should be if the user clicks the up or down arrow. Defaults to 1 |
| snap | Number | What increment should values snap to. Defaults to 1 |
| digitsPrecision | Number | The number of digits to show after the decimal point |
A built in is a special type that allows you to get values that are specified directly in Adobe Muse. These values are passed in the same as any other parameters, and the name can be any one of the values listed below.
| Name | Values | Description |
|---|---|---|---|
| name | Type | Required. One of the types listed below |
| supportedLocales | List | When the name attribute is "locale", this attribute is a comma separated list of locales supported by this MuCow. If the document locale is not one of these, the en_US will be used |
| supportedLanguages | List | When the name attribute is "language", this attribute is a comma separated list of languages supported by this MuCow. If the document language is not one of these languages, the English equivalent will be used instead |
NOTE: The supportedLocale and supportedLangauge attributes are ignored if the name attribute is not locale or language respectively.
-
width - Page item width in Muse
-
height - Page item height in Muse
-
itemUID - The unique ID that is designated to this page item
-
siteUID - The unique ID that identifies this Muse site
-
country - Country code for the current Muse document (e.g. US, FR, JP)
-
language - Character code for the language of the current Muse document (e.g. en, fr, es)
-
locale - Language and country code for the current Muse document (e.g. en_US, fr_FR, es_ES)
-
siteDomain - v4 and later, the domain in which the site is published to (e.g. muse.adobe.com)
-
siteURL - v4 and later, the url to the site (e.g. http://muse.adobe.com)
-
pageTitle - v4 and later, the title of the page (e.g. "home")
-
pageURL - v4 and later, the url to the page (e.g. http://muse.adobe.com/index.html) similar to the `currentPageOrURL` attribute for the `` parameter
Informative text to show in the On-Object UI, which can optionally link to a URL. Only supported by widgets format 2 or above.
<info label="You can place informative text here."/>
<info label="Click Here!" linkURL="http://muse.adobe.com"/>
| Name | Values | Description | |---|---|---|---| | label | String | The text to display to the user |
| Name | Values | Description | |---|---|---|---| | linkURL | URL | The URL to take the user to if the text is clicked |
A line used to separate parameters in the On-Object UI. Only supported by widgets format 2 or above.
<text name="name" label="Name:" defaultValue="You" />
<separator/>
<info label="Here's some more content"/>
Specifies a parameter that will be a user chosen file. This file will be added as a file for upload. Only supported by widgets format 3 or above.
<file name="img1" label="Choose an Image:" filterLabel="Images" fileTypes="*.jpg;*.jpeg;*.png;*.gif" fileRequiredForOutput="true"/>
| Name | Values | Description | |---|---|---|---| | name | String | The name of the value |
| Name | Values | Description | |---|---|---|---| | label | String | Label to display in the OOUI | | toolTip | String | Tooltip to display in the OOUI when hovering over this option | | filterLabel | String | Label for filter in the file browse dialog | | fileTypes | String | File types allowed in the file browse dialog. Should be a semicolon-separated list in format "*.ext;*.ext2" | | fileRequiredForOutput | Boolean | Will warn the user when exporting or publishing the site if no file was chosen. Defaults to false. | | asAbsoluteURL | Boolean | v4 The result is computed as an absolute (http) URL based on publish settings. |
Starting in v4 of the MuCow format, the <file> parameter can resolve with an absolute url to the file if the asAbsoluteURL attribute is true.
Special care must be taken when the user chooses their publication settings when Muse is not publishing the site on their behalf (i.e. when generating
the site to disk.) Muse uses the values entered in these options to build a canonical URL to the file specified.
Specifies a parameter that will be user chosen color. Presented to the user as a color picker in the UI. Only supported by widgets format 3 or above.
<color name="textColor" label="Text Color" defaultValue="#C74040"/>
<color name="backgroundColor" label="Background Color" rgbColor="true" defaultValue="0, 0, 255"/>
| Name | Values | Description | |---|---|---|---| | name | String | The name of the value | | defaultValue | String | Can be either hex color or comma separated RGB value. Does not affect output format. Use rgbColor to output comma separated RGB value. |
| Name | Values | Description |
|---|---|---|---|
| label | String | Label to display in the OOUI |
| toolTip | String | Tooltip to display in the OOUI when hovering over this option |
| rgbColor | Boolean | Color value to be returned as comma separated RGB value. Defaults to false. |
| formatHexColor | Boolean | Adds the # character before the hex value. Use when color is used in CSS. Defaults to false. |
| supportsNoneColor | Boolean | Allow user to pick the none color swatch. Choosing none will output the word transparent. Defaults to false. |
| transparentOption | String | The name of a <number> input parameter to use to control transparency. This Allows the color picker to include a slider to adjust the alpha channel of the color. The named input can later be referenced by the generated code as content to pass as the alpha parameter to rgba(). When specifying a transparentOption, supportsNoneColor must also be set to true . |
Section is a special parameter tag which allows for related parameters to be grouped together. The user experience for section tags is a collapsable group with a disclosure arrow.
<section> tags should have at least 1 of the child parameter tags listed above but it may not contain any other <section> tags.
| Name | Values | Description | |---|---|---|---| | label | String | Label to display in the OOUI |
| Name | Values | Description | |---|---|---|---| | expanded | Boolean | Specifies if the section is initially expanded when the OOUI is displayed for the widget. Defaults to false. | | name | Unique String | The name of the section. This name can be used to reference the section from a "disableOptions" attribute of another parameter |
<bool name="toggleOption" label="Use Background Image" defaultValue="noImage">
<trueVal value="yesImage"/>
<falseVal value="noImage" disableOptions="imageSection" />
</bool>
<section label="image" expanded="true" name="imageSection" >
<file fileTypes="*.png;*.jpg;*.jpeg;*.gif" filterLabel="Image Files" label="Image" name="Image" fileRequiedForOutput="true" tooltip="Image"/>
</section>
