[OpenAjaxIDE] Some questions for Ingo (and everyone else)

Jon Ferraiolo jferrai at us.ibm.com
Tue Jul 1 18:21:32 PDT 2008

Thanks. Here is how the spec reads now for <alias>. Please suggest any
changes that you think are needed:
The <alias> element
The <alias> element can be used to specify an alternate name for an object
that a tool might use during content assist. Typically, the alternate name
is shorter and/or more understandable that the original name.
The name attribute specifies the name of the alias.
The datatype attribute specifies the name of the object to which the alias


             Ingo Muschenetz                                               
             <ingo at aptana.com>                                             
             07/01/08 05:52 PM         Jon Ferraiolo/Menlo Park/IBM at IBMUS, 
                                       "ide at openajax.org"                  
                                       <ide at openajax.org>                  
                                       Re: Some questions for Ingo (and    
                                       everyone else)                      

Hi All,

Apologies for missing the call.

1) Attributes element: yes, editorial error. I’ve corrected that.
5) Alias: yes, the IDE would show the shortened version in content assist.
I would suggest it must reference an available method or property or else
the IDE won’t be able to show proper content assist. It’s a shortcut for
having to define an item multiple times in the XML.

Let me know if there are other questions I can help answer.


On 7/1/08  Jul1 6:33 AM, "Jon Ferraiolo" <jferrai at us.ibm.com.> wrote:

      Here are some of the remaining questions relating to the API chapter
      of the metadata spec:

      (1) (QUESTION SPECIFICALLY FOR INGO) The ScriptDoc XML page says that
      a <method> can have an <attributes> child element, but there is no
      <attributes> element listed in the ScriptDoc XML page. Is this an
      editorial error?

      (2) Let's suppose your Ajax library uses a JavaScript class that is
      located at "MyLibrary.io.xhr". Which one of the following is correct:

      (a) <class name="MyLibrary.io.xhr" ...>...</class>
      (b) <class datatype="MyLibrary.io.xhr" ...>...</class>
      (c) <class type="MyLibrary.io.xhr" ...>...</class>

      I have been assuming (a), where we use the 'name' attribute in
      *definitions*, whereas we use the 'datatype' attribute when
      *referencing* a class (or whatever).

      (3) Same question applies to <interface>, but one more thing on
      <interface>. Our spec right now has a 'type' attribute. Assuming we
      use 'name' to give the interface a referenceable name, I assume we
      don't need 'type' (or 'datatype'). Correct?

      (4) For the <alias> element, we only have a 'name' attribute, whereas
      Aptana ScriptDoc XML has both 'name' and 'type'. My thinking is that
      our metadata spec should have both 'name' and 'datatype', where
      'name' is alias's name/handle and 'datatype' is a reference to thing
      that is being aliased. Correct?

      (5) Further questions for <alias> so that the spec can be clear. How
      is <alias> used by an IDE exactly? Is the main thing that the IDE has
      the option to substitute the shorter-friendlier name of the alias
      (e.g., "io") in place of a longer-unfriendly name (e.g.,
      "MyLibrary.shared.crossplatform.communications.io")? If there is an
      alias in the metadata file, must there be a real JavaScript variable
      that implements this alias (e.g.,

      (6) Right now, our spec shows a 'visibility' attribute on
      <constructor>, <interface> and <class> (and presumably <field>, where
      I recently fixed some editorial errors), where visibility="public|
      private|protected|internal|protected-internal". Aptana has
      'visibility' and <class>, <constructor>, <method> and <property>. It
      seems like 'visibility' should be on <class>, <constructor>,
      <method>, <property> and <field>. Does 'visibility' make sense on
      <interface> and <mixin>?

      (7) I forgot what <namespace> does. Can someone remind me so I can
      add text to the spec?


-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://openajax.org/pipermail/ide/attachments/20080701/fe39a6c1/attachment.html 
-------------- next part --------------
A non-text attachment was scrubbed...
Name: graycol.gif
Type: image/gif
Size: 105 bytes
Desc: not available
Url : http://openajax.org/pipermail/ide/attachments/20080701/fe39a6c1/attachment.gif 
-------------- next part --------------
A non-text attachment was scrubbed...
Name: pic02941.gif
Type: image/gif
Size: 1255 bytes
Desc: not available
Url : http://openajax.org/pipermail/ide/attachments/20080701/fe39a6c1/attachment-0001.gif 
-------------- next part --------------
A non-text attachment was scrubbed...
Name: ecblank.gif
Type: image/gif
Size: 45 bytes
Desc: not available
Url : http://openajax.org/pipermail/ide/attachments/20080701/fe39a6c1/attachment-0002.gif 

More information about the IDE mailing list