fluid-project / infusion-docs

Documentation space for Infusion
http://docs.fluidproject.org/infusion
Creative Commons Attribution 4.0 International
8 stars 45 forks source link

UIO getting started guide should include an explanation of the Prefs Framework #303

Open jobara opened 1 month ago

jobara commented 1 month ago

The Getting Started with UIO documentation should include some information describing the differences between UIO and the Prefs Framework. This information could be an aside or a separate document.

Additional context or notes

Originally filed as FLUID-6369 by @jhung on March 7, 2019.

jobara commented 1 month ago

Comment Migrated from FLUID-6369 originally posted by @jhung on March 7, 2019

This is what @waharnum has written previously on the topic about UIO vs. Prefs Framework which might help with this task:

"Briefly, I want to highlight a distinction between two pieces of the Fluid Project’s Infusion JS framework:

User Interface Options (UIO) is a “standard” component for providing a UI for end users to customize the appearance and behavior of websites. This is what’s described in the documentation at https://docs.fluidproject.org/infusion/development/tutorial-userInterfaceOptions/UserInterfaceOptions.html and https://docs.fluidproject.org/infusion/development/UserInterfaceOptionsAPI.html, what we typically use on our own sites, and what we recommend for use by others if they don’t have specific needs. The Preferences Framework is an underlying piece of the Infusion framework that UIO is built with – the framework is designed to support a wide variety of approaches to building preferences editors, of which UIO is one possible manifestation. It’s described in detail at https://docs.fluidproject.org/infusion/development/PreferencesFramework.html and corresponding sections. So particularly when working with integration with other code (especially code also wanting to expose controls to the user to customize a website), there are options beyond “out of the box” use of UIO that can still draw on the Fluid’s Projects codebase. These have a higher complexity than UIO, but I wanted to make sure to highlight the distinction above."