Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

TOC branch will contain

  • index.html

  • widgets.json

  • robots.txt

  • css/

  • js/

  • images/

Widgets

Types 

  1. Version Switcher ( versions dropdown )
  2. Notification - latest version available on prior versions.

Widget working

  1. Widgets will consume data from the widgets.json file.

  2. widgets.js file generates HTML for widgets and appends them in the empty widget placeholder divs.

widgets.json

  • It will provide data to the widgets

  • Whenever a new version doc is added or removed, this file will have to be updated. 


{
 

...

 "versions":

...

[

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 {
 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

"version":

...

"2.0",
 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

"latest":

...

true
 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 },
 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 {
 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

"version":

...

"1.9",
 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

"latest":

...

false
 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

},
 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

{
 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

"version":

...

"1.8",
 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 "latest":

...

false
 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

}
 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 ]
}

Widgets

Types 

  1. TOC

  2. Sidebar

  3. Notification - latest version available on prior versions.

Widget working

  1. Widgets will be based on handlebar template

  2. Widgets will consume data from the manifest file from each version. 

  3. manifest files will be included with require.js

Note

  • robots.txt 

...

  • - If any of the version is unpublished, then that directory will have to be disallowed to be indexed in Search engines.