| 1 | [[PageOutline(2-5,Contents,pullout)]] |
| 2 | |
| 3 | = yuml.me preprocessor macro = |
| 4 | |
| 5 | == Description == |
| 6 | |
| 7 | A preprocessor for including UML diagrams using the http://yuml.me service. |
| 8 | |
| 9 | Following diagrams are supported: |
| 10 | |
| 11 | * use case diagrams |
| 12 | * class diagrams |
| 13 | * activity diagrams |
| 14 | |
| 15 | See the yuml.me site for information on the syntax to be used. |
| 16 | |
| 17 | == Bugs/Feature Requests == |
| 18 | |
| 19 | Existing bugs and feature requests for YumlPreprocessorMacro are |
| 20 | [report:9?COMPONENT=YumlPreprocessorMacro here]. |
| 21 | |
| 22 | If you have any issues, create a |
| 23 | [http://trac-hacks.org/newticket?component=YumlPreprocessorMacro&owner=dthomas new ticket]. |
| 24 | |
| 25 | == Download == |
| 26 | |
| 27 | Download the zipped source from [download:yumlpreprocessormacro here]. |
| 28 | |
| 29 | == Source == |
| 30 | |
| 31 | You can check out YumlPreprocessorMacro from [http://trac-hacks.org/svn/yumlpreprocessormacro here] using Subversion, or [source:yumlpreprocessormacro browse the source] with Trac. |
| 32 | |
| 33 | == Example == |
| 34 | |
| 35 | {{{ |
| 36 | {{{ |
| 37 | #!YumlUseCase |
| 38 | [User]-(Login) |
| 39 | [User]-(Logout) |
| 40 | (Login)<(Reminder) |
| 41 | (Login)>(Captcha) |
| 42 | }}} |
| 43 | }}} |
| 44 | |
| 45 | {{{ |
| 46 | {{{ |
| 47 | #!YumlActivity |
| 48 | (start)-><d1>logged in->(Show Dashboard)->|a|->(end) |
| 49 | <d1>not logged in->(Show Login)->|a| |
| 50 | }}} |
| 51 | }}} |
| 52 | |
| 53 | {{{ |
| 54 | {{{ |
| 55 | #!YumlClass |
| 56 | [Customer]+1->*[Order] |
| 57 | [Order]++1-items >*[LineItem] |
| 58 | [Order]-0..1>[PaymentMethod] |
| 59 | }}} |
| 60 | }}} |
| 61 | |
| 62 | |
| 63 | |
| 64 | == Recent Changes == |
| 65 | |
| 66 | [[ChangeLog(yumlpreprocessormacro, 3)]] |
| 67 | |
| 68 | == Author/Contributors == |
| 69 | |
| 70 | '''Author:''' [wiki:dthomas] [[BR]] |
| 71 | '''Maintainer:''' [wiki:dthomas] [[BR]] |
| 72 | '''Contributors:''' |