svn commit: r14773 - trunk/documentation/cookbook

Author: euluis
Date: 2008-05-19 16:19:50-0700
New Revision: 14773

Added:
   trunk/documentation/cookbook/subsystemprofile.xml   (contents, props changed)
Modified:
   trunk/documentation/cookbook/cookbook.xml
   trunk/documentation/cookbook/inside_subsystems.xml

Log:
issue 4991: started solving the issue - adding the profile subsystem section

Modified: trunk/documentation/cookbook/cookbook.xml
Url: http://argouml.tigris.org/source/browse/argouml/trunk/documentation/cookbook/cookbook.xml?view=diff&rev=14773&p1=trunk/documentation/cookbook/cookbook.xml&p2=trunk/documentation/cookbook/cookbook.xml&r1=14772&r2=14773
==============================================================================
--- trunk/documentation/cookbook/cookbook.xml	(original)
+++ trunk/documentation/cookbook/cookbook.xml	2008-05-19 16:19:50-0700
@@ -45,6 +45,7 @@
 <!ENTITY subsystemdiagrams SYSTEM "subsystemdiagrams.xml">
 <!ENTITY subsystempersistence SYSTEM "subsystempersistence.xml">
 <!ENTITY subsystemnotation SYSTEM "subsystemnotation.xml">
+<!ENTITY subsystemprofile SYSTEM "subsystemprofile.xml">
 <!ENTITY subsystempropertypanels SYSTEM "subsystempropertypanels.xml">
 <!ENTITY subsysteminternationalization SYSTEM "subsysteminternationalization.xml">
 <!ENTITY subsystemlogging SYSTEM "subsystemlogging.xml">

Modified: trunk/documentation/cookbook/inside_subsystems.xml
Url: http://argouml.tigris.org/source/browse/argouml/trunk/documentation/cookbook/inside_subsystems.xml?view=diff&rev=14773&p1=trunk/documentation/cookbook/inside_subsystems.xml&p2=trunk/documentation/cookbook/inside_subsystems.xml&r1=14772&r2=14773
==============================================================================
--- trunk/documentation/cookbook/inside_subsystems.xml	(original)
+++ trunk/documentation/cookbook/inside_subsystems.xml	2008-05-19 16:19:50-0700
@@ -47,6 +47,7 @@
   &subsystempropertypanels;
   &subsystempersistence;
   &subsystemnotation;
+  &subsystemprofile;
   
   <sect1 id="reverseengineering">
     <title>Reverse Engineering Subsystem</title> <indexterm>
@@ -291,9 +292,9 @@
       the C++ plugin is located <ulink url="http://argouml-cpp.tigris.org/">
       here</ulink>.
     </para>
-    <para>Currently C++ has no reverse engineering but only code generation (and
-      a very simple one at that). The Java classfile module has only reverse 
-      engineering.
+    <para>Currently C++ has a proof of concept reverse engineering module and 
+      a more mature code generation module, although still very simple.
+      The Java classfile module has only reverse engineering.
     </para>
     <para>There are stubs/shells for many different languages, but the following
     are mature enough to be distributed with ArgoUML: C++ (Cpp), C# (Csharp), 

Added: trunk/documentation/cookbook/subsystemprofile.xml
Url: http://argouml.tigris.org/source/browse/argouml/trunk/documentation/cookbook/subsystemprofile.xml?view=auto&rev=14773
==============================================================================
--- (empty file)
+++ trunk/documentation/cookbook/subsystemprofile.xml	2008-05-19 16:19:50-0700
@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!-- $Id$ -->
+<!--
+// Copyright (c) 2008 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.
+-->
+
+<sect1 id="profile">
+  <title>Profile</title>
+  <indexterm>
+    <primary>Profile</primary>
+  </indexterm>
+
+  <para id="profile-subsys-purpose">
+Purpose &ndash; To provide support for the use, definition and 
+management of UML profiles with ArgoUML.
+  </para>
+  <para>
+The Profile subsystem is located in the package 
+<classname>org.argouml.profile</classname> and its subpackages.
+In package <classname>org.argouml.profile</classname> there are classes that 
+define almost all the subsystem API, concerning the definition and management 
+of UML profiles. 
+The package <classname>org.argouml.profile.init</classname> contains the 
+remaining subsystem API, being its only purpose to provide the subsystem 
+initialization API (this is therefore of use only to a minority of external 
+subsystems).
+  </para>
+  <para>
+TODO: place here a simple picture of the subsystem.
+  </para>
+  <para>
+The profile subsystem is similar in some ways to the model subsystem &ndash; 
+there is a <classname>ProfileFacade</classname> that is the main entry point 
+to the methods and classes that provide management functions to the subsystem 
+(notably the <classname>ProfileManager</classname>).
+It also maintains a one to one relationship with the remaining subsystems of 
+ArgoUML, although it is not Singleton based in order to facilitate testing 
+and easy cleanup or reset of its internal state. 
+The classes that provide support for defining profiles are explained in <xref
+        linkend="profile-subsys-design"></xref>
+  </para>
+
+  <sect2 id="profile-subsys-design">
+    <title>Design of the subsystem</title>
+    <para>
+TODO: here the detailed design is explained 
+    </para>
+  </sect2>
+</sect1>
+
+
+<!-- Local stuff for Emacs - please do not delete
+
+Local Variables:
+mode: xml
+sgml-doctype: "cookbook.xml"
+sgml-parent-document: ("cookbook.xml" "sect1" nil)
+sgml-validate-command: "nsgmls -wxml -sv ../docbook-setup/xml.dcl \
+  cookbook.xml"
+indent-tabs-mode: nil
+End:
+
+-->
+