Changeset 1047

Timestamp:

10/28/06 07:25:18 (2 years ago)

Author:

wrobell

Message:

- added name align sketch
- specification of named items styles related to name align finished

- document structure improvements

• defined pylst environment
  
• defined code float environment
  

- clear up name align specification

- document structure improvements - use code extension for float code listings

Files:

• gaphor/branches/new-canvas/doc/items.tex (modified) (5 diffs)

gaphor/branches/new-canvas/doc/items.tex

@@ -1 @@
-[draft]
+
-\usepackage[papername = a4paper, margin = 3cm]{geometry}
-\usepackage{graphicx}
-\usepackage{hyperref}
+\usepackage{listings}
+\usepackage{float}
-
-\title{Gaphor Diagram Item Model}
-\author{wrobell@pld-linux.org}
+
+\newfloat{code}{th}{code}
+
+\lstnewenvironment{pylst}{\lstset{language=Python}}{}
-
-\newcommand{\rmodule}[1]{\texttt{#1}}
@@ -149 +155 @@
-applies for tail.
-
-
+\label{itemstyles}
-All the items are going to contain different parts.
-Many of such parts can be shared by other items, for example
@@ -184 +190 @@
-\iattr{\_\_stereotype\_\_}{item static stereotype}
-\iattr{\_\_style\_\_}{item styles information}
+\iattr{style}{item style information}
-\end{attrs}
-\begin{entitydesc}
@@ -313 +320 @@
-changed, i.e. initial node item.
-
+It should be possible to align name of named element with styles
+(see~\ref{itemstyles}) as depending on an element, the name can be
+displayed in different places related to an item, i.e.
+\begin{itemize}
+\item class               --- top center
+\item use case            --- middle center
+\item object node         --- middle center
+\item actor               --- bottom center, outside item bounduaries
+\item initial action node --- top left, outside item bounduaries
+\item decision node       --- bottom center, outside item bounduaries
+\end{itemize}
+
-%fixme: there can be items with initial name and without initial name
+
+\section{Styles}
+Kind of information we need to align the name
+\begin{itemize}
+\item horizontal align information (left, center or right)
+\item vertical align information (top, middle or bottom)
+\item padding specified as in CSS (top right bottom left)
+\item is name outside an item?
+\end{itemize}
+
+Styles for name align are defined in table~\ref{nameditems:styles:spec}
+(see diagram~\ref{nameditems:styles:example} for example).
+
+\begin{table}
+\begin{center}
+\begin{tabular}{|l|l|l|}
+\hline
+Name           & Default value     & Description \\
+\hline
+name--align    & ('center', 'top') & align information \\
+name--padding  & (5, 5, 5, 5)      & name padding \\
+name--outside  & False             & name outside/inside item bounduaries \\
+\hline
+\end{tabular}
+\caption{Specification of name align styles}\label{nameditems:styles:spec}
+\end{center}
+\end{table}
+
+%\item vertical align information (top, middle or bottom)
+%\item padding specified as in CSS (top right bottom left)
+%\item is name outside an item?
+
+\begin{code}
+\lstset{language={Python}}
+\begin{pylst}
+class NamedItem(DiagramItem):
+    __style__ = {
+        'name-align' : ('center', 'top'),
+        'name-padding': (5, 5, 5, 5),
+        'name-outside': False,
+    }
+\end{pylst}
+\caption{Named items style example}\label{nameditems:styles:example}
+\end{code}
-
-\section{Classes}
@@ -320 +383 @@
-\begin{class}{NamedItem}
-\begin{entitydesc}
-
+
+
-\end{entitydesc}
-\end{class}