[jbosstools-commits] JBoss Tools SVN: r25504 - in trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US: images and 1 other directory.

Author: irooskov(a)redhat.com Date: 2010-10-05 23:52:22 -0400 (Tue, 05 Oct 2010) New Revision: 25504 Added: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Concepts.xml trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Introduction.xml trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/images/ModeShape_context_submenu.png trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/images/Preferences_dialog.png trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/images/Publish_Wizard.png trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/images/publish_unpublish_console_output.png trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/modeshape-concepts.xml trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/publish_or_unpublish_a_resource-task.xml trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/setting_preferences-task.xml Modified: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Book_Info.xml trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/ModeShape_Tools_Reference_Guide.xml trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Tasks.xml trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/master.xml trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/register_a_new_repository-task.xml Log: updated book with new content Modified: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Book_Info.xml =================================================================== --- trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Book_Info.xml 2010-10-05 20:20:26 UTC (rev 25503) +++ trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Book_Info.xml 2010-10-06 03:52:22 UTC (rev 25504) @@ -5,7 +5,7 @@ ]> <bookinfo id="book-ModeShape_Tools_Reference_Guide-ModeShape_Tools_Reference_Guide"> <title>ModeShape Tools Reference Guide</title> - <subtitle>short description</subtitle> + <subtitle>ModeShape tools allow you to interact with the contents of numerious ModeShape repositories.</subtitle> <productname>JBoss Developer Studio</productname> <productnumber>4.0</productnumber> <edition>4.0.0</edition> Added: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Concepts.xml =================================================================== --- trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Concepts.xml (rev 0) +++ trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Concepts.xml 2010-10-06 03:52:22 UTC (rev 25504) @@ -0,0 +1,14 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "ModeShape_Tools_Reference_Guide.ent"> +%BOOK_ENTITIES; +]>--> +<chapter id="chap-ModeShape_Tools_Reference_Guide-Concepts"> + <title>Concepts</title> + <para> + This section outlines the concepts that are assumed information when performing tasks with ModeShape tools. + </para> + <xi:include href="modeshape-concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> + + Added: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Introduction.xml =================================================================== --- trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Introduction.xml (rev 0) +++ trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Introduction.xml 2010-10-06 03:52:22 UTC (rev 25504) @@ -0,0 +1,15 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "ModeShape_Tools_Reference_Guide.ent"> +%BOOK_ENTITIES; + ]>--> +<chapter id="chap-ModeShape_Tools_Reference_Guide-introduction"> + <title>Introduction</title> + <para> + ModeShape tools allows you to link your workspace to ModeShape repositories, publish and unpublish resources to the repositories and define what can and cannot be published and unpublished. + </para> + <para> + The Modeshape registry is persisted from session to session. + </para> +</chapter> + Modified: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/ModeShape_Tools_Reference_Guide.xml =================================================================== --- trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/ModeShape_Tools_Reference_Guide.xml 2010-10-05 20:20:26 UTC (rev 25503) +++ trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/ModeShape_Tools_Reference_Guide.xml 2010-10-06 03:52:22 UTC (rev 25504) @@ -6,6 +6,8 @@ <book> <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="Tasks.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <index /> Modified: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Tasks.xml =================================================================== --- trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Tasks.xml 2010-10-05 20:20:26 UTC (rev 25503) +++ trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/Tasks.xml 2010-10-06 03:52:22 UTC (rev 25504) @@ -9,5 +9,8 @@ This section outlines different tasks that can be achieved through the use of the ModeShape tools. </para> <xi:include href="register_a_new_repository-task.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="publish_or_unpublish_a_resource-task.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="setting_preferences-task.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </chapter> + Added: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/images/ModeShape_context_submenu.png =================================================================== (Binary files differ) Property changes on: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/images/ModeShape_context_submenu.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/images/Preferences_dialog.png =================================================================== (Binary files differ) Property changes on: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/images/Preferences_dialog.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/images/Publish_Wizard.png =================================================================== (Binary files differ) Property changes on: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/images/Publish_Wizard.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/images/publish_unpublish_console_output.png =================================================================== (Binary files differ) Property changes on: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/images/publish_unpublish_console_output.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/master.xml =================================================================== --- trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/master.xml 2010-10-05 20:20:26 UTC (rev 25503) +++ trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/master.xml 2010-10-06 03:52:22 UTC (rev 25504) @@ -3,7 +3,8 @@ "http://www.oasis-open.org/docbook/xml/4.3CR3/docbookx.dtd" [<!ENTITY Preface SYSTEM "Preface.xml"> -<!--<!ENTITY Introduction SYSTEM "Introduction.xml"> --> +<!ENTITY Introduction SYSTEM "Introduction.xml"> +<!ENTITY Concepts SYSTEM "Concepts.xml"> <!ENTITY Tasks SYSTEM "Tasks.xml"> <!ENTITY Revision_History SYSTEM "Revision_History.xml"> ]> @@ -47,7 +48,8 @@ <toc/> <!-- &Preface; --> - <!-- &Introduction; --> + &Introduction; + &Concepts; &Tasks; &Revision_History; Added: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/modeshape-concepts.xml =================================================================== --- trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/modeshape-concepts.xml (rev 0) +++ trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/modeshape-concepts.xml 2010-10-06 03:52:22 UTC (rev 25504) @@ -0,0 +1,22 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "ModeShape_Tools_Reference_Guide.ent"> +%BOOK_ENTITIES; +]>--> + +<section id="sect-ModeShape_Tools_Reference_Guide-Concepts-ModeShape"> + <title>ModeShape</title> + <para> + ModeShape is a component that maintains repositories of resources for your application server, through the implementation of a JCR (Java Content Repository) view. The resources stored can come from many different kinds of systems. + </para> + <para> + To your applications, ModeShape looks and behaves like a regular JCR repository. Using the standard JCR API, applications can search, navigate and listen for changes in content. However, ModeShape retrieves its content by federating multiple back-end systems (such as databases, services and other repositories). This allows those systems to maintain ownership of the information, while ensuring the unified repository remains current. + </para> + <para> + ModeShape repositories can be used in a variety of applications. One such application is provisioning and management. In provisioning and management it is critical to understand and keep track of the metadata for models, databases, services, components, applications, clusters, machines, and other systems used in an enterprise environment. Governance takes that a step further, by also tracking the policies and expectations against which performance can be verified. In these cases, a repository is an excellent mechanism for managing this complex and highly-varied information. + </para> + <para> + A ModeShape repository doesn't have to be large and complex. It could just manage configuration information for an application, or provide a JCR interface on top of non-JCR systems. + </para> +</section> + Added: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/publish_or_unpublish_a_resource-task.xml =================================================================== --- trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/publish_or_unpublish_a_resource-task.xml (rev 0) +++ trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/publish_or_unpublish_a_resource-task.xml 2010-10-06 03:52:22 UTC (rev 25504) @@ -0,0 +1,55 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "ModeShape_Tools_Reference_Guide.ent"> +%BOOK_ENTITIES; +]>--> + +<section id="sect-ModeShape_Tools_Reference_Guide-Tasks-Publish_or_unpublish_a_resource"> + <title>Publish or unpublish a resorce</title> + <para> + Having registered your ModeShape instances in <xref linkend="sect-ModeShape_Tools_Reference_Guide-Tasks-Register_a_new_repository"/>, you can now publish files to the repositories. + </para> + <para> + Right-clicking on one or more projects, folders, or files in your Eclipse workspace will display the context menu for those files. This menu will now include a ModeShape submenu that allows you to publish or unpublish the resources to your ModeShape repository. + </para> + <para> + When only one resource is selected you can also view the locations where that resource has been published. The published locations of a resource can be viewed by right-clicking on an individual resource and navigating the ModeShape context submenu to the <guimenuitem>Show Published Locations</guimenuitem> option. + </para> + <figure> + <title>ModeShape context submenu</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/ModeShape_context_submenu.png"/> + </imageobject> + </mediaobject> + </figure> + <para> + To assist with the publishing or unpublishing of your resource, a wizard will appear when either of these options are selected. + </para> + <figure id="ModeShape_publishing_wizard"> + <title>ModeShape publishing wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Publish_Wizard.png"/> + </imageobject> + </mediaobject> + </figure> + <para> + The publishing wizard (shown in <xref linkend="ModeShape_publishing_wizard"/>) and unpublishing wizard allows you to choose which ModeShape repository to interact with and displays the selected files the operation will be performed on. When a project or folder is selected all their included files are acted upon. + </para> + <para> + When publishing or unpublishing files, you can see the operation output in the <guilabel>Console</guilabel> view. The type of information that you can view includes the repository where the operation took place, how long the operation took, the outcome for each file included in the operation, a hyperlink that allows you to open the file in an Eclipse editor, and a ModeShape repository workspace URL. + </para> + <figure id="publish_unpublish_console_output"> + <title>Console output</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/publish_unpublish_console_output.png"/> + </imageobject> + </mediaobject> + </figure> + <para> + If you wish for certain folders or file types to never be published or unpublished, these conditions can be set through the ModeShape preferences dialog explained in <xref linkend="sect-ModeShape_Tools_Reference_Guide-Tasks-Setting_preferences"/> + </para> +</section> + Modified: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/register_a_new_repository-task.xml =================================================================== --- trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/register_a_new_repository-task.xml 2010-10-05 20:20:26 UTC (rev 25503) +++ trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/register_a_new_repository-task.xml 2010-10-06 03:52:22 UTC (rev 25504) @@ -43,7 +43,7 @@ Once the server with the ModeShape repository has been added three new options become available within the <guilabel>ModeShape</guilabel> view. These options allow you to <guilabel>Edit server properties</guilabel>, <guilabel>Delete a server from the server registry</guilabel> and <guilabel>Reconnect to the selected server</guilabel>. To perform one of these actions either right-click on a server and select from the presented menu of actions, or use the buttons beside the <guilabel>Create a new server</guilabel> button seen in <xref linkend="Adding_a_new_server_for_ModeShape_repositories"/>. </para> <para> - The <guilabel>ModeShape</guilabel> view also allows you to remove files from a workspace in an environment where the registry is being persisted from session to session. + The <guilabel>ModeShape</guilabel> view also allows you to remove files from a workspace. </para> </section> Added: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/setting_preferences-task.xml =================================================================== --- trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/setting_preferences-task.xml (rev 0) +++ trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/setting_preferences-task.xml 2010-10-06 03:52:22 UTC (rev 25504) @@ -0,0 +1,37 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "ModeShape_Tools_Reference_Guide.ent"> +%BOOK_ENTITIES; + ]>--> +<section id="sect-ModeShape_Tools_Reference_Guide-Tasks-Setting_preferences"> + <title>Setting preferences</title> + <para> + The ModeShape <guilabel>Preferences</guilabel> dialog allows you to set specific file types and folders that you never wish to have published to or unpublished from a ModeShape repository. This dialog is accessed by navigating to <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>ModeShape</guimenuitem></menuchoice>. + </para> + <figure id="Preferences_dialog"> + <title>ModeShape preferences dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Preferences_dialog.png"/> + </imageobject> + </mediaobject> + </figure> + <para> + To add a new file extention type or folder name to be filtered from publishing, click on the corresponding <guibutton>New</guibutton> button, enter the details and click the <guibutton>Apply</guibutton> button so that your preference changes are saved. + </para> + <para> + Removing an entry is conducted by selecting an entry from one of the lists in the <guilabel>Preferences</guilabel> dialog and clicking on the <guibutton>Remove</guibutton> button. Ensure that you click the <guibutton>Apply</guibutton> button so that your preference changes are saved. + </para> + <para> + As the <guilabel>Preferences</guilabel> dialog lists file types and folders that will never be published to a repository, it follows that those listed will never be unpublished. If you decide to never have a certain file type or folder publishable, though it has been in the past, ensure that all instances of these are unpublished before setting any preferences for the file type or folder. + </para> + <para> + If you do not ensure all file types and folders that are never to be published are unpublished before setting the prefences, then you will be left with instances of these in your ModeShape repositories that cannot be unpublished unless your preferences are changed. + </para> + <note> + <para> + Publishing folders or files of a certain file type before setting any preferences inhibiting the publishing of these types can be a way of ensuring that these files will never be removed (unpublished) from your ModeShape repositories by accident or someone else. + </para> + </note> +</section> +