Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FLUID-5249: New documentation covering framework reorganisation under FLUID-5249 #63

Merged
merged 13 commits into from Aug 26, 2015

Conversation

amb26
Copy link
Member

@amb26 amb26 commented Apr 22, 2015

and other JIRAs. Documentation for new features for ContextAwareness (FLUID-5264) and Priority (FLUID-5506) features

… FLUID-5249 and other JIRAs. Documentation for new features for ContextAwareness (FLUID-5264) and Priority (FLUID-5506) features
…it, ii) removal of surplus framework grades, iii) new ContextAwareness API
Conflicts:
	src/documents/ComponentConfigurationOptions.md
	src/documents/ComponentGrades.md
	src/documents/InfusionEventSystem.md
	src/documents/IoCReferences.md
	src/documents/IoCSS.md
@@ -18,10 +18,9 @@ Rename "fluid.prefs.enactors" to "fluid.prefs.enactor"

<div class="infusion-docs-note"><strong>Note:</strong> According to the [comment](https://github.com/fluid-project/infusion/blob/master/src/framework/core/js/FluidView.js#L38-L39) on the implementation for relay components, in Infusion 2.0, relay components will be renamed back to its original names. If the rename has been made, this section can be ignored.</div>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we update this comment to clearly describe the reality that the base component grades have been renamed?

Also, can we document other 1.5-2.0 changes such as the removal of demands blocks, non-dynamic invokers, etc.?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also notice that the list of options supported by all components has changed, we should probably mention that. Also, the 'applier' option of modelComponents seems to be gone...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also see that grade linkages have been removed, we should mention that

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

onAttach and onClear have been removed

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

gradeLinkage to me counts as a "less widely-used feature" so I added an entry to it in the DeprecationsIn1_5 page referred to at the head of the list

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the pointer, @amb26, I forgot to check the deprecations page. Should we be adding a DeprecationsIn2_0 page?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mention the change from fluid.event.makeEventFirer to fluid.makeEventFirer?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

priority and namespace added to distributeOptions possibilities

@amb26
Copy link
Member Author

amb26 commented Aug 17, 2015

@colinbdclark , @acheetham - ready for another look. I've also made some fixes to styling, global structure and the docpad scripts.

@@ -39,14 +39,25 @@
[
{ "pageName": "Events", "href": "/Events.html" },
{ "pageName": "Infusion Event System", "href": "/InfusionEventSystem.html" },
{ "pageName": "Priorities", "href": "/Priorities.html" },
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given that priorities apply to so much more than just events, I wonder if we should put this in a different section of the ToC - maybe the "Defining Components" section, since that's where most of the broadly-relevant stuff is.

@acheetham
Copy link
Member

The file Events.md doesn't really seem to serve much purpose. Could we get rid of it?

@acheetham
Copy link
Member

There are some problems with the UIO integration. It works and all, but a) the button is about one pixel high; b) when the panel opens and the page slides down, the ToC doesn’t also slide down.

@acheetham
Copy link
Member

I like the separate scrolling for the ToC and the content, but on pages that are very short, the footer is floating up in the middle of the page. We should try to have the minimum height of the page be the window height.

@acheetham
Copy link
Member

There's supposed to be a gap between the main header of the page and the upper black nav bar, but that seems to be gone now, and it looks rather crowded.

@acheetham
Copy link
Member

The ToC link to APIChangesFrom1_5to2_0.html doesn't actually contain any text; can't tell why. The link is there in the generated html, but without any text in it.


Rename "fluid.prefs.enactors" to "fluid.prefs.enactor"
This section describes major APIs that were in common use. For information about less widely-used features removed in 2.0, consult [Deprecations in 1.5)(DeprecationsIn1_5.md).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo in this link: ) should be ]

@amb26
Copy link
Member Author

amb26 commented Aug 19, 2015

Addressed most of the recent comments - UIO is working again, but I didn't have much luck with the footer - I don't think this can be tackled without changing the containment structure of the markup significantly (I already moved up the footer several levels in the document to prevent it bashing into the "position:fixed" TOC at the left). Perhaps @jhung has some ideas - Cheers

* **model** and **evented components** add support for models and events (respectively) to **little components**
* **view components** support models and events, and also add support for views.
* **model** components add support for models to **plain components**
* **view components** support models, and also add support for views.
* **renderer components** are **view components** with the [Renderer](../Renderer.md) added.

![A venn diagram showing the composition of grades](../images/component-grades-venn-diagram.svg)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This venn diagram needs updating; the paragraph below it still refers to "little component"; the "next" link at the end needs updating

@acheetham
Copy link
Member

The link at the bottom of the "getting started" tutorial's Model Components page still points to the now non-existent Evented Components page

@acheetham
Copy link
Member

The paragraph at the top of the "getting started" tutorial's View Components page still refers to little and evented components.

@acheetham
Copy link
Member

The "Defining components" link at the top of the "Using String Templates" tutorial still links to the little components page

console.log("Event listener received number " + number + " and condition " + condition);
};

fluid.defaults("examples.eventedComponent", {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it make sense to use "evented" in the name of the component, now that everything is evented by default?

@acheetham
Copy link
Member

The "getting started" tutorial's Renderer Components page still has a link to the Evented Components page

@acheetham
Copy link
Member

The Event Injection and Boiling page has a link with link text "eventedComponent" – should probably just be "comonent"?

Events in Infusion are model-oriented, and aren't specific to the DOM. [Events](InfusionEventSystem.md) have a very plain implementation in Infusion &#8212; an event here is really just another kind of function call.
Any function signature can be an event signature, any function can be an event listener, and an event's `fire` method is a plain function handle that can be handed around just like any other function.
There is no special kind of "Event Object" that gets handed around to event listeners, and anyone can easily define a new event by simply calling `fluid.makeEventFirer()`.
In practice, users should use the events which are created automatically by the framework as part of the initialisation of every [Component](tutorial-gettingStartedWithInfusion/EventedComponents.md).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link is still referencing the EventedComponents page

@acheetham
Copy link
Member

The link to the "API Changes from 1.5 to 2.0" page is still broken in the ToC

@amb26
Copy link
Member Author

amb26 commented Aug 20, 2015

"API Changes from 1.5 to 2.0" works for me - what do you observe when operating the link? Does the URL look correct? Does a file like the one it is pointing to exist in the "out" directory?

@amb26
Copy link
Member Author

amb26 commented Aug 20, 2015

Ready for further further review

@acheetham acheetham merged commit 2135d12 into fluid-project:master Aug 26, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants