Page Comparison

This page presents a proposal for a new API for User Interface Options. It lays out what we would like to expect of an integrator.

Guiding Principles

• A schema exists to define the settings, their defaults, ranges, etc.
• Any options that might be set should be top-level.
  • Option names should make sense.
• Integrators should not have to create both a page enhancer and the fat panel individually; If they want the fat panel, the page enhancer would be assumed and should be instantiated on the page automatically.
• Integrators should be able to create a page enhancer without UIO (in the case of a full-page UIO available elsewhere, through a link).

The options shown here represent the minimal options that an integrator would have to provide. Other options will also be available.

Basic API

...

Section

Column UIO + Page Enhancer Only Code Block javascript javascript fluid.uiOptions(container, { gradeNames: [<gradenames of desired panels>, <gradenames of schema for settings>], pathToTemplates: "my/sites/lib/infusion/templates/", }); Column Page Enhancer Only Code Block javascript javascript fluid.pageEnhancer({ pathToTocTemplate: "my/sites/"gradeNames: [<grade names of desired enactors>, siteThemeClassName: "foofer-doodle-theme" }); Column Page Enhancer Only Code Block javascript javascript fluid.pageEnhancer({ gradeNames:<gradenames [<gradeof namesschema for desired settings>], pathToTocTemplate: "my/sites/", siteThemeClassName: "foofer-doodle-theme" });

If no grade names are specified, the default state of the components would be no panels, no settings. It's unlikely anyone would ever use it without grade names.

Basic API with schema support

fluid.uiOptionsuiOptionsPlusPageEnhancer(container, {
    schemagradeNames: [<gradenames <pathof todesired schemapanels>,
including filename>,                <grade names of desired enactors>,
                 <gradenames of schema for settings>],
    pathToTemplates: "my/sites/lib/infusion/templates/",
    pathToTocTemplate: "my/sites/",
    siteThemeClassName: "foofer-doodle-theme"
});

If no grade names are specified, the default state of the components would be no panels, no settings. It's unlikely anyone would ever use it without grade names.

Use Case: 2nd Parties (Infusion-provided "starter-set" of panels and settings)

Add the "starter-set" of panels and settings included in Infusion using the starter grades.

fluid.uiOptions(container, {
    gradeNames: ["fluid.uiOptions.starterSettings"],
    siteThemeClassNamepathToTemplates: "foofer-doodle-thememy/sites/lib/infusion/templates/"
});

Use Case: 2nd Parties (Infusion-provided panels and settings)

Add the provided panels and settings using the default grades.

fluid.uiOptionspageEnhancer(container, {
    gradeNames: ["fluid.uiOptionsuiEnhancer.defaultPanels"],
    pathToTemplates: "my/sites/lib/infusion/templates/"starterSettings],
    pathToTocTemplate: "my/sites/",
    //
TocTemplate filename would be in a separate option
    siteThemeClassName: "foofer-doodle-theme"
});

UIO + Page Enhancer (with schema)

Page Enhancer Only (with schema)

fluid.pageEnhanceruiOptionsPlusPageEnhancer(container, {
    gradeNames: ["fluid.uiOptions.defaultSettingsstarterSettings"],
    pathToTocTemplatepathToTemplates: "my/sites/lib/infusion/templates/",
    pathToTocTemplate: "my/sites/",
TocTemplate filename would be in a separate option
    siteThemeClassName: "foofer-doodle-theme"
});

fluid.uiOptions(container, {
    schema: "my/sites/lib/infusion/defaultSchema.json",
    pathToTemplates: "my/sites/lib/infusion/templates/",
    pathToTocTemplate: "my/sites/",
    // TocTemplate filename would be in a separate option
    siteThemeClassName: "foofer-doodle-theme"
});

fluid.pageEnhancer({
    schema: "my/sites/lib/infusion/defaultSchema.json",
    pathToTocTemplate: "my/sites/",
    // TocTemplate filename would be in a separate option
    siteThemeClassName: "foofer-doodle-theme"
});

Use Case: 3rd Parties (adding or removing panels)

3rd parties will have to define their own grades.

Adding panels to the set of included panels

/**
 * Define a grade for extra panels
 * and their default settings
 */
