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

Add new API info to each plugin page #2161

Closed
toddparker opened this Issue Jul 28, 2011 · 14 comments

Comments

Projects
None yet
7 participants
@toddparker
Contributor

toddparker commented Jul 28, 2011

We have an planned addition to our docs pages that adds theAPI options, methods and events. An example of the new format is here:
http://jquerymobile.com/test/docs/forms/selects/index.html

We're looking for help with adding this format to all the other plugin pages so if you'd like to help, here's how:

  1. Add a comment to this issue indicating what plugin pages you want to tackle so there is no duplication of effort
  2. Update the docs pages following these guidelines: https://github.com/jquery/jquery-mobile/wiki/API-docs:-How-to-help-us-generate-docs
  3. Submit as a pull request.

Bask in the glow of contributing such a helpful thing to the project. Any takers?

@ovargas27

This comment has been minimized.

Show comment
Hide comment
@ovargas27

ovargas27 Jul 28, 2011

Contributor

I'll take an easy one " jquery.mobile.forms.textinput.js"

Contributor

ovargas27 commented Jul 28, 2011

I'll take an easy one " jquery.mobile.forms.textinput.js"

@toddparker

This comment has been minimized.

Show comment
Hide comment
@toddparker

toddparker Jul 28, 2011

Contributor

Thanks ovargas27! Let me know if you run into issues or questions.

Contributor

toddparker commented Jul 28, 2011

Thanks ovargas27! Let me know if you run into issues or questions.

@ovargas27

This comment has been minimized.

Show comment
Hide comment
@ovargas27

ovargas27 Jul 29, 2011

Contributor

I'm working in radio buttons so I'll work in checkboxes

Contributor

ovargas27 commented Jul 29, 2011

I'm working in radio buttons so I'll work in checkboxes

@caseyjustus

This comment has been minimized.

Show comment
Hide comment
@caseyjustus

caseyjustus Jul 29, 2011

Contributor

I'll take the jquery.mobile.forms.slider.js

Contributor

caseyjustus commented Jul 29, 2011

I'll take the jquery.mobile.forms.slider.js

@naugtur

This comment has been minimized.

Show comment
Hide comment
@naugtur

naugtur Aug 1, 2011

Please take a look at jquerymobiledictionary.dyndns.org
I started this project with JQMalpha2 and I was planning on putting it up on a real domain when 1.0 is released.
You might be interested in adding this as an element of the new docs.

My project works like this:
I automatically fetch every occurance of a 'data-something' attribute and collect all its values that I find. A separate file contains descriptions so that the automated fetching won't force me to do any merging with old versions.

If you decide to host this as a part of your docs I will keep maintaining it.

naugtur commented Aug 1, 2011

Please take a look at jquerymobiledictionary.dyndns.org
I started this project with JQMalpha2 and I was planning on putting it up on a real domain when 1.0 is released.
You might be interested in adding this as an element of the new docs.

My project works like this:
I automatically fetch every occurance of a 'data-something' attribute and collect all its values that I find. A separate file contains descriptions so that the automated fetching won't force me to do any merging with old versions.

If you decide to host this as a part of your docs I will keep maintaining it.

@minorOffense

This comment has been minimized.

Show comment
Hide comment
@minorOffense

minorOffense Aug 3, 2011

Edit: Sorry, confused a little, I'll try out the forms.search instead (buttons seem to exist outside of the forms folder)

minorOffense commented Aug 3, 2011

Edit: Sorry, confused a little, I'll try out the forms.search instead (buttons seem to exist outside of the forms folder)

@Toverbal

This comment has been minimized.

Show comment
Hide comment
@Toverbal

Toverbal Aug 7, 2011

I have some additional ideas for the documentation. I think the documentation pages should use a multiple page setup, or at least links with the data-prefetch attribute set to true. People reading these API docs typically use a desktop computer and want to navigate fast without having to wait. Clicking the tabs now generates a request and after that a fading page transition happens. I would like to see no request and no transition to make the API docs as responsive as possible.

Apart from that, I'm charmed about how the jQuery UI documentation is written (e.g. http://jqueryui.com/demos/accordion). You see a demo first, some information about the demo, an expandable div which contains the source and 5 tabs (overview, options, methods, events and theming). I personally use it quite often and it works really good for me, maybe the documentation of the jQuery mobile API can be (a little bit) like this?

Toverbal commented Aug 7, 2011

I have some additional ideas for the documentation. I think the documentation pages should use a multiple page setup, or at least links with the data-prefetch attribute set to true. People reading these API docs typically use a desktop computer and want to navigate fast without having to wait. Clicking the tabs now generates a request and after that a fading page transition happens. I would like to see no request and no transition to make the API docs as responsive as possible.

Apart from that, I'm charmed about how the jQuery UI documentation is written (e.g. http://jqueryui.com/demos/accordion). You see a demo first, some information about the demo, an expandable div which contains the source and 5 tabs (overview, options, methods, events and theming). I personally use it quite often and it works really good for me, maybe the documentation of the jQuery mobile API can be (a little bit) like this?

