From c9b58526146ea7529bd3b07d57a623255e5cf7f6 Mon Sep 17 00:00:00 2001 From: Colin Kuskie Date: Tue, 6 Jun 2006 04:11:26 +0000 Subject: [PATCH] template variable breakout --- lib/WebGUI/Asset/Wobject/WeatherData.pm | 3 +- lib/WebGUI/Help/Asset_StockData.pm | 261 +++++++++ lib/WebGUI/Help/Asset_WeatherData.pm | 25 +- lib/WebGUI/i18n/English/Asset_StockData.pm | 574 ++++++++----------- lib/WebGUI/i18n/English/Asset_WeatherData.pm | 35 +- 5 files changed, 547 insertions(+), 351 deletions(-) diff --git a/lib/WebGUI/Asset/Wobject/WeatherData.pm b/lib/WebGUI/Asset/Wobject/WeatherData.pm index aeade439b..4e4aee1b2 100644 --- a/lib/WebGUI/Asset/Wobject/WeatherData.pm +++ b/lib/WebGUI/Asset/Wobject/WeatherData.pm @@ -77,7 +77,8 @@ sub definition { =head2 _getLocationData ( ) -Accepts an array ref of locations, and returns +Accepts a location, and returns a hashref of information about the weather +at that location. =cut diff --git a/lib/WebGUI/Help/Asset_StockData.pm b/lib/WebGUI/Help/Asset_StockData.pm index 8c664f3fe..e2c8c6ca0 100644 --- a/lib/WebGUI/Help/Asset_StockData.pm +++ b/lib/WebGUI/Help/Asset_StockData.pm @@ -76,6 +76,145 @@ our $HELP = { body => 'help_stock_list_template_description', fields => [ ], + variables => [ + { + 'name' => 'extrasFolder' + }, + { + 'name' => 'editUrl' + }, + { + 'name' => 'isVisitor' + }, + { + 'name' => 'stock.display.url' + }, + { + 'name' => 'lastUpdate.default' + }, + { + 'name' => 'lastUpdate.intl' + }, + { + 'name' => 'lastUpdate.us' + }, + { + 'name' => 'stocks.loop', + 'variables' => [ + { + 'name' => 'stocks.symbol' + }, + { + 'name' => 'stocks.name' + }, + { + 'name' => 'stocks.last' + }, + { + 'name' => 'stocks.high' + }, + { + 'name' => 'stocks.low' + }, + { + 'name' => 'stocks.date' + }, + { + 'name' => 'stocks.time' + }, + { + 'name' => 'stocks.net' + }, + { + 'name' => 'stocks.net.isDown' + }, + { + 'name' => 'stocks.net.isUp' + }, + { + 'name' => 'stocks.net.noChange' + }, + { + 'name' => 'stocks.net.icon' + }, + { + 'name' => 'stocks.p_change' + }, + { + 'name' => 'stocks.volume' + }, + { + 'name' => 'stocks.volume.millions' + }, + { + 'name' => 'stocks.avg_vol' + }, + { + 'name' => 'stocks.bid' + }, + { + 'name' => 'stocks.ask' + }, + { + 'name' => 'stocks.close' + }, + { + 'name' => 'stocks.open' + }, + { + 'name' => 'stocks.day_range' + }, + { + 'name' => 'stocks.year_range' + }, + { + 'name' => 'stocks.year_high' + }, + { + 'name' => 'stocks.year_low' + }, + { + 'name' => 'stocks.eps' + }, + { + 'name' => 'stocks.pe' + }, + { + 'name' => 'stocks.div_date' + }, + { + 'name' => 'stocks.div' + }, + { + 'name' => 'stocks.div_yield' + }, + { + 'name' => 'stocks.cap' + }, + { + 'name' => 'stocks.ex_div' + }, + { + 'name' => 'stocks.nav' + }, + { + 'name' => 'stocks.yield' + }, + { + 'name' => 'stocks.exchange' + }, + { + 'name' => 'stocks.success' + }, + { + 'name' => 'stocks.errormsg' + }, + { + 'name' => 'stocks.method' + } + ] + } + ], related => [ { tag => 'stock list display template', @@ -96,6 +235,128 @@ our $HELP = { body => 'help_stock_list_display_template_description', fields => [ ], + variables => [ + { + 'name' => 'extrasFolder', + }, + { + 'name' => 'lastUpdate.intl', + }, + { + 'name' => 'lastUpdate.us', + }, + { + 'name' => 'stocks.symbol', + }, + { + 'name' => 'stocks.name', + }, + { + 'name' => 'stocks.last', + }, + { + 'name' => 'stocks.high', + }, + { + 'name' => 'stocks.low', + }, + { + 'name' => 'stocks.date', + }, + { + 'name' => 'stocks.time', + }, + { + 'name' => 'stocks.net', + }, + { + 'name' => 'stocks.net.isDown', + }, + { + 'name' => 'stocks.net.isUp', + }, + { + 'name' => 'stocks.net.noChange', + }, + { + 'name' => 'stocks.net.icon', + }, + { + 'name' => 'stocks.p_change', + }, + { + 'name' => 'stocks.volume', + }, + { + 'name' => 'stocks.volume.millions', + }, + { + 'name' => 'stocks.avg_vol', + }, + { + 'name' => 'stocks.bid', + }, + { + 'name' => 'stocks.ask', + }, + { + 'name' => 'stocks.close', + }, + { + 'name' => 'stocks.open', + }, + { + 'name' => 'stocks.day_range', + }, + { + 'name' => 'stocks.year_range', + }, + { + 'name' => 'stocks.year_high', + }, + { + 'name' => 'stocks.year_low', + }, + { + 'name' => 'stocks.eps', + }, + { + 'name' => 'stocks.pe', + }, + { + 'name' => 'stocks.div_date', + }, + { + 'name' => 'stocks.div', + }, + { + 'name' => 'stocks.div_yield', + }, + { + 'name' => 'stocks.cap', + }, + { + 'name' => 'stocks.ex_div', + }, + { + 'name' => 'stocks.nav', + }, + { + 'name' => 'stocks.yield', + }, + { + 'name' => 'stocks.exchange', + }, + { + 'name' => 'stocks.success', + }, + { + 'name' => 'stocks.errormsg', + }, + { + 'name' => 'stocks.method', + } + ], related => [ { tag => 'stock list template', diff --git a/lib/WebGUI/Help/Asset_WeatherData.pm b/lib/WebGUI/Help/Asset_WeatherData.pm index 521a61028..93604a9f8 100644 --- a/lib/WebGUI/Help/Asset_WeatherData.pm +++ b/lib/WebGUI/Help/Asset_WeatherData.pm @@ -26,12 +26,35 @@ our $HELP = { }, ], }, + 'weatherdata template' => { title => 'WeatherData template title', body => 'WeatherData template description', fields => [ ], - related => [ + variables => [ + { + 'name' => 'ourLocations.loop', + 'variables' => [ + { + 'name' => 'query' + }, + { + 'name' => 'cityState' + }, + { + 'name' => 'sky' + }, + { + 'name' => 'tempF' + }, + { + 'name' => 'iconUrl' + } + ] + } + ], + related => [ { tag => 'weather data add/edit', namespace => 'Asset_WeatherData' diff --git a/lib/WebGUI/i18n/English/Asset_StockData.pm b/lib/WebGUI/i18n/English/Asset_StockData.pm index e2be2af82..429096ab0 100644 --- a/lib/WebGUI/i18n/English/Asset_StockData.pm +++ b/lib/WebGUI/i18n/English/Asset_StockData.pm @@ -153,194 +153,235 @@ our $I18N = { lastUpdated => 1119066250 }, + 'extrasFolder' => { + message => q|The url to the extras folder containing css files and images used by the Stock List application|, + lastUpdated => 1149565312, + }, + + 'editUrl' => { + message => q|The url to the page where users can customize stocks|, + lastUpdated => 1149565312, + }, + + 'isVisitor' => { + message => q|Whether or not the current user is a visitor. This returns true if the users is authenticated against the system|, + lastUpdated => 1149565312, + }, + + 'stock.display.url' => { + message => q|General url to the page that displays details for individual stocks. A stock symbol must be added to the end of this url|, + lastUpdated => 1149565312, + }, + + 'lastUpdate.default' => { + message => q|default date and time format for the date and time stocks were updated by the returning sources|, + lastUpdated => 1149565312, + }, + + 'lastUpdate.intl' => { + message => q|international date and time format for the date and time stocks were updated by the returning sources|, + lastUpdated => 1149565312, + }, + + 'lastUpdate.us' => { + message => q|US date and time format for the date and time stocks were updated by the returning sources|, + lastUpdated => 1149565312, + }, + + 'stocks.loop' => { + message => q|Loop containing all default or personalized stocks|, + lastUpdated => 1149565312, + }, + + 'stocks.symbol' => { + message => q|Stock Symbol|, + lastUpdated => 1149565312, + }, + + 'stocks.name' => { + message => q|Company or Mutual Fund Name|, + lastUpdated => 1149565312, + }, + + 'stocks.last' => { + message => q|Last Price|, + lastUpdated => 1149565312, + }, + + 'stocks.high' => { + message => q|Highest trade today|, + lastUpdated => 1149565312, + }, + + 'stocks.low' => { + message => q|Lowest trade today|, + lastUpdated => 1149565312, + }, + + 'stocks.date' => { + message => q|Last Trade Date (MM/DD/YY format)|, + lastUpdated => 1149565312, + }, + + 'stocks.time' => { + message => q|Last Trade Time|, + lastUpdated => 1149565312, + }, + + 'stocks.net' => { + message => q|Net Change|, + lastUpdated => 1149565312, + }, + + 'stocks.net.isDown' => { + message => q|Net Change is negative|, + lastUpdated => 1149565312, + }, + + 'stocks.net.isUp' => { + message => q|Net Change is positive|, + lastUpdated => 1149565312, + }, + + 'stocks.net.noChange' => { + message => q|Net Change is zero|, + lastUpdated => 1149565312, + }, + + 'stocks.net.icon' => { + message => q|Icon associated with net change (up, down, even)|, + lastUpdated => 1149565312, + }, + + 'stocks.p_change' => { + message => q|Percent Change from previous day's close|, + lastUpdated => 1149565312, + }, + + 'stocks.volume' => { + message => q|Day's Volume|, + lastUpdated => 1149565312, + }, + + 'stocks.volume.millions' => { + message => q|Day's Volume In Millions|, + lastUpdated => 1149565312, + }, + + 'stocks.avg_vol' => { + message => q|Average Daily Vol|, + lastUpdated => 1149565312, + }, + + 'stocks.bid' => { + message => q|Bid|, + lastUpdated => 1149565312, + }, + + 'stocks.ask' => { + message => q|Ask|, + lastUpdated => 1149565312, + }, + + 'stocks.close' => { + message => q|Previous Close|, + lastUpdated => 1149565312, + }, + + 'stocks.open' => { + message => q|Today's Open|, + lastUpdated => 1149565312, + }, + + 'stocks.day_range' => { + message => q|Day's Range|, + lastUpdated => 1149565312, + }, + + 'stocks.year_range' => { + message => q|52-Week Range|, + lastUpdated => 1149565312, + }, + + 'stocks.year_high' => { + message => q|52-Week High|, + lastUpdated => 1149565312, + }, + + 'stocks.year_low' => { + message => q|52-Week Low|, + lastUpdated => 1149565312, + }, + + 'stocks.eps' => { + message => q|Earnings per Share|, + lastUpdated => 1149565312, + }, + + 'stocks.pe' => { + message => q|P/E Ratio|, + lastUpdated => 1149565312, + }, + + 'stocks.div_date' => { + message => q|Dividend Pay Date|, + lastUpdated => 1149565312, + }, + + 'stocks.div' => { + message => q|Dividend per Share|, + lastUpdated => 1149565312, + }, + + 'stocks.div_yield' => { + message => q|Dividend Yield|, + lastUpdated => 1149565312, + }, + + 'stocks.cap' => { + message => q|Market Capitalization|, + lastUpdated => 1149565312, + }, + + 'stocks.ex_div' => { + message => q|Ex-Dividend Date.|, + lastUpdated => 1149565312, + }, + + 'stocks.nav' => { + message => q|Net Asset Value|, + lastUpdated => 1149565312, + }, + + 'stocks.yield' => { + message => q|Yield (usually 30 day avg)|, + lastUpdated => 1149565312, + }, + + 'stocks.exchange' => { + message => q|The exchange the information was obtained from.|, + lastUpdated => 1149565312, + }, + + 'stocks.success' => { + message => q|Did the stock successfully return information? (true/false)|, + lastUpdated => 1149565312, + }, + + 'stocks.errormsg' => { + message => q|If success is false, this field may contain the reason why.|, + lastUpdated => 1149565312, + }, + + 'stocks.method' => { + message => q|The module (as could be passed to fetch) which found this information.|, + lastUpdated => 1149565312, + }, + 'help_stock_list_template_description' => { message => q|

The following describes the list of available template variables for building StockList templates

- -

extrasFolder
-The url to the extras folder containing css files and images used by the Stock List application -

- -

editUrl
-The url to the page where users can customize stocks -

- -

isVisitor
-Whether or not the current user is a visitor. This returns true if the users is authenticated against the system -

- -

stock.display.url
-General url to the page that displays details for individual stocks. A stock symbol must be added to the end of this url -

- -

lastUpdate.default
-default date and time format for the date and time stocks were updated by the returning sources -

- -

lastUpdate.intl
-international date and time format for the date and time stocks were updated by the returning sources -

- -

lastUpdate.us
-US date and time format for the date and time stocks were updated by the returning sources -

- -

stocks.loop
-Loop containing all default or personalized stocks -

- -
- -

stocks.symbol
-Stock Symbol -

- -

stocks.name
-Company or Mutual Fund Name -

- -

stocks.last
-Last Price -

- -

stocks.high
-Highest trade today -

- -

stocks.low
-Lowest trade today -

- -

stocks.date
-Last Trade Date (MM/DD/YY format) -

- -

stocks.time
-Last Trade Time -

- -

stocks.net
-Net Change -

- -

stocks.net.isDown
-Net Change is negative -

- -

stocks.net.isUp
-Net Change is positive -

- -

stocks.net.noChange
-Net Change is zero -

- -

stocks.net.icon
-Icon associated with net change (up, down, even) -

- -

stocks.p_change
-Percent Change from previous day's close -

- -

stocks.volume
-Day's Volume -

- -

stocks.volume.millions
-Day's Volume In Millions -

- -

stocks.avg_vol
-Average Daily Vol -

- -

stocks.bid
-Bid -

- -

stocks.ask
-Ask -

- -

stocks.close
-Previous Close -

- -

stocks.open
-Today's Open -

- -

stocks.day_range
-Day's Range -

- -

stocks.year_range
-52-Week Range -

- -

stocks.year_high
-52-Week High -

- -

stocks.year_low
-52-Week Low -

- -

stocks.eps
-Earnings per Share -

- -

stocks.pe
-P/E Ratio -

- -

stocks.div_date
-Dividend Pay Date -

- -

stocks.div
-Dividend per Share -

- -

stocks.div_yield
-Dividend Yield -

- -

stocks.cap
-Market Capitalization -

- -

stocks.ex_div
-Ex-Dividend Date. -

- -

stocks.nav
-Net Asset Value -

- -

stocks.yield
-Yield (usually 30 day avg) -

- -

stocks.exchange
-The exchange the information was obtained from. -

- -

stocks.success
-Did the stock successfully return information? (true/false) -

- -

stocks.errormsg
-If success is false, this field may contain the reason why. -

- -

stocks.method
-The module (as could be passed to fetch) which found this information. -

- -
|, - lastUpdated => 1146785833 + lastUpdated => 1149565354 }, 'help_stock_list_display_template' => { @@ -350,169 +391,8 @@ The module (as could be passed to fetch) which found this information. 'help_stock_list_display_template_description' => { message => q|

The following describes the list of available template variables for building StockList templates

- -

extrasFolder
-The url to the extras folder containing css files and images used by the Stock List application -

- -

lastUpdate.intl
-international date and time format for the date and time stocks were updated by the returning sources -

- -

lastUpdate.us
-US date and time format for the date and time stocks were updated by the returning sources -

- -

stocks.symbol
-Stock Symbol -

- -

stocks.name
-Company or Mutual Fund Name -

- -

stocks.last
-Last Price -

- -

stocks.high
-Highest trade today -

- -

stocks.low
-Lowest trade today -

- -

stocks.date
-Last Trade Date (MM/DD/YY format) -

- -

stocks.time
-Last Trade Time -

- -

stocks.net
-Net Change -

- -

stocks.net.isDown
-Net Change is negative -

- -

stocks.net.isUp
-Net Change is positive -

- -

stocks.net.noChange
-Net Change is zero -

- -

stocks.net.icon
-Icon associated with net change (up, down, even) -

- -

stocks.p_change
-Percent Change from previous day's close -

- -

stocks.volume
-Day's Volume -

- -

stocks.volume.millions
-Day's Volume In Millions -

- -

stocks.avg_vol
-Average Daily Vol -

- -

stocks.bid
-Bid -

- -

stocks.ask
-Ask -

- -

stocks.close
-Previous Close -

- -

stocks.open
-Today's Open -

- -

stocks.day_range
-Day's Range -

- -

stocks.year_range
-52-Week Range -

- -

stocks.year_high
-52-Week High -

- -

stocks.year_low
-52-Week Low -

- -

stocks.eps
-Earnings per Share -

- -

stocks.pe
-P/E Ratio -

- -

stocks.div_date
-Dividend Pay Date -

- -

stocks.div
-Dividend per Share -

- -

stocks.div_yield
-Dividend Yield -

- -

stocks.cap
-Market Capitalization -

- -

stocks.ex_div
-Ex-Dividend Date. -

- -

stocks.nav
-Net Asset Value -

- -

stocks.yield
-Yield (usually 30 day avg) -

- -

stocks.exchange
-The exchange the information was obtained from. -

- -

stocks.success
-Did the stock successfully return information? (true/false) -

- -

stocks.errormsg
-If success is false, this field may contain the reason why. -

- -

stocks.method
-The module (as could be passed to fetch) which found this information. -

- |, - lastUpdated => 1146786317 + lastUpdated => 1149567007 }, }; diff --git a/lib/WebGUI/i18n/English/Asset_WeatherData.pm b/lib/WebGUI/i18n/English/Asset_WeatherData.pm index 5a596a440..6ff319b7a 100644 --- a/lib/WebGUI/i18n/English/Asset_WeatherData.pm +++ b/lib/WebGUI/i18n/English/Asset_WeatherData.pm @@ -43,10 +43,41 @@ our $I18N = { lastUpdated => 1133619940, }, + 'ourLocations.loop' => { + message => q|A loop containing weather information for all configured user locations.|, + lastUpdated => 1149565151, + }, + + 'query' => { + message => q|The requested location.|, + lastUpdated => 1149565151, + }, + + 'cityState' => { + message => q|The city and state returned from the NOAA. This will probably be the same as query.|, + lastUpdated => 1149565151, + }, + + 'sky' => { + message => q|The condition of the sky, i.e. clear, sunny, cloudy, etc.|, + lastUpdated => 1149565151, + }, + + 'tempF' => { + message => q|The temperature in degrees Farenheit.|, + lastUpdated => 1149565151, + }, + + 'iconUrl' => { + message => q|The URL to an icon that represents visually the condition of the sky.|, + lastUpdated => 1149565151, + }, + 'WeatherData template description' => { - message => q|The wobject generates a loops of locations - tmpl_loop ourLocations.|, - lastUpdated => 1133619940, + message => q|

These template variables are available in the WeatherData template:

+|, + lastUpdated => 1149565185, },