[Uml-devel] Missing kdesdk/doc/umbrello files
Sebastian Stein
seb_stein at gmx.de
Tue Nov 4 03:22:03 UTC 2003
Am I wrong or are the following files not in KDE CVS?
faq.docbook
installation.docbook
menu_reference.docbook
I don't understand it, because I get them in the German language module. I
found some mistakes in the original docs, so I wanted to fix it, but the
docs are not there. But they are on my hard drive...
I've attached the 3 files, because I made some small changes to it.
Steinchen
--
Umbrello UML Modeller
Description : UML diagram drawing tool for KDE with code generation
Homepage : http://www.umbrello.org/
Bug Reports : http://bugs.kde.org/
CVS : kdesdk/umbrello on cvs.kde.org:/home/kde
-------------- next part --------------
<chapter id="faq">
<title><acronym>FAQ</acronym> —Frequently Asked Questions</title>
<qandaset>
<qandaentry>
<question>
<para>There are &UML; icons missing in my toolbar, where are they?</para>
</question>
<answer>
<para>You probably not installed &umbrello; correctly, and it cannot find the icons.</para>
<para>If you installed &umbrello; from a pre-compiled binary package, please contact the packager
and inform him about this so that he can fix the package. If you installed from source you probably
did not pass the correct <option>--prefix</option> argument to <command>configure</command>.
Please read the installation chapter of this documentation.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>I have another question not answered by this documentation, where can I find further information?</para>
</question>
<answer>
<para>If you have a question about usage of &umbrello; or about &UML; in general, you can subscribe and write
a mail to the &umbrello;'s user list at <email>umbrello at kde.org</email>
</para>
<para>
If you have a question about &umbrello;'s development, you can contact the developers directly by subscribing
and sending a mail to the &umbrello;'s developers list at <email>umbrello-devel at kde.org</email>
</para>
<para>
Further information and contact addresses, as well as archives of the mailing lists can be found on
<ulink url="http://uml.sf.net">&umbrello;'s home page at http://uml.sf.net</ulink>.
</para>
</answer>
</qandaentry>
</qandaset>
</chapter>
-------------- next part --------------
<chapter id="menu-reference">
<title>Menu Reference</title>
<para>This Chapter is a quick reference of the commands found in &umbrello;'s menus.</para>
<sect1 id="file-menu">
<title>The <guimenu>File</guimenu> Menu</title>
<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut><keycombo>&Ctrl;<keycap>N</keycap></keycombo></shortcut>
<guimenu>File</guimenu><guimenuitem>New</guimenuitem>
</menuchoice></term>
<listitem><para>Creates a new model (new document). If you have made changes to your current
model you will be asked if these should be saved before creating the new document.
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut><keycombo>&Ctrl;<keycap>O</keycap></keycombo></shortcut>
<guimenu>File</guimenu><guimenuitem>Open</guimenuitem>
</menuchoice></term>
<listitem><para>
Opens an existing file. If your current file has been modified, you will have the option
of saving your document before opening the new file.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu><guimenuitem>Open Recent</guimenuitem>
</menuchoice></term>
<listitem><para>
Opens one of the most recently used documents. If there are any changes that need to be saved
before loading the new document, you will have the option to do so.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut><keycombo>&Ctrl;<keycap>S</keycap></keycombo></shortcut>
<guimenu>File</guimenu><guimenuitem>Save</guimenuitem>
</menuchoice></term>
<listitem><para>Saves the current document to disk. If the file has not been saved before, you will have
to specify a name and a path for the file.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu><guimenuitem>Save As...</guimenuitem>
</menuchoice>
</term>
<listitem><para>Saves the current document under a different name or in a different location</para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut><keycombo>&Ctrl;<keycap>P</keycap></keycombo></shortcut>
<guimenu>File</guimenu><guimenuitem>Print...</guimenuitem>
</menuchoice></term>
<listitem><para>Prints the current diagram</para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut><keycombo>&Ctrl;<keycap>W</keycap></keycombo></shortcut>
<guimenu>File</guimenu><guimenuitem>Close</guimenuitem>
</menuchoice></term>
<listitem>
<para>Closes the current document. If the file needs to be saved you will have the option to do
so before closing the document. When you close the current document &umbrello; will automatically
create a new, empty document</para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut><keycombo>&Ctrl;<keycap>Q</keycap></keycombo></shortcut>
<guimenu>File</guimenu><guimenuitem>Quit</guimenuitem>
</menuchoice></term>
<listitem>
<para>Exits the application. If the current document has been modified you have the option of saving
your changes before terminating &umbrello;</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="edit-menu">
<title>The <guimenu>Edit</guimenu> Menu</title>
<variablelist>
<varlistentry>
<term><menuchoice><shortcut>
<keycombo>&Ctrl;<keycap>X</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu><guimenuitem>Cut</guimenuitem>
</menuchoice></term>
<listitem>
<para>Cuts the currently selected objects and puts them into the clipboard.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice><shortcut>
<keycombo>&Ctrl;<keycap>C</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu><guimenuitem>Copy</guimenuitem>
</menuchoice></term>
<listitem>
<para>Copies the selected objects to the clipboard.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice><shortcut>
<keycombo>&Ctrl;<keycap>V</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu><guimenuitem>Paste</guimenuitem>
</menuchoice></term>
<listitem>
<para>Pastes the contents of the application clipboard</para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice><shortcut>
<keycombo>&Ctrl;<keycap>A</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu><guimenuitem>Select All</guimenuitem>
</menuchoice></term>
<listitem><para>
Selects all the items in the current diagram</para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice><shortcut><keycap>Delete</keycap></shortcut>
<guimenu>Edit</guimenu><guimenuitem>Delete Selected</guimenuitem>
</menuchoice></term>
<listitem>
<para>Removes the currently selected items from the Diagram.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="diagram-menu">
<title>The <guimenu>Diagram</guimenu> Menu</title>
<variablelist>
<varlistentry>
<term><menuchoice>
<guimenu>Diagram</guimenu>
<guisubmenu>New</guisubmenu>
</menuchoice></term>
<listitem>
<para>The <guisubmenu>New</guisubmenu> submenu allows you to create the different types of diagrams.</para>
<para>The entries available are:
<itemizedlist>
<listitem><para><guimenuitem>Class Diagram</guimenuitem></para></listitem>
<listitem><para><guimenuitem>Sequence Diagram</guimenuitem></para></listitem>
<listitem><para><guimenuitem>Collaboration Diagram</guimenuitem></para></listitem>
<listitem><para><guimenuitem>Use Case Diagram</guimenuitem></para></listitem>
<listitem><para><guimenuitem>State Diagram</guimenuitem></para></listitem>
<listitem><para><guimenuitem>Activity Diagram</guimenuitem></para></listitem>
</itemizedlist>
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Diagram</guimenu>
<guisubmenu>Show</guisubmenu>
</menuchoice></term>
<listitem>
<para>The <guisubmenu>Show</guisubmenu> submenu allows you to select one of your diagrams and makes it
the active diagram.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Diagram</guimenu><guimenuitem>Clear Diagram</guimenuitem>
</menuchoice></term>
<listitem><para>
Clears (deletes) the contents of the active diagram.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Diagram</guimenu>
<guimenuitem>Snap to Grid</guimenuitem>
</menuchoice></term>
<listitem>
<para>Aligns the elements in the active diagram to the grid.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Diagram</guimenu>
<guimenuitem>Show Grid</guimenuitem>
</menuchoice></term>
<listitem>
<para>Shows the grid for the current diagram.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Diagram</guimenu>
<guimenuitem>Delete</guimenuitem>
</menuchoice></term>
<listitem>
<para>Deletes the active diagram.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Diagram</guimenu>
<guimenuitem>Export as Picture...</guimenuitem>
</menuchoice></term>
<listitem><para>
Exports the active diagram as a PNG picture.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Diagram</guimenu>
<guisubmenu>Zoom</guisubmenu></menuchoice>
</term>
<listitem><para> Scale the active diagram by the amount chosen,
relative to it's original size. You can choose ratios from
<guimenuitem>33%</guimenuitem> up to
<guimenuitem>300%</guimenuitem></para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Diagram</guimenu>
<guimenuitem>Properties...</guimenuitem>
</menuchoice></term>
<listitem>
<para>Shows the properties dialog for the active diagram.</para>
<!-- LW: Is this dialog explained anywhere? This should link to that explanation. -->
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="code-menu">
<title>The <guimenu>Code</guimenu> Menu</title>
<variablelist>
<varlistentry>
<term><menuchoice>
<guimenu>Code</guimenu>
<guimenuitem>Import Classes...</guimenuitem></menuchoice>
</term>
<listitem><para>Allows you to import classes from programming source code into your model.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Code</guimenu>
<guimenuitem>Code Generation Wizard...</guimenuitem>
</menuchoice></term>
<listitem>
<para>Shows a wizard to guide you through the process of code generation.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Code</guimenu>
<guimenuitem>Generate All Code</guimenuitem>
</menuchoice></term>
<listitem><para>Immediately generates code for all classes in your model, using the parameters configured
in the code generation settings.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice><guimenu>Code</guimenu>
<guisubmenu>Active Language</guisubmenu></menuchoice></term>
<listitem>
<para>Allows you to select the active language, which will be used as default for code generation.
</para></listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="settings-menu">
<title>The <guimenu>Settings</guimenu> Menu</title>
<variablelist>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Show Toolbar</guimenuitem>
</menuchoice></term>
<listitem>
<para>Shows or hides the toolbar.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Show Statusbar</guimenuitem>
</menuchoice></term>
<listitem>
<para>Shows or hides the statusbar.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Show Documentation</guimenuitem>
</menuchoice></term>
<listitem>
<para>Shows or hides the documentation window.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure &umbrello;...</guimenuitem>
</menuchoice></term>
<listitem>
<para>Allows you configure many aspects of the application.</para>
<!-- LW: The configuration dialog needs a section somewhere. -->
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="help-menu">
<title>The <guimenu>Help</guimenu> Menu</title>
&help.menu.documentation;
</sect1>
</chapter>
-------------- next part --------------
<appendix id="installation">
<title>Installation</title>
<sect1 id="general_instructions">
<title>General Instructions</title>
<para>
The easiest way to install &umbrello; is to get a pre-compiled binary package for your system.
<!-- If you are running Linux, chances are that your distribution
includes Umbrello UML Modeller, so you can install it directly from
your CDs. FIXME not true as far as I know -->
<!-- LW: Above is absolutely true now that it's part of KDE -->
If you prefer to compile your applications yourself or are running a system
for which there are no binary packages, you can download the sources and follow the instructions for
source installations.
</para>
<!-- LW: Removing, but leaving intact. No point having our translators
work on this, it's largely irrelevant to apps in KDE releases, but
umbrello developers might want to make a standalone release before 3.2
is done -->
<!--
<para>
The &umbrello; developers only release source packages of the program, and these source packages are
the only ones we can officially support. However,
FIXME I officially support the packages I make
We understand that for many users it is difficult to
install a program from sources, so we try to build pre-compiled packages for the systems/distributions
we have access to.
If you want to install &umbrello; from a binary package
you can check if there is a pre-compiled package available for your platform at
<ulink url="http://uml.sourceforge.net">&umbrello;'s home page</ulink>.
There we will publish the packages we can make ourselves, as well as packages made by 3rd parties for
the systems we do not have access to.
</para>
<para>
If you can make a binary package for a distribution for which there are currently no packages available
at our site, please consider contacting the &umbrello; developers and contributing your package so that
other users can benefit from it.
</para> -->
</sect1>
<sect1 id="binary_installation">
<title>Binary Package Installation</title>
<para>
To install &umbrello; from a pre-compiled package, use the package management program that
came with your system.
You can also call the package manager directly from the command line.
For example, to install a deb package change to the directory where you downloaded the file
and enter the following command:
<screen width="40">
<prompt>% </prompt><userinput>dpkg -i umbrello-1.1-i386.deb</userinput>
</screen>
</para>
<para>
In case of rpm packages the command to enter is
<screen width="40">
<prompt>% </prompt><userinput>rpm -i umbrello-1.1-i386.rpm</userinput>
</screen>
</para>
<para>
For other platforms, please consult the documentation provided with your system.
</para>
</sect1>
<sect1 id="source_installation">
<title>Source Installation</title>
&install.compile.documentation;
<!-- LW: Leaving intact, in case umbrello makes a standalone release prior to KDE 3.2. -->
<!-- Once Umbrello is being released as normal with the rest of KDE, individual -->
<!-- instructions make no sense, and can be removed -->
<!--
<para>
When installing from sources it is important that you check the README and INSTALL files
for the latest information on this program.
</para>
<para>
In order to install the program, the first step is to unpack the sources so that you can build them.
To do this, cd into the directory where you downloaded the archive file and execute the following command.
<screen width="40">
<prompt>% </prompt><userinput>tar -xvzf umbrello-1.1.tar.gz</userinput>
</screen>
</para>
<para>
This will create a new directory into which all source files are contained.
</para>
<para>
The next step is to change into this new directory to configure and build the program.
For this you need to execute following commands:
<screen width="40">
<prompt>% </prompt><userinput>./configure ––prefix=<path to your KDE base directory here></userinput>
<prompt>% </prompt><userinput>make</userinput>
</screen>
</para>
<para>
Please substitute the correct path for your base KDE installation in the <quote>–-prefix</quote>, as this
will make sure &umbrello; finds all the files and libraries it needs to work correctly when you install it.
</para>
<para>
When the build process finishes, the only thing left to do is to install the files to their final
destination. Normally you will need root access for this, in which case you should execute
<screen width="40">
<prompt>% </prompt><userinput>su</userinput>
</screen>
</para>
<para>
and then enter the <systemitem> root password. To finally install the program simply type
<screen width="40">
<prompt>% </prompt><userinput>make install</userinput>
</screen>
</para> -->
</sect1>
<sect1 id="running_program">
<title>Starting the program</title>
<para>
Once you have installed &umbrello;, you can run it from any command line by typing:
<screen>
<prompt>%</prompt> <userinput><command>umbrello</command></userinput>
</screen>
</para>
<para>
Or by selecting the entry from the &kmenu;.
The program is located under the <guimenu>Development</guimenu> menu as <guimenuitem>Umbrello UML Modeller</guimenuitem>.
</para>
<screenshot>
<screeninfo>&umbrello;'s main window</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="pics/umbrello-main-screen.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>The main window of &umbrello;</phrase>
</textobject>
<caption>
<para>The main window of &umbrello;
</para>
</caption>
</mediaobject>
</screenshot>
</sect1>
</appendix>
More information about the umbrello-devel
mailing list