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

Better Docs for Installing Plugins #7788

Closed
mgifford opened this issue Nov 29, 2016 · 16 comments
Closed

Better Docs for Installing Plugins #7788

mgifford opened this issue Nov 29, 2016 · 16 comments

Comments

@mgifford
Copy link
Member

On this page here:
https://wet-boew.github.io/wet-boew/docs/ref/plugins-en.html

There should be good docs on how to install plugins. I'm really not certain where this is at the moment (and I'm certainly not new to WxT).

@LaurentGoderre
Copy link
Member

LaurentGoderre commented Nov 29, 2016

What do you mean by "installing" plugins?

@mgifford
Copy link
Member Author

We're trying to debug a video issue. It worked in the old version of WET, but not the new one.

Plugins are generally extras & not includes, but looks like we'll have to look elsewhere to understand why this isn't loading:
https://wet-boew.github.io/wet-boew/docs/ref/multimedia/multimedia-en.html

Better docs is always useful though. Even stating, these plugins come with the default WxT.

@ghost
Copy link

ghost commented Nov 29, 2016

The video page is working fine: https://wet-boew.github.io/wet-boew/demos/multimedia/multimedia-en.html this is WET v4.

If your looking for old browsers (IE8 and IE9 for example) support that was pulled out some time ago. See Issue 7765

Also when updating to WET v4 your class name or JS trigger calls have changed. You can compare with the old WET here: http://wet-boew.github.io/wet-boew-legacy/v3.1/docs/ref/multimedia/multimedia-en.html

@LaurentGoderre
Copy link
Member

@mgifford in WET4, all the plugins are loaded all the time so I am not sure what your are refering to. ANd when you say old version of WET, do you mean WET3?

@mgifford
Copy link
Member Author

Yes.. I'm asking on behalf of one of my team who has been investigating this. It's a WET3 to WET4 upgrade.

@LaurentGoderre
Copy link
Member

Do they have markup I can look at? It's probably a markup issue causing it.

@LaurentGoderre
Copy link
Member

@mgifford
Copy link
Member Author

It isn't where they started. They are happy with things now, thanks! He ended up needing to just change some HTML class names.

@duboisp
Copy link
Member

duboisp commented Nov 30, 2016

@mgifford it is possible to create your own WET4 plugin by inserting them after the wet-boew.min.js script at the end of your html.

@mgifford
Copy link
Member Author

Ok, so if we go back to https://wet-boew.github.io/wet-boew/docs/ref/plugins-en.html

Can we not extend the paragraph at the top to say:

A WET plugin provides various types of functionality useful to a website and provided by calling the function in the class attribute of an HTML tag. All of the plugins below are included with the default package. You can create your own WET4 plugins by inserting them after the wet-boew.min.js script.

This way it addresses what is included & also how to extend it.

@LaurentGoderre
Copy link
Member

WET4 isn't great for extending though. It is something I hope we address in the next version though

@mgifford
Copy link
Member Author

That's rather annoying.. But even stating this in that header would be useful knowledge. Letting folks know it is possible, but it won't be easy.

@duboisp
Copy link
Member

duboisp commented Nov 30, 2016

Thansk for the suggestion @mgifford, I will work on a text to be added in the Getting Started / Contribution guidelines.

@mgifford
Copy link
Member Author

Excellent.. Thanks @duboisp

duboisp added a commit to duboisp/wet-boew that referenced this issue Dec 2, 2016
duboisp added a commit to duboisp/wet-boew that referenced this issue Dec 6, 2016
duboisp added a commit to duboisp/wet-boew that referenced this issue Dec 7, 2016
duboisp added a commit to duboisp/wet-boew that referenced this issue Dec 7, 2016
TTVXStarWake added a commit that referenced this issue Dec 7, 2016
Hello world plugin example and fix #7788
@duboisp
Copy link
Member

duboisp commented Dec 7, 2016

Instruction on how to use your own plugin with WET - http://wet-boew.github.io/wet-boew/docs/ref/plugins-en.html

Quick tutorial on how to create a WET plugin - http://wet-boew.github.io/wet-boew/demos/helloworld/helloworld-en.html

@RobJohnston
Copy link
Contributor

Thanks @duboisp! I dug into plugins a couple months ago and noticed that there were at least 3 distinct styles within the existing ones. It will be good to have a reference implementation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants