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 (da...@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 (da...@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:da...@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 <brian.fede...@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