fluid.defaults("my.extra.panels", {
    defaultSiteSettings: {
        foofer: 7,

Use Case: 3rd Parties Adding Panels To The Starter Set

Note: 3rd parties will have to define their own grades for new settings, panels, enactors.

Note: All further examples will only use the "UIO + Page Enhancer" version: fluid.uiOptionsPlusPageEnhancer(). The pattern holds.

/**
 * Define a grade for the schema for your settings
 */
fluid.defaults("my.extra.settingsSchema", {
    schema: {...}
});
/**
 * Define a grade for extra panels
 * and their default settings
 */
fluid.defaults("my.extra.panels", {
    components: {
        foofer: {
            funcName: "my.integration.fooferPanel",
            options: {
                // if necessary:
                template: "myFooferPanel.html"
            doodle: true   // why },can't panels load their own components:templates?
{         foofer: {  }
          funcName: "my.integration.fooferPanel",
  // any other configuration as necessary
        },
      options  doodle: {
            funcName: "my.integration.doodlePanel",
          // if necessaryoptions: {
                template: "myFooferPanelmyDoodlePanel.html"
                // whyif can'tnecessary
panels load their own templates?        }
    }         },// any other configuration as necessary
        }
  doodle: { }
});
/**
 * Define a grade for extra enactors
 funcName: */
fluid.defaults("my.integrationextra.doodlePanelenactors", {
    components: {
     options: {  foofer: {
             templatefuncName: "myDoodlePanelmy.html"
   integration.fooferEnactor",
            // ifany necessaryother configuration as necessary
        },
}        doodle: }{
    } }); fluid.uiOptions(container, {     gradeNamesfuncName: ["fluidmy.uiOptionsintegration.defaultPanelsdoodleEnactor", "my.extra.panels"],
           pathToTemplates: "my/sites/lib/infusion/templates/",
    pathToTocTemplate: "my/sites/",/ any other configuration as necessary
       // TocTemplate}
filename would be in a}
separate option});
/**
 * A grade siteThemeClassName: "foofer-doodle-theme"
});

fluid.demands("fluid.uiOptions", ["my.integrations"]that combines my enactors, panels and schema.
 */
fluid.defaults("my.extra.settings", {
    gradeNames: ["my.extra.panelsenactors"],
 });
fluid.uiOptions(container, {         gradeNames: ["fluid.uiOptions.defaultPanels"],     pathToTemplates: "my/sites/lib/infusion/templates/.extra.panels",
    pathToTocTemplate: "my/sites/",     // TocTemplate filename would be in a separate option
    siteThemeClassName: "foofer-doodle-theme"
});

/**
 * Define a grade for extra enactors
 * and their default settings
 */
// Define a grade for the extra 
fluid.defaults( "my.extra.settingsSchema"]
});
/**
 * Add the enactors, panels and schema
 */
fluid.uiOptionsPlusPageEnhancer(container, {
    gradeNames: ["fluid.uiOptions.starterSettings",
                 "my.extra.settings"],
{     defaultSiteSettingspathToTemplates: {"my/sites/lib/infusion/templates/",
        fooferpathToTocTemplate: 7"my/sites/",
        doodle: true
    },
    components:siteThemeClassName: "foofer-doodle-theme"
});

Alternatively, the extra grades could be added using demands:

fluid.demands("fluid.uiOptions", ["my.integrations"], {
    gradeNames: ["my.extra.settings"],
});
fluid.uiOptionsPlusPageEnhancer(container, {
    gradeNames: ["fluid.uiOptions.starterSettings"],
  foofer: { pathToTemplates: "my/sites/lib/infusion/templates/",
    pathToTocTemplate: "my/sites/",
    funcNamesiteThemeClassName: "my.integration.fooferEnactor",
            options: {
                // if necessary
            }
        },
        doodle: {
            funcName: "my.integration.doodleEnactor",
            options: {
                // if necessary
            }
        }
    }
});
fluid.pageEnhancer({
    gradeNames: ["fluid.uiOptions.defaultSettings", "my.extra.settings"],
    pathToTocTemplate: "my/sites/",
    // TocTemplate filename would be in a separate option
    siteThemeClassName: "foofer-doodle-theme"
});

