forked from xuyuan/pgf-umlcd
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathpgf-umlcd-manual.tex
160 lines (132 loc) · 4.52 KB
/
pgf-umlcd-manual.tex
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
% Manual of pgf-umlcd.sty, a convenient set of macros for drawing UML
% class diagrams.
% Written by Xu Yuan <[email protected]>
% This file is part of pgf-umlcd
% you may get it at http://code.google.com/p/pgf-umlcd/
\documentclass{article}
\usepackage[margin=12mm]{geometry}
\usepackage{hyperref}
\usepackage[
% school,
% simplified
]{pgf-umlcd}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\usepackage{listings}
\usepackage{color}
\definecolor{listinggray}{gray}{0.92}
\lstset{ %
language=[LaTeX]TeX,
breaklines=true,
frame=single,
% frameround=tttt,
basicstyle=\footnotesize\ttfamily,
backgroundcolor=\color{listinggray},
keywordstyle=\color{blue}
}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\hypersetup{
colorlinks=true,
linkcolor=blue,
anchorcolor=black,
citecolor=olive,
filecolor=magenta,
menucolor=red,
urlcolor=blue
}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\newcommand{\demo}[2][1]{
\begin{minipage}{.49\linewidth}
\centering
\resizebox{#1\linewidth}{!}{
\input{demo/#2}
}
\end{minipage}
\hspace{0.01\linewidth}
\begin{minipage}{.5\linewidth}
\lstinputlisting{demo/#2}
\end{minipage}
}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\newcommand{\example}[1]{
\resizebox{\linewidth}{!}{
\input{demo/#1}
}
\lstinputlisting{demo/#1}
}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{document}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\title{Drawing UML Class Diagram by using \texttt{pgf-umlcd}}
\author{\href{mailto:[email protected]}{Yuan Xu}}
\date{\today{}~(v0.2.1)}
\maketitle
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{abstract}
\texttt{pgf-umlcd} is a LaTeX package for drawing UML Class
Diagrams. As stated by its name, it is based on a very popular
graphic package \texttt{PGF/TikZ}. This document presents the usage
of \texttt{pgf-umlcd} and collects some UML class diagrams as
examples. \texttt{pgf-umlcd} can be downloaded from
\href{http://code.google.com/p/pgf-umlcd/}{http://code.google.com/p/pgf-umlcd/}.
\end{abstract}
\tableofcontents
\section{Basics}
\subsection{Class with attributes and operations}
Note: If you don't want to show empty parts in the diagrams, please
use \texttt{simplified} option, e.g. \lstinline|\usepackage[simplified]{pgf-umlcd}|.\\
\demo{class}
\subsubsection{Visibility of attributes and operations}
\demo[0.8]{visibility}
\subsubsection{Abstract class and interface}
\demo[0.5]{abstract-class}
\demo[0.5]{interface}
\subsubsection{Object}
\demo[0.7]{object}
Note: Object with rounded corners and methods are used in German school for didactic reasons. You get the rounded corners with \lstinline|\usepackage[school]{pgf-umlcd}|. If you need both in one document you can switch it with \lstinline|\switchUmlcdSchool| \\
\switchUmlcdSchool
\demo[0.7]{object}
\demo[0.7]{object-include-methods}
\subsubsection{Note}
The \lstinline|\umlnote| use the same syntax as tikz command
\lstinline|\node|, e.g. \lstinline|\umlnote[style] (name) at (coordinate) {text};|
\demo[0.7]{note}
\subsection{Inheritance and implement}
\subsubsection{Inheritance}
\demo{inheritance}
\subsubsection{Multiple Inheritance}
\demo{multiple-inheritance}
\subsubsection{Implement an interface}
\demo{implement-interface}
\subsection{Association, Aggregation and Composition}
\subsubsection{Association}
\demo{association}
\subsubsection{Unidirectional association}
\demo{unidirectional-association}
\subsubsection{Aggregation}
\demo{aggregation}
\subsubsection{Composition}
\demo{composition}
\subsection{Package}
\demo{package}
\section{Customization}
\subsection{Color settings}
The color of digram is defined by \lstinline|\umltextcolor|, \lstinline|\umldrawcolor| and \lstinline|\umlfillcolor|, such as:
\demo{color}
\section{Examples}
\subsection{Abstract Factory}
\example{abstract-factory}
\section{Acknowledgements}
Many people contributed to \texttt{pgf-umlcd} by reporting problems,
suggesting various improvements or submitting code. Here is a list of
these people: \href{mailto:[email protected]}{Martin Quinson},
\href{mailto:[email protected]}{Johannes Pieper},
\href{mailto:[email protected]}{sh w},
and \href{mailto:[email protected]}{Maarten van Dessel}.
\end{document}
%%% Local Variables:
%%% mode: Tex-PDF
%%% TeX-master: t
%%% End: