Changes between Version 4 and Version 5 of TracYetAnotherChartMacro

Timestamp:

May 15, 2018, 6:34:09 PM (6 years ago)

Author:

figaro

Comment:

Cosmetic changes

TracYetAnotherChartMacro

@@ -3 +3 @@
 = Creare bar/line/pie charts of query results
 
+{{{#!box info
+'''Notice''': The plugin is at its very infancy (May 2018) so only a fraction of plotly's functionality is supported, parameter syntax may change a bit and error checking is very likely to be improveable.
+}}}
+
 == Description
 
-Create a bar/line/pie chart of an SQL query using the [https://plot.ly/javascript/ plotly.js] JavaScript plotting engine.
+This macro allows you to create a bar/line/pie chart of an SQL query using the [https://plot.ly/javascript/ plotly.js] JavaScript plotting engine in your Trac wiki pages and ticket pages. Plotly itself is MIT licensed.
 
-The plugin egg contains plotly.js, ie. there are no external web references.
+The plugin egg contains plotly.js, ie there are no external web references.
 
 A given wiki page can contain any number of plots.
 
-The plugin is at its very infancy (May 2018) so only a fraction of plotly's functionality is supported, parameter syntax may change a bit and error checking is very likely to be improveable.
+Enter the following in your wiki page:
+
+{{{
+[[yachart(id=first; title=Action statuses; query=SELECT status, COUNT(status) FROM ticket WHERE type = 'Action' GROUP BY status)]]
+}}}
+
+This will result in something like this:
+
+[[Image(newplot(1).png, border=2)]]
+
+Note the use of semicolon as the delimiter character for the macro arguments. This is chosen to avoid ambiguous commas which are common in SQL queries.
+
+The query must return two columns. In `line` and `bar` charts, the first column will be used as x-axis data and the second column as y-axis data. In `pie` charts, the columns will be used as labels and values, respectively.
+
+In the query, the macro will replace the string `$USER` with the id of the user logged in. This can be used to display "my tickets":
+
+[[Image(newplot(2).png, border=2)]]
+
+WikiProcessor syntax is supported which may make queries easier to read and write:
+{{{
+{{{#!yachart
+   id=something;
+   title=something else;
+   query=SELECT status, COUNT(status) 
+         FROM ticket 
+         WHERE type = 'Action' 
+         GROUP BY status;
+}}}
+}}}
+
+=== Parameters
+
+{{{#!ini
+id         = dom-name     # The name of the HTML DOM carrying the chart. Mandatory. Must be unique for each macro call on a wiki page
+title      = title-text   # The headline shown above the chart. Default: blank.
+chart_type = bar|line|pie # Optional; default: bar
+query      = sql-query    # Mandatory
+width      = pixel-width  # Optional; default: 600 pixels
+height     = pixel-height # Optional: default: 400 pixels
+}}}
 
 == !Bugs/Feature Requests
@@ -35 +78 @@
 General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.
 
-== Usage
-
-{{{
-[[yachart(id=first; title=Action statuses; query=SELECT status, COUNT(status) FROM ticket WHERE type = 'Action' GROUP BY status)]]
-}}}
-
-...will result in something like this:
-
-[[Image(newplot(1).png, width=300)]]
-
-=== Parameters
-
-Note the unusual use of semicolon as delimiter character - this is chosen in order to avoid escaping commas in the SQL query
-
-{{{#!ini
-id         = dom-name     # The name of the HTML DOM carrying the chart. Mandatory. Must be unique for each macro call on a wiki page
-title      = title-text   # The headline shown above the chart. Default: blank.
-chart_type = bar|line|pie # Optional; default: bar
-query      = sql-query    # Mandatory
-width      = pixel-width  # Optional; default: 600 pixels
-height     = pixel-height # Optional: default: 400 pixels
-}}}
-
-The query must return two columns. In `line` and `bar` charts, the first column will be used as x-axis data and the second column as y-axis data. In `pie` charts, the columns will be used as labels and values, respectively.
-
-In the query, the macro will replace the string `$USER` with the id of the user logged in. This can be used to display "my tickets":
-
-[[Image(newplot(2).png, width=300)]]
-
-WikiProcessor syntax is supported which may make queries easier to read (and write):
-{{{
-   {{{#!yachart
-   id=something;
-   title=something else;
-   query=SELECT 
-            status, 
-            COUNT(status) 
-         FROM ticket 
-         WHERE type = 'Action' 
-         GROUP BY status;
-   }}}
-}}}
-
 == Recent Changes