Skip to content

Provide simple library reference info directly within the IDE #4069

Closed
@lmihalkovic

Description

@lmihalkovic

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

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions