Difference between revisions of "ADF Scripts and CommonSpot Registered Resources"

From ADF Docs
Jump to: navigation, search
(ADF Theme Error Log Entries)
(Register the jQueryUIDefaultTheme as a CommonSpot Resource)
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
== ADF Theme Error Log Entries ==
 
== ADF Theme Error Log Entries ==
If an ADF or ADF App component, custom script, custom field or datasheet module requests Script Library theme via the scripts.loadTheme() method the requested theme does not exist as a CommonSpot Registered Resource this request will attempt to load a registed DefaultTheme resource or the theme files directly but it will also generate a error log entry describing the problem.  
+
If an ADF or ADF App component, custom script, custom field or datasheet module requests Script Library theme (JQueryUI, JSTree, or Table Sorter) via the scripts.loadTheme() method and the requested theme does not exist as a CommonSpot Registered Resource this request will attempt to load a registered "Default Theme" resource or as a last resort the theme files directly but this will will also generate a error log entry describing what loadTheme() needed to do to load the theme. This "issue" will need to be resolved by the site admin/developer.  
  
For these error log entries are pretty easy to resolve with a one of the following approaches:
+
These theme error log entries can be resolved with a one of the following approaches:
 
# Run the ADF [[Register All Scripts|Register ALL Scripts]] tool.
 
# Run the ADF [[Register All Scripts|Register ALL Scripts]] tool.
 
# Manually register the "ui-lightness" theme as a Registered Resource.
 
# Manually register the "ui-lightness" theme as a Registered Resource.
Line 8: Line 8:
 
# If a default them is not Registered... create it (with "ui-lightness") as an ALIAS.
 
# If a default them is not Registered... create it (with "ui-lightness") as an ALIAS.
  
Register the jQueryUIDefaultTheme as a CommonSpot Resource:
+
=== Register the jQueryUIDefaultTheme as a CommonSpot Resource ===
* Resource Tab:
+
#Open "Registered Resources/Libraries" dialog in the Site Admin
** Name: jQueryUIDefaultTheme 1.11
+
#Click "Add Resource/Library"
** Description: jQueryUIDefaultTheme resources.
+
#* Resource Tab:
* Resource URLs Tab:
+
#** Name: '''jQueryUIDefaultTheme 1.11'''
** Early Loading:  
+
#** Description: jQueryUIDefaultTheme resources.
*** URL: /ADF/thirdParty/jquery/ui/jquery-ui-1.11/css/ui-lightness/jquery-ui.css
+
#** Resource Category: Primary or Secondary (Generally themes/style should load before other libs)
*** Type: Stylesheet
+
#* Resource URLs Tab:
*** Combine: disabled
+
#** Early Loading:  
*** Minify: disabled
+
#*** URL: '''/ADF/thirdParty/jquery/ui/jquery-ui-1.11/css/ui-lightness/jquery-ui.css'''
** Description: jQueryUIDefaultTheme resources.
+
#**** (Be sure to register the correct version)
* Alias URLs Tab:
+
#*** Type: Stylesheet
** Aliases:
+
#*** Combine: disabled
*** ui-lightness
+
#*** Minify: disabled
*** jQueryUIDefaultTheme   
+
#** Description: '''jQueryUIDefaultTheme''' resources.
*** jQueryUIstyles
+
#* Alias URLs Tab:
 +
#** Aliases:
 +
#*** ui-lightness
 +
#*** jQueryUIDefaultTheme   
 +
#*** jQueryUIstyles
 +
# Save
 +
 
 +
[[Category: How-to Guide]][[Category: CommonSpot Registered Resources]]

Latest revision as of 21:50, 14 March 2016

ADF Theme Error Log Entries

If an ADF or ADF App component, custom script, custom field or datasheet module requests Script Library theme (JQueryUI, JSTree, or Table Sorter) via the scripts.loadTheme() method and the requested theme does not exist as a CommonSpot Registered Resource this request will attempt to load a registered "Default Theme" resource or as a last resort the theme files directly but this will will also generate a error log entry describing what loadTheme() needed to do to load the theme. This "issue" will need to be resolved by the site admin/developer.

These theme error log entries can be resolved with a one of the following approaches:

  1. Run the ADF Register ALL Scripts tool.
  2. Manually register the "ui-lightness" theme as a Registered Resource.
  3. If the default theme is registered then add "ui-lightness" as an ALIAS for the Registered Resource.
  4. If a default them is not Registered... create it (with "ui-lightness") as an ALIAS.

Register the jQueryUIDefaultTheme as a CommonSpot Resource

  1. Open "Registered Resources/Libraries" dialog in the Site Admin
  2. Click "Add Resource/Library"
    • Resource Tab:
      • Name: jQueryUIDefaultTheme 1.11
      • Description: jQueryUIDefaultTheme resources.
      • Resource Category: Primary or Secondary (Generally themes/style should load before other libs)
    • Resource URLs Tab:
      • Early Loading:
        • URL: /ADF/thirdParty/jquery/ui/jquery-ui-1.11/css/ui-lightness/jquery-ui.css
          • (Be sure to register the correct version)
        • Type: Stylesheet
        • Combine: disabled
        • Minify: disabled
      • Description: jQueryUIDefaultTheme resources.
    • Alias URLs Tab:
      • Aliases:
        • ui-lightness
        • jQueryUIDefaultTheme
        • jQueryUIstyles
  3. Save