@caseyjustus

This comment has been minimized.

Show comment
Hide comment
@caseyjustus

caseyjustus Aug 8, 2011

Contributor

I'll take the "flip toggle switch" next

Contributor

caseyjustus commented Aug 8, 2011

I'll take the "flip toggle switch" next

@toddparker

This comment has been minimized.

Show comment
Hide comment
@toddparker

toddparker Aug 10, 2011

Contributor

@Toverbal - I think adding the prefetch attributes to the tabs is probably a good idea. I like the UI docs too (I helped design them) but the more narrative style on the landing page is better for less technical users IMHO. It's similar in that we have options/method/event tabs, just like UI.

@caseyjustus - thanks!

Contributor

toddparker commented Aug 10, 2011

@Toverbal - I think adding the prefetch attributes to the tabs is probably a good idea. I like the UI docs too (I helped design them) but the more narrative style on the landing page is better for less technical users IMHO. It's similar in that we have options/method/event tabs, just like UI.

@caseyjustus - thanks!

@Toverbal

This comment has been minimized.

Show comment
Hide comment
@Toverbal

Toverbal Aug 12, 2011

@toddpaker - okay, I can live with that, but as am developing now I often visit the API pages and when I view the source to check how certain elements are designed html-wise I often am seeing the wrong code, because the navigation uses Ajax, that is kinda frustrating. That's why I think best is to get a multi-page setup and navigate without Ajax, so the thing you see on screen is always the source you see when you hit ctrl+u (in FireFox or Chrome).

Toverbal commented Aug 12, 2011

@toddpaker - okay, I can live with that, but as am developing now I often visit the API pages and when I view the source to check how certain elements are designed html-wise I often am seeing the wrong code, because the navigation uses Ajax, that is kinda frustrating. That's why I think best is to get a multi-page setup and navigate without Ajax, so the thing you see on screen is always the source you see when you hit ctrl+u (in FireFox or Chrome).

@toddparker

This comment has been minimized.

Show comment
Hide comment
@toddparker

toddparker Aug 12, 2011

Contributor

We're very close to landing pushState so you will be able to simply refresh, then view source on a browser that supports this. Even now, you just need to edit the URL to be the path for the page, refresh and view source. Making this a multi-page wouldn't really solve the problem and would prevent us from being able to deep link to one of the tabs.

Contributor

toddparker commented Aug 12, 2011

We're very close to landing pushState so you will be able to simply refresh, then view source on a browser that supports this. Even now, you just need to edit the URL to be the path for the page, refresh and view source. Making this a multi-page wouldn't really solve the problem and would prevent us from being able to deep link to one of the tabs.

@Toverbal

This comment has been minimized.

Show comment
Hide comment
@Toverbal

Toverbal Aug 12, 2011

@toddparker - I understand. I actually am editing the url to get to the right page, so I figured that one out, thanks for mentioning. The pushstate will be fine. The deeplink argument makes sense, so it'll be fine the way it is :)

Toverbal commented Aug 12, 2011

@toddparker - I understand. I actually am editing the url to get to the right page, so I figured that one out, thanks for mentioning. The pushstate will be fine. The deeplink argument makes sense, so it'll be fine the way it is :)

@jaspermdegroot

This comment has been minimized.

Show comment
Hide comment
@jaspermdegroot

jaspermdegroot Aug 9, 2012

Member

Thanks for all the help everyone!!

@toddparker - shall we remove (or update) this page https://github.com/jquery/jquery-mobile/wiki/API-docs:-How-to-help-us-generate-docs?

Member

jaspermdegroot commented Aug 9, 2012

Thanks for all the help everyone!!

@toddparker - shall we remove (or update) this page https://github.com/jquery/jquery-mobile/wiki/API-docs:-How-to-help-us-generate-docs?

@toddparker

This comment has been minimized.

Show comment
Hide comment
@toddparker

toddparker Aug 9, 2012

Contributor

That page can be deleted for sure. I just noticed yesterday that dialogs and pages don't have this style of docs still but I know @agcolom is tackling it in the new docs.

On Aug 9, 2012, at 6:22 AM, "Jasper de Groot" notifications@github.com wrote:

Thanks for all the help everyone!!

@toddparker - shall we remove (or update) this page https://github.com/jquery/jquery-mobile/wiki/API-docs:-How-to-help-us-generate-docs?


Reply to this email directly or view it on GitHub.

Contributor

toddparker commented Aug 9, 2012

That page can be deleted for sure. I just noticed yesterday that dialogs and pages don't have this style of docs still but I know @agcolom is tackling it in the new docs.

On Aug 9, 2012, at 6:22 AM, "Jasper de Groot" notifications@github.com wrote:

Thanks for all the help everyone!!

@toddparker - shall we remove (or update) this page https://github.com/jquery/jquery-mobile/wiki/API-docs:-How-to-help-us-generate-docs?


Reply to this email directly or view it on GitHub.

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