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

improved document structure/html

parent fca2efed

CMakeLists.txt

+1 −2
Original line number Diff line number Diff line
@@ -134,6 +134,5 @@ endforeach() 
# -----------------------------------------------------------------------------

add_custom_target(docs

    COMMAND mkdir -p ${CMAKE_CURRENT_BINARY_DIR}/wwwdocs

    COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/manual/web/build.sh ${CMAKE_CURRENT_BINARY_DIR}/wwwdocs

    DEPENDS examples)

    COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/manual/web/build.sh ${CMAKE_CURRENT_BINARY_DIR}/wwwdocs)

manual/frontpage.md

0 → 100644
+69 −0
Original line number Diff line number Diff line 
# fviz v0.5.0



fviz is a command line program for creating charts and other data-driven

illustrations. It reads input data from text and CSV files and produces the

output graphic as a SVG or PNG file. All charts are highly customizable using a

simple s-expression based syntax.



In addition to the command line program, fviz is available as the libfviz

software library which can be embedded into any application that can link to C

libraries.



<div style="margin-top: 1.2em;">

  <a href="/documentation/getting-started" style="">Getting Started</a>

  <span style="margin: 0 .3em">·</span>

  <a href="/examples">Examples</a>

  <span style="margin: 0 .3em">·</span>

  <a href="/download">Download</a>

</div>



<div style="margin-top: 2em; background: #f2f2f2; padding: 10pt; max-width: 900px; box-sizing: border-box;">

  <b>BETA:</b> Please note that fviz is pre-1.0 software under active development;

  It is usable, but things might generally still be a bit rough around the edges.

  To see what already works, have a look at the <a href="/examples">Examples</a> page.

</div>



## Quick Start



- [Getting Started]()

- [Download]()

- [Installation]()



## Usage



- [Command Line]()

- [C/C++]()

- [Ruby]()





## Reference



- [Document Setup](/documentation/document-setup)

- [Colors](/documentation/colors)

- [Color Maps](/documentation/color-maps)

- [Typographic Units](/documentation/typographic)

- [Scale Types](/documentation/scale-types)

- [Scale Layout](/documentation/scale-layout)

- [Formatters](/documentation/format)

- [Marker Shapes](/documentation/marker-shapes)

- [Fonts](/documentation/fonts)



## List of Elements



Element | Description

------- | -----------

[`plot/lines`](elements/plot/lines) | ...

[`plot/lines`](elements/plot/lines) | ...

[`plot/lines`](elements/plot/lines) | ...

[`plot/lines`](elements/plot/lines) | ...

[`plot/lines`](elements/plot/lines) | ...

[`plot/lines`](elements/plot/lines) | ...

[`plot/lines`](elements/plot/lines) | ...

[`plot/lines`](elements/plot/lines) | ...

[`plot/lines`](elements/plot/lines) | ...



## Community



- [Github]()

- [Contributing]()

- [License]()

manual/introduction.md

deleted100644 → 0
+0 −27
Original line number Diff line number Diff line 
# fviz v0.5.0



fviz is a command line program for creating charts and other data-driven

illustrations.



It reads input data from text and CSV files and produces the output graphic as

a SVG or PNG file. All charts are highly customizable using a simple s-expression

based syntax.



In addition to the command line program, fviz is available as the libfviz

software library which can be embedded into any application that can link to C

libraries.



**BETA:** Please note that fviz is pre-1.0 software under active development;

It is usable, but things might generally still be a bit rough around the edges.

To see what already works, have a look at the [Examples](https://fviz.org/examples) page.



<div style="margin-top: 1.2em;">

  <a href="/documentation/getting-started" style="">Getting Started</a>

  <span style="margin: 0 .3em">·</span>

  <a href="/examples">Examples</a>

  <span style="margin: 0 .3em">·</span>

  <a href="/download">Download</a>

</div>



---

manual/toc.yaml

+1 −1
Original line number Diff line number Diff line
@@ -9,7 +9,7 @@ documentation: 
          title: "Introduction"

          doctitle: "fviz"

          url: "/"

          file: "introduction"

          file: "frontpage"

        -

          title: "Getting Started"

          url: "/documentation/getting-started"

manual/web/build_layout.py

+25 −38
Original line number Diff line number Diff line
@@ -16,43 +16,30 @@ tpl = """ 
    <meta name="google-site-verification" content="zhyGsSQu1HANExonMZDMr0LppXCCv47inMKRXiZS8aQ" />

  </head>

  <body>

    <div id="navigation">

      <a href="/" class="logo">fviz 0.5.0</a>



      {{#toc}}

        <a class="nav_title">{{title}}</a>

        {{#sections}}

          {{#section_title}}

            <a class="nav_subtitle">{{section_title}}</a>

          {{/section_title}}

          <ul>

            {{#pages}}

              <li>

                {{#api_ref}}

                  <a href="{{url}}"><code>{{title}}</code></a>

                {{/api_ref}}

                {{^api_ref}}

                  <a href="{{url}}">{{title}}</a>

                {{/api_ref}}

              </li>

            {{/pages}}

          </ul>

        {{/sections}}

      {{/toc}}

    </div>



    <article class="{{article_class}}">

      <div class="header">

        <a style="display: block; text-decoration: none; color: #666; float: right; margin-top: 2em;" href="http://github.com/asmuth/fviz" target="_blank">

    <nav>

      <a style="display: block; text-decoration: none; color: #666; float: right;" href="http://github.com/asmuth/fviz" target="_blank">

        View on <img src="https://github.githubassets.com/images/modules/logos_page/GitHub-Logo.png" style="height: 12px; position: relative; top: 1px; margin-left: 2px;">

      </a>



      <a href="/">

        <img src="/favicon.ico" style="height: 1em; position: relative; top: 0.13em; margin-right: 0.3em;"/>

        fviz

      </a>



      <span style="margin: 0 .3em">·</span>

      <a class="link" href="/" style="">Documentation</a>

      <span style="margin: 0 .3em">·</span>

      <a class="link" href="/examples">Examples</a>

      <span style="margin: 0 .3em">·</span>

      <a class="link" href="/download">Download</a>



      <ul class="crumbs">

          <li><a>Documentation</a></li>

        <li><a href="/">Documentation</a></li>

        <li><a>{{title}}</a></li>

      </ul>

      </div>

    </nav>



    <article class="{{article_class}}">

      <div id="documentation">

        {{{content}}}

      </div>
@@ -62,12 +49,12 @@ tpl = """ 
          Edit this page on GitHub

        </a>

      </div>

    </article>



      <div id="footer">

    <footer>

      Copyright &copy; 2011-2018 Paul Asmuth, Laura Schlimmer et al. &mdash;

      fviz is free software licensed under the Apache 2.0 license.

      </div>

    </article>

    </footer>

  </body>

</html>

"""

CRA Git | Maintained and supported by SUSTech CRA and CCSE