Giter VIP home page Giter VIP logo

c4-draw.io's Introduction

C4 Modelling little bit easier (c4-draw.io)

Github-Pages on: https://tobiashochguertel.github.io/c4-draw.io/ (which is the same as the README.adoc file, but I think it’s better to read there…​)

About

You can make C4 Architecture Software System Models with draw.io.

This is a C4 Modelling plugin for draw.io, which provides C4 Notation Elements in draw.io.

Quick Start

  1. Access to https://www.draw.io/.

  2. Save the drawing, or decide later: FileSaveOption

  3. Open the plugin dialog: ExtrasPlugins

  4. Open the add plugin dialog with an click: Add

  5. Put in the field Enter Value (URL): the link to the plugin: https://tobiashochguertel.github.io/c4-draw.io/c4.js

  6. Click on Apply

  7. Reload the page! to see the C4 Notation Shapes in the shape panel (figure 1).

figure 1: After the reload, the C4 Notation Shapes are available from the shape panel:

C4NotationShapes

Usage

figure 2: Quick demonstration of how to use the c4-model plugin:

c4 draw.io preview demonstration

  1. Drag a C4 notation shape on the diagram paper

  2. The most C4 notation shapes provide an small gear icon when they are selected. (figure 3)

  3. Edit the Properties of the selected C4 Notation Shape: (figure 4)

    1. Click the small gear to open the properties dialog (figure 3)

    2. Press the key-stroke CMD+M to open the properties dialog (figure 3)

    3. ,or use the menu: EditEdit Data (CMD+M) (figure 6)

  4. Input Cursor / Focus is on the first field of the dialog, and with tab you can jump through the fields and submit (figure 5).

figure 3: Location of the small gear, to open the properties dialog:

small gear on c4 person shape

figure 4: Example of properties dialog of an C4-Person notation shape:

Data Editor Dialog to set the properties

figure 5: Control tab order of the properties fields:

Control Tab Order of C4 Notation Shape Properties Dialog

figure 6: Other way to open the properties dialog:

Open the Properties Dialog from Menu bar

Good-to-Know about the C4 shapes:

  • Some C4 shapes have issues/limitations which I description in this section:

C4-Relationship Notation shape:
  • Has also a properties dialog, but the small gear icon isn’t available with this shape. (technical reason, I haven’t found a solution, yet.)

  • To open for a C4 Relationship shape the Properties Editor: — key-stroke or over menu.

C4-Person Notation shape:
  • Has also a little technical issue, to open the properties dialog, — gear icon or over menu.

Modify the text on the shapes directly rather than using the properties dialog:
  1. is possible,

  2. can be handy when you want to (re-)format the text, e.g. bold, italic, font size or when you want to insert a line break within the text/properties.

  3. but keep in mind,

  4. if you change the text here directly, and as next open the properties dialog of this shape, your changes will get lost because the information on the shape will be reset to the values from the properties dialog.

Sorry for these issues, I keep fixing these in my spare time, feel free to create an issue, or provide an pull request, hints and ideas what We could improve!
— Tobias Hochgürtel

Key-Strokes

Table 1. Table 1: Key-Strokes
Key-Stroke Description

CMD+M

Open’s the Data-Editor Dialog (properties dialog) of an selected shape on the diagram.

Credits

I want to thank the following people and organisations:

  • Draw.io Plugin: AWS Step Functions Workflow Designer, which has inspired me to done this plugin, and what I use as code-base to done the plugin.

  • C4Model Author: Simon Brown, thanks for let me know that this us useful and thanks for sharing your knowledge about software architecture.

  • draw.io, to provide draw.io as open source software system.

c4-draw.io's People

Contributors

0bsearch avatar jdstuart avatar mcwarman avatar tobiashochguertel avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

c4-draw.io's Issues

Problems with collaborative editing in draw.io

We're seeing problems in our app when used with this plugin and collaborative editing, which was recently added for OneDrive and Google Drive, but also for GitHub and Device files (via File, Synchronize). The problem seems to be related to the plugin attaching data to cells outside of the cell.value property. The recommended and supported custom data storage in cells is inside an XML node in cell.value (see Edit, Edit Data). HTH

Template objects cannot be resized.

The images in the Readme show the diagram elements with resize handles on them. However, they do not seem to have them, nor can they be resized via Edit->Edit Geometry. This makes it very difficult to create diagrams of any complexity/lots of elements, on a normal document size.

Plugin showed up just once

Hi,
The plugin worked OK for me when I first added it. It does not show up when I tried to use it again, after a PC restart.
I looked into 'more shapes', but it is not there - and I also tried removing it and adding again, but still nothing.
Regards,
Bartosz

Add End-User Manual

As an possible customer of C4 draw.io plugin, I want to quick see if this plugin will help me to draw C4 Diagramms with draw.io. I'm specially interested in how the author of the plugin has thought how things have to be done, this is what I want be able to read about in the End-User Manual.

  • Explain which Keyboard Shortcuts are available.

Broken label in boxes/objects

I plugged in success C4-draw.io for draw.io tool. But every object (container, component, context, relationship) has label/title alignment wrong. Pls see attached error-image.
More detail: description, name, type aligned to right, to left or bottom so much - they should in center of object/box

How to setup this plugin to work in Desktop version of draw.io?

Hello, I downloaded a diagram created online on draw.io using your plugin (it worked great) and then I installed desktop version of Draw.io, which doesn't offer the Extras -> Plugins menu.

Everything look fine, but I can't create any more of your predefined shapes.

Any ideas?

BTW, good work.

copy/paste in draw.io

Hello,

I'm using draw.io v11.1.4 with C4 plugin on Windows. I cannot copy / paste C4 shapes with it.

  • Ctrl-C / Ctrl-V don't give anything
  • Copy with right-click, then Edit menu: Paste entry is disabled
  • Mouse drag with Ctrl key pressed simply moves the shape, doesn't duplicate it
  • Duplicate doesn't work

Even worse: C4 shapes are not / don't look available anymore.

Thanks for feedback.

Missing resize handles

I've installed the c4 plugin in diagrams.net 20.2.4 and everything seems to work, only the resize handles are missing. When I hover over a shape it's showing the connect elements and when I click on a shape it shows the stippled rectangle and the shape can be moved. The resize handles are missing, though.

Make the c4-draw.io Shapes looking nearly as the original from c4model.com

The Format of the Text on the Shapes looks ugly. The Formate is not the same as these from Simon Brown.

  • The First like with the Name isn't bold.
  • The font size is not pretty good.
  • Font Spacing should be improved to make the diagram more readable and clean looking.

Preferred way would be to develop the CSS style for the c4-draw.io plugin shapes by hold them next to the original Notation from c4model.com.

Quick Check recreate an existing complete Diagramm e.g. Pet Shop? or techtribes.js? with c4-draw.io plugin and hold the output next to, to see the differences and what can be improved in our CSS style.

External Plugins: External plugins disabled.

Seems that C4 shapes can be added to the current version of draw.io and actually it says "External Plugins: External plugins disabled.". Should this be mentioned at the README.md?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.