XDK Documentation Notes

[Dwight_B_1]

At this URL
https://software.intel.com/en-us/xdk/docs/using-the-develop-tab

Search For
"App Framework UI Components" link

Links to
http://app-framework-software.intel.com/components.php

Gives Error:
"The resource you are looking for has been removed, had its name changed, or is temporarily unavailable."

Tested:
Test 9/29/2015 12:34 Eastern
Test 9/29/2015 18:34 Eastern

Hope this helps,
DB

[Dwight_B_1]

On this page:
https://software.intel.com/en-us/forums/intel-xdk/topic/519891

Search for:
site:https://software.intel.com/en-us/html5/articles/ my search terms

The URL page says:
"Page Not Found"

Is there a better URL for the HTML5 Articles?  Bet that would be some great reading!  :)  

Hope this helps,
DB

[Pamela_H_Intel]

Thank you DB.

We try really hard to keep our docs up to date, but sometimes miss bits and pieces.

Thanks for taking the time to point this out.

I will forward this to our docs guy.

[Pamela_H_Intel]

@DB - I just looked more closely at your second post here. That is just a way to make searching work better. So you would go to Google (or your favorite search engine) and in the search bar type site:https://software.intel.com/en-us/html5/articles/ followed by whatever you are looking for.

For example:  site:https://software.intel.com/en-us/html5/articles/ barcode scanner

Happy searching! 

[Pamela_H_Intel]

Oops - take out the "html5"

[Dwight_B_1]

There are two bad links on:
http://app-framework-software.intel.com/documentation.php#afui/afui-quickstart

Locate this text:
3rd party libraries
App Framework no longer provides a query selector library. We recommend using jQuery* and FastClick libaries. 

jQuery and FastClick are incorrect.
I suggest the text and following URLS:
jQuery/Sizzle to http://jquery.com/ and ;https://sizzlejs.com/
FastClick to https://github.com/ftlabs/fastclick

[Dwight_B_1]

 

App Framework 3.0
https://software.intel.com/en-us/xdk/article/app-framework-30

The above pages has this url in the text: http://app-framework-software.intel.com/af22/index.php It points HREF to http://app-framework-software.intel.com/.  

At the address http://app-framework-software.intel.com/af22/index.php it server-redirects to http://app-framework-software.intel.com/   (probably so it doesn't give 404)

Grower Transition Plugin??
I was looking for the old docs to compare the plugin lists.  

On http://app-framework-software.intel.com/index.php it talks about the new "grower transition plugin" and for the life of me... all I can think of is that this is a typo (that passed spell check) and is supposed to be "drawer transition plugin".

I do not recall drawr transitions in v2.2, and I don't see anything closer on http://app-framework-software.intel.com/api.php  (click on the plugin option in the left menu).  

Here is the list:
actionsheet, animatedheader, animation, drawer, popup, splashscreen, swipereveal, toast, touchevents, transform

What is the grower transition plugin?  :) 

[Dwight_B_1]

*** MVC ***

What are the current recommendations regarding MVCs?
http://app-framework-software.intel.com/docmvc.php#intro/welcome
Only lists Intel MVC, Backbone.js, CanJS, Knockout.js and Ember.js (no Angular JS)

App Framework Documentation
http://app-framework-software.intel.com/documentation.php#afui/afui_about
Only mentions Backbone: "App Framework UI works great along side MVC frameworks like Backbone.js."

XDK Early Release 
When dropping a service method on a listview, the dialog box says:
"Select an MVC Framework" and the options are Angular JS and Backbone (see attached image)

Intel MVC - depricated/not recommended for XDK developers?
Do certain controls, from various UI frameworks, require more sophisticated MVCs?
http://app-framework-software.intel.com/docmvc.php#intro/welcome
https://github.com/01org/appframeworkMVC

Your advise and guidance are appreciated!  Thank you!

DB

[Dwight_B_1]

(1) The METHODS section isn't consistent.
http://app-framework-software.intel.com/api.php#af_drawer

Below you can see what the page currently has followed by two more consistent versions.  My vote is Version 2, which is better for teaching.  

Underscored in Versions 1 and 2 are the differences from the current version.

CURENTLY:
show (id, position, string)         Show a drawer based of the id, position and transition
hide (string, string)                Hide a drawer based off the id and position

VERSION 1
show (string, string, string)         Show a drawer based of the id, position and transition
hide (string,string)                Hide a drawer based off the id and position

VERSION 2 
show (id, position, transition)     Show a drawer based of the id, position and transition
hide (id, position)                 Hide a drawer based off the id and position

(2) HTML Code?  Data Directives table?  Visuals?
Like splashcreen and swipereleal, might the other plugins documentation benefit from having a sample of HTML code showing the attribute values.  

Two other teaching tools that would be nice include a "Data Directive" section (like the Popup) and a visual representation (could speed the learning process... especially for actionsheet, drawer, and toast).

Hope this helps!
DB

[Dwight_B_1]

There are a 2 broken images.

Goto: 
https://software.intel.com/en-us/xdk/articles/app-designer-layout-controls#layout-header-footer

Search for:
Button Grid Control

I compared the two IMG elements with two others on the page.  The difference is that the 2 broken images have the managed directory twice.  It should exist just once.

Current Relative URLs
<img src="/sites/default/files/managed/managed/b9/6a/xdk-adcontrols-layout-button-grid-2.png">

<img src="/sites/default/files/managed/managed/b9/6a/xdk-adcontrols-layout-buttongridcalculator-2.png">

Other src attributes values on the page:
/sites/default/files/managed/7b/18/xdk-adcontrols-layout-header-footer-examples.png
/sites/default/files/managed/c1/f3/xdk-adcontrols-layout-card.png

Correct absolute URLS:
https://software.intel.com/sites/default/files/managed/b9/6a/xdk-adcontrols-layout-button-grid-2.png
https://software.intel.com/sites/default/files/managed/b9/6a/xdk-adcontrols-layout-buttongridcalculator-2.png

[Pamela_H_Intel]

@Dwight - Thank you for the information. I will look through your posts and get back to you. Clearly, you did a lot of work organizing your comments. That is much appreciated. Your clear organization will help us respond to your action requests and answering your questions. However, bear with us as it may take some time to traverse all these issues. As always, we appreciate the feedback.

[Anusha_M_Intel1]

Thanks again Dwight! We will work on a fix for these. Regarding your MVC questions, I will try to get someone more familiar with it to respond.