Difference between revisions of "XML Attribute"

← Older edit

XML Attribute (edit)

Revision as of 12:56, 21 December 2023

354 bytes added , 12:56, 21 December 2023

no edit summary

Anonymous user

173.17.114.221

@@ Line 1: / Line 1: @@
-{{unfinished}}
+XML uses named attributes to specify additional info for an element. The XML syntax doesn't specify what attributes are possible, only that they be given as ''AttributeName="Value"'' in the opening tag of an element.  Oblivion XML recognizes only three true XML attributes: '''name''', '''src''', and '''trait'''.
-XML traits are named attributes of XML elements.  The XML syntax doesn't specify what traits are possible, only that they be given as ''TraitName="TraiValue"'' in the opening tag of an element.  Oblivion XML recognizes only three true XML traits: '''name''', '''src''', and '''trait'''.
-The '''name''' trait provides a way to identify elements in a menu file.  This trait is used only for [[Menu Element]]s - property or operator elements are never named.  The name of an element need not be unique within the entire menu, but every element should at least have a different name from it's siblings (as discussed below).
+The '''name''' attribute provides a way to identify elements in a menu file.  This attribute is used only for [[Object Element]]s - property or operator elements are never named.  The name of an element need not be unique within the entire menu, but every element should at least have a different name from it's siblings (as discussed below).
-  &lt;!-- the 'name' trait of this element has the value "PictureFrame" --&gt;
+  &lt;!-- the 'name' attribute of this element has the value "PictureFrame" --&gt;
   <rect name="PictureFrame"> </rect>
-The '''src''' and '''trait''' traits are always provided together (except for the special case of the Include element).  They are used only in empty Operator elements, to specify the "contents" of the operator:
+The '''src''' and '''trait''' attributes are always provided together (except for the special case of the [[Include Element]]).  They are used only in empty Operator elements, to specify the value used by the operator:
+The '''src''' attribute can refer to any [[Object Element]] by it's name, or can use one of the "relative" sources:
+*'''Me()''' - the object whose property the operator is modifying.
+*'''Parent()''' - the parent of Me(), that is the element of which Me() is a child.
+*'''Sibling(''SiblingName'')''' - a the siblings of Me(), that is the elements that are also children of Parent().  The name of the sibling can be provided as an argument - this is why no two siblings should have the same name. When omitted it will use the sibling that came before it - the one that was defined above it in the XML (doesn't work for the very first element).
+*'''Child(''ChildName'')''' - a child object of Me().  Again, the name must be specified.  The search for ''ChildName'' isn't restricted to direct children - it also includes children of children, and their children, and so on. If multiple children with the same name exist the last one specified in the xml is used.
+The '''trait''' attribute can refer to any [[Property Element]] (or "trait") of the source.  The current value of the property is used as value of the operator.
- &lt;!-- Good --&gt;
   <image>
      <x>
-       &lt;!-- Add the value of SomeElement's width property --&gt;
+       &lt;!-- The Add Operator gets its value from the Width Property/Trait of SomeElement.--&gt;
-       &lt;!-- to the current x value of this image --&gt;
+       &lt;!-- The result is to add SomeElement's width to the current x value of this image --&gt;
        <add src="SomeElement" trait="width" />
      </x>
   </image>
-The '''src''' trait can refer to any ''menu'' element by it's name, or can use one of the "relative" sources:
-*'''Me()''' - refers to the menu element whose property the operator element is modifying.
-*'''Parent()''' - refers to the parent of Me(), the menu element of which Me() is a child.
-*'''Sibling(''SiblingName'')''' - refers to one of the siblings of Me() - that is, the menu elements that are also children of Parent().  The name of the sibling must be provided as an argument - this is why no two siblings should have the same name trait.
-*'''Child(''ChildName'')''' - refers to one of the menu elements that are children of Me().  Again, the name must be specified.
-The '''trait''' trait can refer to any ''property'' of the source element.  The current value of this property is used as the "contents", or second operand, of the operator.
 [[Category:Oblivion XML]]