Forum  General Visual ...  From The Archit...  6.4 Documentation Process Update
Previous Previous
 
Next Disabled
New Post 1/4/2010 9:42 PM
  Guy
2346 posts
1st Level Poster




6.4 Documentation Process Update 

 Hi Guys,

I would like to share with you guys our progress in-terms of documenting Visual WebGui as part of the 6.4 effort. We are working on three main information sources which will be in the format of:

  1. Community knowledge base (articles / videos / tutorials / code samples) which will be tagged and categoriezed to allow easy access throw search engines and optimized navigation and filtering. Which will be a tool to exchange Visual WebGui related information. The resources we have in the site today will all be re-formated and indexed.
  2. Quick Start application which will replace the Catalog application from the educational aspect leaving the catalog to be a unit testing application. The quick start will be a fully SEO optimized Visual WebGui application that will expose every feature of every control and framework services. It will enable bookmarking of features for easy access to be used as kind of a wish list of features to use in your application. Every feature will be used with the minimum amount of code lines that can be viewed in the application in VB and C# and either copy/paste the code or download it. 
  3. A msdn like reference which will document the different  API's and most important the client resources documentation which will document all the client side resources, their usage, customization options and dependencies. This will be the first time we are releasing documentation on the internals and hopefully the level of complexity of customizing and creating custom controls will be lowered dramaticly.

Today I am sharing with you a new capability we added to our build tasks which will be part of the standard VWG build tasks that allows to export the skin resources to a msdn like reference. We designed it to be as informative as possible to expose the content of the client resources in such a way that can be navigated easly so you will be able to see the diffrent methods / templates / css styles and their usage. It is still in a preliminary status and we are planing to make a real effort to complete the missing documentation for the planned release of 6.4.

Here is a link to a reference that was extracted from the current trunk so you guys can check the direction and add your thoughts:
http://visualwebgui.s3.amazonaws.com/documentation/6.4b1/Index.htm

 

The following is still missing:

  •  Skin Property documentation is lacking and some properties are missing and some are exposed which should not be exposed.
  •   We are adding script / xslt variables so properties such as $dir or mobjApp will be documented as well.
  • There is a bug with method enumeration some methods appear twice also in cases where a method is defined twice we are planning to create an index page which will allow to navigate to the required implementation (this is a standard forking behavior for cross browser support).
  • Collapse all and expand all will be added.
  • Collapsing expanding memory will be added.
  • Filter memory will be added.
  •  We are planning to add a preview designer to the skin designer which will enable to show screenshots of the components with links to the different images and styles which will be also integrated into the help as images on the skin level which will have links to the relevant skin resources.

 

Let me know what think...

Cheers,
Guy

 

 

 
New Post 1/4/2010 9:44 PM
  Guy
2346 posts
1st Level Poster




Re: 6.4 Documentation Process Update 

 P.S.

Currently it works best with in IE... we know that there are bugs in mozzila and chrome...

Cheers,
Guy

 
New Post 1/6/2010 8:56 AM
  mhensen
217 posts
www.webvize.nl
4th Level Poster




Re: 6.4 Documentation Process Update 

 The supplied link to the documentation is very good. I like the completeness of the js and xslt!! Now you can browse this as a resource instead of searching through the codes!!


With kind regards,

Michael Hensen

VWG Community Frameworks
 
New Post 8/27/2010 5:38 AM
  FrankR
103 posts
5th Level Poster


Re: 6.4 Documentation Process Update 

Hi Guy,

Is the referenced QuickStart app still in the plan?

 
New Post 8/28/2010 3:03 AM
  itzik.spitzen
1667 posts
1st Level Poster




Re: 6.4 Documentation Process Update 

Hi Frank,

Back then, when Guy wrote this post, it was called QuickStart as a temp name, however, we changed it later to ComanionKit, and if you haven't yet got the chance to take a look at it, you can browse its advanced beta version here.

Kind Regards,
Itzik  Spitzen

 
Previous Previous
 
Next Disabled
  Forum  General Visual ...  From The Archit...  6.4 Documentation Process Update
.NET HTML5 Web, Cloud and Mobile application delivery | Sitemap | Terms of Use | Privacy Statement | Copyright © 2005-2012 Visual WebGui®       Visual WebGui weblog on ASP.NET Gizmox Blog Visual WebGui Group on LinkedIn Visual WebGui updates on Twitter Visual WebGui Page on Facebook Visual WebGui YouTube Channel Visual WebGui Platform News RSS