fluid.demands("fluid.pageEnhancer", ["my.integrations"], {
    gradeNames: ["my.extra.settings"],
});
fluid.pageEnhancer({
    gradeNames: ["fluid.uiOptions.defaultSettings"],
    pathToTocTemplate: "my/sites/",
    // TocTemplate filename would be in a separate option
    siteThemeClassName: "foofer-doodle-theme"
});

Using a subset of defaults

Proposed API

Until schema support is implemented, integrators need a way to say "just give me the settings I saw in the demo."

To create UIO and a page enhancer:

...

fluid.uiOptions(container, {
    gradeNames: [<gradenames of desired panels>],
    pathToTemplates: "my/sites/lib/infusion/templates/",
    pathToTocTemplate: "my/sites/", // filename would be in a separate option
    siteThemeClassName: "foofer-doodle-theme"
});

...

Access to the default panels would be made easy through a "flavour" of uiOptions (similar to flavours of Reorderer):

...

fluid.uiOptionsWithDefaultPanels(container, {
    pathToTemplates: "my/sites/lib/infusion/templates/",
    pathToTocTemplate: "my/sites/",
    siteThemeClassName: "foofer-doodle-theme"
});

...

which would be equivalent to

...

fluid.uiOptions(container, {
    gradeNames: ["fluid.uiOptions.defaultPanels"],
    pathToTemplates: "my/sites/lib/infusion/templates/",
    pathToTocTemplate: "my/sites/",
    siteThemeClassName: "foofer-doodle-theme"
});

To create only a page enhancer:

...

fluid.pageEnhancer({
    gradeNames: [<grade names for desired settings>],
    pathToTocTemplate: "my/sites/", // filename would be in a separate option
    siteThemeClassName: "foofer-doodle-theme"
});

...

Access to the default setting would be made easy through a "flavour" of enhancer (similar to flavours of Reorderer):

...

fluid.pageEnhancerWithDefaultSetting({
    pathToTocTemplate: "my/sites/", // filename would be in a separate option
    siteThemeClassName: "foofer-doodle-theme"
});

...

which would be equivalent to

...

fluid.pageEnhancer({
    gradeNames: ["fluid.uiEnhancer.defaultSettings"],
    pathToTocTemplate: "my/sites/", // filename would be in a separate option
    siteThemeClassName: "foofer-doodle-theme"
});

Once schemas are being used

To create UIO and a page enhancer using out-of-the-box schema for default panels:

...

fluid.uiOptions(container, {
    pathToSchema: "my/sites/lib/infusion/defaultSchema.json",
    pathToTemplates: "my/sites/lib/infusion/templates/",
    pathToTocTemplate: "my/sites/", // filename would be in a separate option
    siteThemeClassName: "foofer-doodle-theme"
});

To create only a page enhancer using out-of-the-box schema for default settings:

...

fluid.pageEnhancer({
    pathToSchema: "my/sites/lib/infusion/defaultSchema.json",
    pathToTocTemplate: "my/sites/", // filename should be in a separate option
    siteThemeClassName: "foofer-doodle-theme"
});

Use Case: Add/remove settings, configure a fresh UIO (3rd parties)

Guiding Principles

Adding panels requires creating components, etc. and therefore requires knowledge of the Framework. For this use case, we expect that integrators understand components, options structures, demands, etc.

• Adding panels should be done through grades, either at invocation time or by adding a grade through a demands block.
• Templates for new panels should be able to be located anywhere i.e. not required to be added to wherever the default templates are.

Consider the use case of the WordPress FSS Theme (which adds UIO to a site) and the VideoPlayer WordPress plugin (which wants to add the media panel to UIO). We want independent modules, plugins, portlets, etc. to be able to add panels to UIO without UIO knowing about it, without other modules, plugins, portlets, etc. knowing about it, without multiple plugins conflicting.

Proposed API

Add panels to UIO

...

// Define a grade with the extra panels and their default settings
fluid.defaults("my.extra.panels", {
    defaultSiteSettings: {
        foofer: 7,
        doodle: true
    },
    components: {
        foofer: {
            funcName: "my.integration.fooferPanel",
            options: {
                template: "myFooferPanel.html" // why can't panels load their own templates?
                // if necessary
            }
        },
        doodle: {
            funcName: "my.integration.doodlePanel",
            options: {
                template: "myDoodlePanel.html"
                // if necessary
            }
        }
    }
});

