https://github.com/astares/pharo-yuml
Simple YUML Link generator to document classes in Pharo
https://github.com/astares/pharo-yuml
pharo
Last synced: about 1 year ago
JSON representation
Simple YUML Link generator to document classes in Pharo
- Host: GitHub
- URL: https://github.com/astares/pharo-yuml
- Owner: astares
- License: mit
- Created: 2020-02-13T23:48:48.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-02-14T09:26:04.000Z (over 6 years ago)
- Last Synced: 2025-02-11T11:40:37.024Z (over 1 year ago)
- Topics: pharo
- Language: Smalltalk
- Size: 21.5 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pharo-YUML
Simple YUML Link generator to document class hierarchies in [Pharo](http://www.pharo.org).
## Introduction
Sometimes it is helpful to create a simple class hierarchy diagram within your documentation. There is an online service [yuml.me](http://yuml.me) which is able to generate diagrams based on given URL parameters.
At it is cumbersome to write the URL pattern manually this little utility project allows you to directly generate a link from a given Pharo class to display a diagram of the subclass hierarchy.
## Quick Start
You can load the project from Pharo catalog or via the following load script:
```Smalltalk
Metacello new
repository: 'github://astares/Pharo-YUML/src';
baseline: 'YUML';
load
```
## Documentation
The project includes a simple class that you can use to generate the link by giving the start of the hierarchy. For example the expression:
```Smalltalk
YUMLGenerator new generateHierarchyFor: String
```
will return a URL string for [yuml.me](http://yuml.me) service:
```
https://yuml.me/diagram/class/class/[String],[String]%5E-[ByteString],[String]%5E-[Symbol],[Symbol]%5E-[ByteSymbol],[Symbol]%5E-[WideSymbol],[String]%5E-[WideString]
```
which you can open in a browser manually but also easily embedd into your documentation.
If you want to check directly you can evaluate:
```Smalltalk
YUMLGenerator open: String
```
while will open your local webbrowser on the generated URL link