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.

      1. Document_help.png
        68 kB
      2. hover_icon.png
        56 kB
      3. HTML_Help.png
        31 kB

        Issue Links

          Activity

          Hide
          Shalom Gibly added a comment -

          HTML doc link is now hidden

          Show
          Shalom Gibly added a comment - HTML doc link is now hidden
          Hide
          Shalom Gibly added a comment -

          Modified to docs to open in the internal browser, instead of the help-view.

          We still need to work on the docs content, and there are other tickets for that. This ticket is implemented for JS.

          Show
          Shalom Gibly added a comment - Modified to docs to open in the internal browser, instead of the help-view. We still need to work on the docs content, and there are other tickets for that. This ticket is implemented for JS.
          Hide
          Clayton Headley (Inactive) added a comment -

          Still seeing the issue that Chris reported earlier in the comments. Using the link for getElementById does not take the user to information on getElementById, but rather to the page for Document: Nodes. Reopening ticket.

          Show
          Clayton Headley (Inactive) added a comment - Still seeing the issue that Chris reported earlier in the comments. Using the link for getElementById does not take the user to information on getElementById, but rather to the page for Document: Nodes. Reopening ticket.
          Hide
          Shalom Gibly added a comment -

          @Clayton - This one is related to what Ingo mentioned before. The docs themselves are missing HTML anchors that can lead us to the right location.
          Opened a ticket at APSTUD-7214

          Show
          Shalom Gibly added a comment - @Clayton - This one is related to what Ingo mentioned before. The docs themselves are missing HTML anchors that can lead us to the right location. Opened a ticket at APSTUD-7214
          Hide
          Clayton Headley (Inactive) added a comment -

          Verified implemented in Windows 7 and Mac OS 10.8 using Titanium Studio, build: 2.2.0.201207282228. Closing ticket.

          Show
          Clayton Headley (Inactive) added a comment - Verified implemented in Windows 7 and Mac OS 10.8 using Titanium Studio, build: 2.2.0.201207282228. Closing ticket.

            People

            • Assignee:
              Shalom Gibly
              Reporter:
              Michael Xia (Inactive)
            • Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development