Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide simple library reference info directly within the IDE #4069

Closed
lmihalkovic opened this issue Nov 3, 2015 · 2 comments
Closed

Provide simple library reference info directly within the IDE #4069

lmihalkovic opened this issue Nov 3, 2015 · 2 comments
Assignees
Labels
Component: IDE user interface The Arduino IDE's user interface feature request A request to make an enhancement (not a bug fix)
Milestone

Comments

@lmihalkovic
Copy link

Builtin libraries have nice, simple reference pages on the arduino.cc web site. It might be nice to present this information directly in the IDE (I tested with the current Wire library, however the page contains dynamic behavior that does not render gracefully as it is).

This could be done in several ways

  • at the minimum, have a link in the library.properties file that the IDE can use to open externally, in the default platform browser, when the user right-clicks on the library's name in the outline view.
  • a more elaborate support could be to include a single page doc.rtf per library, which the UI can display in a popup, with the same or similar triggering. Alternatively the file could be a simple .html file.
  • at the cost of more implementation work, each library could have a doc folder containing a series of html files, with no external links. The IDE could have a template CSS file used for all help files.

Outline view:
screen shot 2015-11-01 at 11 06 05 pm

@ffissore ffissore added feature request A request to make an enhancement (not a bug fix) Component: IDE user interface The Arduino IDE's user interface labels Nov 3, 2015
@ffissore ffissore self-assigned this Nov 3, 2015
@lmihalkovic
Copy link
Author

Right click on a library reference node give the following popup menu (don't mind the first 2 entries, it is to test external menu contributions inside the outline view)
arduino-2015-11-13 at 5 21 54 pm

Clicking "library reference" opens the manual for that library
arduino-2015-11-13 at 5 23 56 pm

TODO:

  • would be nice if a "reference" field was added to library.properties
  • would be nice to support doxygen for contributed libs
  • would be nice if the reference url for platform libs could target a subset of the complete page that does not include the arduino web site header
  • store the last know placement of the help browser for each editor separately?
  • provide coloring based on the current editor selection (?? dunno if worth it)

Currently the browser is using this hardcoded base for accessing the reference info for all the platform libraries... :-(

  static String BASE = "http://www.arduino.cc/en/Reference/";

@lmihalkovic
Copy link
Author

Done

@ffissore ffissore modified the milestone: Release 1.6.7 Nov 26, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: IDE user interface The Arduino IDE's user interface feature request A request to make an enhancement (not a bug fix)
Projects
None yet
Development

No branches or pull requests

2 participants