Social-Gadget.xml

[api.ll...@gmail.com]

Reviewers: opensocial-and-gadgets-spec_googlegroups.com,

Message:
I've made a lot of progress on the Social-Gadget.xml doc and I'd like to
check it in before the break next week.

To review, start by reading my list of changes below. Then check out
the preview at
http://www.opensocial.org/Technical-Resources/draft/Social-Gadget.xml

Thanks,
Lane


http://codereview.appspot.com/157078/diff/1/2
File OpenSocial-Data-Pipelining.xml (left):

http://codereview.appspot.com/157078/diff/1/2#oldcode233
OpenSocial-Data-Pipelining.xml:233: <section title="Tag:
&lt;os:PeopleRequest&gt;"
moved PeopleRequest, ViewerRequest, OwnerRequest, and ActivitiesRequest
to Social-Gadget.xml

http://codereview.appspot.com/157078/diff/1/4
File OpenSocial-Markup-Language-Tags.xml (left):

http://codereview.appspot.com/157078/diff/1/4#oldcode37
OpenSocial-Markup-Language-Tags.xml:37: <section title="Overview">
Moved all the content to Social-Gadget.xml. We can delete this file.

http://codereview.appspot.com/157078/diff/1/3
File Social-Gadget.xml (left):

http://codereview.appspot.com/157078/diff/1/3#oldcode44
Social-Gadget.xml:44: <section title="Using the API Reference">
Moved Using the API reference to the Core-Gadget spec.

http://codereview.appspot.com/157078/diff/1/3#oldcode86
Social-Gadget.xml:86: <section title="Summary">
Moved osapi examples to be near the methods they are examplifying (not a
word, but should be).

http://codereview.appspot.com/157078/diff/1/3#oldcode505
Social-Gadget.xml:505: auth: {"default" : null, "type" : "AuthToken"},
took auth and appId parameters out of the example, since you can't set
them from the client side calls.

http://codereview.appspot.com/157078/diff/1/3#oldcode777
Social-Gadget.xml:777: <section title="osapi.http"
moved osapi.http to Core-Gadget since it's not social

http://codereview.appspot.com/157078/diff/1/3#oldcode1778
Social-Gadget.xml:1778: <section title="Constructor"
removed docs for constructors since they're not used.

http://codereview.appspot.com/157078/diff/1/3#oldcode1877
Social-Gadget.xml:1877: <section title="BODY"
moved fields to list items, rather than sections. It takes up less
space in the TOC and it's easier on the eyes.

http://codereview.appspot.com/157078/diff/1/3#oldcode1879
Social-Gadget.xml:1879: <t>&lt;static&gt; Member of:
opensocial.Activity.Field.BODY</t>
Got rid of <static> Member of: opensocial.Foo.Field.BAR throughout. Was
this adding value for anyone?!

http://codereview.appspot.com/157078/diff/1/3
File Social-Gadget.xml (right):

http://codereview.appspot.com/157078/diff/1/3#newcode50
Social-Gadget.xml:50: <section title="get"
osapi docs just refer to the parameters in Social-API-Server and the
data objects in Social-Data. Any discrepencies between client and
server side invocation are listed in this doc.

http://codereview.appspot.com/157078/diff/1/3#newcode1171
Social-Gadget.xml:1171: <section title="Deprecated JavaScript API"
anchor="DeprecatedJavaScriptAPI">
Created an appendix for deprecated methods

http://codereview.appspot.com/157078/diff/1/3#newcode1178
Social-Gadget.xml:1178: <t><x:highlight>Deprecated.</x:highlight> Use
<eref
target="./OpenSocial-Specification.xml#osapi.cache.invalidate">osapi.cache.invalidate()</eref>
instead.</t>
Deprecated classes now have pointers to their replacements



Please review this at http://codereview.appspot.com/157078

Affected files:
M OpenSocial-Data-Pipelining.xml
M OpenSocial-Markup-Language-Tags.xml
M Social-Gadget.xml

[jon.we...@gmail.com]

Looks good.

http://codereview.appspot.com/157078/diff/1/3
File Social-Gadget.xml (left):

http://codereview.appspot.com/157078/diff/1/3#oldcode44
Social-Gadget.xml:44: <section title="Using the API Reference">

On 2009/11/19 02:23:23, Lane wrote:
> Moved Using the API reference to the Core-Gadget spec.

I did not find this section anywhere on the preview site?

http://codereview.appspot.com/157078/diff/1/3
File Social-Gadget.xml (right):

http://codereview.appspot.com/157078/diff/1/3#newcode57
Social-Gadget.xml:57: <t hangText="Parameters">This method takes a
single parameter, which is a JavaScript object representing the
parameters defined by the <eref
target="Social-API-Server.xml#People.get">People service's get
method</eref>.</t>
The eref, used many places, has changed. Maybe you wanted:
#People-Service-GetPerson

http://codereview.appspot.com/157078

[Jacky]

big +1! :)