Skip to content

Correct case of "Type" in librarymanager links in examples #41

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

Merged
merged 1 commit into from
Nov 2, 2022
Merged

Correct case of "Type" in librarymanager links in examples #41

merged 1 commit into from
Nov 2, 2022

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Oct 28, 2022

Arduino IDE has a feature where opening a link of the form:

http://librarymanager[/<type>[/<topic>]][#<search keywords>]

opens Library Manager with the specified filters and keywords prefilled.

Support for specifying the "Type" filter setting was claimed during the implementation of the feature in Arduino IDE 1.x (arduino/Arduino@b99ab40), but that never actually worked. The text in this path was simply ignored by the IDE (a fact that would not be obvious from the links used by this library, since the "All" type filter setting is the default anyway).

During the reimplementation of the feature in Arduino IDE 2.x (arduino/arduino-ide#1481), support for specifying the "Type" filter setting was actually implemented correctly. Instead of ignoring this path component of the URL, the IDE requires it to match to a valid "Type" filter value. If there is no match, opening the link has no effect. This match is case sensitive.

The previous URLs used the type value "all", but there is no "all" value in the "Type" filter. Instead, there is an "All" value, and that exact case must be used in order for the link to function in Arduino IDE 2.x.

Arduino IDE has a feature where opening a link of the form `http://librarymanager[/<type>[/<topic>][#<search keywords>]`
opens Library Manager with the specified filters and keywords prefilled.

Support for specifying the "Type" filter setting was claimed during the implementation of the feature in Arduino IDE
1.x, but that never actually worked. The text in this path was simply ignored by the IDE (a fact that would not be
obvious from the links used by this library, since the "All" type filter setting is the default anyway).

During the reimplementation of the feature in Arduino IDE 2.x, support for specifying the Type filter setting was
actually implemented correctly. Instead of ignoring this path component of the URL, the IDE requires it to match to a
valid "Type" filter value. If there is no match, opening the link has no effect. This match is case sensitive.

The previous URLs used the type value "all", but there is no "all" value in the "Type" filter. Instead, there is an
"All" value, and that exact case must be used in order for the link to function in Arduino IDE 2.x.
@per1234 per1234 added type: imperfection Perceived defect in any part of project topic: documentation Related to documentation for the project labels Oct 28, 2022
@per1234 per1234 requested a review from aentinger October 28, 2022 21:03
@per1234 per1234 self-assigned this Oct 28, 2022
@github-actions
Copy link

Memory usage change @ 2fce77f

Board flash % RAM for global variables %
arduino:samd:mkrfox1200 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
Click for full report table
Board examples/EventTrigger
flash
% examples/EventTrigger
RAM for global variables
% examples/FirstConfiguration
flash
% examples/FirstConfiguration
RAM for global variables
% examples/SendBoolean
flash
% examples/SendBoolean
RAM for global variables
% examples/WeatherMonitor
flash
% examples/WeatherMonitor
RAM for global variables
% examples/WeatherMonitorStream
flash
% examples/WeatherMonitorStream
RAM for global variables
%
arduino:samd:mkrfox1200 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0
Click for full report CSV
Board,examples/EventTrigger<br>flash,%,examples/EventTrigger<br>RAM for global variables,%,examples/FirstConfiguration<br>flash,%,examples/FirstConfiguration<br>RAM for global variables,%,examples/SendBoolean<br>flash,%,examples/SendBoolean<br>RAM for global variables,%,examples/WeatherMonitor<br>flash,%,examples/WeatherMonitor<br>RAM for global variables,%,examples/WeatherMonitorStream<br>flash,%,examples/WeatherMonitorStream<br>RAM for global variables,%
arduino:samd:mkrfox1200,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0

Copy link
Contributor

@aentinger aentinger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow, that was new to me =) Thank you @per1234 for fixing this =)

@aentinger aentinger merged commit e35da90 into arduino-libraries:master Nov 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants