Skip to content

Latest commit

 

History

History
49 lines (42 loc) · 3.13 KB

02-HTMLWidget.md

File metadata and controls

49 lines (42 loc) · 3.13 KB
Raw

HTMLWidget

The <HTMLWidget> tag is the top level tag of all MuCow files.

Example

<?xml version="1.0" encoding="UTF-8"?>
<HTMLWidget name="My Widget" formatNumber="3"
		localization="none" creator="My Name" 
		defaultWidth="50" defaultHeight="50" 
		isResizable="true">
	<!--
		... Content Goes Here ...
	-->
</HTMLWidget>

Attributes

Name Values Description
name String Required. The name of the widget. Will be displayed in the options dialog, and also in the control strip
formatNumber 6 (Muse 2017.0+)
5 (Muse 2015.2+)
4 (Muse 2015.1+)
3 (Muse 2014.3+)
2 (Muse 2014.0+)
1 (Muse 7.0+)		 Required. The format number of this file. Current Muse versions support format 6 and below.
localization none
stringTable		 Required. The type of localization for this widget
termsURL URL The URL to a 'Terms of Use' page. A link to this URL will appear in options dialog if non-empty. If you specify termsURL, do not specify termsText
termsText String HTML text to appear in a 'Terms of Use' dialog. Text may include links to URLs. If you specify termsText, do not specify termsURL
creator String Indicates the name or email address of the person or company who created this HTML widget file
defaultWidth Number Indicates the initial width for the HTML page item
defaultHeight Number Indicates the initial height for the HTML page item
isResizable Boolean Indicates if the page item should be user resizable. Default value is true
minWidth Number Indicates the minimum allowable width for the page item.
maxWidth Number Indicates the maximum allowable width for the page item. Setting this value means the widget can no longer be a 100% width page item.
minHeight Number Indicates the minimum allowable height for the page item.
maxHeight Number Indicates the maximum allowable height for the page item.
supportsGlobalAndOptionContentTags Boolean Indicates if the widget supports both global and conditional Option content tags (format 4+)
isResponsive Boolean Indicates if the page item should can be responsive to support fluid sizing. Default value is false (format 4+)
supportedSizePolicies String Comma separated list indicating which resize policies are supported. Possible options (fixed,fluidWidth,fluidWidthHeight,browserWidth). (format 5+)
outputAsFixedHeight Boolean Indicates if the page item should export with fixed height or minimum height. If attribute is true, page item exports with fixed height. Default value is true (format 6+)

Child Tags

The <HTMLWidget> must contain at least 1 content tag and can optionally contain a <parameters> tag, which will specify the parameters for the widget and a <stringTable> tag for localization. The <parameters> tag can contain any number of the parameter tags. Check the localization section for more information about the <stringTable> tag.