[jbosstools-commits] JBoss Tools SVN: r30335 - in trunk/modeshape/plugins: org.jboss.tools.modeshape.rest.doc.user and 2 other directories.

Author: elvisisking Date: 2011-04-05 14:31:22 -0400 (Tue, 05 Apr 2011) New Revision: 30335 Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/ trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/ModeShapeMessageConsole.html trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/ModeShapePreferencesDialog.html trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/PublishDialog.html trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/PublishedLocationsDialog.html trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/ResourceContextMenu.html trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/ServerDialog.html trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/ServerView.html trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/Toc.html trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/helpContexts.xml trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/ trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/FileFilterPreferencePage.png trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/GeneralPreferencePage.png trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/ModeShapeMessageConsole.png trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/NewFilteredFileExtension.png trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/NewFilteredFolderName.png trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/OperationDialog.png trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/PublishDialog.png trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/PublishedLocationsDialog.png trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/ResourceContextMenu.png trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/ServerDialog.png trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/ServerView.png trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/ServerViewContextMenu.png trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/collapse_all.gif trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/delete_server.gif trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/edit_server.gif trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/new_server.gif trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/refresh.gif trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/toc.xml Removed: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest/docs/ Modified: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/ModeShapeHelpContexts.xml trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc.zip trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/toc.xml Log: JBIDE-6656 Create a documentation plugin. Adding a folder with the source html and images for the context help documentation. Updated a few of the help pages and removed the html and images from the main java plugin. Modified: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/ModeShapeHelpContexts.xml =================================================================== --- trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/ModeShapeHelpContexts.xml 2011-04-05 18:30:19 UTC (rev 30334) +++ trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/ModeShapeHelpContexts.xml 2011-04-05 18:31:22 UTC (rev 30335) @@ -10,29 +10,29 @@ - individual contributors. --> <contexts> - <context id="serverViewHelpContext" title="ModeShape Server View"> - <description>The ModeShape Server View shows all registered servers and their repositories and workspaces.</description> - <topic href="ServerView.html" label="Server View"/> - <topic href="ServerDialog.html" label="Server Dialog"/> + <context id="serverViewHelpContext" title="ModeShape View"> + <description>The ModeShape View shows all registered servers and their repositories and workspaces.</description> + <topic href="doc/ServerView.html" label="ModeShape View"/> + <topic href="doc/ServerDialog.html" label="Server Dialog"/> </context> <context id="serverDialogHelpContext" title="Server Dialog"> <description>The ModeShape Server Dialog allows you to edit or create a server that hosts one or more repositories.</description> - <topic href="ServerDialog.html" label="Server Dialog"/> - <topic href="ServerView.html" label="Server View"/> + <topic href="doc/ServerDialog.html" label="Server Dialog"/> + <topic href="doc/ServerView.html" label="ModeShape View"/> </context> - <context id="publishDialogHelpContext" title="ModeShape Publish and Unpublish Dialog Help"> - <description>The Publish/Unpublish Dialog uploads or removes selected resources from the selected server.</description> - <topic href="PublishDialog.html" label="Publish/Unpublish Dialog"/> - <topic href="ServerDialog.html" label="Create a new server"/> - <topic href="ModeShapePreferencesDialog.html" label="ModeShape Preferences"/> + <context id="publishDialogHelpContext" title="ModeShape Publishing Operations Dialog Help"> + <description>The Publishing Operations Dialog uploads or removes selected resources from the selected server.</description> + <topic href="doc/PublishDialog.html" label="Publishing Operations Dialog"/> + <topic href="doc/ServerDialog.html" label="Create a new server"/> + <topic href="doc/ModeShapePreferencesDialog.html" label="ModeShape Preferences"/> </context> - <context id="preferencesHelpContext" title="ModeShape Preferences Dialog Help"> + <context id="preferencesHelpContext" title="ModeShape Preference Pages Help"> <description>The ModeShape Preferences Dialog allows you to identify file extensions and folder names that should not be involved in publishing operations.</description> - <topic href="ModeShapePreferencesDialog.html" label="ModeShape Preferences"/> - <topic href="PublishDialog.html" label="Publish/Unpublish Dialog"/> + <topic href="doc/ModeShapePreferencesDialog.html" label="ModeShape Preferences"/> + <topic href="doc/PublishDialog.html" label="Publish/Unpublish Dialog"/> </context> <context id="messageConsoleHelpContext" title="ModeShape Message Console"> <description>The ModeShape Message Console contains the output from the publishing and unpublishing operations.</description> - <topic href="ModeShapeMessageConsole.html" label="ModeShape Message Console"/> + <topic href="doc/ModeShapeMessageConsole.html" label="ModeShape Message Console"/> </context> </contexts> Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/ModeShapeMessageConsole.html =================================================================== --- trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/ModeShapeMessageConsole.html (rev 0) +++ trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/ModeShapeMessageConsole.html 2011-04-05 18:31:22 UTC (rev 30335) @@ -0,0 +1,63 @@ +<!-- + - See the COPYRIGHT.txt file distributed with this work for information + - regarding copyright ownership. + - + - This software is made available by Red Hat, Inc. under the terms of the + - Eclipse Public License v1.0 which accompanies this distribution and is + - available at http://www.eclipse.org/legal/epl-v10.html. + - + - See the AUTHORS.txt file in the distribution for a full listing of + - individual contributors. + --> +<h2>ModeShape Message Console</h2> + +<p>The <i>ModeShape Message Console</i> is shown in the <i>Workbench Console</i> view. Entries show the status and outcome of the publishing or unpublishing operations.</p> + +<p>Here is what the <i>ModeShape Message Console</i> looks like:</p> + +<img src="images/ModeShapeMessageConsole.png" border="0" alt=""> + +<p>There are view toolbar buttons to clear the console, scroll lock, pin the console, display a different console, and to open another <i>ModeShape Message Console</i>.</p> + +<h3>Console Message Entries</h3> + +<p>For each operation there is an entry at the start of the operation that identifies the job number, operation type, number of files involved in the operation, server, repository, and workspace. There is another entry at the end of the operation that identifies the job number, operation type, and how long the operation took. Inbetween these entries are entries for each file involved in the operation. The file entry takes on the form of a job number, message prefix, and message. The message consists of an operation type, eclipse workspace path, and the URL of the repository for that file. The URL is a hyperlink that opens that file in the default or last used editor for that file.</p> + +<p>Here are the file entry message prefixes:</p> + +<table border="1"> +<tr> + <td align="center"><strong>++</strong>&nbsp;</td> + <td>if the file was successfully published (uploaded)</td> +</tr> +<tr> + <td align="center"><strong>--</strong>&nbsp;</td> + <td>if the file was successfully unpublished (removed)</td> +</tr> +<tr> + <td align="center"><strong>ERROR</strong>&nbsp;</td> + <td>if there was an error publishing or unpublishing the file</td> +</tr> +<tr> + <td align="center"><strong>INFO</strong>&nbsp;</td> + <td>if there was an informational message publishing or unpublishing the file</td> +</tr> +<tr> + <td align="center"><strong>WARN</strong>&nbsp;</td> + <td>if there is a warning when publishing or unpublishing a file (like trying to unpublish a file that was never unpublished)</td> +</tr> +</table> + +<h3>Operations</h3> + +<p>Each publishing or unpublishing operation can be run "in the background" so you don't have to wait around until an operation is finished. Simply click "Run in Background" on the operation dialog. This dialog identifies the operation type, the job number, and the operations progress. You can also cancel the operation using this dialog.</p> + +<p>Here is what the <i>Operation Dialog</i> looks like:</p> + +<img src="images/OperationDialog.png" border="0" alt=""> + +<h3>Related Topics</h3> + +<ul> +<li><a href="PublishDialog.html">Publishing Operations Dialog</a></li> +</ul> Property changes on: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/ModeShapeMessageConsole.html ___________________________________________________________________ Added: svn:mime-type + text/plain Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/ModeShapePreferencesDialog.html =================================================================== --- trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/ModeShapePreferencesDialog.html (rev 0) +++ trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/ModeShapePreferencesDialog.html 2011-04-05 18:31:22 UTC (rev 30335) @@ -0,0 +1,63 @@ +<!-- + - See the COPYRIGHT.txt file distributed with this work for information + - regarding copyright ownership. + - + - This software is made available by Red Hat, Inc. under the terms of the + - Eclipse Public License v1.0 which accompanies this distribution and is + - available at http://www.eclipse.org/legal/epl-v10.html. + - + - See the AUTHORS.txt file in the distribution for a full listing of + - individual contributors. + --> +<h2>ModeShape Preference Pages</h2> + +<p>The <i>ModeShape Preference Pages</i> provide settings that allow you to personalize how ModeShape Tools' publishing operations +are done. A publishing operation occurs when selected files in your local workspace are either uploaded (published) or deleted +(unpublished) to/from a specific ModeShape repository workspace. Here's a list of the preference pages:</p> + +<ul> +<li><a href="#generalSettingsPrefPage">General Settings</a> - these settings control if published files should be put under +version control by the ModeShape server. +</li> +<li><a href="#fileFiltersPrefPage">File and Folder Filters</a> - these settings control which files are filtered out of your +publishing operations. +</li> +</ul> + +<h3><a name="generalSettingsPrefPage">General Settings Preference Page</a></h3> + +<p>The <i>General Settings Preference Page</i> currently only has a setting to control if published resources should be versioned +by the ModeShape server. This versioning preference is used by the <a href="PublishDialog.html">Publishing Operations Dialog</a>.</p> + +<p>Here is what the <i>ModeShape General Settings Preference Page</i> looks like:</p> + +<img src="images/GeneralPreferencePage.png" border="0" alt=""> + +<h3><a name="fileFiltersPrefPage">File and Folder Filters Preference Page</a></h3> + +<p>The <i>File and Folder Filters Preference Page</i> is where you identify the file extensions and the folder names you +<strong>do not</strong> want involved in your publishing operations.</p> + +<p>Here is what the <i>File and Folder Filters Preference Page</i> looks like:</p> + +<img src="images/FileFilterPreferencePage.png" border="0" alt=""> + +<p>The <i>Filtered File Extensions</i> preference provides a way to construct a list of file extensions. If a file has an extension +that matches one of these file extensions it will not be involved in either a publishing or unpublishing operation. To add a file +extension (ex., txt, jpg, class) simply click on the <code>New...</code> button to display the following dialog:</p> + +<p><img src="images/NewFilteredFileExtension.png" border="0" alt=""></p> + +<p>The <i>Filtered Folder Names</i> preference provides a way to construct a list of folder names. If a file is contained in a +folder, or has an ancestor folder, with a name that matches one of these folder names it will <strong>not</strong> be involved in +either a publishing or unpublishing operation. To add a folder name simply click on the <code>New...</code> button to display the +following dialog:</p> + +<p><img src="images/NewFilteredFolderName.png" border="0" alt=""></p> + +<h3>Related Topics</h3> + +<ul> +<li><a href="ResourceContextMenu.html">ModeShape Context Menu</a></li> +<li><a href="PublishDialog.html">Publishing Operations Dialog</a></li> +</ul> Property changes on: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/ModeShapePreferencesDialog.html ___________________________________________________________________ Added: svn:mime-type + text/plain Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/PublishDialog.html =================================================================== --- trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/PublishDialog.html (rev 0) +++ trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/PublishDialog.html 2011-04-05 18:31:22 UTC (rev 30335) @@ -0,0 +1,80 @@ +<!-- + - See the COPYRIGHT.txt file distributed with this work for information + - regarding copyright ownership. + - + - This software is made available by Red Hat, Inc. under the terms of the + - Eclipse Public License v1.0 which accompanies this distribution and is + - available at http://www.eclipse.org/legal/epl-v10.html. + - + - See the AUTHORS.txt file in the distribution for a full listing of + - individual contributors. + --> +<h2>ModeShape Publishing Operations Dialog</h2> + +<p>The <i>Publishing Operations Dialog</i> is used to publish and unpublish workspace selected files and folders to/from +repository workspaces. When publishing, the selected files will be uploaded to the selected repository workspace. When +unpublishing, the selected files will be removed from the selected repository workspace (if they exist there). See the +<a href="ModeShapePreferencesDialog.html">ModeShape Preference Pages</a> to identify the file extensions and folder names you +don't want involved in publishing operations. Here is what the <i>Publishing Operations Dialog</i> looks like:</p> + +<img src="images/PublishDialog.png" border="0" alt=""> + +<p>The dialog consists of the following controls:</p> + +<table border="1"> +<tr> + <td align="right"><strong>Server Combo</strong>&nbsp;</td> + <td>allows selection of a registered ModeShape server (the <a href="ServerView.html">ModeShape View</a> lists all the + registered servers)</td> +</tr> +<tr> + <td align="right"><strong>New Server Button</strong>&nbsp;</td> + <td>use to create and register a new server that is hosting one or more ModeShape repositories (see the + <a href="ServerDialog.html">Server Dialog</a>)</td> +</tr> +<tr> + <td align="right"><strong>Repository Combo</strong>&nbsp;</td> + <td>allows selection of a repository found hosted on the selected server</td> +</tr> +<tr> + <td align="right"><strong>Workspace Combo</strong>&nbsp;</td> + <td>allows selection of a workspace of the selected repository</td> +</tr> +<tr> + <td align="right"><strong>Workspace Area Combo</strong>&nbsp;</td> + <td>allows selection of a known root path in the workspace where files will be sequenced (you can also choose to enter one of your own)</td> +</tr> +<tr> + <td align="right"><strong>Resources List</strong>&nbsp;</td> + <td>a list of all the selected files that will be published or unpublished</td> +</tr> +<tr> + <td align="right"><strong>Recurse Checkbox</strong>&nbsp;</td> + <td>when checked will recursively select all files within any selected folders</td> +</tr> +<tr> + <td align="right"><strong>Version Checkbox</strong>&nbsp;</td> + <td>when checked the files being published will be marked as versionable within the ModeShape repository + (initially set to the preference value)</td> +</tr> +<tr> + <td align="right"><strong>Preference Page Link</strong>&nbsp;</td> + <td>selecting this link will open the <a href="ModeShapePreferencesDialog.html#generalSettingsPrefPage">General Settings Preference Page</a> + where you can modify the setting that determines if published files will be marked as versionable by the ModeShape server</td> +</tr> +</table> + +<p>A server must be selected before a repository can be selected. Likewise, a repository must be selected before a workspace +can be selected. The message area at the top of the dialog will indicate the type of operation (publish or unpublish) and if +there is any missing information. The workspace area is a path segment in the workspace that will be used as the root path +for the publishing operation. Once the workspace has been selected the 'Finish' button will be enabled and the operation +can be executed. These operations can be run in the background so that multiple operations can be run at the same time. +The <a href="ModeShapeMessageConsole.html">ModeShape Message Console</a> displays output from the operations.</p> + +<h3>Related Topics</h3> + +<ul> +<li><a href="ModeShapeMessageConsole.html">ModeShape Message Console</a></li> +<li><a href="ModeShapePreferencesDialog.html">ModeShape Preference Pages</a></li> +<li><a href="ServerDialog.html">Server Dialog</a></li> +</ul> Property changes on: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/PublishDialog.html ___________________________________________________________________ Added: svn:mime-type + text/plain Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/PublishedLocationsDialog.html =================================================================== --- trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/PublishedLocationsDialog.html (rev 0) +++ trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/PublishedLocationsDialog.html 2011-04-05 18:31:22 UTC (rev 30335) @@ -0,0 +1,26 @@ +<!-- + - See the COPYRIGHT.txt file distributed with this work for information + - regarding copyright ownership. + - + - This software is made available by Red Hat, Inc. under the terms of the + - Eclipse Public License v1.0 which accompanies this distribution and is + - available at http://www.eclipse.org/legal/epl-v10.html. + - + - See the AUTHORS.txt file in the distribution for a full listing of + - individual contributors. + --> +<h2>ModeShape Published Locations Dialog</h2> + +<p>The <i>Published Locations Dialog</i> identifies all the ModeShape workspaces the selected file has been published to from this Eclipse workspace.</p> + +<p>Here is what the <i>Published Locations Dialog</i> looks like:</p> + +<img src="images/PublishedLocationsDialog.png" border="0" alt=""> + +<p>The table data identifies, for each workspace, the server URL, user, repository name, workspace name, and published URL. A button to copy the published URL of the selected row to the system clipboard is also available.</p> + +<h3>Related Topics</h3> + +<ul> +<li><a href="PublishDialog.html">Publishing Operations Dialog</a></li> +</ul> Property changes on: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/PublishedLocationsDialog.html ___________________________________________________________________ Added: svn:mime-type + text/plain Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/ResourceContextMenu.html =================================================================== --- trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/ResourceContextMenu.html (rev 0) +++ trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/ResourceContextMenu.html 2011-04-05 18:31:22 UTC (rev 30335) @@ -0,0 +1,36 @@ +<!-- + - See the COPYRIGHT.txt file distributed with this work for information + - regarding copyright ownership. + - + - This software is made available by Red Hat, Inc. under the terms of the + - Eclipse Public License v1.0 which accompanies this distribution and is + - available at http://www.eclipse.org/legal/epl-v10.html. + - + - See the AUTHORS.txt file in the distribution for a full listing of + - individual contributors. + --> +<h2>ModeShape Context Menu</h2> + +<p>The <i>ModeShape Context Menu</i> consists of these actions: publish, unpublish, and show published locations. The publish and +unpublish actions will be enabled when one or more resources (i.e, project, folder, or file) in the workspace are selected. When +publishing, the selected resources will be uploaded to a ModeShape repository workspace. When unpublishing, the selected resources +will be removed from a selected ModeShape repository workspace (if they exist there). If a resource has already been published +using the current Eclipse workspace, the <a href="PublishedLocationsDialog.html">show published locations</a> action will be +enabled.</p> + +<p>Here is what the <i>ModeShape Context Menu</i> looks like:</p> + +<img src="images/ResourceContextMenu.png" border="0" alt=""> + +<p>Files can be filtered out of publishing and unpublishing operations even though they have been selected. Use the +<a href="ModeShapePreferencesDialog.html#fileFiltersPrefPage">File and Folder Filters Preference Page</a> to filter out files +contained within the selection based on their file extensions or by the name of the folder, or ancestor folder, they are +contained within.</p> + +<h3>Related Topics</h3> + +<ul> +<li><a href="ModeShapePreferencesDialog.html#fileFiltersPrefPage">File and Folder Filters Preference Page</a></li> +<li><a href="PublishDialog.html">Publishing Operations Dialog</a></li> +<li><a href="PublishedLocationsDialog.html">Published Locations Dialog</a></li> +</ul> Property changes on: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/ResourceContextMenu.html ___________________________________________________________________ Added: svn:mime-type + text/plain Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/ServerDialog.html =================================================================== --- trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/ServerDialog.html (rev 0) +++ trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/ServerDialog.html 2011-04-05 18:31:22 UTC (rev 30335) @@ -0,0 +1,55 @@ +<!-- + - See the COPYRIGHT.txt file distributed with this work for information + - regarding copyright ownership. + - + - This software is made available by Red Hat, Inc. under the terms of the + - Eclipse Public License v1.0 which accompanies this distribution and is + - available at http://www.eclipse.org/legal/epl-v10.html. + - + - See the AUTHORS.txt file in the distribution for a full listing of + - individual contributors. + --> +<h2>ModeShape Server Dialog</h2> + +<p>The <i>Server Dialog</i> is used to create and register new servers that host ModeShape repositories. This dialog is also used to edit an existing server's properties.</p> + +<p>Here is what the <i>Server Dialog</i> looks like:</p> + +<img src="images/ServerDialog.png" border="0" alt=""> + +<p>The dialog consists of the following controls:</p> + +<table border="1"> +<tr> + <td align="right"><strong>URL Field</strong>&nbsp;</td> + <td>enter the server URL (<code><i>protocol://host:port/context</i></code>) where one or more ModeShape repositories are + hosted </td> +</tr> +<tr> + <td align="right"><strong>User Field</strong>&nbsp;</td> + <td>enter the name of the user that will be used when logging in to the server</td> +</tr> +<tr> + <td align="right"><strong>Password Field</strong>&nbsp;</td> + <td>enter the password to use when logging in to the server</td> +</tr> +<tr> + <td align="right"><strong>Save Password Checkbox</strong>&nbsp;</td> + <td>when checked, all the server properties (including the encoded password) will be saved to a file on the local machine</td> +</tr> +<tr> + <td align="right"><strong>Test Server Connection Button</strong>&nbsp;</td> + <td>when clicked will try and connect to the server</td> +</tr> +</table> + +<p>Once all server properties have been entered the 'Finish' button will be enabled and the new server can be created or the +existing server's properties can be modified. You can display the <i>Server Dialog</i> from the <i>ModeShape View</i> and from the +<i>Publishing Operations Dialog</i>.</p> + +<h3>Related Topics</h3> + +<ul> +<li><a href="ServerView.html">ModeShape View</a></li> +<li><a href="PublishDialog.html">Publishing Operations Dialog</a></li> +</ul> \ No newline at end of file Property changes on: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/ServerDialog.html ___________________________________________________________________ Added: svn:mime-type + text/plain Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/ServerView.html =================================================================== --- trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/ServerView.html (rev 0) +++ trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/ServerView.html 2011-04-05 18:31:22 UTC (rev 30335) @@ -0,0 +1,36 @@ +<!-- + - See the COPYRIGHT.txt file distributed with this work for information + - regarding copyright ownership. + - + - This software is made available by Red Hat, Inc. under the terms of the + - Eclipse Public License v1.0 which accompanies this distribution and is + - available at http://www.eclipse.org/legal/epl-v10.html. + - + - See the AUTHORS.txt file in the distribution for a full listing of + - individual contributors. + --> +<h2>ModeShape View</h2> + +<p>The <i>ModeShape View</i> displays the registered servers hosting ModeShape repositories. For each server, the repositories +and repository workspaces are also displayed. There are view toolbar buttons to create a new server +(<img src="images/new_server.gif" border="0" alt="">), edit a selected server's properties +(<img src="images/edit_server.gif" border="0" alt="">), discard one or more selected servers +(<img src="images/delete_server.gif" border="0" alt="">), reconnect to a selected server +(<img src="images/refresh.gif" border="0" alt="">), and collapse all servers so that their repositories and workspaces can't +be seen (<img src="images/collapse_all.gif" border="0" alt="">). If a connection to a server cannot be established that server +icon will be decorated with an error overlay image.</p> + +<p>Here is what the <i>ModeShape View</i> looks like:</p> + +<img src="images/ServerView.png" border="0" alt=""> + +<p>The view's context menu includes the new server, edit server properties, discard server, and reconnect to server actions. Here +is what the <i>ModeShape View</i>'s context menu looks like:</p> + +<img src="images/ServerViewContextMenu.png" border="0" alt=""> + +<h3>Related Topics</h3> + +<ul> +<li><a href="ServerDialog.html">Server Dialog</a></li> +</ul> Property changes on: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/ServerView.html ___________________________________________________________________ Added: svn:mime-type + text/plain Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/Toc.html =================================================================== --- trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/Toc.html (rev 0) +++ trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/Toc.html 2011-04-05 18:31:22 UTC (rev 30335) @@ -0,0 +1,22 @@ +<!-- + - See the COPYRIGHT.txt file distributed with this work for information + - regarding copyright ownership. + - + - This software is made available by Red Hat, Inc. under the terms of the + - Eclipse Public License v1.0 which accompanies this distribution and is + - available at http://www.eclipse.org/legal/epl-v10.html. + - + - See the AUTHORS.txt file in the distribution for a full listing of + - individual contributors. + --> +<h2>ModeShape Publishing</h2> + +<ul> +<li><a href="PublishDialog.html">Publishing Operations Dialog</a></li> +<li><a href="ServerDialog.html">Server Dialog</a></li> +<li><a href="ServerView.html">ModeShape View</a></li> +<li><a href="ModeShapeMessageConsole.html">ModeShape Message Console</a></li> +<li><a href="PublishedLocationsDialog.html">Published Locations Dialog</a></li> +<li><a href="ResourceContextMenu.html">ModeShape Context Menu</a></li> +<li><a href="ModeShapePreferencesDialog.html">ModeShape Preference Pages</a></li> +</ul> \ No newline at end of file Property changes on: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/Toc.html ___________________________________________________________________ Added: svn:mime-type + text/plain Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/helpContexts.xml =================================================================== --- trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/helpContexts.xml (rev 0) +++ trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/helpContexts.xml 2011-04-05 18:31:22 UTC (rev 30335) @@ -0,0 +1,38 @@ +<!-- + - See the COPYRIGHT.txt file distributed with this work for information + - regarding copyright ownership. + - + - This software is made available by Red Hat, Inc. under the terms of the + - Eclipse Public License v1.0 which accompanies this distribution and is + - available at http://www.eclipse.org/legal/epl-v10.html. + - + - See the AUTHORS.txt file in the distribution for a full listing of + - individual contributors. + --> +<contexts> + <context id="serverViewHelpContext" title="ModeShape View"> + <description>The ModeShape View shows all registered servers and their repositories and workspaces.</description> + <topic href="docs/ServerView.html" label="ModeShape View"/> + <topic href="docs/ServerDialog.html" label="Server Dialog"/> + </context> + <context id="serverDialogHelpContext" title="Server Dialog"> + <description>The ModeShape Server Dialog allows you to edit or create a server that hosts one or more repositories.</description> + <topic href="docs/ServerDialog.html" label="Server Dialog"/> + <topic href="docs/ServerView.html" label="ModeShape View"/> + </context> + <context id="publishDialogHelpContext" title="ModeShape Publish and Unpublish Dialog Help"> + <description>The Publish/Unpublish Dialog uploads or removes selected resources from the selected server.</description> + <topic href="docs/PublishDialog.html" label="Publish/Unpublish Dialog"/> + <topic href="docs/ServerDialog.html" label="Create a new server"/> + <topic href="docs/ModeShapePreferencesDialog.html" label="ModeShape Preferences"/> + </context> + <context id="preferencesHelpContext" title="ModeShape Preferences Dialog Help"> + <description>The ModeShape Preferences Dialog allows you to identify file extensions and folder names that should not be involved in publishing operations.</description> + <topic href="docs/ModeShapePreferencesDialog.html" label="ModeShape Preferences"/> + <topic href="docs/PublishDialog.html" label="Publish/Unpublish Dialog"/> + </context> + <context id="messageConsoleHelpContext" title="ModeShape Message Console"> + <description>The ModeShape Message Console contains the output from the publishing and unpublishing operations.</description> + <topic href="docs/ModeShapeMessageConsole.html" label="ModeShape Message Console"/> + </context> +</contexts> Property changes on: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/helpContexts.xml ___________________________________________________________________ Added: svn:mime-type + text/plain Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/FileFilterPreferencePage.png =================================================================== (Binary files differ) Property changes on: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/FileFilterPreferencePage.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/GeneralPreferencePage.png =================================================================== (Binary files differ) Property changes on: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/GeneralPreferencePage.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/ModeShapeMessageConsole.png =================================================================== (Binary files differ) Property changes on: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/ModeShapeMessageConsole.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/NewFilteredFileExtension.png =================================================================== (Binary files differ) Property changes on: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/NewFilteredFileExtension.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/NewFilteredFolderName.png =================================================================== (Binary files differ) Property changes on: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/NewFilteredFolderName.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/OperationDialog.png =================================================================== (Binary files differ) Property changes on: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/OperationDialog.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/PublishDialog.png =================================================================== (Binary files differ) Property changes on: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/PublishDialog.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/PublishedLocationsDialog.png =================================================================== (Binary files differ) Property changes on: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/PublishedLocationsDialog.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/ResourceContextMenu.png =================================================================== (Binary files differ) Property changes on: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/ResourceContextMenu.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/ServerDialog.png =================================================================== (Binary files differ) Property changes on: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/ServerDialog.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/ServerView.png =================================================================== (Binary files differ) Property changes on: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/ServerView.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/ServerViewContextMenu.png =================================================================== (Binary files differ) Property changes on: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/ServerViewContextMenu.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/collapse_all.gif =================================================================== (Binary files differ) Property changes on: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/collapse_all.gif ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/delete_server.gif =================================================================== (Binary files differ) Property changes on: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/delete_server.gif ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/edit_server.gif =================================================================== (Binary files differ) Property changes on: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/edit_server.gif ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/new_server.gif =================================================================== (Binary files differ) Property changes on: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/new_server.gif ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/refresh.gif =================================================================== (Binary files differ) Property changes on: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/images/refresh.gif ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/toc.xml =================================================================== --- trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/toc.xml (rev 0) +++ trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/toc.xml 2011-04-05 18:31:22 UTC (rev 30335) @@ -0,0 +1,20 @@ +<!-- + - See the COPYRIGHT.txt file distributed with this work for information + - regarding copyright ownership. + - + - This software is made available by Red Hat, Inc. under the terms of the + - Eclipse Public License v1.0 which accompanies this distribution and is + - available at http://www.eclipse.org/legal/epl-v10.html. + - + - See the AUTHORS.txt file in the distribution for a full listing of + - individual contributors. + --> +<toc label="ModeShape Publishing"> + <topic label="Publishing Operations Dialog" href="docs/PublishDialog.html"/> + <topic label="ModeShape View" href="docs/ServerView.html"/> + <topic label="Server Dialog" href="docs/ServerDialog.html"/> + <topic label="ModeShape Message Console" href="docs/ModeShapeMessageConsole.html"/> + <topic label="Published Locations Dialog" href="docs/PublishedLocationsDialog.html"/> + <topic label="ModeShape Context Menu" href="docs/ResourceContextMenu.html"/> + <topic label="ModeShape Preference Pages" href="docs/ModeShapePreferencesDialog.html"/> +</toc> Property changes on: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc/toc.xml ___________________________________________________________________ Added: svn:mime-type + text/plain Modified: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/doc.zip =================================================================== (Binary files differ) Modified: trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/toc.xml =================================================================== --- trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/toc.xml 2011-04-05 18:30:19 UTC (rev 30334) +++ trunk/modeshape/plugins/org.jboss.tools.modeshape.rest.doc.user/toc.xml 2011-04-05 18:31:22 UTC (rev 30335) @@ -10,11 +10,11 @@ - individual contributors. --> <toc label="ModeShape Publishing"> - <topic label="Publishing/Unpublishing Dialog" href="docs/PublishDialog.html"/> - <topic label="Server View" href="docs/ServerView.html"/> - <topic label="Server Dialog" href="docs/ServerDialog.html"/> - <topic label="ModeShape Message Console" href="docs/ModeShapeMessageConsole.html"/> - <topic label="Published Locations Dialog" href="docs/PublishedLocationsDialog.html"/> - <topic label="Resource Context Menu" href="docs/ResourceContextMenu.html"/> - <topic label="ModeShape Preferences Dialog" href="docs/ModeShapePreferencesDialog.html"/> + <topic label="Publishing Operations Dialog" href="doc/PublishDialog.html"/> + <topic label="ModeShape View" href="doc/ServerView.html"/> + <topic label="Server Dialog" href="doc/ServerDialog.html"/> + <topic label="ModeShape Message Console" href="doc/ModeShapeMessageConsole.html"/> + <topic label="Published Locations Dialog" href="doc/PublishedLocationsDialog.html"/> + <topic label="ModeShape Context Menu" href="doc/ResourceContextMenu.html"/> + <topic label="ModeShape Preferences Dialog" href="doc/ModeShapePreferencesDialog.html"/> </toc>