Changes between Version 39 and Version 40 of VisualizationPlugin


Ignore:
Timestamp:
Apr 19, 2022, 8:53:04 AM (2 years ago)
Author:
figaro
Comment:

Add examples to functional description

Legend:

Unmodified
Added
Removed
Modified
  • VisualizationPlugin

    v39 v40  
    55== Description
    66
    7 This plugin adds Google charts to Trac pages using the [https://developers.google.com/chart/?csw=1 Google Visualization API]. Its most basic usage is graphing an existing report:
     7This plugin adds Google charts to Trac pages using the [https://developers.google.com/chart/?csw=1 Google Visualization API]. Its most basic usage is graphing an existing Trac report:
    88
    99[[Image(effort.png, border=2)]]
    10 
    11 See more examples [wiki:VisualizationPlugin#Examples below].
    12 
    13 See also: [pypi:TracGViz TracGViz plugin]
    14 
    15 == Bugs/Feature Requests
    16 
    17 Existing bugs and feature requests for VisualizationPlugin are
    18 [report:9?COMPONENT=VisualizationPlugin here].
    19 
    20 If you have any issues, create a
    21 [/newticket?component=VisualizationPlugin new ticket].
    22 
    23 [[TicketQuery(component=VisualizationPlugin&group=type,format=progress)]]
    24 
    25 == Download
    26 
    27 Download the zipped source from [export:visualizationplugin here].
    28 
    29 The plugin is also available on [pypi:TracVisualization PyPI].
    30 
    31 == Source
    32 
    33 You can check out VisualizationPlugin from [/svn/visualizationplugin here] using Subversion, or [source:visualizationplugin browse the source] with Trac.
    34 
    35 == Installation and Configuration
    36 
    37  1. Install the plugin after downloading and unzipping:
    38     {{{#!sh
    39     cd visualizationplugin/0.12
    40     sudo python setup.py bdist_egg
    41     sudo cp dist/TracVisualization*.egg /your/trac/location/plugins/
    42     }}}
    43 
    44     See TracPlugins for more installation details and options. You'll likely need to restart Trac's web server after installation.
    45 
    46  2. Enable the plugin in `trac.ini`:
    47     {{{#!ini
    48     [components]
    49     viz.* = enabled
    50     }}}
    51 
    52     You can alternatively use the Trac Web Admin GUI to enable any or all rules.
    53 
    54  3. Configure which pages to include graphs in `trac.ini`:
    55     {{{#!ini
    56     [viz]
    57     reports = 21
    58     }}}
    59 
    60 The above example will populate an area chart from the table of data found in report 21 and display the chart above that table, see screenshot above. The examples section [wiki:VisualizationPlugin#Examples below] shows additional ways to include graphs and charts on Trac pages.
    61 
    62 This plugin requires Javascript but does not require any other libs to be pre-installed. The Google Visualization libs are loaded dynamically using Google's standard JS loader.
    6310
    6411== Examples
     
    6613=== Existing report
    6714
    68 The most basic usage is adding a chart to an existing report. This can be achieved with almost no configuration. Simply list the reports in the {{{[viz]}}} section in {{{trac.ini}}}:
     15The most basic usage is adding a chart to an existing report using the numbering scheme under `View tickets`. This can be achieved with very little configuration. Simply list the reports in the {{{[viz]}}} section in the {{{trac.ini}}} file:
    6916{{{#!ini
    7017[viz]
     
    156103
    157104As described above, you can add a graph or chart to any Trac page including wiki pages. The steps are:
    158  1. Create a {{{[viz.<page-url>]}}} section in {{{trac.ini}}}.
     105 1. Create a {{{[viz.<page-url>]}}} section in the {{{trac.ini}}} file.
    159106 1. Set its {{{source}}} option to the remote data source url.
    160107 1. (Optional) Add a {{{query}}} option as appropriate for the data source.
     
    162109 1. Configure the chart {{{type}}} and {{{options}}} as desired.
    163110
    164 To embed iGoogle Gadgets in wiki pages using WikiFormatting, you may wish to try [pypi:TracGViz TracGViz plugin] (untested).
     111'''Note''': To embed iGoogle Gadgets in wiki pages using WikiFormatting, you can try [pypi:TracGViz TracGViz plugin] (untested).
     112
     113== Bugs/Feature Requests
     114
     115Existing bugs and feature requests for VisualizationPlugin are
     116[report:9?COMPONENT=VisualizationPlugin here].
     117
     118If you have any issues, create a
     119[/newticket?component=VisualizationPlugin new ticket].
     120
     121[[TicketQuery(component=VisualizationPlugin&group=type,format=progress)]]
     122
     123== Download
     124
     125Download the zipped source from [export:visualizationplugin here].
     126
     127The plugin is also available on [pypi:TracVisualization PyPI].
     128
     129== Source
     130
     131You can check out VisualizationPlugin from [/svn/visualizationplugin here] using Subversion, or [source:visualizationplugin browse the source] with Trac.
     132
     133== Installation
     134
     135 1. Install the plugin after downloading and unzipping:
     136    {{{#!sh
     137    cd visualizationplugin/0.12
     138    sudo python setup.py bdist_egg
     139    sudo cp dist/TracVisualization*.egg /your/trac/location/plugins/
     140    }}}
     141
     142    See TracPlugins for more installation details and options. You will likely need to restart Trac's web server after installation.
     143
     144 2. Enable the plugin in the `trac.ini` file:
     145    {{{#!ini
     146    [components]
     147    viz.* = enabled
     148    }}}
     149
     150    You can alternatively use the Trac Web Admin GUI to enable any or all rules.
     151
     152== Configuration
     153
     154Configure which pages to include graphs in the `trac.ini` file:
     155    {{{#!ini
     156    [viz]
     157    reports = 21
     158    }}}
     159
     160The above example will populate an area chart from the table of data found in report 21 and display the chart above that table, see screenshot above.
     161
     162This plugin requires Javascript to be enabled, and does not require any other libraries to be pre-installed. The Google Visualization libraries are loaded dynamically using Google's standard JS loader.
    165163
    166164== Recent Changes