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

fluid.uiOptions(container, {
    gradeNames: [<gradenames of desired panels>,
                 <gradenames of schema for settings>],
    pathToTemplates: "my/sites/lib/infusion/templates/"
});

fluid.pageEnhancer({
    gradeNames: [<grade names of desired enactors>,
                 <gradenames of schema for 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.

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

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

fluid.uiOptions(container, {
    gradeNames: ["fluid.uiOptions.starterSettingsPanels",
                 "fluid.uiOptions.starterSettingsSchemastarterSettings"],
    pathToTemplates: "my/sites/lib/infusion/templates/"
});

fluid.pageEnhancer({
    gradeNames: ["fluid.uiEnhancer.starterSettings],
    pathToTocTemplate: "my/sites/",
    siteThemeClassName: "foofer-doodle-theme"
});

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 extrathe panelsschema  * and their defaultfor your settings
 */
fluid.defaults("my.extra.panelssettingsSchema", {
    defaultSiteSettingsschema: {...}
});
/**
 * Define a grade for foofer:extra 7,panels
 * and their default settings
  doodle: true
    },*/
fluid.defaults("my.extra.panels", {
    components: {
        foofer: {
            funcName: "my.integration.fooferPanel",
            options: {
                // if necessary:
                template: "myFooferPanel.html"
                // why can't panels load their own templates?
            }
            // any other configuration as necessary
        },
        doodle: {
            funcName: "my.integration.doodlePanel",
            options: {
                template: "myDoodlePanel.html"
                // if necessary
            }
            // any other configuration as necessary
        }
    }
});
fluid.defaults("my.extra.settingsSchema", {
    schema: {...}
});
fluid.uiOptions(container, {
    gradeNames: ["fluid.uiOptions.starterSettingsPanels",

/**
 * Define a grade for extra enactors
 */
fluid.defaults("my.extra.enactors", {
    components: {
        foofer:  "fluid.uiOptions.starterSettingsSchema",{
                  funcName: "my.extraintegration.panelsfooferEnactor",
            // any other configuration  "my.extra.settingsSchema"],as necessary
    pathToTemplates: "my/sites/lib/infusion/templates/",   },
 pathToTocTemplate: "my/sites/",     siteThemeClassName: "foofer-doodle-theme"
});

:

fluid.demands("fluid.uiOptions", ["my.integrations"], {
    gradeNames: ["my.extra.panels", "my.extra.settingsSchema"], }); fluid.uiOptions(container, {     gradeNamesfuncName: ["fluidmy.uiOptionsintegration.starterSettingsPanelsdoodleEnactor",
            // any other configuration  "fluid.uiOptions.starterSettingsSchema"],as necessary
    gradeNames: ["fluid.uiOptions.defaultPanels"],   }
 pathToTemplates: "my/sites/lib/infusion/templates/",
    pathToTocTemplate: "my/sites/",
    siteThemeClassName: "foofer-doodle-theme"  }
});

/**
 * DefineA agrade gradethat forcombines extramy enactors,  *panels and their defaultschema.
settings  */
fluid.defaults("my.extra.enactorssettings", {
    defaultSiteSettings: {
        foofer: 7,
        doodle: true
    },gradeNames: ["my.extra.enactors",
       components: {         foofer: {
            funcName: "my.integrationextra.fooferEnactor",
            // any other configuration as necessary
        }panels",
        doodle: {             funcName: "my.integrationextra.doodleEnactorsettingsSchema",]
});
/**
 * Add the enactors, panels and schema
  *//
any other configuration as necessary
        }
    }
});
fluid.pageEnhancer(fluid.uiOptionsPlusPageEnhancer(container, {
    gradeNames: ["fluid.uiEnhanceruiOptions.starterEnactorsstarterSettings",
                 "fluid.uiEnhancer.starterSettingsSchema",
                 "my.extra.enactorssettings"],
                 "my.extra.settingsSchema]pathToTemplates: "my/sites/lib/infusion/templates/",
    pathToTocTemplate: "my/sites/",
    siteThemeClassName: "foofer-doodle-theme"
});

Alternatively, the extra

...

grades could be added using demands:

fluid.demands("fluid.pageEnhanceruiOptions", ["my.integrations"], {
    gradeNames: ["my.extra.enactors", "my.extra.settingsSchema"settings"],
});
fluid.pageEnhanceruiOptionsPlusPageEnhancer(container, {
    gradeNames: ["fluid.uiEnhanceruiOptions.starterEnactorsstarterSettings"],
                 "fluid.uiEnhancer.starterSettingsSchema"]pathToTemplates: "my/sites/lib/infusion/templates/",
    pathToTocTemplate: "my/sites/",
    siteThemeClassName: "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.

// The grade definition would be the same as above

fluid.uiOptions(container, {fluid.uiOptionsPlusPageEnhancer(container, {
    gradeNames: ["fluid.uiOptions.starterSettings"],

    // XXXcomponents: Would custom{
schema include 'default' panels?     schema: "my/sites/mySchema.json" Override the   pathToTemplates: "my/sites/lib/infusion/templates/",
 settings panels
  pathToTocTemplate: "my/sites/",     siteThemeClassNamecontrast: "foofer-doodle-theme"
});

// The grade definition would be the same as above

fluid.pageEnhancer({{
            type: "fluid.emptySubcomponent"
     // XXX: Would custom},
schema include 'default' panels?     schemalayoutControls: "my/sites/mySchema.json" {
      pathToTocTemplate: "my/sites/",     siteThemeClassNametype: "foofer-doodle-themefluid.emptySubcomponent"
}); 

Using a subset of the included panels (no schema)

 /**  * Define a grade including},
only
desired panels  */ fluid.defaults("my.panels", {   // Override components:the {enactors
        textSizertheme: {
            type: "fluid.uiOptions.textSizer",
            // any other configuration as necessaryemptySubcomponent"
        },
        lineSpacertableOfContentsEnactor: {
            type: "fluid.uiOptions.lineSpacer",
       emptySubcomponent"
    // any other configuration as necessary
        }
    }
});
fluid.uiOptions(container, {
    gradeNames: ["my.panels"],
    pathToTemplates: "my/sites/lib/infusion/templates/",
    pathToTocTemplate: "my/sites/",
    siteThemeClassName: "foofer-doodle-theme"
});

/**
 * Define a grade including only desired enactors
 */
fluid.defaults("my.settings", {
        textSize: {
    fluid.defaults("my.panelSet", {
    gradeNames: [
        // Specify each of the four desired panels directly
        "fluid.uiOptions.textSizer",
       type: "fluid.uiOptions.enactor.textSizerlineSpacer",
        "fluid.uiOptions.textFont",
   // any other configuration as necessary "fluid.uiOptions.linksControls",
        },
        textFont: {
    // Specify each of the four desired enactors directly
       type: "fluid.uiOptionsuiEnhancer.enactor.classSwappertextSizer",
        "fluid.uiEnhancer.lineSpacer",
   // any other configuration as necessary "fluid.uiEnhancer.textFont",
        }"fluid.uiEnhancer.linksControls",
    } });
fluid.pageEnhancer({   
 gradeNames: ["my.settings"],     pathToTocTemplate: "my/sites/", Use the full schema
siteThemeClassName: "foofer-doodle-theme" }); 

Using a subset of the included panels (with schema)

 // The grade definition would be the same as above
 "fluid.uiOptions.starterSettingsSchema"
    ]
});
fluid.uiOptionsuiOptionsPlusPageEnhancer(container, {
    schemagradeNames: ["my/sites/mySchema.jsonpanelSet"],
    pathToTemplates: "my/sites/lib/infusion/templates/",
    pathToTocTemplate: "my/sites/",
    siteThemeClassName: "foofer-doodle-theme"
});

// The grade definition would be the same as above

fluid.pageEnhancer({
    schema: "my/sites/mySchema.json"
    pathToTocTemplate: "my/sites/",
    siteThemeClassName: "foofer-doodle-theme"
});

...