You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cloudstack.apache.org by Joe Brockmeier <jz...@zonker.net> on 2013/06/22 22:01:11 UTC
Re: [DISCUSS]- Dynamic Rendering of tooltip Content from the
documentation
Was there any resolution to this thread? I have not seen one, but I see
several bugs filed for tooltip documentation.
What's up here? Can someone provide an update and instructions on how
tooltip documentation is supposed to be added if the feature is present
in 4.2?
Note, I've raised this question to the list previously to deafening
silence:
http://markmail.org/message/pkxucyto36a4k4ik
On Fri, Mar 8, 2013, at 01:14 PM, Parth Jagirdar wrote:
> This is nice.
>
> Whatever the approach we agree upon, I will contribute towards this
> feature.
>
>
> Thanks,
> .. Parth
>
>
> -----Original Message-----
> From: rohityadav89@gmail.com [mailto:rohityadav89@gmail.com] On Behalf Of
> Rohit Yadav
> Sent: Thursday, March 07, 2013 11:56 AM
> To: cloudstack-dev@incubator.apache.org
> Cc: Parth Jagirdar; Brian Federle; Jessica Tomechak; David Nalley
> (david@gnsa.us)
> Subject: Re: [DISCUSS]- Dynamic Rendering of tooltip Content from the
> documentation
>
> Oh I just saw tooltip and javascript, and I dislike that js
> implementations for tooltips consume a lot of resources; so let me
> promote my friend's tooltip framework that is pure css :)
> https://github.com/chinchang/hint.css
>
> Regards.
>
> On Thu, Mar 7, 2013 at 11:51 PM, Pranav Saxena <pr...@citrix.com>
> wrote:
> > Yes exactly . These set of changes are from the documentation point of view . These Id's and xref tags would be picked up by a py script to convert the content into a json response which can further be rendered by javascript.
> >
> > Thanks for looking into this.
> >
> > Thanks,
> > Pranav
> >
> > -----Original Message-----
> > From: Parth Jagirdar
> > Sent: Thursday, March 07, 2013 11:36 PM
> > To: Pranav Saxena; cloudstack-dev@incubator.apache.org
> > Cc: Brian Federle; Jessica Tomechak; David Nalley (david@gnsa.us)
> > Subject: RE: [DISCUSS]- Dynamic Rendering of tooltip Content from the
> > documentation
> >
> > Is this what you have in mind?
> >
> > http://www.sagehill.net/docbookxsl/CrossRefs.html#OptsGenXref
> >
> >
> > Thanks,
> > .. Parth
> >
> > -----Original Message-----
> > From: Pranav Saxena
> > Sent: Wednesday, March 06, 2013 8:26 PM
> > To: cloudstack-dev@incubator.apache.org
> > Cc: Brian Federle; Parth Jagirdar; Jessica Tomechak; David Nalley
> > (david@gnsa.us)
> > Subject: [DISCUSS]- Dynamic Rendering of tooltip Content from the
> > documentation
> >
> > Hi,
> >
> > I would like to propose a new feature here to effectively render the content from the documentation xml files to be displayed in the tooltip dynamically . The idea is to associate a " xref tag" with every major entity /form field /feature in the documentation notes , which could be parsed by a python script using the xpath module and generate a json-formatted javascript file .
> >
> > Currently all the content displayed in the tooltips is hardcoded in a javascript file which gets rendered based on a doc ID. With the introduction of "xref tags" in the documentation notes, this javascript file would be generated during the build time and stored in the UI folder from where the content would be rendered dynamically based on the above mentioned approach .
> >
> > If the community is satisfied with the proposal , then I would take it forward , working in collaboration with few other folks as well to implement this . May be , I could put up a detailed FS for this . This is just a novice level discussion and I believe , we would still need to refine the approach based on the community comments/reviews.
> >
> > Thoughts /Flames ?
> >
> > Regards,
> > Pranav
> >
> > -----Original Message-----
> > From: David Nalley [mailto:david@gnsa.us]
> > Sent: Saturday, March 02, 2013 12:18 AM
> > To: cloudstack-dev@incubator.apache.org
> > Subject: Re: Help tooltip for form fields
> >
> > On Mon, Oct 22, 2012 at 6:27 PM, Brian Federle <Br...@citrix.com> wrote:
> >> Hi All,
> >>
> >> I have completed the tooltip feature, which appears for most form fields in the UI.
> >>
> >> Note that right now we had to embed the documentation strings into the source due to technical limitations. In the future we'll work to get this data dynamically, so it is easier to fix typos, etc., without having to commit directly to the source.
> >>
> >> If you need to modify any of the documentation data, please update the file /ui/scripts/docs.js. This contains key/value pairs with the key indicating which field in the UI that particular string is for.
> >>
> >> Functional spec is @
> >> https://cwiki.apache.org/CLOUDSTACK/ui-dynamic-tooltip.html
> >>
> >> Committed to master branch only right now.
> >>
> >> Thanks,
> >> Brian
> >
> >
> > Hi Brian,
> >
> > I think I missed this message originally, and Jessica drew my attention to it.
> >
> > It's been 4 months since this message was sent. Has there been any progress on making the strings come from actual docs per the original func spec?
> > How does the current implementation deal with l10n?
> >
> > My concern is that 'temporary' becomes permanent in a lot of cases, and the key-value pair system with what appears to be no capability for l10n is troubling.
> >
> > --David
Best,
jzb
--
Joe Brockmeier
jzb@zonker.net
Twitter: @jzb
http://www.dissociatedpress.net/
RE: [DISCUSS]- Dynamic Rendering of tooltip Content from the
documentation
Posted by Pranav Saxena <pr...@citrix.com>.
Due to time constraints for developing the UI for so many other features for 4.2 , unfortunately this dynamic loading of content on the tooltip would have to be targeted for the next release . Currently , the only way to add tooltip information is to hardcode the content in docs.js file .
The bugs related to tooltip would be addressed pretty soon though .
Thanks,
Pranav
-----Original Message-----
From: Jessica Tomechak
Sent: Monday, June 24, 2013 11:36 PM
To: Joe Brockmeier; cloudstack-dev@incubator.apache.org; Rohit Yadav
Cc: Brian Federle; David Nalley (david@gnsa.us); Pranav Saxena
Subject: RE: [DISCUSS]- Dynamic Rendering of tooltip Content from the documentation
Joe,
I agree with the deafening silence comment. I have not seen any resolution either.
Cc'ing Pranav, since he was the one proposing to make an FS for the auto-tooltip feature.
Thanks,
Jessica Tomechak
-----Original Message-----
From: Joe Brockmeier [mailto:jzb@zonker.net]
Sent: Saturday, June 22, 2013 1:01 PM
To: cloudstack-dev@incubator.apache.org; Rohit Yadav
Cc: Brian Federle; Jessica Tomechak; David Nalley (david@gnsa.us)
Subject: Re: [DISCUSS]- Dynamic Rendering of tooltip Content from the documentation
Was there any resolution to this thread? I have not seen one, but I see several bugs filed for tooltip documentation.
What's up here? Can someone provide an update and instructions on how tooltip documentation is supposed to be added if the feature is present in 4.2?
Note, I've raised this question to the list previously to deafening
silence:
http://markmail.org/message/pkxucyto36a4k4ik
On Fri, Mar 8, 2013, at 01:14 PM, Parth Jagirdar wrote:
> This is nice.
>
> Whatever the approach we agree upon, I will contribute towards this
> feature.
>
>
> Thanks,
> .. Parth
>
>
> -----Original Message-----
> From: rohityadav89@gmail.com [mailto:rohityadav89@gmail.com] On Behalf
> Of Rohit Yadav
> Sent: Thursday, March 07, 2013 11:56 AM
> To: cloudstack-dev@incubator.apache.org
> Cc: Parth Jagirdar; Brian Federle; Jessica Tomechak; David Nalley
> (david@gnsa.us)
> Subject: Re: [DISCUSS]- Dynamic Rendering of tooltip Content from the
> documentation
>
> Oh I just saw tooltip and javascript, and I dislike that js
> implementations for tooltips consume a lot of resources; so let me
> promote my friend's tooltip framework that is pure css :)
> https://github.com/chinchang/hint.css
>
> Regards.
>
> On Thu, Mar 7, 2013 at 11:51 PM, Pranav Saxena
> <pr...@citrix.com>
> wrote:
> > Yes exactly . These set of changes are from the documentation point of view . These Id's and xref tags would be picked up by a py script to convert the content into a json response which can further be rendered by javascript.
> >
> > Thanks for looking into this.
> >
> > Thanks,
> > Pranav
> >
> > -----Original Message-----
> > From: Parth Jagirdar
> > Sent: Thursday, March 07, 2013 11:36 PM
> > To: Pranav Saxena; cloudstack-dev@incubator.apache.org
> > Cc: Brian Federle; Jessica Tomechak; David Nalley (david@gnsa.us)
> > Subject: RE: [DISCUSS]- Dynamic Rendering of tooltip Content from
> > the documentation
> >
> > Is this what you have in mind?
> >
> > http://www.sagehill.net/docbookxsl/CrossRefs.html#OptsGenXref
> >
> >
> > Thanks,
> > .. Parth
> >
> > -----Original Message-----
> > From: Pranav Saxena
> > Sent: Wednesday, March 06, 2013 8:26 PM
> > To: cloudstack-dev@incubator.apache.org
> > Cc: Brian Federle; Parth Jagirdar; Jessica Tomechak; David Nalley
> > (david@gnsa.us)
> > Subject: [DISCUSS]- Dynamic Rendering of tooltip Content from the
> > documentation
> >
> > Hi,
> >
> > I would like to propose a new feature here to effectively render the content from the documentation xml files to be displayed in the tooltip dynamically . The idea is to associate a " xref tag" with every major entity /form field /feature in the documentation notes , which could be parsed by a python script using the xpath module and generate a json-formatted javascript file .
> >
> > Currently all the content displayed in the tooltips is hardcoded in a javascript file which gets rendered based on a doc ID. With the introduction of "xref tags" in the documentation notes, this javascript file would be generated during the build time and stored in the UI folder from where the content would be rendered dynamically based on the above mentioned approach .
> >
> > If the community is satisfied with the proposal , then I would take it forward , working in collaboration with few other folks as well to implement this . May be , I could put up a detailed FS for this . This is just a novice level discussion and I believe , we would still need to refine the approach based on the community comments/reviews.
> >
> > Thoughts /Flames ?
> >
> > Regards,
> > Pranav
> >
> > -----Original Message-----
> > From: David Nalley [mailto:david@gnsa.us]
> > Sent: Saturday, March 02, 2013 12:18 AM
> > To: cloudstack-dev@incubator.apache.org
> > Subject: Re: Help tooltip for form fields
> >
> > On Mon, Oct 22, 2012 at 6:27 PM, Brian Federle <Br...@citrix.com> wrote:
> >> Hi All,
> >>
> >> I have completed the tooltip feature, which appears for most form fields in the UI.
> >>
> >> Note that right now we had to embed the documentation strings into the source due to technical limitations. In the future we'll work to get this data dynamically, so it is easier to fix typos, etc., without having to commit directly to the source.
> >>
> >> If you need to modify any of the documentation data, please update the file /ui/scripts/docs.js. This contains key/value pairs with the key indicating which field in the UI that particular string is for.
> >>
> >> Functional spec is @
> >> https://cwiki.apache.org/CLOUDSTACK/ui-dynamic-tooltip.html
> >>
> >> Committed to master branch only right now.
> >>
> >> Thanks,
> >> Brian
> >
> >
> > Hi Brian,
> >
> > I think I missed this message originally, and Jessica drew my attention to it.
> >
> > It's been 4 months since this message was sent. Has there been any progress on making the strings come from actual docs per the original func spec?
> > How does the current implementation deal with l10n?
> >
> > My concern is that 'temporary' becomes permanent in a lot of cases, and the key-value pair system with what appears to be no capability for l10n is troubling.
> >
> > --David
Best,
jzb
--
Joe Brockmeier
jzb@zonker.net
Twitter: @jzb
http://www.dissociatedpress.net/
RE: [DISCUSS]- Dynamic Rendering of tooltip Content from the
documentation
Posted by Jessica Tomechak <Je...@citrix.com>.
Joe,
I agree with the deafening silence comment. I have not seen any resolution either.
Cc'ing Pranav, since he was the one proposing to make an FS for the auto-tooltip feature.
Thanks,
Jessica Tomechak
-----Original Message-----
From: Joe Brockmeier [mailto:jzb@zonker.net]
Sent: Saturday, June 22, 2013 1:01 PM
To: cloudstack-dev@incubator.apache.org; Rohit Yadav
Cc: Brian Federle; Jessica Tomechak; David Nalley (david@gnsa.us)
Subject: Re: [DISCUSS]- Dynamic Rendering of tooltip Content from the documentation
Was there any resolution to this thread? I have not seen one, but I see several bugs filed for tooltip documentation.
What's up here? Can someone provide an update and instructions on how tooltip documentation is supposed to be added if the feature is present in 4.2?
Note, I've raised this question to the list previously to deafening
silence:
http://markmail.org/message/pkxucyto36a4k4ik
On Fri, Mar 8, 2013, at 01:14 PM, Parth Jagirdar wrote:
> This is nice.
>
> Whatever the approach we agree upon, I will contribute towards this
> feature.
>
>
> Thanks,
> .. Parth
>
>
> -----Original Message-----
> From: rohityadav89@gmail.com [mailto:rohityadav89@gmail.com] On Behalf
> Of Rohit Yadav
> Sent: Thursday, March 07, 2013 11:56 AM
> To: cloudstack-dev@incubator.apache.org
> Cc: Parth Jagirdar; Brian Federle; Jessica Tomechak; David Nalley
> (david@gnsa.us)
> Subject: Re: [DISCUSS]- Dynamic Rendering of tooltip Content from the
> documentation
>
> Oh I just saw tooltip and javascript, and I dislike that js
> implementations for tooltips consume a lot of resources; so let me
> promote my friend's tooltip framework that is pure css :)
> https://github.com/chinchang/hint.css
>
> Regards.
>
> On Thu, Mar 7, 2013 at 11:51 PM, Pranav Saxena
> <pr...@citrix.com>
> wrote:
> > Yes exactly . These set of changes are from the documentation point of view . These Id's and xref tags would be picked up by a py script to convert the content into a json response which can further be rendered by javascript.
> >
> > Thanks for looking into this.
> >
> > Thanks,
> > Pranav
> >
> > -----Original Message-----
> > From: Parth Jagirdar
> > Sent: Thursday, March 07, 2013 11:36 PM
> > To: Pranav Saxena; cloudstack-dev@incubator.apache.org
> > Cc: Brian Federle; Jessica Tomechak; David Nalley (david@gnsa.us)
> > Subject: RE: [DISCUSS]- Dynamic Rendering of tooltip Content from
> > the documentation
> >
> > Is this what you have in mind?
> >
> > http://www.sagehill.net/docbookxsl/CrossRefs.html#OptsGenXref
> >
> >
> > Thanks,
> > .. Parth
> >
> > -----Original Message-----
> > From: Pranav Saxena
> > Sent: Wednesday, March 06, 2013 8:26 PM
> > To: cloudstack-dev@incubator.apache.org
> > Cc: Brian Federle; Parth Jagirdar; Jessica Tomechak; David Nalley
> > (david@gnsa.us)
> > Subject: [DISCUSS]- Dynamic Rendering of tooltip Content from the
> > documentation
> >
> > Hi,
> >
> > I would like to propose a new feature here to effectively render the content from the documentation xml files to be displayed in the tooltip dynamically . The idea is to associate a " xref tag" with every major entity /form field /feature in the documentation notes , which could be parsed by a python script using the xpath module and generate a json-formatted javascript file .
> >
> > Currently all the content displayed in the tooltips is hardcoded in a javascript file which gets rendered based on a doc ID. With the introduction of "xref tags" in the documentation notes, this javascript file would be generated during the build time and stored in the UI folder from where the content would be rendered dynamically based on the above mentioned approach .
> >
> > If the community is satisfied with the proposal , then I would take it forward , working in collaboration with few other folks as well to implement this . May be , I could put up a detailed FS for this . This is just a novice level discussion and I believe , we would still need to refine the approach based on the community comments/reviews.
> >
> > Thoughts /Flames ?
> >
> > Regards,
> > Pranav
> >
> > -----Original Message-----
> > From: David Nalley [mailto:david@gnsa.us]
> > Sent: Saturday, March 02, 2013 12:18 AM
> > To: cloudstack-dev@incubator.apache.org
> > Subject: Re: Help tooltip for form fields
> >
> > On Mon, Oct 22, 2012 at 6:27 PM, Brian Federle <Br...@citrix.com> wrote:
> >> Hi All,
> >>
> >> I have completed the tooltip feature, which appears for most form fields in the UI.
> >>
> >> Note that right now we had to embed the documentation strings into the source due to technical limitations. In the future we'll work to get this data dynamically, so it is easier to fix typos, etc., without having to commit directly to the source.
> >>
> >> If you need to modify any of the documentation data, please update the file /ui/scripts/docs.js. This contains key/value pairs with the key indicating which field in the UI that particular string is for.
> >>
> >> Functional spec is @
> >> https://cwiki.apache.org/CLOUDSTACK/ui-dynamic-tooltip.html
> >>
> >> Committed to master branch only right now.
> >>
> >> Thanks,
> >> Brian
> >
> >
> > Hi Brian,
> >
> > I think I missed this message originally, and Jessica drew my attention to it.
> >
> > It's been 4 months since this message was sent. Has there been any progress on making the strings come from actual docs per the original func spec?
> > How does the current implementation deal with l10n?
> >
> > My concern is that 'temporary' becomes permanent in a lot of cases, and the key-value pair system with what appears to be no capability for l10n is troubling.
> >
> > --David
Best,
jzb
--
Joe Brockmeier
jzb@zonker.net
Twitter: @jzb
http://www.dissociatedpress.net/