Skip to content

Latest commit

 

History

History
84 lines (54 loc) · 3.54 KB

README.md

File metadata and controls

84 lines (54 loc) · 3.54 KB
Raw

Java CI

Kite9 is an SVG Visualization Library for converting XML into SVG, useful for creating diagrams and user interfaces.

Basic Kite9 Process

For examples, head over to the Risk-First website to see some example Kite9 diagrams.

Basic Features

  • Sizing Instructions Such as horizontal-align, min-width, padding and margin. These are used in HTML CSS, but are now available for use in SVG.
  • Various Element Types such as links, text, containers, decals, and various ways to layout and transform them.
  • Templating. Use the --kite9-template CSS directive to specify an SVG template to use to render a piece of XML.
  • Links. You can link elements together to create graphs.
  • Text Flow. You can intelligently size SVG elements according to the text they contain, and flow text within the element a la HTML.
  • Grids. It's possible to add SVG elements to a grid, and have the grid resize to contain them all.

Output Formats

1. Batik

Kite9 supports writing SVG using Java and heavily based on Apache Batik SVG Toolkit, which supplies parsers for SVG and CSS, as well as conversion from SVG primitives to Java Graphics2D primitives for sizing and layout.

2. JavaScript

Kite9 is cross-compiled into JS to run in the browser, using Houdini APIs. More coming.

General Principles

This is a transform process. The input to the transform in any XML document. However, in order for any transformation to take place, elements need to be styled using CSS to indicate to Kite9 how to display them.

For this reason, Kite9 defines plenty of it's own CSS directives, prefixed with kite9. Have a look at the stylesheet example here and it's related template.svg

A CSS stylesheet can be included in SVG using <style> and either in-line or @imported, like so:

<svg:svg xmlns:svg="http://www.w3.org/2000/svg">
  <svg:defs>
    <svg:style type="text/css"> 
      @import url("stylesheets/designer.css");
    </svg:style>
  </svg:defs>
    
<diagram xmlns="http://www.kite9.org/schema/adl" id="The Diagram">
  <context id="Context" rank="0" bordered="true">
    <glyph id="1-rob's glyph">
      <stereotype id="1-rob's glyph-stereo">Stereo</stereotype>
      <label id="1-rob's glyph-label">Rob's Glyph</label>
     </glyph>
  </context>
</diagram>
</svg:svg>

With the directives contained in the designer.css stylesheet, this SVG+XML can be rendered as:

Basic Glyph

Note a few features:

  • Drop shadow
  • Sizing of the Glyph element, according to it's text.
  • Centering and vertical flow of text.
  • All with SVG.

In Action

Take a look at Risk First, which heavily uses Kite9 to lay out diagrams.

Online

tbc.

Usage

Kite9 implements Batik's Transcoder interface, called Kite9SVGTranscoder.

Instructions for using this are here

It transcodes XML into SVG, (rather than into JPEG as shown in the example). You should modify the output filename accordingly.

Deploying Batik