ux-window

Use the <ux-window> element to provide specifications for a window or viewport in which a user assistance topic or Web page can be displayed. The window or viewport can be referenced by the <resourceid> element associated with a topic or <topicref> element.

The <ux-window> element can be used anywhere within a map. If more than one <ux-window> element in a map has the same @name attribute, the first window specification in document order with that @name attribute is used.

Content models

See appendix for information about this element in OASIS document type shells.

Inheritance

- map/ux-window

Example

In this example, a window with a name of "csh" is defined in the map. The window name is later referenced by the @ux-windowref attribute on the <resourceid> element.

<map title="Widget Help">
 <topicmeta>
  <ux-window id="fg23" name="csh" top="10" left="20" height="400" width="500" 
     features="status=yes,toolbar=no,menubar=no,location=no" relative="yes"
     full-screen="no" />
 </topicmeta>
 <topicref href="file_ops.dita" type="concept">
   <topicref href="saving.dita" type="task" />
   <topicref href="deleting.dita" type="task" />
   <topicref href="editing.dita" type="task">
     <topicmeta>  
       <resourceid id="ab43" appname="ua" 
          appid="5432" ux-context-string="idh_fileedit" ux-windowref="csh" />
     </topicmeta>
   </topicref>
</topicref>
</map>

In this example, different window specifications are defined for tablet and desktop presentation:

<map title="Puggles Help">
 <topicmeta>
 <ux-window id="p76" name="ux-tablet" top="1cm" left="1cm" height="4cm" width="3cm" 
    features="status=no,toolbar=no,menubar=no,location=no" relative="no"
    full-screen="no" />
 <ux-window id="p80" name="ux-desktop" top="5cm" left="10cm" height="16cm" width="12cm" 
    features="status=yes,toolbar=no,menubar=no,location=yes" relative="no"
    full-screen="no" />
 </topicmeta>
 <topicref href="c_puggles_intro.dita" type="concept">
  <!-- ... -->
 </topicref>
</map>

Attributes

The following attributes are available on this element: ID attribute group, Metadata attribute group, Debug attribute group, class (Not for use by authors), and the attributes defined below.

@name (REQUIRED)

The value used to refer to this window definition.

@top

The top position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).

@left

The left position of the target help window, whether relative to the calling window or to the entire display. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).

@height

The height of the window. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).

@width

The width of the window. The value of this attribute is a real number optionally followed by a unit of measure from the set of pc, pt, px, in, cm, mm, em (picas, points, pixels, inches, centimeters, millimeters, and ems respectively). The default unit is px (pixels).

@on-top

Indicates whether the initial z-order of the target help window is on top of all windows on the desktop. Allowable values are: "yes", "no", and -dita-use-conref-target. The default value is "no".

@features

A list of other features (size, position, scrollbars, etc.) of the window. Each feature name and value can not contain any blank space, and each feature name and value is separated by a comma or other delimiter character.

@relative

Indicates whether the window dimensions are relative to the calling window or the entire target display. The default value is "no". Allowable values are:

no: The window dimensions specified on this element are absolute positions (not relative to the calling window).
yes: The window dimensions specified on this element are relative to the calling window.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

@full-screen

Indicates whether the window is initially displayed in a maximized state. Allowable values are: "yes", "no", and -dita-use-conref-target. The default value is "no".