...

foofer-doodle-theme"
});

Use Case: 3rd Parties Wanting A Subset Of The Starter Set

There are three possible ways to do this:

1. Cut-and-paste: Copy the code that defines the "starter" grades, rename the grades, delete the parts you don't want, and use these new grades instead of the starter grades (not really recommended).
2. Empty subcomponents: Use the starter grades and override the excluded subcomponents with fluid.emptySubcomponent
3. Individual grades: Use the individual settings grades desired instead of the starter set.

The last two of these methods will be shown here, excluding the colour-and-contrast setting and the layout setting.

fluid.uiOptionsPlusPageEnhancer(container, {
    gradeNames: ["fluid.uiOptions.defaultPanelsstarterSettings"],
"my.extra.panels"],
    pathToTemplatescomponents: "my/sites/lib/infusion/templates/", {
       pathToTocTemplate: "my/sites/", // filename would be in a separate option
    siteThemeClassName: "foofer-doodle-theme"
});

// Add the grade to UIOptions through demands
fluid.demands("fluid.uiOptions", "my.integration", {
    gradeNames: ["my.extra.panels"]
});
// create UIO
fluid.uiOptions(container, {
    gradeNames: ["fluid.uiOptions.defaultPanels"],
    pathToTemplates: "my/sites/lib/infusion/templates/",
    pathToTocTemplate: "my/sites/", // filename would be in a separate option
    siteThemeClassName: "foofer-doodle-theme"
});

Add settings to UIE

/ Override the settings panels
        contrast: {
            type: "fluid.emptySubcomponent"
        },
        layoutControls: {
            type: "fluid.emptySubcomponent"
        },

        // Override the enactors
        theme: {
            type: "fluid.emptySubcomponent"
        

},
        

tableOfContentsEnactor: 

{
    

  type: "fluid.emptySubcomponent"
     

  }
    }

    

pathToTemplates: "my

/sites/lib/infusion/templates/",
    

pathToTocTemplate: 

"my/sites/",
    siteThemeClassName: "foofer-doodle-theme"

});

fluid.defaults("my.panelSet", {
    gradeNames: [
    

    // Specify each of the 

four desired panels directly
     

"fluid.uiOptions.textSizer",
       

 "

fluid.

uiOptions.

lineSpacer",
        "fluid.uiOptions.textFont",
   

"fluid.uiOptions.linksControls",
       

        // Specify each of the 

four desired enactors directly
     

To add the grade to UIE, use one of the following:

// Add the grade to UIEnhancer as part of creation
fluid.pageEnhancer({"fluid.uiEnhancer.textSizer",
        "fluid.uiEnhancer.lineSpacer",
       gradeNames: ["fluid.uiEnhancer.defaultSettingstextFont",
        "myfluid.extrauiEnhancer.settingslinksControls"],
       pathToTocTemplate: "my/sites/",
    siteThemeClassName: "foofer-doodle-theme" }); 

 // add grade to UIEnhancer through demands
fluid.demands("fluid.uiEnhancer", "my.integrations" { Use the full schema
        "fluid.uiOptions.starterSettingsSchema"
    gradeNames:["my.extra.settings"] 
});
// create UIEnhancer
fluid.pageEnhanceruiOptionsPlusPageEnhancer(container, {
    gradeNames: ["fluidmy.uiEnhancer.defaultSettingspanelSet"],
    pathToTocTemplatepathToTemplates: "my/sites/lib/infusion/templates/",
    siteThemeClassNamepathToTocTemplate: "foofer-doodle-theme"
});

Once schemas are being used

Use Case: Users of customized UIO (4th parties)

Guiding Principles

Proposed API

Use Case: Localization

Guiding Principles

Integrators should be able to translate a single strings bundle that would take care of the entire interface.

• The strings will all be in a single .js files that places the message bundle in the global namespace.
• To translate, the integrator either
  • creates a copy of the file and edits the link in the header to reference translated file (preferred), or
  • edits the original file.

Proposed API

...

my/sites/",
    siteThemeClassName: "foofer-doodle-theme"
});

Use Case: 4th Parties (users of customized UIOs)