Adding fields to ModulePrefs - help page and support page

[Amar Gandhi]

in orkut, we have need for users to find help and support for apps.

 

the gadget spec at http://code.google.com/apis/gadgets/docs/reference.html#Moduleprefs_Ref doesn't have these fields.  there is author info but i'd imagine most app developers wouldn't want the author_email to be flooded with support issues.

 

so, the proposal is to add two fields to ModulePrefs:

• <help> - Url to help and FAQ about the app
• <support_URL> - Url to page for users to contact the app about issues
• <support_email> - email address to send mail to

feedback welcome.

[Paul Lindner]

I proposed this before but how about using <link> tags. These are
very versatile. In addition to specifying favicons

<ModulePrefs ...>
...
<link rel="gadget help" href="mailto:sup...@example.com"/>
<link rel="gadget support" href="http://www.example.com/support.html"/>
</ModulePrefs>

On Fri, Mar 28, 2008 at 11:09:26AM -0700, Amar Gandhi wrote:
> in orkut, we have need for users to find help and support for apps.
>
> the gadget spec at
> http://code.google.com/apis/gadgets/docs/reference.html#Moduleprefs_Ref
> doesn't have these fields. there is author info but i'd imagine most app
> developers wouldn't want the author_email to be flooded with support issues.
>
> so, the proposal is to add two fields to ModulePrefs:
>

> * <help> - Url to help and FAQ about the app
> * <support_URL> - Url to page for users to contact the app about
> issues
> * <support_email> - email address to send mail to
>
> feedback welcome.
>
> You received this message because you are subscribed to the Google Groups "OpenSocial and Gadgets Specification Discussion" group.
> To post to this group, send email to opensocial-an...@googlegroups.com
> To unsubscribe from this group, send email to opensocial-and-gadg...@googlegroups.com
> For more options, visit this group at http://groups.google.com/group/opensocial-and-gadgets-spec?hl=en
> -~----------~----~----~----~------~----~------~--~---
>

--
Paul Lindner ||||| | | | | | | | | |
lin...@inuus.com

[Amar Gandhi]

The naming style seems inconsistent with rest of ModulePrefs tags which are
named after the purpose.

For example, the tag naming style is <screenshot> and not <img rel="gadget
screenshot" href="url" />

-----Original Message-----
From: opensocial-an...@googlegroups.com
[mailto:opensocial-an...@googlegroups.com] On Behalf Of Paul
Lindner
Sent: Friday, March 28, 2008 4:33 PM
To: opensocial-an...@googlegroups.com
Cc: 'Shauna O'Brien'
Subject: Re: Adding fields to ModulePrefs - help page and support page

I proposed this before but how about using <link> tags. These are very
versatile. In addition to specifying favicons

<ModulePrefs ...>
...
<link rel="gadget help" href="mailto:sup...@example.com"/>
<link rel="gadget support" href="http://www.example.com/support.html"/>
</ModulePrefs>
On Fri, Mar 28, 2008 at 11:09:26AM -0700, Amar Gandhi wrote:
> in orkut, we have need for users to find help and support for apps.
>
> the gadget spec at
> http://code.google.com/apis/gadgets/docs/reference.html#Moduleprefs_Re

> f doesn't have these fields. there is author info but i'd imagine

[Amar Gandhi]

What's the next step here? Ultimately, I'm fine with Paul or my proposal.
How do we decide and make part of the gadget Xml spec?

-----Original Message-----
From: opensocial-an...@googlegroups.com
[mailto:opensocial-an...@googlegroups.com] On Behalf Of Paul
Lindner
Sent: Friday, March 28, 2008 4:33 PM
To: opensocial-an...@googlegroups.com
Cc: 'Shauna O'Brien'
Subject: Re: Adding fields to ModulePrefs - help page and support page

I proposed this before but how about using <link> tags. These are very
versatile. In addition to specifying favicons

<ModulePrefs ...>
...
<link rel="gadget help" href="mailto:sup...@example.com"/>
<link rel="gadget support" href="http://www.example.com/support.html"/>
</ModulePrefs>
On Fri, Mar 28, 2008 at 11:09:26AM -0700, Amar Gandhi wrote:
> in orkut, we have need for users to find help and support for apps.
>
> the gadget spec at
> http://code.google.com/apis/gadgets/docs/reference.html#Moduleprefs_Re

> f doesn't have these fields. there is author info but i'd imagine

[Cassie]

First, we have to figure out what the exact spec change is. This is the spec in question:
http://code.google.com/apis/gadgets/docs/gadgets-extended-xsd.html

I see a couple options which have been discussed:

1. Add three new attributes to ModulePrefs:

<xs:attribute name="help" type="xs:string" use="optional"/>
<xs:attribute name="support_url" type="xs:string" use="optional"/>

<xs:attribute name="support_email" type="xs:string" use="optional"/>

2. Add these things as a subelement of ModulePrefs as link tags, something like this...

<xs:element name="Link">

   <xs:complexType>
      <xs:attribute name="rel" type="xs:string" use="required"/>
      <xs:attribute name="href" type="xs:string" use="required"/>

   </xs:complexType>
</xs:element>

3. Add these things as a subelement each with their own type

<xs:element name="SupportUrl">
   <xs:complexType>
      <xs:attribute name="href" type="xs:string" use="required"/>

   </xs:complexType>
</xs:element>

etc etc

Okay, so I think I got those right but please help me correct these proposals if I am wrong.

Now that they are defined, the second thing we do is vote and strive for consensus. So, readers of this thread - please choose the option you think should be added to the spec for 0.8.

Thanks!

- Cassie

[Graham Spencer]

I like Paul's proposal (#2). I agree with Amar that it doesn't fit the style of existing ModulePrefs elements, so perhaps we could (over time) deprecate the named elements in ModulePrefs when such elements could be represented as link tags instead.

--g

[Amar Gandhi]

i'm fine with either - as long as the usecase is covered.

 

is there a spec czar that can decide - since this thread has gone quiet.  should we treat silence == approval?

---

From: opensocial-an...@googlegroups.com [mailto:opensocial-an...@googlegroups.com] On Behalf Of Graham Spencer
Sent: Wednesday, April 02, 2008 11:44 AM
To: opensocial-an...@googlegroups.com

[Cassie]

Okay, so we have three votes from Amar, Graham and Paul for this spec change:

<xs:element name="Link">
<xs:complexType>
<xs:attribute name="rel" type="xs:string" use="required"/>
<xs:attribute name="href" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>

Where "gadget help" and "gadget support" would be two rel values that
Orkut would support (and hopefully others).

Anybody else want to chime in?

- Cassie

[Zhen Wang]

+1 re: <Link> tags

I also like the idea of migrating named elements in <ModulePrefs> to
<Link> tags.

[Cassie]

+1

This thread has 5 votes and is now considered approved for 0.8 unless there are any objections.
Thanks.

- Cassie