Difference between revisions of "Umbrello/FAQ"

Jump to: navigation, search
(fix formatting, remove outdated parts)
(Marked this version for translation)
Line 7: Line 7:
 
The current stable version 2.9.4 is based on [http://techbase.kde.org/Getting_Started/Build/KDE4 KDE 4].
 
The current stable version 2.9.4 is based on [http://techbase.kde.org/Getting_Started/Build/KDE4 KDE 4].
  
 +
<!--T:58-->
 
There are also versions available for [http://uml.sourceforge.net/download.php download on this site] for older KDE releases.
 
There are also versions available for [http://uml.sourceforge.net/download.php download on this site] for older KDE releases.
  
Line 15: Line 16:
 
===Can I use Umbrello command line features without an X server ?=== <!--T:5-->
 
===Can I use Umbrello command line features without an X server ?=== <!--T:5-->
  
 +
<!--T:59-->
 
No, unfortunately the existence of a graphics display is encoded deep into Umbrello's design.
 
No, unfortunately the existence of a graphics display is encoded deep into Umbrello's design.
 
As a workaround, you can use xvfb, which is part of xorg-x11-server or Xvnc to provide a virtual display without any real output.  For further discussion see {{Bug|283748}}.
 
As a workaround, you can use xvfb, which is part of xorg-x11-server or Xvnc to provide a virtual display without any real output.  For further discussion see {{Bug|283748}}.
Line 33: Line 35:
 
You would need to install it to a separate path using (from the <tt>build</tt> subdirectory in the source)
 
You would need to install it to a separate path using (from the <tt>build</tt> subdirectory in the source)
  
 +
<!--T:60-->
 
{{Input|1=cmake -DCMAKE_INSTALL_PREFIX=/home/me/kdedevelopment ..}}
 
{{Input|1=cmake -DCMAKE_INSTALL_PREFIX=/home/me/kdedevelopment ..}}
  
Line 38: Line 41:
 
then set to include this
 
then set to include this
  
 +
<!--T:61-->
 
{{Input|1=export KDEDIRS=`kde-config --prefix`:/home/me/foo}}
 
{{Input|1=export KDEDIRS=`kde-config --prefix`:/home/me/foo}}
  
Line 97: Line 101:
 
Versions before 1.4 used a file format that was only very loosely based on XMI and was not compatible with other UML programs.
 
Versions before 1.4 used a file format that was only very loosely based on XMI and was not compatible with other UML programs.
  
 +
<!--T:62-->
 
Version 1.4 can read the static structure elements from most other UML tools which use XMI 1.x. However, currently Umbrello cannot import XMI 2.0 or UML-DI (Diagram Interchange.)
 
Version 1.4 can read the static structure elements from most other UML tools which use XMI 1.x. However, currently Umbrello cannot import XMI 2.0 or UML-DI (Diagram Interchange.)
  
 +
<!--T:63-->
 
If you have a specific problem with XMI interchange then please add a detailed description to the {{Bug|56184}}.
 
If you have a specific problem with XMI interchange then please add a detailed description to the {{Bug|56184}}.
  
 
===Why don't I have any icons on the toolbar ?=== <!--T:39-->
 
===Why don't I have any icons on the toolbar ?=== <!--T:39-->
  
 +
<!--T:64-->
 
This occurs when you change the location of installing the program by using a prefix on <i>configure</i> and KDE is unaware of that location.
 
This occurs when you change the location of installing the program by using a prefix on <i>configure</i> and KDE is unaware of that location.
  
Line 111: Line 118:
 
Just add the following lines
 
Just add the following lines
  
 +
<!--T:65-->
 
{{Input|1=KDEDIRS="$KDEDIRS:<prefix use in configure>"
 
{{Input|1=KDEDIRS="$KDEDIRS:<prefix use in configure>"
 
export KDEDIRS}}
 
export KDEDIRS}}
Line 133: Line 141:
 
The following is taken from [irc://irc.freenode.net/kde-devel #kde-devel]
 
The following is taken from [irc://irc.freenode.net/kde-devel #kde-devel]
  
 +
<!--T:66-->
 
* one is a list of paths, the other is the single KDE installation path where the binaries and libs are expected to be
 
* one is a list of paths, the other is the single KDE installation path where the binaries and libs are expected to be
  
 +
<!--T:67-->
 
* KDEDIRS is supposed to be used for configfile location resolution
 
* KDEDIRS is supposed to be used for configfile location resolution
  
 +
<!--T:68-->
 
* -DCMAKE_INSTALL_PREFIX overrides $KDEDIR
 
* -DCMAKE_INSTALL_PREFIX overrides $KDEDIR
  
 +
<!--T:69-->
 
* install it wherever, but make sure that KDEDIR still points to the original KDE install path, and add the prefix where you're installing the app to KDEDIRS
 
* install it wherever, but make sure that KDEDIR still points to the original KDE install path, and add the prefix where you're installing the app to KDEDIRS
  
Line 155: Line 167:
 
Try asking [http://user-mode-linux.sourceforge.net/ User Mode Linux].
 
Try asking [http://user-mode-linux.sourceforge.net/ User Mode Linux].
  
 +
<!--T:70-->
 
[[Category:Development]]
 
[[Category:Development]]
  
 
</translate>
 
</translate>

Revision as of 19:41, 16 December 2012

Other languages:
English • ‎dansk • ‎français • ‎українська

What are the different versions of Umbrello ?

The current stable version 2.9.4 is based on KDE 4.

There are also versions available for download on this site for older KDE releases.

When submitting bug reports with Umbrello it is helpful if you have tested against a recent build from KDE SVN. Umbrello 2.x is based on the Qt4 and KDE4 technologies.

Can I use Umbrello command line features without an X server ?

No, unfortunately the existence of a graphics display is encoded deep into Umbrello's design. As a workaround, you can use xvfb, which is part of xorg-x11-server or Xvnc to provide a virtual display without any real output. For further discussion see bug #283748.

Can I submit a patch ?

We love patches. Patches should be against a current svn checkout. Then run

svn diff > mypatch.diff

to get the patch. Put the resulting patch on a webserver somewhere and send the URL with an explanation to uml-devel.

Umbrello takes up too much memory ?

Switch to a code generator other than C++ or Java. Recent SVN versions also allow Undo to be switched off. Current Umbrello handles memory much better than previous versions for large diagrams.

How can I install the development version in parallel to the production version ?

You would need to install it to a separate path using (from the build subdirectory in the source)

cmake -DCMAKE_INSTALL_PREFIX=/home/me/kdedevelopment ..

then set to include this

export KDEDIRS=`kde-config --prefix`:/home/me/foo

Can I help translate Umbrello into my spoken language ?

Certainly. As part of KDE you will have to work with the KDE i18n team for your language http://i18n.kde.org.

Umbrello contains some UML and programming specific terms. Take care to research the most understandable translations of these terms for your spoken language.

How do I write a code generator ?

First check that there isn't already one in the KDE SVN version of Umbrello.

Then read the instructions in codegenerator.h and use one of the other generators as a template. The C++ and Java code generators are a lot more advanced than the rest, it would be nice to have the others offer the same functionality as them.

Why the silly name ?

The program's name is Umbrello UML Modeller. The shortened form is Umbrello. When translating it translate UML Modeller in the most sensible way or if it can not be easily translated it can be left out. Umbrello should generally be left as is when translating to Latin alphabet languages.

Previously the program was called UML Modeller or UML Object Modeller or just UML. This was considered too generic by packagers and others. After some consultation and a public vote Umbrello showed surprising popularity, so the name Umbrello UML Modeller is now used. Umbrello does not mean anything as far as we know.

In sequence diagrams how do I extend the object's lifeline ?

Drag a message arrow downwards.

In previous versions you had to click and drag with the mouse at the bottom of the object's vertical line.

My package format is not supported and I can't install from source, what do I do ?

Contact us and if there are enough requests, we may be able to find a way to help you.

Can I have SVN write access ?

Umbrello is now part of KDE (in kdesdk). Anyone with a KDE SVN account can commit changes. Anything significant should be run past the mailing list first.

Can I have bugs.kde.org write access ?

You firstly need write access to KDE's SVN. Then make sure your address in kde-common/accounts (kde-common is a SVN module) is the same as the one used by your bugs.kde.org account.

Some UML features that I need don't seem to be supported ?

Let us know what features you require. The most requested features will be the first features introduced.

What file format does the program use ?

Versions before 1.4 used a file format that was only very loosely based on XMI and was not compatible with other UML programs.

Version 1.4 can read the static structure elements from most other UML tools which use XMI 1.x. However, currently Umbrello cannot import XMI 2.0 or UML-DI (Diagram Interchange.)

If you have a specific problem with XMI interchange then please add a detailed description to the bug #56184.

Why don't I have any icons on the toolbar ?

This occurs when you change the location of installing the program by using a prefix on configure and KDE is unaware of that location.

To help KDE find the program you have to edit the environmental variable KDEDIRS. You will need to consult your distribution documentation for the exact file to edit, but there's a chance it will be .bash_profile in your home directory if you are the only one to use the program. If more than one person will use the program you can edit the file profile in the etc directory.

Just add the following lines

KDEDIRS="$KDEDIRS:<prefix use in configure>"
export KDEDIRS

Run

kbuildsycoca4

the first time you do this.

If you compiled from source you may have installed Umbrello in /usr/local or /usr/local/kde in which case you can add that directory to $KDEDIRS or change -DCMAKE_INSTALL_PREFIX so it installs in /usr or /opt/kde or whatever the norm for your distribution is.

I can't export diagrams as images, it complains about the mime type ?

Check your KDE install and upgrade or recompile kdelibs if possible.

Then delete /tmp/kde-storri/ksycoca file and restarting Umbrello fixed the problem.

What's the difference between $KDEDIR and $KDEDIRS ?

The following is taken from #kde-devel

  • one is a list of paths, the other is the single KDE installation path where the binaries and libs are expected to be
  • KDEDIRS is supposed to be used for configfile location resolution
  • -DCMAKE_INSTALL_PREFIX overrides $KDEDIR
  • install it wherever, but make sure that KDEDIR still points to the original KDE install path, and add the prefix where you're installing the app to KDEDIRS

Does Umbrello run on Windows ?

Yes. Umbrello is part of the KDE on Windows initiative.

My problem still isn't solved - help!

If it is a user related problem, send an e-mail to the uml-user mailing list. If it is a developer problem, try the uml-devel mailing list. Details of the mailing lists can be found on the contact page.

My user-mode-linux won't work ?

Try asking User Mode Linux.


Content is available under Creative Commons License SA 4.0 unless otherwise noted.