... | ... | @@ -10,7 +10,7 @@ |
|
|
|
|
|
---
|
|
|
|
|
|
![Don't do this. Please.](https://gitlab2.informatik.uni-wuerzburg.de/s337805/public/blob/master/styleguide/dont.png "Spaghetti!")
|
|
|
![Don't do this. Please.](https://gitlab2.informatik.uni-wuerzburg.de/s337805/public/raw/master/styleguide/dont.png "Spaghetti!")
|
|
|
(This is bad.)
|
|
|
|
|
|
|
... | ... | @@ -44,7 +44,7 @@ There's a few things you should keep in mind while cleaning up your blueprints. |
|
|
|
|
|
## Typical workflow
|
|
|
|
|
|
![Step One](https://gitlab2.informatik.uni-wuerzburg.de/IGAME/IG-Management/raw/master/styleguide/1.png)
|
|
|
![Step One](https://gitlab2.informatik.uni-wuerzburg.de/s337805/public/raw/master/styleguide/1.png)
|
|
|
|
|
|
Say, you have been working on a cool feature inside a Blueprint all day and now you're as good as done, but you want to do the Integrations-team a favor and you decide to make the Blueprint look pretty. Where should you start?
|
|
|
|
... | ... | @@ -52,13 +52,13 @@ Say, you have been working on a cool feature inside a Blueprint all day and now |
|
|
|
|
|
Make sure the most important line in your Blueprint is straight. in this example (and probably in most other cases) that's the white line which's job is to link Elements in their order of Execution. Most Elements have just one In- and Output, so this should be pretty straightforward.
|
|
|
|
|
|
![Step_Two](https://gitlab2.informatik.uni-wuerzburg.de/IGAME/IG-Management/raw/master/styleguide/2.png)
|
|
|
![Step_Two](https://gitlab2.informatik.uni-wuerzburg.de/s337805/public/raw/master/styleguide/2.png)
|
|
|
|
|
|
#### Step 2: Stretch
|
|
|
|
|
|
Once your main line is straight, you can focus on having all lines point "forwards", that is to the right. Lines should never flow in inverted "S" shapes, stretch your Blueprint to the right until that doesn't happen anymore.
|
|
|
|
|
|
![Step_Three](https://gitlab2.informatik.uni-wuerzburg.de/IGAME/IG-Management/raw/master/styleguide/3.png)
|
|
|
![Step_Three](https://gitlab2.informatik.uni-wuerzburg.de/s337805/public/raw/master/styleguide/3.png)
|
|
|
|
|
|
#### Finally: Polishing
|
|
|
|
... | ... | @@ -69,12 +69,12 @@ Now hat you're done doing all that stuff, check the details. |
|
|
* Do you have wasted space between your elements? Move them back together!
|
|
|
* Do you have Elements that do similar things? Arrange them the same way so that someone looking at them can find a pattern quickly!
|
|
|
|
|
|
![Step_Four](https://gitlab2.informatik.uni-wuerzburg.de/IGAME/IG-Management/raw/master/styleguide/4.png)
|
|
|
![Step_Four](https://gitlab2.informatik.uni-wuerzburg.de/s337805/public/raw/master/styleguide/4.png)
|
|
|
|
|
|
## More images
|
|
|
|
|
|
Have a look at this before/after example. See how it started out with a lot of S-shaped and crossing lines? There's a solution for most Blueprints, and even though the red version still has some crossing and not every line is 100% straight, but it's a big improvement over the previous chaos.
|
|
|
|
|
|
![Before](https://gitlab2.informatik.uni-wuerzburg.de/IGAME/IG-Management/raw/master/styleguide/before.png)
|
|
|
![Before](https://gitlab2.informatik.uni-wuerzburg.de/s337805/public/raw/master/styleguide/before.png)
|
|
|
|
|
|
![after](https://gitlab2.informatik.uni-wuerzburg.de/IGAME/IG-Management/raw/master/styleguide/after.png) |
|
|
\ No newline at end of file |
|
|
![after](https://gitlab2.informatik.uni-wuerzburg.de/s337805/public/raw/master/styleguide/after.png) |
|
|
\ No newline at end of file |