Commit f1999a99 authored by Paul Asmuth's avatar Paul Asmuth
Browse files

docs: update getting started page

parent 5a12fecd
Loading
Loading
Loading
Loading
+12 −2
Original line number Diff line number Diff line
@@ -232,7 +232,7 @@ ul li p {
}

article {
  max-width: 860px;
  max-width: 800px;
  display: flex;
  flex: 1;
  flex-direction: column;
@@ -434,11 +434,21 @@ table.invisible tr, table.invisible td {

#documentation .info_box {
  border: 1px solid #ddd;
  margin-bottom: 3em;
  margin-top: 1em;
  margin-bottom: 25px;
  border-radius: 2px;
  padding-top: .5em;
}

#documentation .info_box > .example {
  background: #f6f6f6;
  padding: .3em;
}

#documentation .info_box > .example img {
  display: block;
}

#documentation .info_box code strong {
  font-size: 110%;
}
+20 −15
Original line number Diff line number Diff line
Frequently Asked Questions
==========================

### I'm getting build errors when compiling the code

PlotFX needs a reasonably modern C++ compiler and standard library. In most
cases where the code doesn't build it's due to some problem with the local build
environment. We always appreciate bug reports so we improve our build system, but
often the best workaround for the moment is to download a binary release from the
downloads page.


### The test suite fails on my machine because text placement is slightly offset

The test suite requires that you have the original Microsoft Arial TTF files
installed on your machine. To verify that this is the case, run `fc-match
'Arial,Helvetica,Helvetica Neue:style=Regular,Roman'` and check that it returns
the correct 'arial.ttf' file.


### What are some differences between PlotFX and other chart generators?

While PlotFX's primary usecase *is* creating charts, it is at the core not a
@@ -33,24 +50,12 @@ stacked vertically from top to bottom, similar to the way rows of text are place
one after another other in a page.

This concept of page flow, or page layout does not exit in PlotFX.
PlotFX is a tool for creating illustrations, not a document publishin system, so
it does make sense to assume "row by row" as a default element placement strategy.
Most of the rest of CSS's layout features build from this core assumption so they
are equally unapplicable to PlotFX.
PlotFX is a tool for creating illustrations, not a document publishing system, so
it does make sense to assume "top to bottom" as a default element placement strategy.

Instead of being stacked horizontally within the parent box, like in CSS, boxes
So instead of being stacked horizontally within the parent box, like in CSS, boxes
in PlotFX will, by default, simply be drawn on top of each other with each one
filling up the entirety of the parent box. This is a much more useful default
behaviour for creating illustrations where in many cases an element more closely
resembles the concept of a 'layer' as found in graphics editing software such as
Photoshop or Illustrator than that of a row of text.


### I'm getting build errors when compiling the code

PlotFX needs a reasonably modern C++ compiler and standard library. In most
cases where the code doesn't build it's due to some problem with the local build
environment. We always appreciate bug reports so we improve our build system, but
often the best workaround for the moment is to download a binary release from the
downloads page.
+9 −0
Original line number Diff line number Diff line
width: 800px;
height: 400px;

points {
  xs: 90px, 650px, 420px;
  ys: 180px, 300px, 120px;
  sizes: 3pt, 6pt, 11pt;
  colors: #06c, #0c6, #c06;
}
+6 −0
Original line number Diff line number Diff line
<svg xmlns="http://www.w3.org/2000/svg" width="800.000000" height="400.000000" viewBox="0 0 800.0 400.0">
  <rect width="800.000000" height="400.000000" fill="#ffffff"/>
  <path fill="#0066cc" d="M114.0 200.0 M106.0 200.0 a4.0 4.0 0 1 0 8.0 0 a4.0 4.0 0 1 0 -8.0 0 "/>
  <path fill="#00cc66" d="M678.0 80.0 M662.0 80.0 a8.0 8.0 0 1 0 16.0 0 a8.0 8.0 0 1 0 -16.0 0 "/>
  <path fill="#cc0066" d="M454.666667 260.0 M425.333333 260.0 a14.666667 14.666667 0 1 0 29.333333 0 a14.666667 14.666667 0 1 0 -29.333333 0 "/>
</svg>
 No newline at end of file
+17 −0
Original line number Diff line number Diff line
width: 800px;
height: 400px;

points {
  xs: 90px, 650px, 420px;
  ys: 180px, 300px, 120px;
  sizes: 3pt, 6pt, 11pt;
  colors: #06c, #0c6, #c06;
}

axis {
  position: left;
}

axis {
  position: bottom;
}
Loading