Author: zearin
Date: 2008-01-15 19:28:43-0800
New Revision: 14049
Modified:
branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-credits.xml
branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-installation.xml
branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-introduction.xml
branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-preface.xml
branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-running.xml
branches/work_docbook5_zearin/branch1/documentation/quick-guide/quickguide.xml
Log:
QuickGuide updated to DocBook v5.
Modified: branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-credits.xml
Url: http://argouml.tigris.org/source/browse/argouml/branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-credits.xml?view=diff&rev=14049&p1=branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-credits.xml&p2=branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-credits.xml&r1=14048&r2=14049
==============================================================================
--- branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-credits.xml (original)
+++ branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-credits.xml 2008-01-15 19:28:43-0800
@@ -1,71 +1,71 @@
<!-- $Id$ -->
<!--
-// Copyright (c) 1996-2005 The Regents of the University of California. All
-// Rights Reserved. Permission to use, copy, modify, and distribute this
-// software and its documentation without fee, and without a written
-// agreement is hereby granted, provided that the above copyright notice
-// and this paragraph appear in all copies. This software program and
-// documentation are copyrighted by The Regents of the University of
-// California. The software program and documentation are supplied "AS
-// IS", without any accompanying services from The Regents. The Regents
-// does not warrant that the operation of the program will be
-// uninterrupted or error-free. The end-user understands that the program
-// was developed for research purposes and is advised not to rely
-// exclusively on the program for any reason. IN NO EVENT SHALL THE
-// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
-// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
-// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
-// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
-// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
-// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
-// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
-// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
-// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
+ // Copyright (c) 1996-2005 The Regents of the University of California. All
+ // Rights Reserved. Permission to use, copy, modify, and distribute this
+ // software and its documentation without fee, and without a written
+ // agreement is hereby granted, provided that the above copyright notice
+ // and this paragraph appear in all copies. This software program and
+ // documentation are copyrighted by The Regents of the University of
+ // California. The software program and documentation are supplied "AS
+ // IS", without any accompanying services from The Regents. The Regents
+ // does not warrant that the operation of the program will be
+ // uninterrupted or error-free. The end-user understands that the program
+ // was developed for research purposes and is advised not to rely
+ // exclusively on the program for any reason. IN NO EVENT SHALL THE
+ // UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
+ // SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
+ // ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
+ // THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
+ // SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
+ // WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+ // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
+ // PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
+ // CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
+ // UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
-->
<!--
-
- This is a documentation template for a chapter in the ArgoUML manual.
- It was designed by Kunle Odutola for use in the ArgoUML ducumentation
- effort. Please use the template as the basis for writing additional
- chapters for the manual.
- All the words written in UPPERCASE are placeholders and should be replaced.
- Please not that _id_ must be unique wihin the entire ArgoUML DocBook manual
- document so, you are encouraged to prefix all subsequent _id_ with the
- chapter id thus:
- If CHAPTER-ID is "installation", you may then have "installation-windows",
- "installation-system" etc...
-
- Please remember that this is only a template and you are free to deviate
- from it where there is a benefit to doing so. In this event please post
- your ideas to the ArgoUML mailing list and I may update this template with
- your idea.
-
- Please help to keep the ArgoUML manual logical and readable. And don't forget
- to remove these comments from the final documentation! ;-)
-
+
+ This is a documentation template for a chapter in the ArgoUML manual.
+ It was designed by Kunle Odutola for use in the ArgoUML ducumentation
+ effort. Please use the template as the basis for writing additional
+ chapters for the manual.
+ All the words written in UPPERCASE are placeholders and should be replaced.
+ Please not that _id_ must be unique wihin the entire ArgoUML DocBook manual
+ document so, you are encouraged to prefix all subsequent _id_ with the
+ chapter id thus:
+ If CHAPTER-ID is "installation", you may then have "installation-windows",
+ "installation-system" etc...
+
+ Please remember that this is only a template and you are free to deviate
+ from it where there is a benefit to doing so. In this event please post
+ your ideas to the ArgoUML mailing list and I may update this template with
+ your idea.
+
+ Please help to keep the ArgoUML manual logical and readable. And don't forget
+ to remove these comments from the final documentation! ;-)
+
-->
<!--
-
- [ PLEASE DO NOT REMOVE THIS COMMENT BLOCK!! ]
-
- Maintained by Kunle Odutola for the ArgoUML Project
- http://www.argouml.org/
- Template version: 0.0.1
- Template last modified: May 4, 2001
-
+
+ [ PLEASE DO NOT REMOVE THIS COMMENT BLOCK!! ]
+
+ Maintained by Kunle Odutola for the ArgoUML Project
+ http://www.argouml.org/
+ Template version: 0.0.1
+ Template last modified: May 4, 2001
+
-->
-<chapter id="credits">
- <title>Credits</title>
- <!--
- ===========================================================
- Authors
- ===========================================================
- -->
- <para>Author:
- <!-- Repeat <author> and [optional] <email> elements as needed for each "main" author -->
- &author-kunle.odu;
- &email-kunle.odu;
- </para>
-</chapter>
+<chapter xml:id="credits">
+ <title>Credits</title>
+ <!--
+ ===========================================================
+ Authors
+ ===========================================================
+ -->
+ <para>Author:
+ <!-- Repeat <author> and [optional] <email> elements as needed for each "main" author -->
+ &author-kunle.odu;
+ &email-kunle.odu;
+ </para>
+</chapter>
\ No newline at end of file
Modified: branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-installation.xml
Url: http://argouml.tigris.org/source/browse/argouml/branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-installation.xml?view=diff&rev=14049&p1=branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-installation.xml&p2=branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-installation.xml&r1=14048&r2=14049
==============================================================================
--- branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-installation.xml (original)
+++ branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-installation.xml 2008-01-15 19:28:43-0800
@@ -1,204 +1,130 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Id$ -->
<!--
-// Copyright (c) 1996-2005, 2007 The Regents of the University of California. All
-// Rights Reserved. Permission to use, copy, modify, and distribute this
-// software and its documentation without fee, and without a written
-// agreement is hereby granted, provided that the above copyright notice
-// and this paragraph appear in all copies. This software program and
-// documentation are copyrighted by The Regents of the University of
-// California. The software program and documentation are supplied "AS
-// IS", without any accompanying services from The Regents. The Regents
-// does not warrant that the operation of the program will be
-// uninterrupted or error-free. The end-user understands that the program
-// was developed for research purposes and is advised not to rely
-// exclusively on the program for any reason. IN NO EVENT SHALL THE
-// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
-// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
-// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
-// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
-// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
-// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
-// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
-// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
-// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
+ // Copyright (c) 1996-2005, 2007 The Regents of the University of California. All
+ // Rights Reserved. Permission to use, copy, modify, and distribute this
+ // software and its documentation without fee, and without a written
+ // agreement is hereby granted, provided that the above copyright notice
+ // and this paragraph appear in all copies. This software program and
+ // documentation are copyrighted by The Regents of the University of
+ // California. The software program and documentation are supplied "AS
+ // IS", without any accompanying services from The Regents. The Regents
+ // does not warrant that the operation of the program will be
+ // uninterrupted or error-free. The end-user understands that the program
+ // was developed for research purposes and is advised not to rely
+ // exclusively on the program for any reason. IN NO EVENT SHALL THE
+ // UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
+ // SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
+ // ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
+ // THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
+ // SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
+ // WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+ // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
+ // PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
+ // CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
+ // UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
-->
<!--
-Part of the QuickGuide: Installation.
+ Part of the QuickGuide: Installation.
-->
-<chapter id="installation">
- <title>Installing ArgoUML</title>
- <sect1>
- <title>System requirements</title>
- <para>
-Minimum system requirements:
- <itemizedlist>
- <listitem>
- <para>
- Any Operating System that supports Java.
- </para>
- </listitem>
- <listitem>
- <para>10MB of free disk storage space on your hard disk.
- </para>
- </listitem>
- <listitem>
- <para>Mouse (or other pointing device) and a Keyboard.</para>
- </listitem>
- <listitem>
- <para>
- Java 2 JRE or JDK version 1.4 or higher.
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </sect1>
- <sect1>
- <title>Installation options</title>
- <para>
- Now that you have a computer that can install and run ArgoUML effectively, you need to decide which
- of the installation options available is appropriate for you. You can choose from the following options:
-
- <itemizedlist>
- <listitem>
- <para>
-Java Web Start
-</para>
- <para>
-This alternative is good for occasional users and tests.
-It is the easiest and quickest way to start using ArgoUML.
-It requires connection to the &argo-homepage;.
- </para>
- <orderedlist>
- <listitem>
- <para>
-Make sure you have
-<ulink url="http://java.sun.com/products/javawebstart/">
-Java Web Start
-</ulink>
-installed.
-</para>
- </listitem>
- <listitem>
- <para>
-Follow the Launch ArgoUML-link from the &argo-homepage;.
-</para>
- </listitem>
- <listitem>
- <para>
-ArgoUML will be downloaded, cached locally and started.
-</para>
- </listitem>
- <listitem>
- <para>
-On subsequent starts, the ArgoUML is available also from the
-Java Web Start console
-(even without being connected to the internet)
-and (if connected) at each start the version is checked
-against that on the web server and updates are automatically
-downloaded.
-</para>
- </listitem>
- </orderedlist>
- </listitem>
- <listitem>
- <para>
-Binary distribution
-</para>
- <para>
-This is good for regular users and guarantees that the
-version of ArgoUML cannot change during the course of your project.
-</para>
- <orderedlist>
- <listitem>
- <para>
-Make sure that you have a Java 2 JRE installed.
-</para>
- </listitem>
- <listitem>
- <para>
-Download the ArgoUML binary distribution from the &argo-homepage;.
-</para>
- <para>
-This could also include copying it to and from floppy disks or CD's
-in order to get it to the computer if no network connection is
-available.
-</para>
- </listitem>
- <listitem>
- <para>
-Create an ArgoUML installation directory.
-</para>
- </listitem>
- <listitem>
- <para>
-Change the current directory
-to the ArgoUML installation directory and
-extract the ArgoUML files to the installation directory.
-<!--:
- <computeroutput>
-jar xvf <replaceable>ArgoUML-archive-filename</replaceable>
- </computeroutput>
- </para>
- <para>
-Remember to use <command>jar</command> to do this.
-For some odd reason WinZIP might have problems with the
-ArgoUML zip-files. -->
- </para>
-
- </listitem>
- <listitem>
- <para>
-Start by running the <filename>argouml.jar</filename> file,
-either by simply (double-)clicking on the file,
-or by executing the following command:
- <computeroutput>
-java -jar argouml.jar
- </computeroutput>
- at the command line, or via a batch-file.
-</para>
- </listitem>
- </orderedlist>
- </listitem>
- </itemizedlist>
- </para>
- </sect1>
+<chapter
+ xmlns="http://docbook.org/ns/docbook"
+ version="5.0"
+ xml:lang="en"
+ xml:id="installation"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:xlink="http://www.w3.org/1999/xlink">
- <sect1>
- <title>Installing Auxiliary Modules</title>
- <para>
- The standard installation of ArgoUML does not support C++, php and C# code
- generation. To make this possible, you need to download the
- <literal>auxiliary modules</literal>
- from the download page at the ArgoUML website.
- </para>
+ <title>Installing ArgoUML</title>
+
+ <section>
+ <title>System requirements</title>
- <para>
- Unpack the downloaded file in the same directory as
- you unpacked ArgoUML itself.
+ <para>Minimum system requirements: <itemizedlist>
+ <listitem>
+ <para>Any Operating System that supports Java. </para>
+ </listitem>
+ <listitem>
+ <para>10MB of free disk storage space on your hard disk. </para>
+ </listitem>
+ <listitem>
+ <para>Mouse (or other pointing device) and a Keyboard.</para>
+ </listitem>
+ <listitem>
+ <para>Java 2 JRE or JDK version 1.4 or higher. </para>
+ </listitem>
+ </itemizedlist>
</para>
+ </section>
+
+
+ <section>
+ <title>Installation options</title>
- <para>
- The result should be that the directory that contains the
- <filename>argouml.jar</filename> file, now also contains a subdirectory
- named <filename>ext</filename>, which contains the
- <filename>.jar</filename> files for the extra languages.
+ <para>Now that you have a computer that can install and run ArgoUML effectively, you need to decide which of the installation options available is appropriate for you. You can choose from the following options: <itemizedlist>
+ <listitem>
+ <para>Java Web Start </para>
+ <para>This alternative is good for occasional users and tests. It is the easiest and quickest way to start using ArgoUML. It requires connection to the <link xlink:href="http://argouml.tigris.org">Argo Homepage</link>. </para>
+
+ <orderedlist>
+ <listitem>
+ <para>Make sure you have <link xlink:href="http://java.sun.com/products/javawebstart/">Java Web Start</link> installed. </para>
+ </listitem>
+ <listitem>
+ <para>Follow the Launch ArgoUML-link from the <link xlink:href="http://argouml.tigris.org">Argo Homepage</link>.</para>
+ </listitem>
+ <listitem>
+ <para>ArgoUML will be downloaded, cached locally and started. </para>
+ </listitem>
+ <listitem>
+ <para>On subsequent starts, the ArgoUML is available also from the Java Web Start console (even without being connected to the internet) and (if connected) at each start the version is checked against that on the web server and updates are automatically downloaded. </para>
+ </listitem>
+ </orderedlist>
+ </listitem>
+
+ <listitem>
+ <para>Binary distribution </para>
+ <para>This is good for regular users and guarantees that the version of ArgoUML cannot change during the course of your project. </para>
+
+ <orderedlist>
+ <listitem>
+ <para>Make sure that you have a Java 2 JRE installed. </para>
+ </listitem>
+ <listitem>
+ <para>Download the ArgoUML binary distribution from the <link xlink:href="http://argouml.tigris.org">Argo Homepage</link>. </para>
+ <para>This could also include copying it to and from floppy disks or CD's in order to get it to the computer if no network connection is available. </para>
+ </listitem>
+ <listitem>
+ <para>Create an ArgoUML installation directory. </para>
+ </listitem>
+ <listitem>
+ <para>Change the current directory to the ArgoUML installation directory and extract the ArgoUML files to the installation directory. <!--: <computeroutput> jar xvf <replaceable>ArgoUML-archive-filename</replaceable> </computeroutput> </para> <para>Remember to use <command>jar</command> to do this. For some odd reason WinZIP might have problems with the ArgoUML zip-files. -->
+ </para>
+ </listitem>
+ <listitem>
+ <para>Start by running the <filename>argouml.jar</filename> file, either by simply (double-)clicking on the file, or by executing the following command: <computeroutput> java -jar argouml.jar </computeroutput> at the command line, or via a batch-file. </para>
+ </listitem>
+ </orderedlist>
+ </listitem>
+ </itemizedlist>
</para>
- </sect1>
+ </section>
+
+ <section>
+ <title>Installing Auxiliary Modules</title>
+
+ <para>The standard installation of ArgoUML does not support C++, php and C# code generation. To make this possible, you need to download the <literal>auxiliary modules</literal> from the download page at the ArgoUML website. </para>
+ <para>Unpack the downloaded file in the same directory as you unpacked ArgoUML itself. </para>
+ <para>The result should be that the directory that contains the <filename>argouml.jar</filename> file, now also contains a subdirectory named <filename>ext</filename>, which contains the <filename>.jar</filename> files for the extra languages. </para>
+ </section>
- <sect1>
+ <section>
<title>Command Line Options</title>
- <para>When starting ArgoUML from a command line,
- there are several extra possibilities.
- Try typing:</para>
-
- <para><command>java -jar argouml.jar -help</command>
- </para>
-
+ <para>When starting ArgoUML from a command line, there are several extra possibilities. Try typing:</para>
+ <para><command>java -jar argouml.jar -help</command> </para>
<para>You will see the instructions:</para>
-
+
<programlisting><![CDATA[
Usage: [options] [project-file]
Options include:
@@ -218,98 +144,47 @@
You can also set java settings which influence the behaviour of ArgoUML:
-Xms250M -Xmx500M [makes ArgoUML reserve more memory for large projects]]]>
</programlisting>
-
- <para> A common problem is that the User Interface is shown in the wrong language.
- Below is an easy way to switch back to the English UI.
- Please beware: the language is in lowercase.
- </para>
-
- <para><command>java -jar argouml.jar -locale en</command>
- </para>
-
- <para> ArgoUML may be run without UI, in batch mode.
- Currently the possibilities are very limited.
- Below is an example (everything on 1 line!):
- It reads a "test.zargo" from my working directory,
- gets the diagram named "A",
- and writes a PNG graphical file for this diagram.
- Without the "-batch",
- ArgoUML would start up the UI after executing the commands.
- </para>
-
- <para><command>java -jar argouml.jar -batch -command "org.argouml.uml.ui.ActionOpenProject=c:\Documents and Settings\Michiel\My Documents\test.zargo" -command org.argouml.ui.cmd.ActionGotoDiagram=A -command "org.argouml.uml.ui.ActionSaveGraphics=c:\Documents and Settings\Michiel\My Documents\test.PNG"</command>
- </para>
-
- </sect1>
+
+ <para>A common problem is that the User Interface is shown in the wrong language. Below is an easy way to switch back to the English UI. Please beware: the language is in lowercase. </para>
+ <para><command>java -jar argouml.jar -locale en</command> </para>
+ <para>ArgoUML may be run without UI, in batch mode. Currently the possibilities are very limited. Below is an example (everything on 1 line!): It reads a "test.zargo" from my working directory, gets the diagram named "A", and writes a PNG graphical file for this diagram. Without the "-batch", ArgoUML would start up the UI after executing the commands. </para>
+ <para><command>java -jar argouml.jar -batch -command "org.argouml.uml.ui.ActionOpenProject=c:\Documents and Settings\Michiel\My Documents\test.zargo" -command org.argouml.ui.cmd.ActionGotoDiagram=A -command "org.argouml.uml.ui.ActionSaveGraphics=c:\Documents and Settings\Michiel\My Documents\test.PNG"</command> </para>
+ </section>
- <sect1>
+ <section>
<title>Making .zargo-file clickable (on Windows)</title>
- <sect1info>
+
+ <info>
<authorgroup>
<author>
- <firstname>Ewan</firstname>
- <othername>R.</othername>
- <surname>Grantham</surname>
+ <personname>
+ <firstname>Ewan</firstname>
+ <othername>R.</othername>
+ <surname>Grantham</surname>
+ </personname>
</author>
</authorgroup>
- </sect1info>
+ </info>
+
<warning>
- <para>
-<!-- This is issue 4733 -->
-We have reports that this isn't working on Windows Vista.
-Please don't try it there.
-</para>
+ <!-- This is issue 4733 -->
+ <para>We have reports that this isn't working on Windows Vista. Please don't try it there. </para>
</warning>
- <para>
-This works only if you have installed using the binary distribution.
-</para>
- <para>
-First, find a Zargo file, and right-click on it.
-You should get the normal Windows menu, including an Open or Open With option.
-At this point, give a description for the file like "ArgoUML Model",
-and tell Windows to use Notepad to open the file.
-That's not what you want to do ultimately, but it does get Windows to
-accept the .zargo extension as representing a valid file type.
-</para>
- <para>
-Now, open Windows Explorer and from the menu select View->Options
-(or on Windows XP: Tools->Folder Options...).
-You
-should get a two (or more) tabbed dialog. Click the "File Types" dialog, and
-then scroll through the list for the Description you gave - in the example
-"ArgoUML Model". Click to select that file type, and then click the "Edit"
-button.
-</para>
- <para>
-Now, click on the "Open" action and then the "Edit" button there. You will
-then get a dialog that has a line for entering in the application action
-which will have a line for using Notepad to open the file. Replace that line
-with:
-<command>
-"C:\Program Files\Java\j2re1.4.0_01\bin\javaw.exe" -jar "c:\ArgoUML\argouml.jar" "%L"
-</command>
-</para>
- <para>
-Substitute your path to your <filename>javaw.exe</filename> and
-<filename>argouml.jar</filename> files if they are
-in a different location.
-Click OK, then click OK, then click OK (three buttons on
-three different levels of the dialog).
-</para>
-<para>The %L in the above commandline is needed instead of %1
-because that is the way to
-support filename extensions of more than 3 characters.
-</para>
- </sect1>
-
+
+ <para>This works only if you have installed using the binary distribution. </para>
+ <para>First, find a Zargo file, and right-click on it. You should get the normal Windows menu, including an Open or Open With option. At this point, give a description for the file like "ArgoUML Model", and tell Windows to use Notepad to open the file. That's not what you want to do ultimately, but it does get Windows to accept the .zargo extension as representing a valid file type. </para>
+ <para>Now, open Windows Explorer and from the menu select View->Options (or on Windows XP: Tools->Folder Optionsâ¦). You should get a two (or more) tabbed dialog. Click the "File Types" dialog, and then scroll through the list for the Description you gave - in the example "ArgoUML Model". Click to select that file type, and then click the "Edit" button. </para>
+ <para>Now, click on the "Open" action and then the "Edit" button there. You will then get a dialog that has a line for entering in the application action which will have a line for using Notepad to open the file. Replace that line with: <command> "C:\Program Files\Java\j2re1.4.0_01\bin\javaw.exe" -jar "c:\ArgoUML\argouml.jar" "%L" </command> </para>
+ <para>Substitute your path to your <filename>javaw.exe</filename> and <filename>argouml.jar</filename> files if they are in a different location. Click OK, then click OK, then click OK (three buttons on three different levels of the dialog). </para>
+ <para>The %L in the above commandline is needed instead of %1 because that is the way to support filename extensions of more than 3 characters. </para>
+ </section>
</chapter>
-
<!-- Local stuff for Emacs - please do not delete
-
-Local Variables:
-mode: xml
-sgml-doctype: "quickguide.xml"
-sgml-parent-document: ("quickguide.xml" "chapter" nil)
-End:
-
--->
+
+ Local Variables:
+ mode: xml
+ sgml-doctype: "quickguide.xml"
+ sgml-parent-document: ("quickguide.xml" "chapter" nil)
+ End:
+
+-->
\ No newline at end of file
Modified: branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-introduction.xml
Url: http://argouml.tigris.org/source/browse/argouml/branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-introduction.xml?view=diff&rev=14049&p1=branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-introduction.xml&p2=branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-introduction.xml&r1=14048&r2=14049
==============================================================================
--- branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-introduction.xml (original)
+++ branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-introduction.xml 2008-01-15 19:28:43-0800
@@ -1,32 +1,32 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Id$ -->
<!--
-// Copyright (c) 1996-2005 The Regents of the University of California. All
-// Rights Reserved. Permission to use, copy, modify, and distribute this
-// software and its documentation without fee, and without a written
-// agreement is hereby granted, provided that the above copyright notice
-// and this paragraph appear in all copies. This software program and
-// documentation are copyrighted by The Regents of the University of
-// California. The software program and documentation are supplied "AS
-// IS", without any accompanying services from The Regents. The Regents
-// does not warrant that the operation of the program will be
-// uninterrupted or error-free. The end-user understands that the program
-// was developed for research purposes and is advised not to rely
-// exclusively on the program for any reason. IN NO EVENT SHALL THE
-// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
-// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
-// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
-// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
-// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
-// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
-// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
-// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
-// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
+ // Copyright (c) 1996-2005 The Regents of the University of California. All
+ // Rights Reserved. Permission to use, copy, modify, and distribute this
+ // software and its documentation without fee, and without a written
+ // agreement is hereby granted, provided that the above copyright notice
+ // and this paragraph appear in all copies. This software program and
+ // documentation are copyrighted by The Regents of the University of
+ // California. The software program and documentation are supplied "AS
+ // IS", without any accompanying services from The Regents. The Regents
+ // does not warrant that the operation of the program will be
+ // uninterrupted or error-free. The end-user understands that the program
+ // was developed for research purposes and is advised not to rely
+ // exclusively on the program for any reason. IN NO EVENT SHALL THE
+ // UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
+ // SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
+ // ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
+ // THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
+ // SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
+ // WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+ // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
+ // PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
+ // CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
+ // UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
-->
<!--
-
+
[ PLEASE DO NOT REMOVE THIS COMMENT BLOCK!! ]
Maintained by Kunle Odutola for the ArgoUML Project
@@ -35,85 +35,70 @@
Template last modified: May 4, 2001
-->
-<chapter id="introduction">
- <chapterinfo>
+<chapter
+ xmlns="http://docbook.org/ns/docbook"
+ version="5.0"
+ xml:lang="en"
+ xml:id="introduction"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:xlink="http://www.w3.org/1999/xlink">
+
+ <title>Introduction</title>
+
+ <info>
<!--
===========================================================
- Authors
+ Authors
===========================================================
-->
<!-- Repeat <author> block (and optional <address> and <email> elements) as needed for each "main" author -->
- &author-kunle.odu;
- &address-kunle.odu;
- </chapterinfo>
- <title>Introduction</title>
+ <author>
+ <personname>
+ <firstname>Kunle</firstname>
+ <surname>Odutola</surname>
+ </personname>
+ <address><email>Kunle_Odutola@hotmail.com</email></address>
+ </author>
+
+ </info>
+
<!--
===========================================================
- Chapter "INTRODUCTION" section
+ Chapter "INTRODUCTION" section
===========================================================
-->
- <sect1>
- <title>Welcome to &argo;</title>
- <para>
-&argo; is a powerful yet
- easy-to-use interactive, graphical software design environment that supports the design,
- development and documentation of object-oriented software applications.
- </para>
- <para>
- If you are familiar with a family of software applications called Computer Aided Software
- Engineering (CASE) tools then you should find &argo; instantly familiar.
- </para>
- <para>
- The users of &argo; are software designers
- & architects, software developers,
- business analysts, systems analysts and other professionals involved in the analysis, design and
- development of software applications.
- Main features:
+ <section>
+ <title>Welcome to ArgoUML</title>
+
+ <para>ArgoUML is a powerful yet easy-to-use interactive, graphical software design environment that supports the design, development and documentation of object-oriented software applications. </para>
+ <para>If you are familiar with a family of software applications called Computer Aided Software Engineering (CASE) tools then you should find ArgoUML instantly familiar. </para>
+ <para>The users of ArgoUML are software designers & architects, software developers, business analysts, systems analysts and other professionals involved in the analysis, design and development of software applications. Main features:
<itemizedlist>
<listitem>
- <para>
-Open standards: XMI, SVG and PGML
- </para>
+ <para>Open standards: XMI, SVG and PGML </para>
</listitem>
<listitem>
- <para>
- 100% Platform independent thanks to the exclusive use of Java
- </para>
+ <para>100% Platform independent thanks to the exclusive use of Java </para>
</listitem>
<listitem>
- <para>
- Open Source, which allows extending or customizeing.
- </para>
+ <para>Open Source, which allows extending or customizeing. </para>
</listitem>
<listitem>
- <para>
- Cognitive features like:
- reflection-in-action, opportunistic design,
- comprehension and problem solving
- </para>
+ <para>Cognitive features like: reflection-in-action, opportunistic design, comprehension and problem solving </para>
</listitem>
</itemizedlist>
</para>
- </sect1>
+ </section>
+
<!--
===========================================================
- Chapter section template - copy for each major "topic"
- discussed in this chapter
+ Chapter section template - copy for each major "topic"
+ discussed in this chapter
===========================================================
-->
- <sect1>
- <title>About this guide...</title>
- <para>
- This guide - the &document-title; - is provided to help you get up and running as quickly as
- possible with &argo;.
- It provides step-by-step instructions
- for obtaining, installing and starting
- &argo;, performing common tasks, and
- learn more about &argo;.
-If you need further details please look in the
-<ulink url="http://argouml.tigris.org/documentation/defaulthtml/manual/">
-User Manual
-</ulink>.
- </para>
- </sect1>
-</chapter>
+ <section>
+ <title>About this guideâ¦</title>
+
+ <para>This guide - the ArgoUML Quick Guide - is provided to help you get up and running as quickly as possible with ArgoUML. It provides step-by-step instructions for obtaining, installing and starting ArgoUML, performing common tasks, and learn more about ArgoUML. If you need further details please look in the <link xlink:href="http://argouml.tigris.org/documentation/defaulthtml/manual/" >User Manual</link>. </para>
+ </section>
+</chapter>
\ No newline at end of file
Modified: branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-preface.xml
Url: http://argouml.tigris.org/source/browse/argouml/branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-preface.xml?view=diff&rev=14049&p1=branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-preface.xml&p2=branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-preface.xml&r1=14048&r2=14049
==============================================================================
--- branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-preface.xml (original)
+++ branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-preface.xml 2008-01-15 19:28:43-0800
@@ -1,28 +1,28 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Id$ -->
<!--
-// Copyright (c) 1996-2005 The Regents of the University of California. All
-// Rights Reserved. Permission to use, copy, modify, and distribute this
-// software and its documentation without fee, and without a written
-// agreement is hereby granted, provided that the above copyright notice
-// and this paragraph appear in all copies. This software program and
-// documentation are copyrighted by The Regents of the University of
-// California. The software program and documentation are supplied "AS
-// IS", without any accompanying services from The Regents. The Regents
-// does not warrant that the operation of the program will be
-// uninterrupted or error-free. The end-user understands that the program
-// was developed for research purposes and is advised not to rely
-// exclusively on the program for any reason. IN NO EVENT SHALL THE
-// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
-// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
-// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
-// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
-// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
-// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
-// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
-// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
-// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
+ // Copyright (c) 1996-2005 The Regents of the University of California. All
+ // Rights Reserved. Permission to use, copy, modify, and distribute this
+ // software and its documentation without fee, and without a written
+ // agreement is hereby granted, provided that the above copyright notice
+ // and this paragraph appear in all copies. This software program and
+ // documentation are copyrighted by The Regents of the University of
+ // California. The software program and documentation are supplied "AS
+ // IS", without any accompanying services from The Regents. The Regents
+ // does not warrant that the operation of the program will be
+ // uninterrupted or error-free. The end-user understands that the program
+ // was developed for research purposes and is advised not to rely
+ // exclusively on the program for any reason. IN NO EVENT SHALL THE
+ // UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
+ // SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
+ // ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
+ // THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
+ // SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
+ // WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+ // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
+ // PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
+ // CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
+ // UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
-->
<preface>
<title>Preface</title>
@@ -42,7 +42,7 @@
These languages combined support for OO programming with support for traditional procedural programming.
The lack of support of procedural programming in pure OO languages had hindered the adoption of OO technology
for many years. The journey that had begun with the introduction of <emphasis>objects</emphasis> in Simula in
- the 1960s was now complete. OO technology was now accessible to the mainstream...well, OO programming was at least.
+ the 1960s was now complete. OO technology was now accessible to the mainstreamâ¦well, OO programming was at least.
</para>
<para>
Simulation is the basic premise that underpins OO technology. An OO system is designed and implemented
@@ -104,4 +104,4 @@
<para>
Kunle Odutola
</para>
-</preface>
+</preface>
\ No newline at end of file
Modified: branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-running.xml
Url: http://argouml.tigris.org/source/browse/argouml/branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-running.xml?view=diff&rev=14049&p1=branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-running.xml&p2=branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-running.xml&r1=14048&r2=14049
==============================================================================
--- branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-running.xml (original)
+++ branches/work_docbook5_zearin/branch1/documentation/quick-guide/qstart-running.xml 2008-01-15 19:28:43-0800
@@ -1,147 +1,70 @@
-<?xml version="1.0" encoding="UTF-8"?>
+<?xml version="1.0" encoding="UTF-8" ?>
<!-- $Id$ -->
<!--
-// Copyright (c) 1996-2005 The Regents of the University of California. All
-// Rights Reserved. Permission to use, copy, modify, and distribute this
-// software and its documentation without fee, and without a written
-// agreement is hereby granted, provided that the above copyright notice
-// and this paragraph appear in all copies. This software program and
-// documentation are copyrighted by The Regents of the University of
-// California. The software program and documentation are supplied "AS
-// IS", without any accompanying services from The Regents. The Regents
-// does not warrant that the operation of the program will be
-// uninterrupted or error-free. The end-user understands that the program
-// was developed for research purposes and is advised not to rely
-// exclusively on the program for any reason. IN NO EVENT SHALL THE
-// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
-// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
-// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
-// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
-// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
-// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
-// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
-// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
-// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
+ // Copyright (c) 1996-2005 The Regents of the University of California. All
+ // Rights Reserved. Permission to use, copy, modify, and distribute this
+ // software and its documentation without fee, and without a written
+ // agreement is hereby granted, provided that the above copyright notice
+ // and this paragraph appear in all copies. This software program and
+ // documentation are copyrighted by The Regents of the University of
+ // California. The software program and documentation are supplied "AS
+ // IS", without any accompanying services from The Regents. The Regents
+ // does not warrant that the operation of the program will be
+ // uninterrupted or error-free. The end-user understands that the program
+ // was developed for research purposes and is advised not to rely
+ // exclusively on the program for any reason. IN NO EVENT SHALL THE
+ // UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
+ // SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
+ // ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
+ // THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
+ // SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
+ // WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+ // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
+ // PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
+ // CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
+ // UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
-->
-<chapter id="running">
- <title>ArgoUML Principles</title>
- <para>
- When ArgoUML starts, then it shows an empty class diagram
- on which you can add various objects. ArgoUML works according the following
- principles:
- </para>
-
+<chapter
+ xmlns="http://docbook.org/ns/docbook"
+ version="5.0"
+ xml:lang="en"
+ xml:id="running"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:xlink="http://www.w3.org/1999/xlink">
+
+ <title>ArgoUML Principles</title>
+
+ <para>When ArgoUML starts, then it shows an empty class diagram on which you can add various objects. ArgoUML works according the following principles: </para>
+
+
<section>
<title>Project, Model and Diagram</title>
- <para>
- The file operations save and open handle one
- <literal>project</literal> at a
- time. One <literal>project</literal> corresponds to a
- <literal>model</literal> plus diagram information,
- i.e. everything you can edit within the ArgoUML window.
- </para>
- <para>
- The <literal>model</literal> may contain many
- objects (ModelElements) which
- form the complete UML description
- of the system you are describing.
- All ModelElements might be present on a diagram,
- but this is not required.
- Hence, the <literal>model</literal>
- that is stored in ArgoUML is
- independent of the contents of the diagrams.
- This may be explained by the possibility
- to generate programming code from the
- <literal>model</literal> - you
- do not need any diagrams for this.
- </para>
- <para>
- A ArgoUML <literal>project</literal> also contains
- all diagram information, i.e.
- the shapes (presentation) used
- to represent the various UML ModelElements,
- their location, color, etc.
- Some ModelElements appear on multiple diagrams,
- some on one or none.
- </para>
- <para>
- Hence, saving and opening projects
- retains all this information.
- There is a way to only save the
- <literal>model</literal> information
- though, which is by the menu
- "Tools" -> "Export as XMI...".
- This may be usefull e.g.
- when generating programming code
- with an external tool
- that understands XMI.
- </para>
+
+ <para>The file operations save and open handle one <literal>project</literal> at a time. One <literal>project</literal> corresponds to a <literal>model</literal> plus diagram information, i.e. everything you can edit within the ArgoUML window. </para>
+ <para>The <literal>model</literal> may contain many objects (ModelElements) which form the complete UML description of the system you are describing. All ModelElements might be present on a diagram, but this is not required. Hence, the <literal>model</literal> that is stored in ArgoUML is independent of the contents of the diagrams. This may be explained by the possibility to generate programming code from the <literal>model</literal> - you do not need any diagrams for this. </para>
+ <para>A ArgoUML <literal>project</literal> also contains all diagram information, i.e. the shapes (presentation) used to represent the various UML ModelElements, their location, color, etc. Some ModelElements appear on multiple diagrams, some on one or none. </para>
+ <para>Hence, saving and opening projects retains all this information. There is a way to only save the <literal>model</literal> information though, which is by the menu "Tools" -> "Export as XMIâ¦". This may be usefull e.g. when generating programming code with an external tool that understands XMI. </para>
</section>
-
+
+
<section>
<title>Objects</title>
- <para>
- Select objects by left-clicking on them.
- The functionality of ArgoUML can be activated in the menu,
- in toolbars,
- or in pop-up menus when right-clicking above an object.
- Many of these functions work on the selected objects.
- </para>
- <para>
- All diagrams have toolbars at the top which are used
- to create objects on the diagram.
- </para>
- <para>
- Most objects can be added to a diagram and removed from a diagram without
- deleting it from the <literal>model</literal>!
- Select an object on a diagram, and then the menu item
- "Edit" -> "Remove from Diagram" clears the object from the diagram,
- but the object remains intact in the model,
- which may be seen in the explorer,
- i.e. the tree structure at the left hand side.
- Once removed, and item can be added back to the diagram
- (or any other diagram for that matter)
- by selecting it in the explorer
- and selecting the item "Add to Diagram"
- in the right-click pop-up menu.
- </para>
+
+ <para>Select objects by left-clicking on them. The functionality of ArgoUML can be activated in the menu, in toolbars, or in pop-up menus when right-clicking above an object. Many of these functions work on the selected objects. </para>
+ <para>All diagrams have toolbars at the top which are used to create objects on the diagram. </para>
+ <para>Most objects can be added to a diagram and removed from a diagram without deleting it from the <literal>model</literal>! Select an object on a diagram, and then the menu item "Edit" -> "Remove from Diagram" clears the object from the diagram, but the object remains intact in the model, which may be seen in the explorer, i.e. the tree structure at the left hand side. Once removed, and item can be added back to the diagram (or any other diagram for that matter) by selecting it in the explorer and selecting the item "Add to Diagram" in the right-click pop-up menu. </para>
</section>
-
- <section>
- <title>Overview of the window</title>
- <para>
- The top of the window contains a menu bar with commands available.
- In the <literal>File</literal> menu you can store the project or
- open another project instead.
- </para>
- <para>
- The upper left part of the ArgoUML window shows a tree model
- of diagrams and objects.
- This view can be adapted to your needs
- by filtering the objects that are shown,
- and the structure in which they are shown.
- </para>
- <para>
- The upper right part of ArgoUML shows the current diagram (one at a time).
- You can drag and drop the objects in the diagrams,
- and you can use the quick-links
- that appear when hovering over a selected object
- to create new objects connected to the
- already present objects.
- </para>
- <para>
- The lower right part contains various details of the currently selected
- object: You select the object in one of the upper
- levels and choose what details you want to examine using the
- tabs.
- </para>
- <para>
- The lower left part contains a list of all ToDo items for this
- model.
- </para>
- </section>
-
-</chapter>
+
+
+ <section>
+ <title>Overview of the window</title>
+
+ <para>The top of the window contains a menu bar with commands available. In the <literal>File</literal> menu you can store the project or open another project instead. </para>
+ <para>The upper left part of the ArgoUML window shows a tree model of diagrams and objects. This view can be adapted to your needs by filtering the objects that are shown, and the structure in which they are shown. </para>
+ <para>The upper right part of ArgoUML shows the current diagram (one at a time). You can drag and drop the objects in the diagrams, and you can use the quick-links that appear when hovering over a selected object to create new objects connected to the already present objects. </para>
+ <para>The lower right part contains various details of the currently selected object: You select the object in one of the upper levels and choose what details you want to examine using the tabs. </para>
+ <para>The lower left part contains a list of all ToDo items for this model. </para>
+ </section>
+</chapter>
\ No newline at end of file
Modified: branches/work_docbook5_zearin/branch1/documentation/quick-guide/quickguide.xml
Url: http://argouml.tigris.org/source/browse/argouml/branches/work_docbook5_zearin/branch1/documentation/quick-guide/quickguide.xml?view=diff&rev=14049&p1=branches/work_docbook5_zearin/branch1/documentation/quick-guide/quickguide.xml&p2=branches/work_docbook5_zearin/branch1/documentation/quick-guide/quickguide.xml&r1=14048&r2=14049
==============================================================================
--- branches/work_docbook5_zearin/branch1/documentation/quick-guide/quickguide.xml (original)
+++ branches/work_docbook5_zearin/branch1/documentation/quick-guide/quickguide.xml 2008-01-15 19:28:43-0800
@@ -1,96 +1,112 @@
-<?xml version="1.0" encoding="UTF-8"?>
+<?xml version="1.0" encoding="UTF-8" ?>
<!-- $Id$ -->
<!--
-// Copyright (c) 1996-2005 The Regents of the University of California. All
-// Rights Reserved. Permission to use, copy, modify, and distribute this
-// software and its documentation without fee, and without a written
-// agreement is hereby granted, provided that the above copyright notice
-// and this paragraph appear in all copies. This software program and
-// documentation are copyrighted by The Regents of the University of
-// California. The software program and documentation are supplied "AS
-// IS", without any accompanying services from The Regents. The Regents
-// does not warrant that the operation of the program will be
-// uninterrupted or error-free. The end-user understands that the program
-// was developed for research purposes and is advised not to rely
-// exclusively on the program for any reason. IN NO EVENT SHALL THE
-// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
-// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
-// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
-// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
-// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
-// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
-// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
-// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
-// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
+ // Copyright (c) 1996-2005 The Regents of the University of California. All
+ // Rights Reserved. Permission to use, copy, modify, and distribute this
+ // software and its documentation without fee, and without a written
+ // agreement is hereby granted, provided that the above copyright notice
+ // and this paragraph appear in all copies. This software program and
+ // documentation are copyrighted by The Regents of the University of
+ // California. The software program and documentation are supplied "AS
+ // IS", without any accompanying services from The Regents. The Regents
+ // does not warrant that the operation of the program will be
+ // uninterrupted or error-free. The end-user understands that the program
+ // was developed for research purposes and is advised not to rely
+ // exclusively on the program for any reason. IN NO EVENT SHALL THE
+ // UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
+ // SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
+ // ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
+ // THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
+ // SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
+ // WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+ // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
+ // PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
+ // CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
+ // UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
-->
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "../docbook-setup/docbookx/docbookx.dtd" [
+<!DOCTYPE book [
- <!-- ...................................................................... -->
- <!-- Imported General Entity declarations ................................. -->
- <!-- -->
- <!-- Please look inside these files (below) for shortcuts to entering -->
- <!-- common information such as Author details, Argo/Tigris addresses etc. -->
- <!-- ...................................................................... -->
-
- <!ENTITY % author-entities SYSTEM "declare-authors.ent">
- %author-entities;
+<!-- ...................................................................... -->
+<!-- Imported General Entity declarations ................................. -->
+<!-- -->
+<!-- Please look inside these files (below) for shortcuts to entering -->
+<!-- common information such as Author details, Argo/Tigris addresses etc. -->
+<!-- ...................................................................... -->
- <!ENTITY % argo-entities SYSTEM "declare-argostuff.ent">
- %argo-entities;
+<!ENTITY % author-entities SYSTEM "declare-authors.ent">
+%author-entities;
- <!--
- FILE INCLUDE MACROS
- -->
- <!ENTITY preface.xml SYSTEM "qstart-preface.xml">
- <!ENTITY chapter-introduction.xml SYSTEM "qstart-introduction.xml">
- <!ENTITY chapter-installation.xml SYSTEM "qstart-installation.xml">
- <!ENTITY chapter-credits.xml SYSTEM "qstart-credits.xml">
- <!ENTITY chapter-running.xml SYSTEM "qstart-running.xml">
-
- <!--
- TEXT SUBSTITUTION MACROS
-
- These macros should be used to include links to the web site, etc...
- e.g. To include a link to the "ArgoUML project" use:
- &argo-project-link;
- -->
- <!ENTITY document-title 'ArgoUML Quick Guide'>
- <!ENTITY document-subtitle 'Get started with ArgoUML @VERSION@'>
+<!ENTITY % argo-entities SYSTEM "declare-argostuff.ent">
+%argo-entities;
+
+<!--
+FILE INCLUDE MACROS
+-->
+<!ENTITY preface.xml SYSTEM "qstart-preface.xml">
+<!ENTITY chapter-credits.xml SYSTEM "qstart-credits.xml">
]>
-<book>
- <title>&document-title;</title>
- <bookinfo>
- <subtitle>&document-subtitle;</subtitle>
+<book
+ xmlns="http://docbook.org/ns/docbook"
+ version="5.0"
+ xml:lang="en"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ >
+
+ <title>ArgoUML Quick Guide</title>
+ <subtitle>Get started with ArgoUML @VERSION@</subtitle>
+
+ <info>
<authorgroup>
- &author-kunle.odu;
- &author-anthony.ogu;
<author>
- <firstname>Linus</firstname>
- <surname>Tolke</surname>
+ <personname>
+ <firstname>Kunle</firstname>
+ <surname>Odutola</surname>
+ </personname>
+ <address><email>Kunle_Odutola@hotmail.com</email></address>
</author>
+
<author>
- <firstname>Michiel</firstname>
- <surname>van der Wulp</surname>
+ <personname>
+ <firstname>Anthony</firstname>
+ <surname>Oguntimehin</surname>
+ </personname>
+ </author>
+
+ <author>
+ <personname>
+ <firstname>Linus</firstname>
+ <surname>Tolke</surname>
+ </personname>
+ </author>
+
+ <author>
+ <personname>
+ <firstname>Michiel</firstname>
+ <surname>van der Wulp</surname>
+ </personname>
</author>
</authorgroup>
+
<copyright>
<year>2001</year>
<holder>Kunle Odutola</holder>
</copyright>
+
<copyright>
<year>2004-2005</year>
<holder>Michiel van der Wulp</holder>
</copyright>
+
<legalnotice>
&open-content-license;
</legalnotice>
- </bookinfo>
-
-&chapter-introduction.xml;
-&chapter-installation.xml;
-&chapter-running.xml;
-
-</book>
+ </info>
+
+ <xi:include href="qstart-introduction.xml" />
+ <xi:include href="qstart-installation.xml" />
+ <xi:include href="qstart-running.xml" />
+
+</book>
\ No newline at end of file
lmpx.com only provides a reader for public news (NNTP) servers. It is not
affiliated with the servers or forums shown here and is not responsible for
the content of articles, which is written by their respective authors.