incubator-graffito-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From clomb...@apache.org
Subject svn commit: r227082 - in /incubator/graffito/trunk/site: xdocs-templates/ xdocs/ xdocs/images/uml/
Date Tue, 02 Aug 2005 20:51:41 GMT
Author: clombart
Date: Tue Aug  2 13:51:31 2005
New Revision: 227082

URL: http://svn.apache.org/viewcvs?rev=227082&view=rev
Log:
Update the Graffito site : 
*Add class diagrams
*Draft for graffito modules definition

Added:
    incubator/graffito/trunk/site/xdocs/class-diagrams.xml
    incubator/graffito/trunk/site/xdocs/graffito-modules.xml
    incubator/graffito/trunk/site/xdocs/images/uml/
    incubator/graffito/trunk/site/xdocs/images/uml/graffito-class-server.png   (with props)
    incubator/graffito/trunk/site/xdocs/images/uml/graffito-class.png   (with props)
Modified:
    incubator/graffito/trunk/site/xdocs-templates/navigation.xml
    incubator/graffito/trunk/site/xdocs/navigation.xml

Modified: incubator/graffito/trunk/site/xdocs-templates/navigation.xml
URL: http://svn.apache.org/viewcvs/incubator/graffito/trunk/site/xdocs-templates/navigation.xml?rev=227082&r1=227081&r2=227082&view=diff
==============================================================================
--- incubator/graffito/trunk/site/xdocs-templates/navigation.xml (original)
+++ incubator/graffito/trunk/site/xdocs-templates/navigation.xml Tue Aug  2 13:51:31 2005
@@ -36,7 +36,8 @@
 			<item name="Support" href="/support.html"/>
 		</menu>
 		<menu name="Project Structure"> 
-		        <item name="Directory Layout" href="/project-structure.html"/>
+		        <!-- item name="Graffito Modules" href="/graffito-modules.html"/ -->
+		        <item name="Directory Layout" href="/project-structure.html"/>				
 			#foreach ($reactorProject in $reactorProjects) 
 				<item name="$reactorProject.name"     href="./${reactorProject.file.parentFile.name}/index.html"/>

 		        #end 
@@ -47,13 +48,19 @@
 			<item name="Supported DB" href="supported-db.html"/>
 			<item name="Deploy Graffito into Jetspeed 2" href="deploy.html"/>
 		</menu>
- 	    <menu name="Screenshots">
+ 	    
+		<menu name="Screenshots">
 			<item name="Portlets" href="/portlet-screenshots.html"/>
 		</menu>			
-		<menu name="Documentation">
+		
+		<menu name="Design">
 			<item name="Architecture" href="/architecture.html"/>
-			<item name="Graffito Content Store Setup" href="/store.html"/>
+			<item name="Class diagrams" href="/class-diagrams.html"/>
+		</menu>
+		
+		<menu name="Tech. Doc">
 			<item name="Maven goals" href="/maven-goals.html"/>
+			<item name="Graffito Content Store Setup" href="/store.html"/>
 		</menu>
 
 	</body>

Added: incubator/graffito/trunk/site/xdocs/class-diagrams.xml
URL: http://svn.apache.org/viewcvs/incubator/graffito/trunk/site/xdocs/class-diagrams.xml?rev=227082&view=auto
==============================================================================
--- incubator/graffito/trunk/site/xdocs/class-diagrams.xml (added)
+++ incubator/graffito/trunk/site/xdocs/class-diagrams.xml Tue Aug  2 13:51:31 2005
@@ -0,0 +1,113 @@
+<?xml version="1.0"?>
+<!--
+Copyright 2004 The Apache Software Foundation
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+<document>
+	<properties>
+		<author email="christophe.lombart@sword-technologies.com">Christophe Lombart</author>
+		<title>Graffito Class Diagram</title>
+	</properties>
+	<body>
+		<section name="CmsObject, Content and Folder">
+            <subsection name="Diagram">	
+			    <img src="./images/uml/graffito-class.png"  widht="50%" ></img>
+            </subsection>			
+   		    <subsection name="Core Interfaces">			
+				<table>
+					<tr>
+						<th>Interface</th>
+						<th>Description</th>
+					</tr>
+					<tr>
+						<td>CmsObject</td>
+						<td>Ancestor for all kind of CMS objects. A CmsObject has a unique URI, a unique
name and a collection of properties</td>
+					</tr>
+					<tr>
+						<td>Folder</td>
+						<td>Generic collection of CmsObjects</td>
+					</tr>
+					<tr>
+						<td>Content</td>
+						<td>Generic content interface</td>
+					</tr>
+					<tr>
+						<td>Link</td>
+						<td>Reference to a CmsObject</td>
+					</tr>					
+					<tr>
+						<td>VersionnedContent</td>
+						<td>Generic content which require version management. VersionContent is referenced
in an HistoryElement</td>
+					</tr>
+					<tr>
+						<td>HistoryElement</td>
+						<td>Simple interface used to build the version history. Each element refer to
an VersionContent and to the previous HistoryElement</td>
+					</tr>					
+				</table>
+			</subsection>
+			<subsection name="Optional Module : Document Management">						
+				<table>
+					<tr>
+						<th>Interface</th>
+						<th>Description</th>
+					</tr>
+					<tr>
+						<td>Document</td>
+						<td>Binary content interface associated to a content type(pdf, images, Open Office,
...). A document can have severals document binary content (see interface DocumentStream).
Each document stream is associated to an encoding and an iso code.</td>
+					</tr>
+					
+				</table>
+			</subsection>
+			<subsection name="Other Optional Modules : Forum and article management">		
+			   <p>Thoses modules are not yet implemented.</p>
+			</subsection>
+			
+		</section>
+		<section name="Content Server">
+            <subsection name="Diagram">	
+			    <img src="./images/uml/graffito-class-server.png" ></img>
+            </subsection>			
+            
+   		    <subsection name="Class Description">			
+				<table>
+					<tr>
+						<th>Interface</th>
+						<th>Description</th>
+					</tr>
+					<tr>
+						<td>Server</td>
+						<td>Abstract server interface. A server contains a collection of CmsObject</td>
+					</tr>					
+					<tr>
+						<td>GraffitoServer</td>
+						<td>Default Content Server based on a DB Schema</td>
+					</tr>
+					<tr>
+						<td>FileSystemServer</td>
+						<td>Content Server based on a file system (not yet implemented)</td>
+					</tr>
+					<tr>
+						<td>WebdavServer</td>
+						<td>Webdav Content Server (not yet implemented)</td>
+					</tr>
+					<tr>
+						<td>JcrServer</td>
+						<td>JCR based Content Server (not yet implemented). This server will be the default
one as soon as possible.</td>
+					</tr>					
+				</table>
+			</subsection>
+		</section>
+		
+	</body>
+</document>

