Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3


JIRA Documentation issues for 1.5
http://issues.fluidproject.org/issues/?filter=10360

 

IoC Docs

TopicWhoStatus
 Why Inversion of Control
  • flesh out to give more explanation

  • update code samples to latest form

  • remove anything without 'autoInit'  

    Jira
    serverFluid Project Issue Tracker
    keyFLUID-5152

  • remove mention of lifecycle functions
    Jira
    serverFluid Project Issue Tracker
    keyFLUID-5140
  • remove mention of initDependents
    Jira
    serverFluid Project Issue Tracker
    keyFLUID-5141
  

Remove mention of demands 

Jira
serverFluid Project Issue Tracker
keyFLUID-5139

We've decided that demands blocks will no longer be used or recommended, so we will remove references to them altogether. They should be replaced with either the use of distributeOptions, or with a grade that overrides things.

 

Status
colourYellow
titleIn progress

The two pages have been removed. The rest of the docs still need to be reviewed.

Invokers        

Jira
serverFluid Project Issue Tracker
keyFLUID-5138

fast invokers, dynamic invokers, compact syntax

Justin,

Antranig to review

Status
colourGreen
titleDone

Component Grade page Component Grades    

Jira
serverFluid Project Issue Tracker
keyFLUID-5147

    combining grades
    creating your own grades

- and then cover dynamic grades, both supplied via direct options as well as those resolved
via an IoC reference in the "gradeNames" list - explain the limitations on this latter process
and how it must be used carefully.

dynamic grades and grade merging
   ability to write an ioc expression where a grade name is expected

See

Jira
serverFluid Project Issue Tracker
keyFLUID-5085
for notes that might be helpful.

Antranig to review

Status
colourRed
titleNeeds Review

 Model Transformation   

Jira
serverFluid Project Issue Tracker
keyFLUID-4030
    update to reflect latest code
        transforms now in "fluid.transforms" namespace
        many new transforms available (see ModelTransformationTransforms.js)
        transforms now specified with "transform:" instead of "expander:"

Some docs exist in the GPII wiki:
http://wiki.gpii.net/index.php/Architecture_-_Available_transformation_functions

Cindy
Status
colourYellow
titleIn progress
the ginger process, why it's useful 
Jira
serverFluid Project Issue Tracker
keyFLUID-5148

rename it! explain it somewhere where appropriate
  
Jira
serverFluid Project Issue Tracker
keyFLUID-5158
Michelle
Status
colourYellow
titleIn Progress
Each child page of IoC - Inversion of Control
    ensure any code samples reflect current APIs, practices, features, etc
    ensure text reflects current framework
    add new features where appropriate
  
  • How to Use Infusion IoC Needs to be reviewed and brought up-to-date to reflect current best practices (e.g. no demands, IoCSS, etc)
  
Colin 
  • Contexts   
    Jira
    serverFluid Project Issue Tracker
    keyFLUID-5149
    • diagram from demand resolution page, plus some explanation

Anastasia
Status
colourYellow
titleIn progress
  • Pseudoarguments
    • "a demands block which uses named arguments such as "options", "container", etc. rather than an argument list"
  

Message loading: We need an overview page describing how to work with message files/string bundles, for localization, including

  • in renderer components
  • using the message resolver (fluid.messageResolver) in non-renderer-component scenarios
  
  • Update the scenarios, use to identify "paths through the docs"
Anastasianot started
Overview of IoC and its goals (on this page? IoC - Inversion of Control), including   
Jira
serverFluid Project Issue Tracker
keyFLUID-5153

    configuration only
        declarative listeners
        declarative prototrees
        declarative invokers and events
  
Component authoring process from the perspective of 2nd parties, 3rd parties, etc.  
Jira
serverFluid Project Issue Tracker
keyFLUID-5154

convey the fact that you're developing something that might be used by future authors
What are the mechanisms by which an author would make an application reconfigurable?
  
Jira
serverFluid Project Issue Tracker
keyFLUID-5176
  

 

Preferences Framework Docs

Tutorials to date: Preferences Framework

TopicWhoStatus

Overview of preference editor framework
    what it's for
    what it is
    how it's structured/architected
    what is a preferences editor

Justin 

How is prefs config different from IoC config
    how does it build upon it
    spine of lookup onto names

  
Non-tutorial API docs  

GPII preferences server as a crucial element of the system
    for schema users
    a central place where 'all' prefs are defined/stored
    stress the fact that the gpii prefs server is not required (even though right now it is required)

  

New Framework Features (and under-documented things)

TopicWhoStatus
Members component option

Justin,

Antranig to review

Status
colourRed
titleNeeds Review

Jira
serverFluid Project Issue Tracker
keyFLUID-5257

Please paste a link here to where the docs have been started!

Antranig
Status
colourYellow
titleIN Progress
Jira
serverFluid Project Issue Tracker
keyFLUID-5238
  
Jira
serverFluid Project Issue Tracker
keyFLUID-5256

Declarative Syntax for Binding ChangeApplier Events

Antranig
Status
colourYellow
titleIN Progress
Flesh out the kettle docs Kettle  

General Issues

TopicWhoStatus
Jira
serverFluid Project Issue Tracker
keyFLUID-5206
  
Jira
serverFluid Project Issue Tracker
keyFLUID-5227
  
Jira
serverFluid Project Issue Tracker
keyFLUID-5230
  
Jira
serverFluid Project Issue Tracker
keyFLUID-5235