Get Help
Thank you for using Nomnoml Diagrams! I'm committed to providing excellent support and ensuring you have the best experience creating UML diagrams for your designs.
Before Contacting Support
Please include the following information in your support request:
- What you were trying to do (e.g., render diagram, add to design)
- The nomnoml syntax you were using (copy/paste if possible)
- What happened instead (error messages, unexpected rendering)
- Screenshots if applicable
Nomnoml Syntax Quick Reference
Basic Syntax
[ClassName]- Define a class/box[A] -> [B]- Association (arrow)[A] - [B]- Line without arrow[A] <-> [B]- Bidirectional arrow
Relationships
[A] -:> [B]- Dependency (dashed arrow)[A] --:> [B]- Realization[A] -/- [B]- Line with X (hidden)[A] o-> [B]- Aggregation[A] +-> [B]- Composition[A] <:- [B]- Inheritance
Class Details
[A|field1;field2]- Class with fields[A|field|method()]- Class with fields and methods[<abstract>A]- Abstract class[<interface>I]- Interface
Styling
#direction: down- Layout direction (down, right)#.important: fill=#f00- Custom style[<important>A]- Apply custom style
Frequently Asked Questions
Q: What is nomnoml?
A: Nomnoml is a text-based diagramming tool for drawing UML diagrams. It uses a simple syntax where square brackets define elements and arrows define relationships. It's great for quickly sketching out class diagrams, flowcharts, and more.
Q: My diagram isn't rendering. What's wrong?
A: Check for common syntax errors:
- Make sure brackets are properly closed:
[ClassName] - Use proper arrow syntax:
->not=> - Each element needs square brackets
Example: [User] -> [Database]
Q: How do I add methods and properties to a class?
A: Use the pipe character to separate sections:
[ClassName|property1;property2|method1();method2()]
Q: Can I change the diagram direction?
A: Yes! Add a directive at the top of your diagram:
#direction: down or #direction: right
Q: How do I create different arrow types?
A: Nomnoml supports various relationship types:
[A] -> [B]- Simple arrow[A] <:- [B]- Inheritance (B inherits from A)[A] o-> [B]- Aggregation[A] +-> [B]- Composition[A] -:> [B]- Dependency (dashed)
Q: The "Add to design" button is disabled. Why?
A: The button is disabled until valid diagram syntax is entered. Make sure you have at least one element defined with proper square brackets.
Q: Can I style my diagram?
A: Yes! Use directives to customize appearance:
#fill: #ffeeff - Background color
#stroke: #333 - Border color
#fontSize: 14 - Font size
Learn More About Nomnoml
For comprehensive nomnoml documentation:
- Official Nomnoml Website - Live editor and examples
- Nomnoml GitHub Repository - Source code and documentation
Feature Requests
Have an idea for a new feature? I'd love to hear it! Send your suggestions to bhavnani.naveen@gmail.com.
Report a Bug
Found something that's not working correctly? Please email me with:
- Steps to reproduce the issue
- The nomnoml syntax that caused the problem
- What you expected to happen
- What actually happened
- Screenshots if possible