| Index: trunk/extensions/SemanticResultFormats/Ploticus/README |
| — | — | @@ -25,7 +25,8 @@ |
| 26 | 26 | E.g. if you plan to use additional fonts in SWF files |
| 27 | 27 | SWF_FONTS_DIR=/usr/share/ming/fonts/ttf-dejavu/fdb |
| 28 | 28 | |
| 29 | | - E.g. set global ploticus config parameters with a config file. See ./ploticus-addons/ploticus.config for a sample config file. |
| | 29 | + E.g. set global ploticus config parameters with a config file. See ./ploticus-addons/ploticus.config for a sample config file and |
| | 30 | + http://ploticus.sourceforge.net/doc/config.html for more info. |
| 30 | 31 | PLOTICUS_CONFIG=/etc/ploticus/ploticus.config |
| 31 | 32 | |
| 32 | 33 | Remember, you can pass multiple environment variables, e.g. |
| — | — | @@ -52,14 +53,6 @@ |
| 53 | 54 | (e.g. 0,1,2,3...9,a,b,c,d,e,f) should also be created, all with permission 777. |
| 54 | 55 | (see http://www.mediawiki.org/wiki/Manual:$wgUploadPath) |
| 55 | 56 | |
| 56 | | -PLOTICUS_CONFIG: |
| 57 | | -Ploticus' default delimiter is set to space. For CSV files, this needs to be set to comma (,). One can do this by explicitly specifying |
| 58 | | -delim=comma in ploticusparam, or better still, by setting it once and for all using the PLOTICUS_CONFIG env variable. |
| 59 | | - |
| 60 | | -To do this, ensure the PLOTICUS_CONFIG environment variable is set and the file it points to contains "option: delim=comma". |
| 61 | | -See $srfgEnvSettings above. |
| 62 | | - |
| 63 | 57 | == Configuration and Usage == |
| 64 | 58 | |
| 65 | 59 | The SRF-ploticus Result Format has the following parameters: |
| — | — | @@ -75,19 +68,40 @@ |
| 76 | 69 | can and should be used in script mode. Otherwise, the ploticus script parser will fail. |
| 77 | 70 | |
| 78 | 71 | * imageformat (enum/optional) |
| 79 | | - - png (default), gif, jpeg, svg, svgz, swf, eps, ps, drawdump, drawdumpa (drawdump append). |
| | 72 | + - png (default), gif, jpeg, svg, svgz, swf, eps, ps, drawdump, drawdumpa (drawdump append) and csv. |
| 80 | 73 | Availability of format depends on how ploticus is built. When using svgz, make sure Apache |
| 81 | 74 | is configured properly, i.e. you have the svgz mime-type and svgz encoding. |
| 82 | 75 | AddType image/svg+xml svg svgz |
| 83 | 76 | AddEncoding gzip svgz |
| 84 | 77 | |
| | 78 | + The csv format is a special case. It only generates the CSV result and sets showcsv=true (see below), and |
| | 79 | + Ploticus is NOT actually invoked. |
| | 80 | + |
| | 81 | + This is useful in cases when the result set is very large and you want the ability to download the CSV file |
| | 82 | + without bumping up against SMW and PHP memory limits. |
| | 83 | + |
| | 84 | + FYI, while the stock CSV result printer creates the file in memory, SRF-Ploticus streams the result directly to the filesystem. |
| | 85 | + As a result, the resulting CSV file can be much bigger. |
| | 86 | + |
| | 87 | + As an added benefit, the CSV file is also persistent across sessions. That is, the generated URL for the CSV file is available |
| | 88 | + without running the query, within bounds of the $srfgPloticusCacheAgeHours LocalSettings.php parameter. |
| | 89 | + |
| 85 | 90 | * alttext (string/optional) |
| 86 | | - - alternate text displayed on mouseover. Ignored when client-side imagemap is generated. |
| | 91 | + - alternate text displayed on mouseover for raster formats (PNG/JPEG/GIF). Ignored when client-side imagemap is generated. |
| | 92 | + On vector formats (SVG/SVGZ/EPS/PS), alttext is prepended to the warning message if the browser is not capable of displaying |
| | 93 | + the plot. |
| 87 | 94 | |
| 88 | 95 | * showcsv (bool/optional) |
| 89 | 96 | - 0 (default). When 1, displays link to CSV file used to generate plot. Beware that the CSV |
| 90 | 97 | ALWAYS shows the latest query result, which may sometimes fall out of sync with the "cached" plot. |
| 91 | 98 | (See liveupdating, showtimestamp & updatefrequency parameters below) |
| | 99 | + |
| | 100 | + Also note that the Inline query headers parameter influences how the CSV file is generated. |
| | 101 | + If headers=show (default), a header row will be inserted. |
| | 102 | + |
| | 103 | + Keep in mind that most Ploticus prefabs automatically create legends when header=show is set. |
| | 104 | + If you want to suppress legends, be sure to specify legend parameter accordingly. |
| | 105 | + (http://ploticus.sourceforge.net/doc/prefab_stdparms.html#legend) |
| 92 | 106 | |
| 93 | 107 | * debug (bool/optional) |
| 94 | 108 | - 0 (default). When 1, displays ploticus prefab cmdline or script used to generate plot. |