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

adding example of protocol_handlers #451

Merged
merged 4 commits into from
May 28, 2020
Merged

adding example of protocol_handlers #451

merged 4 commits into from
May 28, 2020

Conversation

tsl143
Copy link
Contributor

@tsl143 tsl143 commented Apr 19, 2020

No description provided.

@tsl143
Copy link
Contributor Author

tsl143 commented May 15, 2020

Hi @rebloor , can you review this?

@rebloor
Copy link
Collaborator

rebloor commented May 15, 2020

@tsl143 I expect to do this next week.

Copy link
Collaborator

@rebloor rebloor left a comment

Choose a reason for hiding this comment

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

Looking good, thank you, just a few language nits. Please also update examples.json with details of the example. Thank you.


## What it does

This add-on sets default client for opening IRC links using protocol_handlers.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please add "the" before "default" i.e. "… sets the default client …"


This add-on sets default client for opening IRC links using protocol_handlers.

Whenever any link with IRC protocol is clicked it opens with pre-defined URI template.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please change to "Whenever a link using the IRC protocol is clicked, the link is opened in the URI defined in the add-on's manifest. In this example, all IRC protocol links are opened in mibbit.com."

This add-on sets default client for opening IRC links using protocol_handlers.

Whenever any link with IRC protocol is clicked it opens with pre-defined URI template.
For example click [here](irc://irc.freenode.net/drupal).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please change to "For example, click this link to irc://irc.freenode.net/drupal and the protocol handler opens the Drupal channel in mibbit.com."


## What it shows

* usage of protocol_handlers in webextension.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please change to "How to use protocol handlers to pass content to an application or website designed to handle that content."

{
"manifest_version": 2,
"name": "IRC Protocol Handler",
"description": "Demo the usage of protocol_handlers",
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please change to "Demos the use of protocol_handlers"

@tsl143 tsl143 requested a review from rebloor May 26, 2020 09:37
examples.json Outdated
@@ -582,5 +582,10 @@
"windows​.Window"
],
"name": "window-manipulator"
},
{
"description": "Demonstrates usage of the protocol handlers.",
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please change to "Demonstrates the use of protocol handlers."


## What it does

This add-on sets the default client for opening IRC links using protocol_handlers.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Sorry, please format protocol_handlers as code.


Whenever a link using the IRC protocol is clicked, the link is opened in the URI defined in the add-on's manifest.
In this example, all IRC protocol links are opened in mibbit.com.
For example, click [here](irc://irc.freenode.net/drupal) and the protocol handler opens the Drupal channel in mibbit.com.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please expose the URL so the reader can see what they clicking. Also, we should probably point out they need to install the extension first:
"For example, once you've installed the extension, open this link irc://irc.freenode.net/drupal and the protocol handler opens the Drupal channel in mibbit.com."

@tsl143 tsl143 requested a review from rebloor May 27, 2020 12:13
@rebloor rebloor merged commit 60ce50b into mdn:master May 28, 2020
mike-west added a commit to mike-west/webextensions-examples that referenced this pull request Jul 12, 2020
adding example of protocol_handlers (mdn#451)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants