> > -----Original Message----- > From: David Nalley [mailto:[email protected]] > Sent: Tuesday, October 16, 2012 5:19 AM > To: [email protected] > Subject: Re: [DOCS] Proposed technique for making tooltips from doc XML > files > > > > > David, > > You bring up a question which I meant to ask earlier. Can we be sure > > that the URLs of doc pages won't change over time? I think we can, if > > the following is true: Each Help link in the UI links to a page under > > the correct software version and language on the doc site, like > > http://incubator.apache.org/cloudstack/docs/4.0.0/en-US/about-zones.html > . > > > No - we can't be sure of that. > Our URL will (hopefully) change when we graduate to a TLP - we'll then > have cloudstack.apache.org as our domain. >
David, Sorry, I should have been more specific. I was wondering more about the last part of the URL, the part that Publican generates. I think those parts, like "about-zones.html", will always match the XML filenames in the repo -- and we control those. I hope, and believe, it's easy enough to set the code up to make it easy to swap in a different domain. Anyone who's customizing the UI for any reason will want to do that. Jessica T. CloudStack Tech Pubs > > > > > > I don't know exactly how the UI help would handle l10n. The eng/UI > > teams would know more. We'd have localized content in different > > subdirectories in the git repo, just as we have English content in the > > docs/en-US subdirectory. And the <phrase> tags around the tooltip > > content would still be there just like all other XML tags, which > > translators don't touch. So I imagine the UI could pull tooltip > > content from each language directory in the repo, then at runtime > > display the right tooltip strings using the same mechanism as is used > for any other localized UI text. > > > That's not how l10n works in Docbook - take a look at docs/runbook/zh-CN > which has a Chinese localized version of the 3.0.2 runbook. There's not > even XML, hence my 'how is this gonna work' > question. > > --David >
