ditaa: DIagrams Through Ascii Art http://ditaa.sourceforge.net

README.md

• DIagrams Through Ascii Art
• How do you make diagrams of memory and data structures?

examples.ditaa

Memory:

      +--------+
   0  |        |  <- start
      +--------+
   1  |        |  <- q  scans from start to end
      +--------+
      :  ..... |
      +--------+
      |        |  <- end
      +--------+  <-+
      |        |    |
      +--------+    | rest of the
      :  ..... |    | allocated memory
      +--------+    |
  n   |        |    |
      +--------+  <-+


Strings:


    0               n
   +--+=----+--+--+--+
   |  | ... |  |  |\0|
   +--+-----+--+--+--+
     ^        ^
     |        |
     |        +-- q moves from the
     |            end to the start
     p moves from
       start to the end


Sectioned:

   +------+----+----+----+----+----+----+
   | xxxx | yy | zz | 00 | tt | 11 | ss |
   +------+----+----+----+----+----+----+
    ^      ^    ^    ^    ^    ^    ^ 
    |      |    |    |    |    |    |
    |      |    |    |    |    |    +--- storage registry
    |      |    |    |    |    +-------- always set to 1
    |      |    |    |    +------------- temp value
    |      |    |    +------------------ always zeroed 
    |      |    +----------------------- zero flag value
    |      +---------------------------- y register
    +----------------------------------- x address   

flowchart.dot

/* dot -T png flowchart.dot > flowchart.png */

digraph G {
	mode = hier

	start [shape = ellipse];
	end [shape = ellipse];

	process [shape = box];
	task [shape = box];
	action [shape = box];
	operation [shape = box];
	alternate [shape = box, style = rounded];
	manual [shape = invtrapezium];

	decision [shape = diamond];

	connector [shape = circle];
	6 [shape = circle, width = .4, fixedsize = true];
	offpage [shape = invhouse];

	delay [shape = cds];

	input [shape = parallelogram];
	manualinput [shape = house];
	output [shape = parallelogram];
	display [shape = egg];

	document [shape = folder];
	documents [shape = box3d];
	storage [shape = doublecircle];

	start   -> process;
	process -> task;
	task    -> action;
	action  -> decision;
	decision -> input [label="yes"];
	decision -> manualinput [label="no"];
	manualinput -> display;

	display -> end;
	input -> end;

	overlap=false
	sep = 1.5
}

sample.ditaa

      /-\
  /-\ | |
  | | | | /-\
<-/ | | | | | /->
    \-/ | | | |
        | | \-/
        \-/

    +--------+   +-------+    +-------+
    |        | --+ ditaa +--> |       |
    |  Text  |   +-------+    |diagram|
    |Document|   |!magic!|    |       |
    |     {d}|   |       |    |       |
    +---+----+   +-------+    +-------+
        :                         ^
        |       Lots of work      |
        +-------------------------+

+---------+
| cBLU    |
|         |
|    +----+
|    |cPNK|
|    |    |
+----+----+


Rounded Corners:

/--+
|  |
+--/


Tags:

+-----+
|{d}  |
|     |
|     |
+-----+

+-----+
|{s}  |
|     |
|     |
+-----+

+-----+
|{io} |
|     |
|     |
+-----+


Dashed Lines:

+----+
:    |
|{s} |
+----+

/----\ 
|    | 
|    | 
\-=--+ 

----+
    :
    |
    v


Point Markers:

*----*
|    |
*    *
|    |
*----*

    /--*
    |
-*--+


Text Handling:

/-----------------\
| Things to do    |
| cGRE            |
| o Cut the grass |
| o Buy jam       |
| o Fix car       |
| o Make website  |
\-----------------/


Color codes:

/-------------+-------------\
|cRED RED     |cBLU BLU     |
+-------------+-------------+
|cGRE GRE     |cPNK PNK     |
+-------------+-------------+
|cBLK BLK     |cYEL YEL     |
\-------------+-------------/

/----\ /----\
|c33F| |cC02|
|    | |    |
\----/ \----/

/----\ /----\
|c1FF| |c1AB|
|    | |    |
\----/ \----/