Metadata
- Source
- FLUID-5452
- Type
- Task
- Priority
- Blocker
- Status
- Closed
- Resolution
- Fixed
- Assignee
- Simon Bates
- Reporter
- Simon Bates
- Created
2014-06-19T11:26:59.637-0400 - Updated
2014-06-23T16:04:06.008-0400 - Versions
- N/A
- Fixed Versions
-
- 1.5
- Component
-
- Tech. Documentation
Description
We will need a solution for the 1.5 docs for links to framework API pages. As a first step, we will review the converted docs and identify the existing links.
For this task:
- Review each converted page in https://github.com/fluid-project/infusion-docs
- Record a count of the number of framework API links in each page
Comments
-
Simon Bates commented
2014-06-20T16:19:45.528-0400 I have reviewed the links on the existing pages (not only for framework API, but also for missing pages). Here's what I found:
- APIChangesFrom1_4To1_5.md [good]
- AuxiliarySchemaForPreferencesFramework.md [good]
- Builder.md
- fluid.invokeGlobalFunction
- missing SettingsStore.md [page does not exist on wiki either]
- ChangeApplier.md
- EventSystem.md should be InfusionEventSystem.md
- Tutorial-ModelBearingComponent.md should be tutorial-gettingStartedWithInfusion/ModelComponents.md
- ChangeApplierAPI.md
- TutorialModelComponents.md -> tutorial-gettingStartedWithInfusion
- ComponentGrades.md
- fluid.defaults
- missing ContextsAndDemands.md
- missing DOMBinder.md
- BasicComponentCreationLittleComponents.md -> tutorial-gettingStartedWithInfusion
- TutorialEventedComponents.md -> tutorial-gettingStartedWithInfusion
- TutorialModelComponents.md -> tutorial-gettingStartedWithInfusion
- TutorialRendererComponents.md -> tutorial-gettingStartedWithInfusion
- TutorialSubcomponents.md -> tutorial-gettingStartedWithInfusion
- TutorialViewComponents.md -> tutorial-gettingStartedWithInfusion
- http://wiki.fluidproject.org/display/fluid/New+Notes+on+the+ChangeApplier
- ComponentLifecycle.md
- TutorialSubcomponents.md -> tutorial-gettingStartedWithInfusion
- http://wiki.fluidproject.org/display/Infusion14/Component+Lifecycle+and+autoInit
- ComponentOptionsAndDefaults.md
- fluid.defaults
- missing ComponentConfigurationOptions.md
- Contexts.md [good]
- Cutpoints.md
- fluid.renderer.selectorsToCutpoints
- fluid.rendererComponent
- DeclarativeThisismInIoC.md
- missing Expanders.md [page does not exist on wiki either]
- DeprecationsIn1_5.md [good]
- Enactors.md
- fluid.viewComponent
- EventInjectionAndBoiling.md
- missing IoCInversionOfControl.md
- Events.md
- do we really need this landing page?
- ExpansionOfComponentOptions.md [good]
- FrameworkConcepts.md
- missing ComponentConfigurationOptions.md
- missing Components.md
- missing DOMBinder.md
- missing Pager.md
- TutorialEventedComponents.md -> tutorial-gettingStartedWithInfusion
- TutorialModelComponents.md -> tutorial-gettingStartedWithInfusion
- TutorialViewComponents.md -> tutorial-gettingStartedWithInfusion
- HowToUseInfusionIoC.md
- fluid.defaults
- HowToUseTheRenderer.md
- fluid.fetchResources
- fluid.reRender
- fluid.render
- fluid.selfRender
- InfusionEventSystem.md
- missing ComponentConfigurationOptions.md
- missing InversionOfControl.md
- missing Reorderer.md
- there are 2 instances of links with text "Event Types" which link back to this page
on the wiki page they pointed to Infusion+Event+System#InfusionEventSystem-EventsTypes
maybe this section was removed? - Invokers.md [good]
- IoCReferences.md [good]
- IoCSS.md
- http://wiki.fluidproject.org/display/docs/IoC+References should be IoCReferences.md
- ModelRelay.md
- fluid.defaults
- missing ModelTransformation.md
- http://wiki.fluidproject.org/display/fluid/New+Notes+on+the+ChangeApplier
- OptionsMerging.md
- missing UnderstandingComponentOptionsAndTheirDefaults.md
- PreferencesEditor.md
- missing SettingsStore.md [page does not exist on wiki either]
- missing UIEnhancer.md
- PrimarySchemaForPreferencesFramework.md [good]
- ProgressiveEnhancement.md [good]
- ProtoComponentTypes.md
- fluid.formatMessage
- Renderer.md [good]
- RendererComponents.md
- fluid.fetchResources
- fluid.renderer.createRendererSubcomponent
- ModelComponents.md -> tutorial-gettingStartedWithInfusion
- RendererComponentTreeExpanders.md [good]
- RendererComponentTrees.md
- missing Components.md
- RendererDecorators.md
- missing Components.md
- missing FluidComponentAPI.md [link goes nowhere in wiki]
- Subcomponents.md -> tutorial-gettingStartedWithInfusion
- SubcomponentDeclaration.md
- fluid.defaults
- missing ModelTransformation.md
- TutorialViewComponents.md -> tutorial-gettingStartedWithInfusion
- UnderstandingInfusionComponents.md
- fluid.defaults
tutorial-gettingStartedWithInfusion:
- BasicComponentCreation-LittleComponents.md
- fluid.defaults
- missing InlineEdit.md
- missing IoC-InversionOfControl.md
- missing Progress.md
- DefineANamespaceAndCreateAClosure.md
- fluid.registerNamespace
- EventedComponents.md
- missing Reorderer.md
- missing Uploader.md
- GettingStartedWithInfusion.md [good]
- ModelComponents.md
- missing ModelObjects.md [the wiki links to a 1.3 page: http://wiki.fluidproject.org/display/Infusion13/Model+Objects]
- missing Pager.md [the wiki links to a 1.3 page: http://wiki.fluidproject.org/display/Infusion13/Pager]
- missing UserInterfaceOptions.md
- PickAComponentType.md [good]
- RendererComponents.md
- missing Components.md
- missing ModelTransformation.md
- SetUpYourEnvironment.md
- missing DeveloperIntroductionToInfusionFramework.md
- http://wiki.fluidproject.org/display/fluid/Contributing+Code
- Subcomponents.md
- missing PagerSubcomponents.md [wiki links to a 1.3 page: http://wiki.fluidproject.org/display/Infusion13/Pager+Subcomponents]
- missing UserInterfaceOptions.md
- ViewComponents.md
- missing DOMBinder.md
-
Simon Bates commented
2014-06-20T16:20:17.660-0400 Summary of the above.
Referenced Framework API
- fluid.defaults
- fluid.fetchResources
- fluid.formatMessage
- fluid.invokeGlobalFunction
- fluid.registerNamespace
- fluid.render
- fluid.renderer.createRendererSubcomponent
- fluid.renderer.selectorsToCutpoints
- fluid.rendererComponent
- fluid.reRender
- fluid.selfRender
- fluid.viewComponent
Links to missing pages
[with the assessment from http://wiki.fluidproject.org/display/fluid/Infusion+Documentation+Plan]
- ComponentConfigurationOptions.md [should probably be rethought]
- Components.md
- ContextsAndDemands.md
- DeveloperIntroductionToInfusionFramework.md
- DOMBinder.md [ok but I think reads confusingly]
- Expanders.md [page does not exist on wiki either]
- FluidComponentAPI.md [page does not exist on wiki either]
- InlineEdit.md
- IoCInversionOfControl.md [needs more modern treatment and motivation]
- also "InversionOfControl.md"
- also "IoC-InversionOfControl.md"
- ModelObjects.md [latest version appears to be: http://wiki.fluidproject.org/display/Infusion13/Model+Objects]
- ModelTransformation.md [ok but incredibly incomplete]
- Pager.md
- PagerSubcomponents.md [latest version appears to be: http://wiki.fluidproject.org/display/Infusion13/Pager+Subcomponents]
- Progress.md
- Reorderer.md
- SettingsStore.md [page does not exist on wiki either]
- UIEnhancer.md [out of date]
- UnderstandingComponentOptionsAndTheirDefaults.md
- Uploader.md
- UserInterfaceOptions.md
-
Justin Obara commented
2014-06-23T10:56:15.823-0400 Links to github for referenced framework api. these links all point to the Infusion 1.5 tag of the repo. Github's search seemed too fuzzy to be able to use directly for these references.
- fluid.defaults
https://github.com/fluid-project/infusion/blob/infusion-1.5/src/framework/core/js/Fluid.js#L1519-L1539
- fluid.fetchResources
https://github.com/fluid-project/infusion/blob/infusion-1.5/src/framework/core/js/FluidRequests.js#L24-L50
- fluid.formatMessage
https://github.com/fluid-project/infusion/blob/infusion-1.5/src/framework/core/js/JavaProperties.js#L93-L115
- fluid.invokeGlobalFunction
https://github.com/fluid-project/infusion/blob/infusion-1.5/src/framework/core/js/Fluid.js#L930-L944
- fluid.registerNamespace
https://github.com/fluid-project/infusion/blob/infusion-1.5/src/framework/core/js/Fluid.js#L957-L966
- fluid.render
https://github.com/fluid-project/infusion/blob/infusion-1.5/src/framework/renderer/js/fluidRenderer.js#L1551-L1570
- fluid.renderer.createRendererSubcomponent
https://github.com/fluid-project/infusion/blob/infusion-1.5/src/framework/renderer/js/RendererUtilities.js#L62-L100
- fluid.renderer.selectorsToCutpoints
https://github.com/fluid-project/infusion/blob/infusion-1.5/src/framework/renderer/js/RendererUtilities.js#L268-L285
- fluid.rendererComponent
https://github.com/fluid-project/infusion/blob/infusion-1.5/src/framework/renderer/js/RendererUtilities.js#L139-L141
- fluid.reRender
https://github.com/fluid-project/infusion/blob/infusion-1.5/src/framework/renderer/js/fluidRenderer.js#L1480-L1527
- fluid.defaults