SB - MoinMoin

Moin-Moin Bits

uml2ascii Processor: a simple tool to generate ASCII box and class UML diagrams.

Example 1:

{{{#!uml2ascii
[Box1] -> [Box2]
}}}

will result in:

+------+     +------+
| Box1 |---->| Box2 |
+------+     +------+

Example 2:

{{{#!uml2ascii
[Box 1] -> [Box2] --(1)-- [Box 3]
[Box 4|...two liner...] -> [Box 5] --(5,2)--
}}}

produces:

+-------+               +------+      +-------+
| Box 1 |-------------->| Box2 |      | Box 3 |
+-------+               +------+      +-------+
    |                       |             |    
    +-----------------------|-------------+    
                            |                  
+-----------------+     +-------+              
| Box 4           |---->| Box 5 |              
| ...two liner... |     +-------+              
+-----------------+

Example 3:

{{{#!uml2ascii
[Class Point|-|int getX()|int getY()|void setX(int)|void setY(int)]
}}}

will result in:

+----------------+
| Class Point    |
|----------------|
| int getX()     |
| int getY()     |
| void setX(int) |
| void setY(int) |
+----------------+

Usage:

{{{#!uml2ascii [Options]
Diagram DDL
}}}

   DDL Sample:
       [Box 1] -> [Box2] -(1)- [Box 3]
       [Box 4|...two liner...] -> --(2)-- [Box 5.hvc=///]

   Box format:   [pos_x, pos_y, text, attr]
    pos_x      - column position of the box (optional, auto-incremented by default)
    pos_y      - row position of the box (optional, auto-incremented with new-line by default)
    text       - text to display in the box. Required. Use "|" for multi-line text. Use "|-|" for divider.
    attr       - Optional attributes:
                 hvc=... : use alternative characters: Horizontal, Vertical and Corner.
    Box samples: [Box1] [Class Point|-|int getX()|int getY()|void setX(int)|void setY(int)] [1,5,Box at cell 1:5]

   Link format:  START_CHAR -* FROM_TO -* END_CHAR
    START_CHAR - starting character. Required. 
    END_CHAR   - ending character. Required. 
    FROM_TO    - (id_from, id_to). Optional. From previous to next by default.
    id_from    - Box ID from which the links starts. Optional. Previous box by default.
    id_to      - Box ID to which the link goes. Optional. Next box by default.
    Link samples: -> <-> -- <> -(2,5)-> -(,7)-> --(3)--

   Options:
    fg:color   - diagram color
    dx:value   - minimum horizontal gap
    dy:value   - minimum vertical gap
    nn:        - print box IDs

Contact