Uploaded image for project: 'Aptana Studio'
  1. Aptana Studio
  2. APSTUD-4193

Add icon to "Open HTML docs" for current content assist entry for JS language

    Details

      Description

      Amend the current hover tooltip to add a link the HTML documentation for the specified item (if available).

      For core HTML, JavaScript and CSS functionality where the documentation is provided by standard metadata files, the URL can be constructed to point to In-Studio help. See Studio 2 for an example of this:

      /**
      * 
      * @param topics
      * @param lowerName
      */
      private void addSelectorHelpTopics(ArrayList topics, ArrayList generalTopics, String lowerName) {
       
      	ElementMetadata el = environment.getElement(lowerName);
      	String anchor = ""; //$NON-NLS-1$
      	if(el != null)
              {
      	   anchor = el.getFullName();
      	   String url = "/com.aptana.ide.documentation/html/reference/api/CSS.element." + el.getFullName() + ".html"; //$NON-NLS-1$ //$NON-NLS-2$
                 HelpResource hr = new HelpResource("'" + lowerName + "' Selector", url); //$NON-NLS-1$ //$NON-NLS-2$
      	   topics.add(hr);
      	}
      		
      	HelpResource index = new HelpResource("CSS Selector Reference", "/com.aptana.ide.documentation/html/reference/api/CSS.index-elements.html#" + anchor); //$NON-NLS-1$ //$NON-NLS-2$
      	generalTopics.add(index);
      }
      

      For other elements (like Titanium properties) perhaps there is a mechanism by which we can provide a custom resolver to generate the URL. It could also be that this might be provided by an extension point or class property when the contribution happens.

      See https://wiki.appcelerator.org/display/tools/In-Studio+Documentation for details.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                sgibly Shalom Gibly
                Reporter:
                mxia Michael Xia
              • Watchers:
                0 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Git Source Code