[kde-doc-english] [umbrello] doc: Cosmetic update of documentation
Yuri Chornoivan
yurchor at ukr.net
Sat Jun 1 15:03:59 UTC 2013
Git commit 72b758bff537fd836adef9b11633d3d449a80525 by Yuri Chornoivan.
Committed on 01/06/2013 at 17:03.
Pushed by yurchor into branch 'master'.
Cosmetic update of documentation
M +- -- doc/activity-diagram.png
D +- -- doc/add-remove-languages.png
M +- -- doc/aggregation.png
M +- -- doc/association.png
M +- -- doc/class-diagram.png
M +- -- doc/class.png
M +- -- doc/code-import.png
M +7 -7 doc/code_import_and_generation.docbook
M +- -- doc/collaboration-diagram.png
M +- -- doc/composition.png
M +1 -3 doc/credits.docbook
M +- -- doc/entity-relationship-diagram.png
M +- -- doc/entity.png
M +- -- doc/folders.png
M +- -- doc/generalization.png
M +- -- doc/generation-options.png
M +2 -2 doc/index.docbook
M +2 -1 doc/introduction.docbook
M +- -- doc/sequence-diagram.png
M +- -- doc/state-diagram.png
D +- -- doc/umbrello-ui-clean.png
M +- -- doc/umbrello-ui.png
M +- -- doc/use-case-diagram.png
M +9 -11 doc/working_with_umbrello.docbook
http://commits.kde.org/umbrello/72b758bff537fd836adef9b11633d3d449a80525
diff --git a/doc/activity-diagram.png b/doc/activity-diagram.png
index 97827fd..f9695b7 100644
Binary files a/doc/activity-diagram.png and b/doc/activity-diagram.png differ
diff --git a/doc/add-remove-languages.png b/doc/add-remove-languages.png
deleted file mode 100644
index dea7d9e..0000000
Binary files a/doc/add-remove-languages.png and /dev/null differ
diff --git a/doc/aggregation.png b/doc/aggregation.png
index 20ec173..0892a64 100644
Binary files a/doc/aggregation.png and b/doc/aggregation.png differ
diff --git a/doc/association.png b/doc/association.png
index 9f4cbd0..07d21de 100644
Binary files a/doc/association.png and b/doc/association.png differ
diff --git a/doc/class-diagram.png b/doc/class-diagram.png
index ad0a644..9e3e9a1 100644
Binary files a/doc/class-diagram.png and b/doc/class-diagram.png differ
diff --git a/doc/class.png b/doc/class.png
index 33d343f..3a4e5d4 100644
Binary files a/doc/class.png and b/doc/class.png differ
diff --git a/doc/code-import.png b/doc/code-import.png
index 85b04fb..5a6d2d2 100644
Binary files a/doc/code-import.png and b/doc/code-import.png differ
diff --git a/doc/code_import_and_generation.docbook b/doc/code_import_and_generation.docbook
index 1ced32c..345ebb3 100644
--- a/doc/code_import_and_generation.docbook
+++ b/doc/code_import_and_generation.docbook
@@ -18,7 +18,7 @@ of the class declarations, with their methods and attributes so you can <quote>f
blanks</quote> by providing the functionality of your classes' operations.
</para>
<para>
-&umbrello; 1.2 comes with code generation support for ActionScript, Ada, C++, CORBA IDL, &Java;, JavaScript, <acronym>PHP</acronym>, Perl, Python, SQL and XMLSchema.
+&umbrello; 2 comes with code generation support for ActionScript, Ada, C++, C#, D, IDL, &Java;, JavaScript, MySQL and Pascal.
</para>
<sect2 id="generate-code">
<title>Generating Code</title>
@@ -59,7 +59,7 @@ while writing your code. The following options are available:
<!-- LW; to rearrange -->
<sect4>
-<title>Code Verbosity</title>
+<title>Comment Verbosity</title>
<para>
The option <guilabel>Write documentation comments even if empty</guilabel> instructs the
Code Generator to write comments of the /** blah */ style even if the comment blocks are empty.
@@ -138,13 +138,13 @@ This will generate code for all the classes in your Model using the current sett
<title>Code Import</title>
<para>
&umbrello; can import source code from your existing projects to help you build Model of
-your systems. &umbrello; 1.2 supports only C++ source code, but other languages
-should be available in future versions.
+your systems. &umbrello; 2 supports ActionScript, Ada, C++, C#, D, IDL, &Java;, Javascript, MySQL, and Pascal source code.
</para>
<para>
-To import classes into your Model, select the entry <guimenuitem>Import Classes...</guimenuitem> from
-the <guimenu>Code</guimenu> menu. In the file dialog select the files containing the C++
-class declarations and press OK. The classes will be imported and you will find them as part of
+To import classes into your Model, select the entry <guimenuitem>Code Importing Wizard...</guimenuitem> from
+the <guimenu>Code</guimenu> menu. In the file dialog select the files containing
+class declarations and press <guibutton>Next ></guibutton> then <guibutton>Start import</guibutton> and <guibutton>Finish</guibutton>.
+The classes will be imported and you will find them as part of
your Model in the Tree View. Note that &umbrello; will not create any kind of Diagram for showing
your classes, they will only be imported into your Model so that you can use them later in any
diagram you want.
diff --git a/doc/collaboration-diagram.png b/doc/collaboration-diagram.png
index c177491..604db20 100644
Binary files a/doc/collaboration-diagram.png and b/doc/collaboration-diagram.png differ
diff --git a/doc/composition.png b/doc/composition.png
index 05cf7f7..5431472 100644
Binary files a/doc/composition.png and b/doc/composition.png differ
diff --git a/doc/credits.docbook b/doc/credits.docbook
index 807089a..48db7f2 100644
--- a/doc/credits.docbook
+++ b/doc/credits.docbook
@@ -2,9 +2,7 @@
<title>Copyright</title>
<para>Copyright 2001, Paul Hensgen</para>
-<para>Copyright 2002, 2003 The &umbrello; Authors. See
-<ulink url="http://uml.sf.net/developers.php">http://uml.sf.net/developers.php</ulink>
-for more information</para>
+<para>Copyright 2002-2013 The &umbrello; Authors.</para>
&underFDL;
&underGPL;
diff --git a/doc/entity-relationship-diagram.png b/doc/entity-relationship-diagram.png
index da17620..c86775f 100644
Binary files a/doc/entity-relationship-diagram.png and b/doc/entity-relationship-diagram.png differ
diff --git a/doc/entity.png b/doc/entity.png
index 1b11630..2a02dba 100644
Binary files a/doc/entity.png and b/doc/entity.png differ
diff --git a/doc/folders.png b/doc/folders.png
index 14b6b94..f516daf 100644
Binary files a/doc/folders.png and b/doc/folders.png differ
diff --git a/doc/generalization.png b/doc/generalization.png
index 77ce4c7..e960be8 100644
Binary files a/doc/generalization.png and b/doc/generalization.png differ
diff --git a/doc/generation-options.png b/doc/generation-options.png
index cc9dffe..58e2983 100644
Binary files a/doc/generation-options.png and b/doc/generation-options.png differ
diff --git a/doc/index.docbook b/doc/index.docbook
index 27c8610..3a260e7 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -38,8 +38,8 @@
</copyright>
-<date>2003-10-15</date>
-<releaseinfo>1.2</releaseinfo>
+<date>2013-06-01</date>
+<releaseinfo>2.11.0</releaseinfo>
<abstract>
<para>
diff --git a/doc/introduction.docbook b/doc/introduction.docbook
index 3af9f71..282993e 100644
--- a/doc/introduction.docbook
+++ b/doc/introduction.docbook
@@ -18,7 +18,7 @@ you code things right the first time.
</para>
<para>
&UML; is the diagramming language used to describing such models. You can represent your ideas in &UML;
-using different types of diagrams. &umbrello; 1.2 supports the following types:
+using different types of diagrams. &umbrello; 2.11 supports the following types:
</para>
<itemizedlist>
<listitem><para>Class Diagram</para></listitem>
@@ -29,6 +29,7 @@ using different types of diagrams. &umbrello; 1.2 supports the following types:
<listitem><para>Activity Diagram</para></listitem>
<listitem><para>Component Diagram</para></listitem>
<listitem><para>Deployment Diagram</para></listitem>
+<listitem><para>Entity Relationship Diagram</para></listitem>
</itemizedlist>
<para>
More information about &UML; can be found at the website of
diff --git a/doc/sequence-diagram.png b/doc/sequence-diagram.png
index 57d96f5..32caf5b 100644
Binary files a/doc/sequence-diagram.png and b/doc/sequence-diagram.png differ
diff --git a/doc/state-diagram.png b/doc/state-diagram.png
index 8b2864f..e05b61f 100644
Binary files a/doc/state-diagram.png and b/doc/state-diagram.png differ
diff --git a/doc/umbrello-ui-clean.png b/doc/umbrello-ui-clean.png
deleted file mode 100644
index e71ad3b..0000000
Binary files a/doc/umbrello-ui-clean.png and /dev/null differ
diff --git a/doc/umbrello-ui.png b/doc/umbrello-ui.png
index ec6751f..5284d22 100644
Binary files a/doc/umbrello-ui.png and b/doc/umbrello-ui.png differ
diff --git a/doc/use-case-diagram.png b/doc/use-case-diagram.png
index 2b81907..88b6cd8 100644
Binary files a/doc/use-case-diagram.png and b/doc/use-case-diagram.png differ
diff --git a/doc/working_with_umbrello.docbook b/doc/working_with_umbrello.docbook
index f3f1c4f..212ecd1 100644
--- a/doc/working_with_umbrello.docbook
+++ b/doc/working_with_umbrello.docbook
@@ -25,7 +25,7 @@ and access the different diagrams quickly while working on your model.
<itemizedlist>
<listitem><para>Tree View</para></listitem>
<listitem><para>Work Area</para></listitem>
-<listitem><para>Documentation Window</para></listitem>
+<listitem><para>Documentation and Command history Window</para></listitem>
</itemizedlist>
<screenshot>
@@ -58,18 +58,17 @@ If you are working on a model with more than just a few classes and diagrams, th
you stay on top of things by organizing your model elements in folders. You can create
folders by selecting the appropriate option from the context menu (&RMB; click on one of the folders
in the tree view) and you can organize your elements by moving them to the appropriate folder (drag and drop)
-<!-- (screen shot) FIXME-->
</para>
</sect2>
<sect2 id="documentation-window">
-<title>Documentation Window</title>
+<title>Documentation and Command History Window</title>
<para>
-The Documentation Window is the small window located on the left bottom of &umbrello;, and it gives
-you a quick preview of the documentation for the currently selected item. The Documentation Window is
-rather small because it is intended to allow you just a quick pick into the element's documentation while
-taking as little screen space as possible. If you need to view the documentation in more detail you can always
-open the item's properties.
+The Documentation and Command history Window is the small window located on the left bottom of &umbrello;, and it gives
+you a quick preview of the documentation for the currently selected item and the command history of your work session.
+The Documentation Window is rather small because it is intended to allow you just a quick pick into the element's documentation
+and the overview of the command history while taking as little screen space as possible. If you need to view the documentation
+in more detail you can always open the item's properties.
</para>
</sect2>
<sect2 id="work-area">
@@ -226,9 +225,8 @@ The second way of adding elements to your diagram is by using the Work Toolbar's
that this will also add the elements to your model).
</para>
<para>
-The Work Toolbar was by default located on the far right of the application window, &umbrello; 1.2 has moved this to the top of the window.
-You can dock it into other edge or have it floating around if you prefer. The tools available
-on this toolbar (the buttons you see on it) change depending on the type of diagram
+The Work Toolbar was by default located on the top of the window.
+The tools available on this toolbar (the buttons you see on it) change depending on the type of diagram
you are currently working on. The button for the currently
selected tool is activated in the toolbar. You can switch to the select tool
by pressing the &Esc; key.
More information about the kde-doc-english
mailing list