Added: incubator/graffito/trunk/site/xdocs/graffito-modules.xml
URL: http://svn.apache.org/viewcvs/incubator/graffito/trunk/site/xdocs/graffito-modules.xml?rev=227082&view=auto
==============================================================================
--- incubator/graffito/trunk/site/xdocs/graffito-modules.xml (added)
+++ incubator/graffito/trunk/site/xdocs/graffito-modules.xml Tue Aug  2 13:51:31 2005
@@ -0,0 +1,41 @@
+<?xml version="1.0"?>
+<!--
+Copyright 2004 The Apache Software Foundation
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+<document>
+	<properties>
+		<author email="christophe.lombart@sword-technologies.com">Christophe Lombart</author>
+		<title>Graffito Modules</title>
+	</properties>
+	<body>
+		<section name="What it a Graffito Module ?">
+			<p>
+               Graffito is an extensible CMS framework. A Graffito Module is mainly used
to add new features or to modify the default behaviour of
+               the existing components. For example, it is quite easy to add new modules
for document management, asset management, 
+			   scheduler application, forums, news management, ... 
+            </p>
+			<p>The Graffito core object model &amp; services are the foundation for all
Graffito modules. </p> 
+
+			<subsection name="Graffito Module Structure">
+
+				<p>A Graffito Module is composed a set of jars containing the module components,
portlet application (war), one assembly script and one deployment script.</p>
+
+			</subsection>
+			<subsection name="Building a new Graffito Module">			
+			   <p>TBD</p>
+			</subsection>
+		</section>
+	</body>
+</document>

Added: incubator/graffito/trunk/site/xdocs/images/uml/graffito-class-server.png
URL: http://svn.apache.org/viewcvs/incubator/graffito/trunk/site/xdocs/images/uml/graffito-class-server.png?rev=227082&view=auto
==============================================================================
Binary file - no diff available.

Propchange: incubator/graffito/trunk/site/xdocs/images/uml/graffito-class-server.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: incubator/graffito/trunk/site/xdocs/images/uml/graffito-class.png
URL: http://svn.apache.org/viewcvs/incubator/graffito/trunk/site/xdocs/images/uml/graffito-class.png?rev=227082&view=auto
==============================================================================
Binary file - no diff available.

Propchange: incubator/graffito/trunk/site/xdocs/images/uml/graffito-class.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Modified: incubator/graffito/trunk/site/xdocs/navigation.xml
URL: http://svn.apache.org/viewcvs/incubator/graffito/trunk/site/xdocs/navigation.xml?rev=227082&r1=227081&r2=227082&view=diff
==============================================================================
--- incubator/graffito/trunk/site/xdocs/navigation.xml (original)
+++ incubator/graffito/trunk/site/xdocs/navigation.xml Tue Aug  2 13:51:31 2005
@@ -36,7 +36,8 @@
 			<item name="Support" href="/support.html"/>
 		</menu>
 		<menu name="Project Structure"> 
-		        <item name="Directory Layout" href="/project-structure.html"/>
+		        <!-- item name="Graffito Modules" href="/graffito-modules.html"/ -->
+		        <item name="Directory Layout" href="/project-structure.html"/>				
 							<item name="Graffito Core API"     href="./api/index.html"/> 
 		        				<item name="Graffito Components"     href="./components/index.html"/>

 		        				<item name="Graffito Engine"     href="./engine/index.html"/> 
@@ -47,13 +48,19 @@
 			<item name="Supported DB" href="supported-db.html"/>
 			<item name="Deploy Graffito into Jetspeed 2" href="deploy.html"/>
 		</menu>
- 	    <menu name="Screenshots">
+ 	    
+		<menu name="Screenshots">
 			<item name="Portlets" href="/portlet-screenshots.html"/>
 		</menu>			
-		<menu name="Documentation">
+		
+		<menu name="Design">
 			<item name="Architecture" href="/architecture.html"/>
-			<item name="Graffito Content Store Setup" href="/store.html"/>
+			<item name="Class diagrams" href="/class-diagrams.html"/>
+		</menu>
+		
+		<menu name="Tech. Doc">
 			<item name="Maven goals" href="/maven-goals.html"/>
+			<item name="Graffito Content Store Setup" href="/store.html"/>
 		</menu>
 
 	</body>



Mime
View raw message