Plugin Directory

Changeset 562099


Ignore:
Timestamp:
06/22/2012 12:10:38 AM (14 years ago)
Author:
technosailor
Message:

Cleanup Readme :(

File:
1 edited

Legend:

Unmodified
Added
Removed
  • easy-graphs/trunk/readme.txt

    r562098 r562099  
    1010== Description ==
    1111
    12 <p style=\"color: #333333; font-family: Georgia, \'Times New Roman\', \'Bitstream Charter\', Times, serif; font-size: 13px; line-height: 19px;\">Everyone likes data visualizations so I wrote a plugin that will make the quick and secure creation of Pie Charts, Bar Charts and Line Charts easy. The answer is: Easy Graphs.<p style=\"color: #333333; font-family: Georgia, \'Times New Roman\', \'Bitstream Charter\', Times, serif; font-size: 13px; line-height: 19px;\">Easy graphs is very simple to use. It\'s a shortcode - [easy_graphs]</p> <p style=\"color: #333333; font-family: Georgia, \'Times New Roman\', \'Bitstream Charter\', Times, serif; font-size: 13px; line-height: 19px;\">Not just like that. The shortcode also requires one parameter \"data\". This parameter is a comma separated list of number values \"1,2,3,4,5,6,7\".</p> <p style=\"color: #333333; font-family: Georgia, \'Times New Roman\', \'Bitstream Charter\', Times, serif; font-size: 13px; line-height: 19px;\">You can also add a \"type\" parameter. The \"type\" can be \"line\", \"bar\" or \"pie\". \"bar\" is the default.</p> <p style=\"color: #333333; font-family: Georgia, \'Times New Roman\', \'Bitstream Charter\', Times, serif; font-size: 13px; line-height: 19px;\">For a Bar graph, you can optionally pass additional parameters: width, height, and color.</p> <p style=\"color: #333333; font-family: Georgia, \'Times New Roman\', \'Bitstream Charter\', Times, serif; font-size: 13px; line-height: 19px;\">Example: [easy_graphs height=\"200\" type=\"bar\" data=\"30,70,65\"]</p> <p style=\"color: #333333; font-family: Georgia, \'Times New Roman\', \'Bitstream Charter\', Times, serif; font-size: 13px; line-height: 19px;\">By default, width and height are populated from your media embed sizes that are set in your Settings > Media menu inside WordPress. Color should be a hex color code.</p> <p style=\"color: #333333; font-family: Georgia, \'Times New Roman\', \'Bitstream Charter\', Times, serif; font-size: 13px; line-height: 19px;\">For a line graph, the options are similar: color1, color2, height and width.</p> <p style=\"color: #333333; font-family: Georgia, \'Times New Roman\', \'Bitstream Charter\', Times, serif; font-size: 13px; line-height: 19px;\">If you will: [easy_graphs height=\"200\" type=\"line\" data=\"200,150,175,260\"]</p> <p style=\"color: #333333; font-family: Georgia, \'Times New Roman\', \'Bitstream Charter\', Times, serif; font-size: 13px; line-height: 19px;\">In this case, color1 is the \"fill\" color and color2 is the line color. Both should be hex.</p> <p style=\"color: #333333; font-family: Georgia, \'Times New Roman\', \'Bitstream Charter\', Times, serif; font-size: 13px; line-height: 19px;\">For Pie charts, there are some additional limitations but fewer parameters: color1, color2 and diameter.</p> <p style=\"color: #333333; font-family: Georgia, \'Times New Roman\', \'Bitstream Charter\', Times, serif; font-size: 13px; line-height: 19px;\">Try this: [easy_graphs diameter=\"150\" data=\"40,60\" type=\"pie\"]</p> <p style=\"color: #333333; font-family: Georgia, \'Times New Roman\', \'Bitstream Charter\', Times, serif; font-size: 13px; line-height: 19px;\">Diameter should be an integer represented in pixels. Color1 and color2 are the fill colors of the pie slices. The limitation is the pie chart, at this time, can only take 2 values. I\'ll work on that.</p> <p style=\"color: #333333; font-family: Georgia, \'Times New Roman\', \'Bitstream Charter\', Times, serif; font-size: 13px; line-height: 19px;\">On the roadmap are other things. Make the pie chart take more values than just 2. Maybe include other graph types. Labels so the data can be more easily understood.</p> <p style=\"color: #333333; font-family: Georgia, \'Times New Roman\', \'Bitstream Charter\', Times, serif; font-size: 13px; line-height: 19px;\">What would you add to this?</p> </p>
     12Everyone likes data visualizations so I wrote a plugin that will make the quick and secure creation of Pie Charts, Bar Charts and Line Charts easy. The answer is: Easy Graphs.
     13
     14Easy graphs is very simple to use. It's a shortcode - [easy_graphs]
     15
     16Not just like that. The shortcode also requires one parameter "data". This parameter is a comma separated list of number values "1,2,3,4,5,6,7".
     17
     18You can also add a "type" parameter. The "type" can be "line", "bar" or "pie". "bar" is the default.
     19
     20For a Bar graph, you can optionally pass additional parameters: width, height, and color.
     21
     22Example: [easy_graphs height="200" type="bar" data="30,70,65"]
     23
     24By default, width and height are populated from your media embed sizes that are set in your Settings > Media menu inside WordPress. Color should be a hex color code.
     25
     26For a line graph, the options are similar: color1, color2, height and width.
     27
     28If you will: [easy_graphs height="200" type="line" data="200,150,175,260"]
     29
     30In this case, color1 is the "fill" color and color2 is the line color. Both should be hex.
     31
     32For Pie charts, there are some additional limitations but fewer parameters: color1, color2 and diameter.
     33
     34Try this: [easy_graphs diameter="150" data="40,60" type="pie"]
     35
     36Diameter should be an integer represented in pixels. Color1 and color2 are the fill colors of the pie slices. The limitation is the pie chart, at this time, can only take 2 values. I'll work on that.
     37
     38On the roadmap are other things. Make the pie chart take more values than just 2. Maybe include other graph types. Labels so the data can be more easily understood.
     39
     40What would you add to this?
    1341
    1442== Installation ==
     
    1745== Screenshots ==
    18461. Rendered charts.
     47
     48== Frequently Asked Questions ==
     49
     50= Q: Where can I get support?
     51
     52= A: Click on that support link on the right and start a post. Please don't email me directly and for the love of all that is good and holy, don't ask me on Twitter. :)
Note: See TracChangeset for help on using the changeset viewer.