diff options
Diffstat (limited to 'plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide')
51 files changed, 3898 insertions, 0 deletions
diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/Allocation-of-Requirements.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/Allocation-of-Requirements.html new file mode 100644 index 00000000000..7c9a524ec3d --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/Allocation-of-Requirements.html @@ -0,0 +1,59 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Concepts - Allocation of Requirements</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Allocation of Requirements</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Functional-decomposition-of-a-system.html" title="Functional decomposition of a system"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Verification-and-Validation-relations.html" title="Verification and Validation relations"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Functional decomposition of a system</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Verification and Validation relations</td> + </tr> + </table><hr/> + <h1 id="Allocation_of_Requirements">Allocation of Requirements</h1> + <p>Requirements are allocated using allocation relation links to components (of the functional decomposition). A requirement at a given level is allocated to a component at the corresponding next lower level in the functional decomposition.</p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Functional-decomposition-of-a-system.html" title="Functional decomposition of a system"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="Concepts.html" title="Concepts"> + <img alt="Concepts" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Verification-and-Validation-relations.html" title="Verification and Validation relations"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Functional decomposition of a system</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Verification and Validation relations</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/Attributes.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/Attributes.html new file mode 100644 index 00000000000..a093934d884 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/Attributes.html @@ -0,0 +1,62 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Concepts - Attributes</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Attributes</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Concepts.html" title="Concepts"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Relations.html" title="Relations"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Concepts</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Relations</td> + </tr> + </table><hr/> + <h1 id="Attributes">Attributes</h1> + <p>An + <b>attribute</b> is data attached to an artifact. A <tt>User</tt> artifact might have <tt>Email</tt>, <tt>Name</tt>, and <tt>Phone Number</tt> attributes. A <tt>Software Requirement</tt> artifact might have attributes such as <tt>Qualification Method</tt>, <tt>Safety Criticality</tt>, or <tt>Subsystem</tt>. + </p> + <p>The default attribute <tt>Name</tt> is required for all artifacts. Other attribute types can be created and associated with any artifact in the system.</p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Concepts.html" title="Concepts"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="Concepts.html" title="Concepts"> + <img alt="Concepts" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Relations.html" title="Relations"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Concepts</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Relations</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/BLAM.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/BLAM.html new file mode 100644 index 00000000000..a83a4e105c8 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/BLAM.html @@ -0,0 +1,61 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Concepts - BLAM</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">BLAM</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Branches.html" title="Branches"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Requirements-traceability-for-a-system.html" title="Requirements traceability for a system"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Branches</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Requirements traceability for a system</td> + </tr> + </table><hr/> + <h1 id="BLAM">BLAM</h1> + <p> + <b>BLAM Lightweight Artifact Manipulation</b> (BLAM) allows non-programmers to graphically construct workflows to automate repetitive tasks. A given workflow can be used for variety of similar tasks by using customizable controls to specify workflow parameters. BLAM also provides programmers the ability to interact with the OSEE Artifact Framework API to build and execute tasks. + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Branches.html" title="Branches"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="Concepts.html" title="Concepts"> + <img alt="Concepts" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Requirements-traceability-for-a-system.html" title="Requirements traceability for a system"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Branches</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Requirements traceability for a system</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/Branches.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/Branches.html new file mode 100644 index 00000000000..eefa91f6eb4 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/Branches.html @@ -0,0 +1,68 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Concepts - Branches</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Branches</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Relations.html" title="Relations"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="BLAM.html" title="BLAM"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Relations</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">BLAM</td> + </tr> + </table><hr/> + <h1 id="Branches">Branches</h1> + <p>A fundamental feature provided by OSEE is the concurrent management of multiple variants or lines of a product. After a set of requirements is developed, it may become the baseline for variant sets of requirements for similar products. In other words, you may develop the same product for another customer, but have slight changes to the requirements, code, and test for features specific to that customer. </p> + <p>Historically, this would mean maintaining completely separate "copies" of all the requirements and other artifacts. This is costly to maintain when changes from the baseline artifacts must be propagated to the other product line. The expense of this undertaking increases dramatically as more customers are added, each with their own set of requirements changes.</p> + <p>For this reason, OSEE provides full + <b>branching</b> functionality. Using OSEE, it is possible to create these variant branches, record where they originated, and to apply changes made to a baseline branch to its variants. + </p> + <p>By default, OSEE has two system branches. The <tt>System Root Branch</tt> is the parent of all other branches in the system. The <tt>Common</tt> branch is used to store OSEE configuration information, such as users. <tt>Common</tt> is a child of <tt>System Root Branch</tt>.</p> + <h2 id="Working_Branches">Working Branches</h2> + <p>On complex projects, artifacts can be subject to modification by any one of hundreds of engineers. To have requirements "locked" while they are being modified by one user can cause significant delays in schedule. The need for parallel development (multiple users working on the same requirements) is a necessity to keeping a project moving forward. In addition, users making mistakes need the ability to revert or throw away their changes and start over without polluting the baseline branch. This is done using + <b>working branches</b>. A working branch is a sandbox area used to prepare a commit to a baseline branch. + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Relations.html" title="Relations"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="Concepts.html" title="Concepts"> + <img alt="Concepts" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="BLAM.html" title="BLAM"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Relations</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">BLAM</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/Concepts.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/Concepts.html new file mode 100644 index 00000000000..a665f4cb29f --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/Concepts.html @@ -0,0 +1,49 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Concepts</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Concepts</th> + </tr> + <tr> + <td style="width: 20%" align="left"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Attributes.html" title="Attributes"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Attributes</td> + </tr> + </table><hr/> + <h1 id="Artifacts">Artifacts</h1> + <p>The + <b>artifact</b> is the fundamental object in OSEE. All data objects stored within OSEE are artifacts. Artifacts are strongly typed and can store any data throughout the systems engineering lifecycle. Any type of data can be stored in OSEE as an artifact; not only systems engineering data (such as processes and requirements), but also anything from meeting minutes to architecture diagrams. + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Attributes.html" title="Attributes"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Attributes</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/Functional-decomposition-of-a-system.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/Functional-decomposition-of-a-system.html new file mode 100644 index 00000000000..85c2b6aba16 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/Functional-decomposition-of-a-system.html @@ -0,0 +1,59 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Concepts - Functional decomposition of a system</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Functional decomposition of a system</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Requirements-traceability-for-a-system.html" title="Requirements traceability for a system"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Allocation-of-Requirements.html" title="Allocation of Requirements"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Requirements traceability for a system</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Allocation of Requirements</td> + </tr> + </table><hr/> + <h1 id="Functional_decomposition_of_a_system">Functional decomposition of a system</h1> + <p>The functional decomposition of a system produces a proper tree (i.e. every node in the tree has exactly one parent except the root which has no parent). The tree's root represents the system in its entirety. The root is decomposed into some number of components that can be further decomposed to any desired level. Neither the root nor any of its components are themselves requirements.</p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Requirements-traceability-for-a-system.html" title="Requirements traceability for a system"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="Concepts.html" title="Concepts"> + <img alt="Concepts" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Allocation-of-Requirements.html" title="Allocation of Requirements"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Requirements traceability for a system</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Allocation of Requirements</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/Relations.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/Relations.html new file mode 100644 index 00000000000..992defac934 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/Relations.html @@ -0,0 +1,61 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Concepts - Relations</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Relations</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Attributes.html" title="Attributes"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Branches.html" title="Branches"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Attributes</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Branches</td> + </tr> + </table><hr/> + <h1 id="Relations">Relations</h1> + <p>A + <b>relation</b> is a link between two artifacts. Like artifacts, they are strongly typed; an <tt>attend</tt> relation <tt>attend</tt> might relate a <tt>User</tt> artifact to a <tt>Meeting</tt> artifact. Similarly, a <tt>Customer Requirement</tt> might be linked to the low-level <tt>Software Requirement</tt> that satisfies it. + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Attributes.html" title="Attributes"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="Concepts.html" title="Concepts"> + <img alt="Concepts" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Branches.html" title="Branches"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Attributes</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Branches</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/Requirements-traceability-for-a-system.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/Requirements-traceability-for-a-system.html new file mode 100644 index 00000000000..74512e8c0d6 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/Requirements-traceability-for-a-system.html @@ -0,0 +1,59 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Concepts - Requirements traceability for a system</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Requirements traceability for a system</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="BLAM.html" title="BLAM"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Functional-decomposition-of-a-system.html" title="Functional decomposition of a system"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">BLAM</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Functional decomposition of a system</td> + </tr> + </table><hr/> + <h1 id="Requirements_traceability_for_a_system">Requirements traceability for a system</h1> + <p>Every requirement for a system is defined at a distinct level of detail, and these levels are ordered from the highest level down to the lowest level. A trace relation connects two requirements from adjacent levels. Every requirement that is not a top level (highest level) requirement, must trace to one or more requirement at the next higher level. All requirements, except those at the lowest level, must trace to one or more requirement at the next lower level.</p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="BLAM.html" title="BLAM"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="Concepts.html" title="Concepts"> + <img alt="Concepts" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Functional-decomposition-of-a-system.html" title="Functional decomposition of a system"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">BLAM</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Functional decomposition of a system</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/Updating-This-Document.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/Updating-This-Document.html new file mode 100644 index 00000000000..c8fe2096e8e --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/Updating-This-Document.html @@ -0,0 +1,55 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Concepts - Updating This Document</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Updating This Document</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Verification-and-Validation-relations.html" title="Verification and Validation relations"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"></td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Verification and Validation relations</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top"></td> + </tr> + </table><hr/> + <h1 id="Updating_This_Document">Updating This Document</h1> + <p> This document is maintained in a collaborative wiki. If you wish to + update or modify this document please visit + + <a href="http://wiki.eclipse.org/OSEE/Users_Guide/Concepts" target="osee_external">http://wiki.eclipse.org/OSEE/Users_Guide/Concepts</a> + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Verification-and-Validation-relations.html" title="Verification and Validation relations"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="Concepts.html" title="Concepts"> + <img alt="Concepts" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"></td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Verification and Validation relations</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top"></td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/Verification-and-Validation-relations.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/Verification-and-Validation-relations.html new file mode 100644 index 00000000000..6402737ab93 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Concepts/Verification-and-Validation-relations.html @@ -0,0 +1,59 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Concepts - Verification and Validation relations</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Verification and Validation relations</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Allocation-of-Requirements.html" title="Allocation of Requirements"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Updating-This-Document.html" title="Updating This Document"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Allocation of Requirements</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Updating This Document</td> + </tr> + </table><hr/> + <h1 id="Verification_and_Validation_relations">Verification and Validation relations</h1> + <p>Verification and Validation relations should be defined for requirements at every level of the requirements decomposition.</p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Allocation-of-Requirements.html" title="Allocation of Requirements"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="Concepts.html" title="Concepts"> + <img alt="Concepts" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Updating-This-Document.html" title="Updating This Document"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Allocation of Requirements</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Updating This Document</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/Custom-Widgets.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/Custom-Widgets.html new file mode 100644 index 00000000000..fa2a584d042 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/Custom-Widgets.html @@ -0,0 +1,171 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Features - Custom Widgets</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Custom Widgets</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Services.html" title="Services"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Updating-This-Document.html" title="Updating This Document"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Services</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Updating This Document</td> + </tr> + </table><hr/> + <h1 id="Custom_Widgets">Custom Widgets</h1> + <h2 id="XViewer_-_Advanced_TreeViewer_Widget">XViewer - Advanced TreeViewer Widget</h2> + <p> + <a href="http://www.eclipse.org/osee/xviewer/XViewer.pdf" target="osee_external">EclipseCon 2009 Presentation Slides</a> + </p> + <p> + <a href="http://www.eclipse.org/osee/xviewer/org_eclipse_nebula_widgets_xviewer.zip" target="osee_external">Download Zip of Code and Example</a> + </p> + <p> + <a href="http://www.eclipse.org/osee/xviewer/README.txt" target="osee_external">Download Instructions</a> + </p> + <p>The purpose of the XViewer is to give the application developer a more advanced and dynamic TreeViewer that has the filtering and sorting the capabilities of a spreadsheet while providing the users the ability to customize their table to suit their current needs and save/restore these customizations for future use by individual or group.</p> + <p>The XViewer has been incorporated into the Nebula project.</p> + <p> + <img border="0" src="images/Xviewer_main.png"/> + </p> + <h3 id="Table_Customizations">Table Customizations</h3> + <p> + <img border="0" src="images/Xviewer_customize.PNG"/> + </p> + <ul> + <li>Provides + <b>Table Customization</b> dialog to allow selection of visible columns, as well as the specification of their widths and names + </li> + <li> + <b>Easily reorder columns</b> through drag/drop or table customization + </li> + <li>Provides mechanism to + <b>save and load table customizations</b> so users can easily switch between customizations + </li> + <li>Provides mechanism to '''mark table customizations as individual or global '''to provide sharing of customizations by users and teams (needs to be backed with shared file system or database)</li> + <li>Provides mechanism to + <b>mark table customization as default customization</b> to display whenever this table is shown + </li> + <li>Provides ability for + <b>multiple XViewer tables to be used within the same application</b>, but provide their own columns and customizations + </li> + </ul> + <h3 id="Sorting_and_Filtering">Sorting and Filtering</h3> + <p> + <img border="0" src="images/Xviewer_sortfilter.png"/> + </p> + <h4 id="Sorting">Sorting</h4> + <ul> + <li>Sort individual columns (forward or reverse) using + <b>data-specific configured sorter</b> for that columns data type + </li> + <li>Perform unlimited + <b>multi-column sorting</b> by holding Ctrl key down and selecting other columns. Re-selecting a column while Ctrl is held down will reverse the sort for that column + </li> + </ul> + <h4 id="Filtering">Filtering</h4> + <ul> + <li> + <b>Quick filter (bottom left)</b> provides for filtering of all visible data by entered keywords + </li> + <li>Alt-left click on column header (or right-click menu) allows for + <b>filtering by column</b>. As many column filters can be added and work together. + </li> + <li>Provides + <b>simple metrics (bottom status label)</b> to show number of objects loaded, number shown and number selected. + </li> + <li> + <b>Status label shows filters and sorters</b> that are currently applied to viewer (bottom status label) + </li> + </ul> + <h3 id="Other_Capabilities">Other Capabilities</h3> + <ul> + <li>Provides ability to + <b>copy rows, columns or individual cells into buffer</b> for pasting into other applications + </li> + <li>Allows for + <b>multi-column editing of selected rows/columns</b> + </li> + <li>Provides + <b>html rendering</b> of currently visible table data + </li> + <li>Provides + <b>comma separated value export</b> to csv file that can be opened in any spreadsheet application + </li> + <li>All the normal capabilities of the existing SWT Tree/TreeViewer have been retained as XViewer is an extension to TreeViewer</li> + </ul> + <h3 id="Future">Future</h3> + <ul> + <li> + <b>Submitted to Nebula</b> as alternative to existing SWT TreeViewer (already part of eclipse.org/osee project) + </li> + <li>Allow for + <b>advanced column filtering</b> by complex expression and "canned list" of already entered items + </li> + <li>Add + <b>regular expressions</b> to all filtering capabilities + </li> + <li>Provide easy ability to + <b>sum selected rows for selected column</b> + </li> + <li>Provide simple + <b>summing/counting of rows/column</b> data + </li> + <li>Provide + <b>formulas and functions</b> for advanced summing/counting of data + </li> + <li>Provide + <b>graphing and charting</b> of data + </li> + <li>Collaborate with other table/tree solutions to integrate functionality... </li> + </ul> + <h3 id="HTML_Report_and_CSV_Export">HTML Report and CSV Export</h3> + <p> + <img border="0" src="images/Xviewer_reportexport.PNG"/> + </p> + <p> + <a href="http://wiki.eclipse.org/Category:OSEE" title="Category:OSEE" target="osee_external">Category:OSEE</a> + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Services.html" title="Services"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="Features.html" title="Features"> + <img alt="Features" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Updating-This-Document.html" title="Updating This Document"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Services</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Updating This Document</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/Features.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/Features.html new file mode 100644 index 00000000000..c1abbbbc029 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/Features.html @@ -0,0 +1,151 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Features</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Features</th> + </tr> + <tr> + <td style="width: 20%" align="left"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Views-and-Editors.html" title="Views and Editors"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Views and Editors</td> + </tr> + </table><hr/> + <h1 id="Component_Overview">Component Overview</h1> + <h2 id="Application_Framework">Application Framework</h2> + <p> + <b>Key Capabilities</b> + </p> + <ul> + <li>Dynamic and strongly typed artifact model (persistence layer)</li> + <li>Bidirectional traceability through typed relations model</li> + <li>Advanced version control including multi-level branching</li> + <li>Subject-based and object-based Access Control</li> + <li>User management and authentication</li> + <li>Dynamic searching API</li> + <li>Indexing and tagging services</li> + <li>Views and editors for the creation, manipulation, and navigation of artifacts, attributes, and relations</li> + <li>Remote event service for communication and synchronization of OSEE instances</li> + <li>Rules framework for text processing</li> + <li>Utilities for plug-in developers</li> + <li>Scheduling framework</li> + <li>API for the extension and use of this framework to build tightly integrated applications</li> + <li>Encryption Utility</li> + <li>Database Utilities</li> + <li>Jini Utilities</li> + <li>Scheduling Service</li> + <li>Datastore Adapter</li> + </ul> + <h2 id="Define_.28Requirements_Management.29">Define (Requirements Management)</h2> + <p>Define provides requirements and process management with tightly integrated change management using the Action Tracking System (ATS). OSEE provides publishing capabilities that enable the creation of documents from smaller internal documents to the complex documents needed to meet military requirements for contract deliverables such as the Software Requirements Specification (SRS), System Performance Specification (SPS), Prime Item Development Specification (PIDS), and all the required traceability between them.</p> + <p> + <b>Key Capabilities</b> + </p> + <ul> + <li>Enterprise support for concurrent, distributed requirements development</li> + <li>Integrated process and workflow</li> + <li>Programmatic, bidirectional traceability</li> + <li>End user navigation and search capabilities</li> + <li>Capture accurate, meaningful review metrics</li> + <li>Tight integration with lifecycle tools</li> + <li>Automated change detection capabilities</li> + </ul> + <h2 id="Action_Tracking_System">Action Tracking System</h2> + <p>ATS is a tightly integrated change tracking system that manages changes throughout a product's lifecycle. ATS provides integrated change management to all OSEE applications through user customizable workflows.</p> + <p> + <b>Key Capabilities</b> + </p> + <ul> + <li>Built on same OSEE application framework as requirements, code, test development</li> + <li>Common Workflow Framework that provides for the creation of any number of simple to complex workflow state machine configurations that can work together during the engineering lifecycle</li> + <li>Workflows are configured through graphical diagrams that ATS uses at runtime</li> + <li>Configuration of ATS performed through OSEE?s common application framework enabling workflows to be created and modified without separate OSEE releases</li> + <li>Advanced project planning capabilities and release management</li> + <li>Duplication errors are minimized as items are automatically linked and data is shared</li> + <li>Menus, Views and Editors give access to ATS while working in any other aspect in OSEE</li> + <li>ATS is used to track changes and support issues for the development of OSEE itself</li> + <li>Bug Icon allows quick Action creation against any OSEE integrated tool</li> + </ul> + <h2 id="Open_Test_Environment">Open Test Environment</h2> + <p>OTE is a powerful test solution within OSEE that integrates with existing Java, C, and C++ development environments to provide a seamless flow between developing, debugging, executing, and dispositioning of tests for complex hardware and software. The user is provided a common interface to the simulated and real-time environments for both functional and unit testing.</p> + <p> + <b>Key Capabilities</b> + </p> + <ul> + <li>Supports the execution of multiple simultaneous batches within a single workspace</li> + <li>Built-in help system extended with test manger user guide</li> + <li>Message system supporting MIL-STD-1553 MUX, serial, wire, Ethernet, and Data Distribution Service (DDS)</li> + <li>Message GUIs provide monitoring, manipulation, and recording of messaging data</li> + <li>Utilizes OSEE application framework to provide traceability to software requirements</li> + <li>Automatic generation of tests and testing support classes, directly from requirements.</li> + <li>Leverages off Java Development Toolkit (JDT) and C/C++ Development Toolkit (CDT)</li> + <li>Provides remote execution of scripts against target hardware and operating system</li> + <li>Test results are logged in XML</li> + <li>Transforms test results via built-in or user supplied XSL Transformations</li> + <li>Built-in XSL Transformations produce interactive HTML result reports</li> + <li>A test environment service that provides both soft real-time and simulated capabilities, schedules the periodic execution of simulation components, and manages the I/O and testing resources.</li> + </ul> + <h2 id="BLAM">BLAM</h2> + <p>BLAM Lightweight Artifact Manipulation (BLAM) allows non-programmers to graphically construct workflows to automate repetitive tasks. A given workflow can be used for variety of similar tasks by using customizable controls to specify workflow parameters.</p> + <p> + <b>Key Capabilities</b> + </p> + <ul> + <li>Integrated management of charge/cost accounting</li> + <li>Build planning and execution</li> + <li>Reporting services</li> + <li>Rules framework for requiring/alerting certain conditions</li> + <li>Scheduling services for automating reoccurring tasks</li> + </ul> + <h2 id="Program.2FProject_Management">Program/Project Management</h2> + <p>Program and project management tightly integrated with the Action Tracking System and other OSEE components to provide services necessary for estimation, planning, execution, and delivery of products managed within OSEE.</p> + <h2 id="Discovery_and_Learning">Discovery and Learning</h2> + <p>Services provided for allowing advanced learning and discovery using OSEE's abundant and inherent lifecycle data and metrics.</p> + <p> + <b>Key Capabilities</b> + </p> + <ul> + <li>Discovery of inefficiencies in lifecycle processes</li> + <li>Advanced data mining and data fusion</li> + <li>Advanced estimation</li> + <li>Advanced import/export of product capabilities between programs including applicable design, requirements, code, and test</li> + <li>Advanced data visualization</li> + <li>Prediction of future risks</li> + <li>Simulation of recommended process and lifecycle changes</li> + </ul> + <h2 id="Application_Development">Application Development</h2> + <p>Provide capabilities needed for external software application development plug-ins, like JDT, to utilize the OSEE persistence layer and integrate with other OSEE-based applications.</p> + <h2 id="Design_and_Modeling">Design and Modeling</h2> + <p>Provide capabilities needed for external design and modeling plug-ins to utilize the OSEE persistence layer and integrate with other OSEE-based applications.</p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Views-and-Editors.html" title="Views and Editors"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Views and Editors</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/Search.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/Search.html new file mode 100644 index 00000000000..0c608e52fd1 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/Search.html @@ -0,0 +1,70 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Features - Search</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Search</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Views-and-Editors.html" title="Views and Editors"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Wizards.html" title="Wizards"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Views and Editors</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Wizards</td> + </tr> + </table><hr/> + <h1 id="Search">Search</h1> + <h2 id="Advanced_Artifact_Search">Advanced Artifact Search</h2> + <p> + <img border="0" src="images/Artifact_search_page.gif"/> + </p> + <p>What it is + The search page in the Eclipse Search window for finding artifacts on the default branch. + How to use it</p> + <p>The Artifact Search page works by building a list of filters which that describe the desired artifacts. Filter types are selected from the drop down at the top of the page. After completing the options for the filter, pressing the Add Filter button will add the filter to the list of filters. If the Not Equal option is checked, then it will be added with the image signifying that the complement of the filter will be used.</p> + <p>Filters can be removed from the list at anytime by selecting the next to the filter.</p> + <p>The radio buttons in the Artifacts that match frame are used to control whether artifacts are returned that match every filter listed or at least one filter listed.</p> + <p>Once all of the options have been filled out, the Search button can be pressed to start the search against the default branch. For convenience the default branch is stated at the top of the search page. If a large number of artifacts will be returned then a confirmation will be displayed with a count of the artifacts that are about to be loaded.</p> + <p>The Search button will not be enabled until there is at least one filter in the list.</p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Views-and-Editors.html" title="Views and Editors"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="Features.html" title="Features"> + <img alt="Features" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Wizards.html" title="Wizards"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Views and Editors</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Wizards</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/Services.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/Services.html new file mode 100644 index 00000000000..85755aeda8a --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/Services.html @@ -0,0 +1,110 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Features - Services</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Services</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Wizards.html" title="Wizards"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Custom-Widgets.html" title="Custom Widgets"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Wizards</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Custom Widgets</td> + </tr> + </table><hr/> + <h1 id="Services">Services</h1> + <h2 id="Event_Service">Event Service</h2> + <p>OSEE is a client side application that runs off an Oracle database. As with many applications, OSEE caches some of the data it provides to the user. These caches need to be notified that there are updates available. These updates are triggered by an event service that "connects" all OSEE instances and notifies them that changes have been made to cached data.</p> + <p>When your application focus is on any OSEE View, you will notice a double-arrow icon at the bottom of your workbench. When NOT connected to the event service, this icon will show a red slash. When this happens, you should shutdown, restart and accept all OSEE updates. If this does not solve the problem, contact an OSEE Team member for help in resolving the problem.</p> + <h2 id="Attribute_Tagging_for_Quick_Search">Attribute Tagging for Quick Search</h2> + <p>When an artifact is saved, each attribute contained in the artifact is analyzed to produce a list of tags that are then associated with the artifact. Quick search is a form of <i>keyword</i> based searching which uses tags to perform contextual artifact searches.</p> + <p>For an attribute to be tagged by the system, it must meet the following criteria:</p> + <ul> + <li>The attribute's type must specify an <b>Attribute Tagger</b> to be used by the tagging system.</li> + <li>The attribute must contain valid data.</li> + <li>The attribute revision must be saved in the database before sending to tagging system.</li> + </ul> + <p>To produce tags, modified attributes are sent to the OSEE application server where the tagging system processes each attribute using an <b>Attribute Tagger</b> specified by the attribute's type. The <b>Attribute Tagger</b> knows how to interpret the attribute's data and how to extract words from the content. At this point, a word is defined as a sequential set of alphanumeric characters delimited by one or more spaces. As words are parsed, they are sent to the tagging system's word encoder where the following processing takes place:</p> + <ul> + <li>The characters in the original word are converted to lower case.</li> + <li>The lowercase version of the word is encoded and stored in the tagging system.</li> + <li>The lowercase version of the word is split using <tt>(' ', !, ", #, $, %, (, ), *, +, ,, -, ., /, :, ;, <, >, ?, @, + <a href=",">\, </a>, ^, {, |, }, ~, _)</tt> as delimiters. + </li> + <li>Words given in inflected form (possessive, plural, etc) are converted into + <a href="http://en.wikipedia.org/wiki/Dictionary_form" target="osee_external">citation form</a>. + </li> + <li>Each word is encoded and stored in the tag system.</li> + </ul> + <p>When encoding words into tags, the tag encoder uses an algorithm which transforms the word's characters into a bit-packed tag that will fit in a 64-bit integer. The tag will represent up to 12 characters (all that can fit into 64-bits). Longer words will be turned into consecutive tags.</p> + <h3 id="Tag_Encoding_Examples">Tag Encoding Examples</h3> + <table class="wikitable" border="1"> + <tr> + <th>Original</th> + <th>Keywords</th> + <th>Encoding</th> + </tr> + <tr> + <td>appendices</td> + <td>appendix</td> + <td>-220858502</td> + </tr> + <tr> + <td>batteries</td> + <td>battery</td> + <td>529513131</td> + </tr> + <tr> + <td>alternate</td> + <td>alternate</td> + <td>-1420231874</td> + </tr> + <tr> + <td>backup</td> + <td>backup</td> + <td>24902827</td> + </tr> + </table><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Wizards.html" title="Wizards"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="Features.html" title="Features"> + <img alt="Features" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Custom-Widgets.html" title="Custom Widgets"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Wizards</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Custom Widgets</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/Updating-This-Document.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/Updating-This-Document.html new file mode 100644 index 00000000000..662ad6810a2 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/Updating-This-Document.html @@ -0,0 +1,55 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Features - Updating This Document</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Updating This Document</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Custom-Widgets.html" title="Custom Widgets"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"></td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Custom Widgets</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top"></td> + </tr> + </table><hr/> + <h1 id="Updating_This_Document">Updating This Document</h1> + <p> This document is maintained in a collaborative wiki. If you wish to + update or modify this document please visit + + <a href="http://wiki.eclipse.org/OSEE/Users_Guide/Features" target="osee_external">http://wiki.eclipse.org/OSEE/Users_Guide/Features</a> + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Custom-Widgets.html" title="Custom Widgets"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="Features.html" title="Features"> + <img alt="Features" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"></td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Custom Widgets</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top"></td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/Views-and-Editors.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/Views-and-Editors.html new file mode 100644 index 00000000000..854db7e6664 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/Views-and-Editors.html @@ -0,0 +1,1142 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Features - Views and Editors</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Views and Editors</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Features.html" title="Features"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Search.html" title="Search"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Features</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Search</td> + </tr> + </table><hr/> + <h1 id="Views_and_Editors">Views and Editors</h1> + <h2 id="Branch_Manager_View">Branch Manager View</h2> + <p>The Branch Manager View, shown by default in the Define Perspective, shows all branches and transactions on each branch managed by OSEE in a hierarchical fashion. By default, OSEE is initialized with two branches. The System Root Branch (visible to OSEE Administrators only) and the Common Branch. The System Root Branch is the base branch for all other branches in the system. The Common branch is used to store system-wide artifacts such as configuration artifacts, users, and user preferences.</p> + <p> + <img align="right" border="0" src="images/BranchManager.gif"/> + </p> + <h3 id="Toolbar_buttons">Toolbar buttons</h3> + <table class="wikitable" style="border:1"> + <tr style="background:#CCCCCC"> + <th>Icon</th> + <th>Description</th> + </tr> + <tr> + <td> + <img border="0" src="images/Refresh.gif"/> + </td> + <td>Refreshes the branch hierarchy tree with the latest branch information.</td> + </tr> + <tr> + <td> + <img border="0" src="images/Customize.gif"/> + </td> + <td>Opens the table customization dialog. This allows users to add or hide columns.</td> + </tr> + <tr> + <td> + <img border="0" src="images/Bug.gif"/> + </td> + <td>Opens an action against the Branch Manager View.</td> + </tr> + </table> + <h3 id="Toolbar_Drop-Down">Toolbar Drop-Down</h3> + <p>To display, click on the inverted triangle located on the upper right-hand side of the Branch Manager view.</p> + <table class="wikitable" style="border:1"> + <tr style="background:#CCCCCC"> + <th>Command</th> + <th>Description</th> + </tr> + <tr> + <td>Open Branch Graph</td> + <td>Display a diagram showing the relations among branches.</td> + </tr> + <tr> + <td>Open OSEE Data Model Editor</td> + <td>Opens a graphical editor of all the artifact, attribute, and relation types in the system.</td> + </tr> + <tr> + <td>Branch Presentation</td> + <td>Switch presentation between flat or hierarchical views.</td> + </tr> + <tr> + <td>Show Archived Branches</td> + <td>(Admins Only) Toggles archived branch visibility.</td> + </tr> + <tr> + <td>Show Merge Branches</td> + <td>(Admins Only) Toggles merge branch visibility.</td> + </tr> + <tr> + <td>Show/Hide Transactions</td> + <td>Toggles branch transaction visibility.</td> + </tr> + <tr> + <td>Show Favorites First</td> + <td>Orders branches by showing favorite branches first.</td> + </tr> + </table> + <h3 id="Pop-up_Menu">Pop-up Menu</h3> + <p>To display, perform a right-click on any branch.</p> + <table class="wikitable" style="border:1"> + <tr style="background:#CCCCCC"> + <th>Command</th> + <th>Description</th> + </tr> + <tr> + <td>Explore</td> + <td>Opens the Artifact Explorer View for the selected branch. This operation can also be performed by double-clicking on a branch.</td> + </tr> + <tr> + <td>Change Report</td> + <td>Opens the Change Report View for the selected branch.</td> + </tr> + <tr> + <td>Merge Manager</td> + <td>Opens the merge manager. This is used to resolve conflicts when committing a working branch back into its parent branch.</td> + </tr> + <tr> + <td>Branch</td> + <td>Creates a child branch of the selected branch.</td> + </tr> + <tr> + <td>Update Branch</td> + <td>Re-baselines a branch into its parent, leaving the selected branch in place. If there are conflicts, the merge manager will be opened to allow the user to resolve them.</td> + </tr> + <tr> + <td>Commit Into</td> + <td>Commits changes made to a branch into another branch. Unlike "Update Branch," this feature does not assume that the destination branch is the parent. This feature can only be used by administrators. </td> + </tr> + <tr> + <td>Delete Branch</td> + <td>Deletes the selected branch from the system by setting the branch state to deleted. The data from this branch will still be recoverable.</td> + </tr> + <tr> + <td>Purge Branch</td> + <td>Purges the selected branch from the system by removing all data from the data store. This action cannot be undone.</td> + </tr> + <tr> + <td>Purge Transaction</td> + <td>Purges the currently selected transaction from its branch. Removes all changes made on the selected transaction. (Not recoverable)</td> + </tr> + <tr> + <td>Open Associated Artifact</td> + <td>Opens the artifact that was associated with the creation of the selected branch.</td> + </tr> + <tr> + <td>Set Associated Artifact</td> + <td>Associates an artifact with the currently selected branch.</td> + </tr> + <tr> + <td>Archive</td> + <td>Archives the branch so that it does not appear in a list of branches unless archived branches are specifically requested.</td> + </tr> + <tr> + <td>Access Control</td> + <td>Opens the access control dialog.</td> + </tr> + <tr> + <td>Rename</td> + <td>Allows users to change the branch name.</td> + </tr> + <tr> + <td>Mark as Favorite</td> + <td>Sets/Unsets a branch as a favorite branch.</td> + </tr> + <tr> + <td>Copy</td> + <td>Places branch information into the clipboard.</td> + </tr> + <tr> + <td>Open Osee Data Model Editor</td> + <td>Opens a graphical editor of all the artifact, attribute, and relation types in the system.</td> + </tr> + <tr> + <td>Open Branch Graph</td> + <td>Shows a graphical representation of branches using the currently selected branch as the base branch.</td> + </tr> + </table> + <h3 id="Additional_Operations">Additional Operations</h3> + <p> + <b>Searching</b> - Can be performed by typing text in the Search text box. Matching text will be highlighted. Click on the + <img border="0" src="images/Clear.jpg"/> icon to clear the search box and clear all the search results. + </p> + <p> + <b>Filtering</b> - Can be performed by typing text in the Filter box. Click on the + <img border="0" src="images/Clear.jpg"/> icon to clear the filter box and display all items. + </p> + <h2 id="Artifact_Explorer_View">Artifact Explorer View</h2> + <p>The Artifact Explorer view, shown by default in the Define perspective, shows the artifact hierarchy of the selected branch. The artifact hierarchy is derived from the artifact's default hierarchy relation. By default, all branches have a default hierarchy root artifact which is the hierarchy tree's base element. </p> + <p> + <img align="right" border="0" src="images/ArtifactExplorer.jpg"/> + </p> + <h3 id="Toolbar_buttons_2">Toolbar buttons</h3> + <table class="wikitable" style="border:1"> + <tr style="background:#CCCCCC"> + <th>Icon</th> + <th>Description</th> + </tr> + <tr> + <td> + <img border="0" src="images/CollapseAll.gif"/> + </td> + <td>Collapses all tree nodes.</td> + </tr> + <tr> + <td> + <img border="0" src="images/Up.gif"/> + </td> + <td>Navigates to the parent container of the artifacts that are currently displayed at the top level in the view.</td> + </tr> + <tr> + <td> + <img border="0" src="images/Artifact_explorer.gif"/> + </td> + <td>Opens a new instance of the Artifact Explorer view.</td> + </tr> + <tr> + <td> + <img border="0" src="images/Branch_change.gif"/> + </td> + <td>Opens the Change Report View for the Artifact Explorer's selected branch. This report will show all changes made to the selected branch.</td> + </tr> + <tr> + <td> + <img border="0" src="images/Artifact_search.gif"/> + </td> + <td>Opens the Quick Search View for the selected branch.</td> + </tr> + <tr> + <td> + <img border="0" src="images/Bug.gif"/> + </td> + <td>Opens an action against the Artifact Explorer view.</td> + </tr> + </table> + <h3 id="Pop-up_Menu_2">Pop-up Menu</h3> + <p>To display, select one or more artifacts and perform a right-click.</p> + <table class="wikitable" style="border:1"> + <tr style="background:#CCCCCC"> + <th>Command</th> + <th>Description</th> + </tr> + <tr> + <td>Open</td> + <td>Opens the selected artifact using the default editor.</td> + </tr> + <tr> + <td>Open With</td> + <td>Opens a sub-menu listing the available editor's for this artifact.</td> + </tr> + <tr></tr> + <tr> + <td>Reveal on Another Branch</td> + <td>Open's a new instance of Artifact Explorer for a user selected branch. Expands tree elements to display the selected artifact to be revealed.</td> + </tr> + <tr></tr> + <tr> + <td>New Child</td> + <td>Creates a new artifact and places it directly under the selected artifact.</td> + </tr> + <tr> + <td>Go Into</td> + <td>Sets the selected artifact as the base of the artifact hierarchy tree hiding artifacts except child artifacts.</td> + </tr> + <tr> + <td>Mass Edit</td> + <td>Opens the Artifact Mass Editor populated with the selected artifacts.</td> + </tr> + <tr> + <td>Sky Walker</td> + <td>Launches the Sky Walker View. </td> + </tr> + <tr></tr> + <tr> + <td>Delete Artifact</td> + <td>Deletes the selected artifacts.</td> + </tr> + <tr> + <td>Purge Artifact(s)</td> + <td>Purges the selected artifacts from the data store.</td> + </tr> + <tr> + <td>Rename Artifact</td> + <td>Allows a user to quickly change the artifact's name attribute.</td> + </tr> + <tr></tr> + <tr> + <td>Show Resource History</td> + <td>Opens the Resource History view for the selected artifact. This will display all transactions for this artifact.</td> + </tr> + <tr></tr> + <tr> + <td>Import</td> + <td>Opens Eclipse's import dialog.</td> + </tr> + <tr> + <td>Export</td> + <td>Opens Eclipse's export dialog.</td> + </tr> + <tr></tr> + <tr> + <td>Lock</td> + <td>Locks the artifact so the current user is the only one allowed to make changes to its attributes.</td> + </tr> + <tr></tr> + <tr> + <td>Copy</td> + <td>Copies the artifact.</td> + </tr> + <tr> + <td>Paste</td> + <td>Pastes the artifact.</td> + </tr> + <tr> + <td>Expand All</td> + <td>Expands all tree nodes from the selected artifact down.</td> + </tr> + <tr> + <td>Select All</td> + <td>Selects all open tree nodes.</td> + </tr> + <tr></tr> + <tr> + <td>Access Control</td> + <td>Opens the access control dialog.</td> + </tr> + </table> + <h3 id="Operations">Operations</h3> + <p>Operations that can be performed on an Artifact Explorer.</p> + <table class="wikitable" style="border:1"> + <tr style="background:#CCCCCC"> + <th>Command</th> + <th>Description</th> + </tr> + <tr> + <td>Cross Branch Drag and Drop</td> + <td>Artifacts can be referenced from other branches by dragging an artifact from one branch and dropping in onto another Artifact Explorer. The outcome will be one of two actions. If the artifact already existed on the branch it will be updated with the source artifacts state data. If the artifact did not exist on the destination branch it will be introduced to that branch. Meaning it will show up in the change report as an introduced artifact.</td> + </tr> + <tr> + <td>File Document Drag and Drop</td> + <td>Artifacts can be created by dragging and dropping files directly onto the parent artifact. After the drop is performed, the Artifact Import Wizard should open. Select the import method and artifact type to convert file into. This should create a child artifact directly under the artifact where the file was dropped.</td> + </tr> + </table> + <p>Dragging An Artifact From The Artifact Explorer</p> + <ul> + <li>If an artifact is dragged from the explorer into a Word document a hyper link will be created with the artifact name in text and when selected it will open the artifact in the Artifact Editor.</li> + <li>If an artifact is dragged into a Text File the name of the artifact will be written inside the document.</li> + <li>If an artifact is dragged into a relation in the Relational View of the Artifact Editor a new relation will be created with the source artifact and the target artifact in the editor.</li> + <li>If an artifact is dragged within the Artifact Explorer the original Default Hierarchal Relation will be deleted and a new one be created whith the target artifact.</li> + </ul> + <p>Dropping Onto The Artifact Explorer</p> + <ul> + <li>If a file is dropped onto the Artifact Explorer a new artifact will be created with the contents of the source file and a new Default Hierarchal Relationship.</li> + </ul> + <h2 id="Artifact_Editor">Artifact Editor</h2> + <p>The Artifact editor provides specialized features for editing artifacts (this is the default editor for editing attributes and relations). The editor can be opened through Artifact Explorer, by double-clicking on any artifact or right-clicking on an artifact and selecting to Open With "Artifact Editor".</p> + <p>Associated with the editor is an Artifact-specific Outline view, which shows the structure of the active artifact. It is updated as the user edits the artifact.</p> + <p> + <img align="right" border="0" src="images/ArtifactEditor.jpg"/> + </p> + <p>The Artifact Editor is divided into the following sections + <i>(some sections can be expanded and collapsed by clicking on the section's title bar)</i>. + </p> + <h3 id="Title_Area">Title Area</h3> + <ol> + <li> + <b>Artifact Name</b> - the artifact's name attribute + </li> + <li> + <b>Message Area</b> - reports issues that need to be addressed by the user before saving is allowed. Click on the message to open a message summary window. From the message summary window, click on any message to jump to the item associated with the message. + </li> + <li> + <b>Toolbar Area</b> + </li> + </ol> + <table class="wikitable" style="border:1"> + <tr style="background:#CCCCCC"> + <th>Icon</th> + <th>Description</th> + </tr> + <tr> + <td> + <img border="0" src="images/Refresh.gif"/> + </td> + <td>Refreshes the artifact editor. Displaying the artifact's current data. NOTE: Changes made to the form will be lost unless data is saved before clicking on this button.</td> + </tr> + <tr> + <td> + <img border="0" src="images/Bug.gif"/> + </td> + <td>Opens an action against the Artifact Editor.</td> + </tr> + <tr> + <td> + <img border="0" src="images/Open.gif"/> + </td> + <td>Opens the artifact or if clicking on the down-arrow, displays the open with sub-menu.</td> + </tr> + <tr> + <td> + <img border="0" src="images/Delete.gif"/> + </td> + <td>Deletes the artifact and closes the editor.</td> + </tr> + <tr> + <td> + <img border="0" src="images/Outline_co.gif"/> + </td> + <td>Displays the outline view.</td> + </tr> + <tr> + <td> + <img border="0" src="images/DBiconBlue.GIF"/> + </td> + <td>Opens the artifact's resource history.</td> + </tr> + <tr> + <td> + <img border="0" src="images/Magnify.gif"/> + </td> + <td>Displays the artifact in an Artifact Explorer view.</td> + </tr> + <tr> + <td> + <img border="0" src="images/Branch.gif"/> + </td> + <td>Open the Branch Manager View and highlights the artifact's branch.</td> + </tr> + <tr> + <td> + <img border="0" src="images/Authenticated.gif"/> + </td> + <td>Locks or unlocks the artifact for editing. Locking an artifact prevents other users from making changes to it.</td> + </tr> + <tr> + <td> + <img border="0" src="images/CopyToClipboard.gif"/> + </td> + <td>Copies a link to the latest version of the artifact to the clipboard.</td> + </tr> + </table> + <h3 id="Artifact_Information_Area">Artifact Information Area</h3> + <p>Displays the artifact's branch, artifact type, and human readable id.</p> + <h3 id="Attributes_Section">Attributes Section</h3> + <p>Displays attribute types to be edited. Attribute types can be added or deleted by clicking on the appropriate toolbar button + <i>located on the upper-right of the attributes section title bar</i>. + + <b>Note: The following operations follow min/max occurrence rules defined by the attribute's type.</b> + </p> + <table class="wikitable" style="border:1"> + <tr style="background:#CCCCCC"> + <th>Icon</th> + <th>Description</th> + </tr> + <tr> + <td> + <img border="0" src="images/Back.gif"/> + </td> + <td>Opens an attribute type selection dialog; the selected attribute type instances will be reset to their default value.</td> + </tr> + <tr> + <td> + <img border="0" src="images/GreenPlus.gif"/> + </td> + <td>Opens a dialog displaying attribute types that can be added to the artifact.</td> + </tr> + <tr> + <td> + <img border="0" src="images/Delete.gif"/> + </td> + <td>Opens a dialog displaying attribute types that can be deleted from the artifact. + <b>Note: Data entered for the attribute type to be deleted will be lost as soon as the dialog's '''OK</b> button is selected. + </td> + </tr> + </table> + <h3 id="Relations_Section">Relations Section</h3> + <p>All relations that are defined as being valid for the artifact are shown. Relations can be added by dragging any set of artifacts into the appropriate relation group. Opening a relation group will show all the artifacts that are currently related. Double-clicking a related artifact will open it in its default editor (normally the Artifact Editor).</p> + <p> + <b>Pop-up Menu</b> - To display, expand the + <b>Relations</b> section, select one or more artifacts, and perform a right-click. + </p> + <table class="wikitable" style="border:1"> + <tr style="background:#CCCCCC"> + <th>Command</th> + <th>Description</th> + </tr> + <tr> + <td>Open</td> + <td>Opens the selected relation using the default editor.</td> + </tr> + <tr> + <td>Edit</td> + <td>Opens the Artifact for editing.</td> + </tr> + <tr> + <td>Mass Edit</td> + <td>Opens the Artifact Mass Editor populated with the selected artifacts.</td> + </tr> + <tr> + <td>View Relation Table Report</td> + <td>Opens an HTML report of the relation tree.</td> + </tr> + <tr> + <td>Order Relation...</td> + <td>Select an order type for the relations in the group. Once the user makes a selection, the artifacts will be ordered appropriately. Options include:</td> + </tr> + <tr> + <td>Delete Relation</td> + <td>Deletes the selected relations.</td> + </tr> + <tr> + <td>Expand All</td> + <td>Expands all tree nodes containing relations to this artifact.</td> + </tr> + <tr> + <td>Select All</td> + <td>Selects all tree nodes.</td> + </tr> + <tr> + <td>Delete Artifact</td> + <td>Deletes the selected artifact and its relation to this artifact.</td> + </tr> + </table> + <h4 id="Drag_N.27_Drop_Operation">Drag N' Drop Operation</h4> + <p>Artifacts can be related by dragging and dropping artifacts from Artifact Explorer onto a relation link group.</p> + <p>Relation links may be reordered within the same relation link group by selecting the link and dropping it into the desired location.</p> + <h3 id="Details_Section">Details Section</h3> + <p>Displays artifact meta-data.</p> + <h2 id="Blam_Editor">Blam Editor</h2> + <p>BLAM Lightweight Artifact Manipulation (BLAM) allows non-programmers to graphically construct workflows to automate repetitive tasks. A given workflow can be used for variety of similar tasks by using customizable controls to specify workflow parameters.</p> + <h2 id="Resource_History_View">Resource History View</h2> + <p>The resource history view allows users to view the detailed changes to an aritfact.</p> + <p> + <img border="0" src="images/Resourcehistoryview.jpg"/> + </p> + <p>In addition, the view also provides the user with the ability to select and compare artifacts.</p> + <p> + <img border="0" src="images/Resourcehistoryviewmenu2.jpg"/> + </p> + <h2 id="Mass_Artifact_Editor">Mass Artifact Editor</h2> + <p>The Mass Artifact Editor allows for easy view and editing of multiple artifacts and their attributes. To Open, right-click on the Artifact Explorer, the Search Results page, to open the pop-up menu and select the + <b>Mass Edit</b> option. Single cells can be edited via Alt-Left-Mouse-Click. After editing any number of artifacts, click on the save button. All changes will be saved. + </p> + <p> + <img title=" center" alt=" center" border="0" src="images/MassEditor.png_"/> + </p> + <h3 id="Toolbar_buttons_3">Toolbar buttons</h3> + <table class="wikitable" style="border:1"> + <tr style="background:#CCCCCC"> + <th>Icon</th> + <th>Description</th> + </tr> + <tr> + <td> + <img border="0" src="images/Refresh.gif"/> + </td> + <td>Refreshes the data with the latest information.</td> + </tr> + <tr> + <td> + <img border="0" src="images/Customize.gif"/> + </td> + <td>Opens the table customization dialog. This allows users to add or hide columns.</td> + </tr> + <tr> + <td> + <img border="0" src="images/Bug.gif"/> + </td> + <td>Opens an action against the Mass Editor.</td> + </tr> + </table> + <p>See + <a href="http://wiki.eclipse.org/OSEE/Users_Guide#XViewer_-_Advanced_TreeViewer_Widget" target="osee_external">Xviewer</a> for more information + </p> + <h2 id="Quick_Search_View">Quick Search View</h2> + <p>The Quick Search view allows users to perform searches for information that is contained + <i>inside</i> artifacts in a selected branch or search for artifacts by their GUID. The view is opened by default in the Define Perspective. It can also be opened by clicking on the Artifact Explorer tool bar's + <img border="0" src="images/Artifact_search.jpg"/> icon. + </p> + <p> + <img border="0" src="images/QuickSearchView.png"/> + </p> + <p>To find all artifacts that contain a particular set of keywords:</p> + <ol> + <li>Select + <b>Window > Show View > Other... > OSEE > Quick Search</b> to open the view + </li> + <li>Type your search string in the + <b>Enter Search String</b> combo box (or use the pull-down list to select a previously entered search expression). + <ul> + <li>Special characters such as <tt>(' ', !, ", #, $, %, (, ), *, +, ,, -, ., /, :, ;, <, >, ?, @, + <a href=",">\, </a>, ^, {, |, }, ~, _)</tt> are assumed to be word separators. + </li> + <li>In the GUID search, spaces and commas are treated as separators. + <dl> + <dd>For example: + <ul> + <li> + <ul> + <li>Under normal attribute search operations, <tt>hello.world</tt> will be translated to <tt>hello</tt> and <tt>world</tt>. The search will match attributes with <tt>hello</tt> and <tt>world</tt> keywords.</li> + <li>When the GUID search is used, (<tt>A+ABG7jFm+0BKaVZIxfqOQ,AFABG7jFm+0BKaVZIxfqOQ</tt>) will be interpreted as two GUIDs. The search will match artifacts containing <tt>A+ABG7jFm+0BKaVZIxfqOQ</tt> and <tt>AFABG7jFm+0BKaVZIxfqOQ</tt> as its GUID.</li> + </ul> + </li> + </ul> + </dd> + </dl> + </li> + </ul> + </li> + <li>Select search options</li> + <li>Click + <b>Search</b> or press + <b>Enter</b> from the combo box to execute the search + </li> + <li>The Search view displays the results of your search</li> + <li>Right-click on any item in the Search view to open a context menu that allows you perform various operations on the artifacts such as copy search results to the clipboard or reveal a selected artifact in Artifact Explorer.</li> + <li>To open one of the listed artifacts, double-click it or select + <b>Open</b> from the context menu. + </li> + </ol> + <h3 id="Quick_Search_Options">Quick Search Options</h3> + <h4 id="Attribute_Type_Filter">Attribute Type Filter</h4> + <p>An option to search in a specific set of attribute types for artifacts on the selected branch. + Type in the desired words to search for. Make sure the Attribute Type Filter option is selected under Options. By default, the filter is set to filter by attributes of type Name. If you wish to change the filter, select the button to the right of the configuration text area. When this is performed, a dialog displaying all the different tagged attribute types will be displayed. Check the items to include in the filter and select Ok. Press the Search button to execute the search.</p> + <p>Note: When Attribute Type Filter option is selected, By Id option is not allowed. Therefore, selecting Attribute Type Filter option disables the By Id option by setting its state to not selected.</p> + <h4 id="By_GUID">By GUID</h4> + <p>An option to search for artifacts with a particular GUID on the default branch. Type in the desired GUID(s) separated by commas or spaces. Make sure the By GUID option is selected under Options, then press the Search button.</p> + <p>Note: When By GUID option is selected, Attribute Type Filter option is not allowed. Therefore, selecting By GUID option disables the Attribute Type Filter option by setting its state to not selected.</p> + <h4 id="Include_Deleted">Include Deleted</h4> + <p>An option to include artifacts that have been deleted as part of a quick search on the default branch. Type in the desired words. Make sure the Include Deleted option is selected under Options, then press the Search button.</p> + <h4 id="Match_Word_Order">Match Word Order</h4> + <p>An option to match a phrase against artifacts during a quick search operation on the default branch. Type in the desired words. Make sure the Match Word Order option is selected under Options, then press the Search button.</p> + <h4 id="Exact_Match">Exact Match</h4> + <p>An option to return exact matches to the input string. The case and special characters that are part of the input must be matched.</p> + <h4 id="Case_Sensitive">Case Sensitive</h4> + <p>Type in the desired words. Make sure the Match Word Order option is selected under Options, select All Match Locations then press the Search button.</p> + <h2 id="Sky_Walker_View">Sky Walker View</h2> + <p>The Sky Walker View displays a graphical representation of artifacts and their relations for easy navigation.</p> + <p> + <img border="0" src="images/SkyWalker.png"/> + </p> + <h2 id="Change_Report_Editor">Change Report Editor</h2> + <p>The change report view shows all changes made to a branch. A Change Report can be performed for a branch two ways. The first way is by right-clicking a branch from the Branch Manager then choosing the "Show Change Report" menu item. The second way is to select "Show Change Report" from the Aspect view of an ATS Action that is still in work; this will do a Change Report for the working branch of the Aspect.</p> + <p>The Change Report will display all of the artifacts on the branch that have had an attribute or relation link modified. It will also do conflict detection on these artifacts against the parent branch. Attributes and relation links with multiple changes will provide a summarized node that shows the final effect of the changes and can be expanded to view all of the minor changes that were made. If an attribute or relation link was modified on both branches then the summary will show a red conflict mark to signify that a commit will cause an override to occur. </p> + <p>On the Transactions tab, OSEE will show all the transactions that were made on the branch. Author and timestamp show who and when and admins have the ability to purge a transaction.</p> + <p> + <img width="550" align="right" border="0" src="images/ChangeReportEditor.png"/> + </p> + <h3 id="Toolbar_buttons_4">Toolbar buttons</h3> + <table class="wikitable" style="border:1"> + <tr style="background:#CCCCCC"> + <th>Command</th> + <th>Description</th> + </tr> + <tr> + <td> + <img border="0" src="images/Refresh.gif"/> + </td> + <td>Refreshes the data in the change report view with the latest information.</td> + </tr> + <tr> + <td> + <img border="0" src="images/Customize.gif"/> + </td> + <td>Opens the table customization dialog. This allows users add or hide columns.</td> + </tr> + <tr> + <td> + <img border="0" src="images/Bug.gif"/> + </td> + <td>Opens an action against the Change Report View.</td> + </tr> + </table> + <h3 id="Toolbar_Drop-Down_2">Toolbar Drop-Down</h3> + <p>To display, click on the inverted triangle located on the upper right-hand side of the Change Report View.</p> + <table class="wikitable" style="border:1"> + <tr style="background:#CCCCCC"> + <th>Command</th> + <th>Description</th> + </tr> + <tr> + <td>Show Document Order</td> + <td>Switch presentation to show artifacts ordered by their default hierarchy relation.</td> + </tr> + </table> + <h3 id="Pop-up_Menu_3">Pop-up Menu</h3> + <p>To display, perform a right-click on any branch.</p> + <table class="wikitable" style="border:1"> + <tr style="background:#CCCCCC"> + <th>Command</th> + <th>Description</th> + </tr> + <tr> + <td>Open</td> + <td>Opens the selected artifact using the default editor.</td> + </tr> + <tr> + <td>Open With</td> + <td>Opens a sub-menu listing the available editor's for this artifact.</td> + </tr> + <tr> + <td>Reveal in Artifact Explorer</td> + <td>Displays an artifacts location in the Artifact Explorer.</td> + </tr> + <tr> + <td>Resource History</td> + <td>Opens the Resource History view for the selected artifact. This will display all transactions for this artifact.</td> + </tr> + <tr> + <td>View Word Change Report</td> + <td>Displays a Word document populated with the branch differences of the selected artifacts.</td> + </tr> + <tr> + <td>View Viewer Report</td> + <td>Generates a report of the Change Report View content.</td> + </tr> + <tr> + <td>Copy</td> + <td>Copies the artifact.</td> + </tr> + <tr> + <td>Replace with Baseline Version...</td> + <td>Displays dialog to Replace a single Attribute or Artifact. Attribute - Will replace the current attribute with the baseline version. Artifact - Will replace the complete artifact (all attributes and relations).</td> + </tr> + </table> + <p> + <br/> + <br/> + </p> + <h2 id="Define_Navigator">Define Navigator</h2> + <p>The Define Navigator, shown by default in the Define Perspective, provides a central location to launch frequently used define operations. To quickly find a define operation to execute, enter text into the filter box. This will filter out all navigation items that contains the entered text. Select the clear action ( + <img border="0" src="images/Clear.gif"/>) to clear out the text and restore all navigation items. To execute the operation, double-click on any of the navigation item. + </p> + <h2 id="Merge_Manager">Merge Manager</h2> + <p>The Merge Manager is used to resolve conflicts that arise when doing development on parallel branches. The Merge Manager makes conflicts that arise easily identifiable and then provides the means for resolving the conflicts, so that the working branch can be committed. A conflict exists if the value of an attribute/artifact has changed on both the Destination and Source Branches. For reference the Source Branch is the users working branch. It is the branch that the user has been making changes to and would like to then add back into the Destination Branch or Baseline Branch. Both branches are identified by name in the header of the Merge Manager. </p> + <p>Depending upon the conflict found, the user may have several choices for resolution. These include:</p> + <ul> + <li>Accept the value on the Source Branch and overwrite the value on the Destination Branch</li> + <li>Accept the value on the Destination Branch and do not add any of the Source Branch changes, (These will still show up as merged on Change Reports)</li> + <li>Create a solution that is a combination of the two changes</li> + <li>Revert the changes on the Source Branch (This is the only available solution when the Artifact/Attribute was deleted on the Destination Branch, will show up as no change on the Change Report)</li> + <li>Do nothing (only possible for informational conflicts)</li> + </ul> + <p> + <b>Committing of Branches is blocked until all conflicts are resolved.</b> + </p> + <p> + <img align="middle" border="0" src="images/MergeManager.png"/> + </p> + <h3 id="Icons">Icons</h3> + <table class="wikitable" style="border:1"> + <tr style="background:#CCCCCC"> + <th>Icon</th> + <th>Description</th> + </tr> + <tr> + <td> + <img border="0" src="images/Chkbox_disabled.gif"/> + </td> + <td>Resolution has been started for the conflict</td> + </tr> + <tr> + <td> + <img border="0" src="images/Accept.gif"/> + </td> + <td>Conflict has been resolved and is ready to be committed, In the Merge column it means that the Source and Destination Branches have the same value even though they were both changed.</td> + </tr> + <tr> + <td> + <img border="0" src="images/Chkbox_enabled_conflicted.gif"/> + </td> + <td>After a conflict has been marked as resolved the value changed on the source or destination branch</td> + </tr> + <tr> + <td> + <img border="0" src="images/Issue.gif"/> + </td> + <td>A conflict that provides the user special information but does not need to be resolved</td> + </tr> + <tr> + <td> + <img border="0" src="images/Red_light.gif"/> + </td> + <td>A conflict that can not be resolved except by reverting the Artifact or Attribute, because it was deleted on the Destination Branch</td> + </tr> + <tr> + <td> + <img border="0" src="images/Blue_d.gif"/> + </td> + <td>Shows that the item defined by the column it is in has the Destination Branches value</td> + </tr> + <tr> + <td> + <img border="0" src="images/Green_s.gif"/> + </td> + <td>Shows that the item defined by the column it is in has the Source Branches value</td> + </tr> + <tr> + <td> + <img border="0" src="images/Yellow_m.gif"/> + </td> + <td>Shows that the item defined by the column it is in has a new value that is neither the Source Branch nor Destination Branch value.</td> + </tr> + <tr> + <td> + <img border="0" src="images/Conflict.gif"/> + </td> + <td>Shows that the conflict has not been given an initial value</td> + </tr> + <tr> + <td> + <img border="0" src="images/User.gif"/> + </td> + <td>Opens the Associated Artifact for the merge</td> + </tr> + <tr> + <td> + <img border="0" src="images/Branch_change_source.gif"/> + </td> + <td>Opens up the Change Report for the Source Branch</td> + </tr> + <tr> + <td> + <img border="0" src="images/Branch_change_dest.gif"/> + </td> + <td>Opens up the Change Report for the Destination Branch</td> + </tr> + <tr> + <td> + <img border="0" src="images/Refresh.gif"/> + </td> + <td>Refreshes the Merge Manger view to find new conflicts</td> + </tr> + <tr> + <td> + <img border="0" src="images/Customize.gif"/> + </td> + <td>Allows the user to customize the Merge Manager tables</td> + </tr> + <tr> + <td> + <img border="0" src="images/Bug.gif"/> + </td> + <td>Report a bug with the Merge Manager</td> + </tr> + </table> + <h3 id="GUI_Overview">GUI Overview</h3> + <p>The GUI is organized to provide the user with an ability to quickly identify conflicts.</p> + <ul> + <li> + <b>The Heading</b> - The Heading contains text to help identify what is being merged. It identifies the Source Branch, and the Destination Branch. It also provides the user with information about how many conflicts there are and if they have been resolved. The Heading also contains easy launch icons for additional tools in connection with the Merge Manager. + </li> + <li> + <b>The Conflict Resolution Column</b> - This column provides the user information about the state of the conflict. A blank entry in the column means that the conflict is new and has not had any actions performed on it. + <ul> + <li>A + <img border="0" src="images/Chkbox_disabled.gif"/> indicates that conflict is in the modified state. This means the user has begun merging the conflict but has not marked it as resolved. The user may transition it into the resolved state by left clicking on the + <img border="0" src="images/Chkbox_disabled.gif"/> icon. + </li> + <li>The + <img border="0" src="images/Accept.gif"/> icon indicates the user has marked the conflict as resolved. This means they have selected a value for it and have verified the value going in is what they want. No additional changes are allowed on a conflict once it is in the resolved state. It can be placed back into the modified state by left clicking on the + <img border="0" src="images/Accept.gif"/> icon. + </li> + <li>The + <img border="0" src="images/Chkbox_enabled_conflicted.gif"/> means that a conflict was in the resolved state but a new change has occurred on either the Source or Destination Branch. It serves to notify the user that the conflict was not in the finalized state when they resolved the conflict. The user can return to resolved state by left clicking on the + <img border="0" src="images/Chkbox_enabled_conflicted.gif"/> icon. + </li> + <li>The + <img border="0" src="images/Red_light.gif"/> icon indicates that an Artifact or Attribute must be reverted on the Source Branch. This indicates that the Artifact/Attribute was deleted on the Destination Branch and can not have a change committed onto it. The user must abandon any change to that artifact attribute by using the revert command. Once the Artifact/Attribute has been reverted the Merge Manager will be refreshed and the conflict will be removed. + </li> + <li>The + <img border="0" src="images/Issue.gif"/> icon indicates an informational conflict. The user does not have to take any action to resolve these conflicts. It just provides the information that the Source Branch deleted the Artifact/Attribute but the Destination Branch has been modified. The user is free to act as desired based on the provided information. + </li> + </ul> + </li> + <li> + <b>The Artifact Name Column</b> - This column tells which artifact the conflict occurred on. If the name is different between the Source and Destination Branches, (this will show up as a conflict) it will at first showing use the Source Branch value and then use whatever the name is resolved to be after that has occurred. + </li> + <li> + <b>The Artifact Type Column</b> - Simply lists what type of Artifact is conflicted + </li> + <li> + <b>The Conflicting Item Column</b> - In the case of an attribute conflict it states what attribute type is conflicting. In the case of an artifact conflict it will always say "Artifact State" + </li> + <li> + <b>The Source Value Column</b> - When possible this column tells what value the Source Branch has for the conflict. It will always have a + <img border="0" src="images/Green_s.gif"/> icon. If the conflicting item is Word Formatted Content the words "Stream data" will be shown. For artifact conflicts it will either show "Modified" or "Deleted". Left clicking on the + <img border="0" src="images/Green_s.gif"/> icon will populate the Merge Branch with value found on the Source Branch. + </li> + <li> + <b>The Destination Value Column</b> - When possible this column tells what value the Destination Branch has for the conflict. It will always have a + <img border="0" src="images/Blue_d.gif"/> icon. If the conflicting item is Word Formatted Content the words "Stream data" will be shown. For artifact conflicts it will either show "Modified" or "Deleted". Left clicking on the + <img border="0" src="images/Blue_d.gif"/> icon will populate the Merge Branch with value found on the Destination Branch. + </li> + <li> + <b>The Merge Value Column</b> - The Merged Value column serves to show the user the value that has been selected for use when the Branch is committed. The Merge value is actually kept on a new "Merge Branch" and so any changes made to it will not affect the value seen on the Source or Destination Branches. When the Merge Value column is blank with no icon, the conflict is informational and no actions are provided. + <ul> + <li>When the Merge Value column contains a + <img border="0" src="images/Conflict.gif"/> icon the value has not been set. This is the icon that should be shown for all conflicts (Except informational conflicts, or same value conflicts) the first time the user brings up the merge manager. + </li> + <li>The + <img border="0" src="images/Green_s.gif"/> icon indicates that the Source Value was selected as the final value. The actual Source Value text will also be shown in this column if possible. + </li> + <li>The + <img border="0" src="images/Blue_d.gif"/> icon indicates that the Destination Value was selected as the final value. The Destination Value text will also be shown in this column if possible. + </li> + <li>The + <img border="0" src="images/Yellow_m.gif"/> icon will be shown when a new value has been selected for the final value. This indicates that the user has modified the final value so that it is no longer a copy of the Source or Destination, but some variation thereof. + </li> + <li>A + <img border="0" src="images/Accept.gif"/> icon indicates that although both the Source Branch Value and Destination Branch Value have changed they were both changed to the same value and so there is not really a conflict. Left clicking on the icon in the Merge Value column will bring up the Merge Wizard or in the case of un-resolvable conflicts a dialog offering the ability to revert the conflicting item. + </li> + </ul> + </li> + </ul> + <h3 id="Pop-up_Menu_4">Pop-up Menu</h3> + <p>To display, perform a right click on any row. This will provide a menu with options to resolve conflicts.</p> + <table class="wikitable" border="1" cellpadding="1"> + <tr style="background:#CCCCCC"> + <th>Item</th> + <th>Description</th> + </tr> + <tr> + <td>Set Source as Default Branch</td> + <td>This selection is a quick way to set the Source Branch as the default branch. + <br/>If the Source Branch is already set as the Default Branch, the menu item will be grayed out and there will be a check mark next to the option. + </td> + </tr> + <tr> + <td>Set Destination as Default Branch</td> + <td>This selection is a quick way to set the Destination Branch as the default branch. + <br/>If the Destination Branch is already set as the Default Branch, the menu item will be grayed out and there will be a check mark next to the option. + </td> + </tr> + <tr> + <td>Edit Merge Artifact</td> + <td>This option is only enabled for Word Formatted Content conflicts and will bring up the Merge Artifact in Word. </td> + </tr> + <tr> + <td>Generate Three Way Merge</td> + <td>Will generate a Three Way Merge for the Word Formatted Content.</td> + </tr> + <tr> + <td>Preview Source Artifact</td> + <td rowspan="3">Show a preview in Word of the Artifact based on the version selected.</td> + </tr> + <tr> + <td>Preview Destination Artifact</td> + </tr> + <tr> + <td>Preview Merge Artifact</td> + </tr> + <tr> + <td>Show Source Branch Differences</td> + <td rowspan="5">Generates differences based upon which option is selected. Allows the user to see how different versions of the artifact differ</td> + </tr> + <tr> + <td>Show Destination Branch Differences</td> + </tr> + <tr> + <td>Show Source/Destination Differences</td> + </tr> + <tr> + <td>Show Source/Merge Differences</td> + </tr> + <tr> + <td>Show Destination/Merge Differences</td> + </tr> + <tr> + <td>Reveal Artifact in Explorer</td> + <td>This option is only available when either the Source or Destination Branch is set as the default branch. When such is the case this will reveal the artifact in the Artifact Explorer for the Branch that is the default branch.</td> + </tr> + <tr> + <td>Resource History</td> + <td>This option is only available when either the Source or Destination Branch is set as the default branch. When such is the case this will reveal the resource history of the artifact on the Branch that is the default branch.</td> + </tr> + </table> + <h3 id="General_Resolution_of_Conflicts">General Resolution of Conflicts</h3> + <table class="wikitable" border="1" cellpadding="1"> + <tr style="background:#CCCCCC"> + <th>Type</th> + <th>Description</th> + </tr> + <tr> + <td>Informational Conflicts</td> + <td>Informational conflicts are identified by the + <img border="0" src="images/Issue.gif"/> icon in the conflict resolution column in the GUI. Informational conflicts require no action by the user, and no actions are provided in the GUI other than the ability to use the right click menu to examine the artifact using the tools provided there. An informational conflict is generated when the Source branch deletes an Artifact or an Attribute and that same Artifact or Attribute was modified on the Destination Branch. This is to allow the user the opportunity to review a change that was made on the Destination Branch that might make them want to take some action in regards to their deletion. + </td> + </tr> + <tr> + <td>Un-resolvable Conflicts</td> + <td>Un-resolvable Conflicts are identified by the + <img border="0" src="images/Red_light.gif"/> icon in the conflict resolution column of the GUI. This conflicts require the user to revert the Artifact or Attribute that caused the conflict on the Source Branch. An Un-resolvable conflict is caused when the Destination Branch deletes an Artifact or Attribute while the Source Branch modifies that same Artifact, Attribute. The reason the user must revert their changes is that committing in their changes would essentially undo that deletion and bring that item back into existence. If the deletion should not have happened the user needs to talk with the committer of the deletion to resolve the issue. + </td> + </tr> + <tr> + <td>Attribute Conflicts</td> + <td>Attribute Conflicts occur when both the Destination and Source branch modify an attribute. This section will cover all attributes except Word Formatted Content Attributes. </td> + </tr> + </table> + <h3 id="Word_Formatted_Content_Conflict_Resolution">Word Formatted Content Conflict Resolution</h3> + <p>Resolution of conflicts is provided in two different ways. They can either copy and paste the changes into their Merge Artifact document or they can generate a Three Way Merge and accept the changes that show up in the generated document. Both approaches have their advantages and disadvantages and are best suited for different situations. They can also be combined where the situation warrants it, however the three way merge must always be done first if this is the case.</p> + <h3 id="Manual_Merging">Manual Merging</h3> + <p> + <b>Usage:</b> + </p> + <ul> + <li>When one version of the artifact has many changes and the other version has very few changes</li> + <li>When both files have formatting changes</li> + <li>When three way merging generates a complex document</li> + <li>When both versions edit the same text in multiple places</li> + </ul> + <p>Manual Merging is the process of combining the Source Branch changes and the destination branch changes manually by copying and pasting them into the Merge Artifact document. The Merge Artifact is a separate version of the artifact that will preserve the details of the Merge, and will be reviewable in the Merge Manager after an artifact is committed. IMPORTANT: If the user makes the changes to their Source Branch instead of on the Merge Artifact the Merge Manager will incorrectly represent the merge in future reviews.</p> + <p>The following procedure illustrates the functionality available to facilitate a manual merge.</p> + <p>The user will first either launch the Merge Wizard by left clicking on the icon in the Merge Value column of the GUI or they may select the functionality from the right click menu for the conflict in question. The first thing to do is to bring up a word document comparison of both the Source Branch Version and the Destination Branch Version. These documents will show all of the changes that have been made to these two artifacts since the Source Branch was created. To launch these difference's the user either select "Show Source Diff" and "Show Destination Diff" from the wizard or "Differences"->"Show Source Branch Differences" and "Differences"->"Show Destination Branch Differences" from the right click menu. These will bring up the two difference's in different Word instances with window labels to allow the user to differentiate the files. The intention of bringing up these difference's is twofold. Firstly, it allows the user to identify the file that has the most changes. Secondly, it will come in use later when the user copy's and paste's changes into the Merge document.</p> + <p>Upon identifying the branch that has the most changes the user should then set the Merge Artifact to contain that branches value. This is done by either selecting "Populate with Source Data" or "Populate with Destination Data" from the Merge Wizard or left clicking on the icon or the icon in the Source and Destination Value columns in the Merge Manager GUI. The user can then bring up the Merge Artifact for editing by clicking on "Edit Merge Artifact" in the Merge Wizard or in the right click menu. The Document that comes up contains the Merge Artifact and any changes made to it will be reflected when the Source Branch is committed. The user can than begin to copy the changes from the diff report that showed the fewest changes (opposite of the one chosen as the baseline). After all changes have been migrated into the Merge Artifact document the user than saves the document, which will preserve the Merge Artifact value. The user should be aware that any changes they do not wish to preserve from either the Source or Destination version of the Artifact need to be omitted on the Merge Artifact.</p> + <p>The user then right clicks on the in the Conflict Status Column so that the icon is displayed. The conflict is resolved and will allow the Source Branch to be committed.</p> + <h4 id="Three_Way_Merge">Three Way Merge</h4> + <p> + <b>Usage:</b> + </p> + <ul> + <li>When both versions have many changes or both versions have few changes.</li> + <li>When only one file has formatting changes (Must be combined with Manual Merging in this case)</li> + <li>When three way merging generates an understandable document </li> + </ul> + <p>Three Way Merging leverages Microsoft Words ability to merge documents. At the beginning of any Word Formatted Content merge it is recommended that user generate a Three Way Merge and check the complexity of the document. In most cases Three Way Merging is a quicker way to merge two documents, however in some cases the Three Way Merge will generate a document that is difficult to use and understand. This usually arises when the Source and Destination branches have edited the same text or if one of the branches has touched a large percentage of the file. As it runs fairly quickly it is always a good idea to run it at the beginning of a Merge to check if it is useful. Three Way Merging only allows the user to maintain format changes from one of the documents. If format changes are made on both documents the Three Way Merge will prompt the user as to which format changes they would like to maintain, the user will then need to copy the format changes from the other document into the Merge Artifact document manually.</p> + <p>A Three Way Merge is generated by selecting Generate Three Way Merge from either the Merge Wizard or the right click menu. IMPORTANT: Generating a Three Way Merge will discard any changes made to the Merge Artifact, therefore a prompt will make sure this is the intended operation. If a user had started a Three Way Merge previously but had not completed the Merge the user is also given the option of continuing the previous Merge in the prompt (Selecting Edit Merge Artifact will also have this effect). The following is an example of a Three Way Merge in Word.</p> + <p> + <img width="650" align="middle" border="0" src="images/WordThreeWayMerge.png"/> + </p> + <p>The changes made by the Source Branch and Destination Branch are shown in different colors in the Word Document. In this particular case the changes made in Red were done by the Source Branch and the changes made in Blue were done on the Destination Branch. The color scheme is not consistent and the user needs to verify which color equates to which changes by hovering there mouse over one of the changes. A popup will be shown which will identify the author. The following Guide will explain how to resolve the changes in the document. IMPORTANT: All changes must be either accepted or rejected before the conflict can be marked as resolved. After the user has resolved all the changes it is a good idea to do generate a difference document between the Source Artifact and the Merge Artifact, and the Destination Artifact and the Merge Artifact by selecting "Show Source/Merge Diff" and "Show Destination/Merge Diff" from the merge Wizard or "Differences"->"Show Source/Merge Differences" and "Differences"->"Show Destination/Merge Differences" from the right click menu. These views will show the differences between the branch artifact and the merge artifact. For the Source/Merge difference this will show everything that is different between the source document and the Merge document. In the case where the user accepts all changes from the source and destination branches this diff will highlight all of the changes that occurred on the destination branch. In the Destination/Merge diff it will highlight all of the changes that happened on the source branch. It is always possible to use Manual Merging techniques in conjunction with Three Way Merging.</p> + <p>The user then right clicks on the in the Conflict Status Column so that the icon is displayed. The conflict is resolved and will allow the Source Branch to be committed.</p> + <p> + <img width="400" align="middle" border="0" src="images/Word_formatted_content_merge_wizard.jpg"/> + </p> + <h3 id="Additional_Features">Additional Features</h3> + <p>The Merge Wizard contains a "Clear the Merge Artifact" that is not available from the right click menu and only available for Word Formatted Content. This will empty out the Merge artifact and allow the user to start with an empty document for editing. It will also place a + <img border="0" src="images/Conflict.gif"/>icon in the merge value column for that conflict. + </p> + <h3 id="Step-By-Step_Recipe">Step-By-Step Recipe</h3> + <p>Upon selecting to commit a working branch, OSEE will prompt the user to perform a merge if conflicts are detected between the changes made on the child branch and any changes made to the parent branch since the child branch was created. </p> + <p> + <img width="350" align="middle" border="0" src="images/StoppedDialog.JPG"/> + </p> + <p>The Merge Manager in OSEE will be used to reconcile these differences. From the + <i>Merge Manager</i> tab, select the Merged Value icon which will cause the + <i>Edit the attribute</i> window to appear. + </p> + <p>Perform the following steps for each artifact listed on the + <i>Merge Manager</i> tab: + </p> + <ol> + <li>Determine which change would be the easiest to re-implement (typically the smaller and simpler of the two). This can be done by comparing all of the changes made to this UI. + <ol> + <li> + <b>Show Source Diff</b> displays the changes made on this working branch. + </li> + <li> + <b>Show Destination Diff</b> displays the changes made on the parent branch. + </li> + <li> + <b>Show Source/Destination Diff</b> displays the effect on the parent branch prior to any merge management. This view will show how the changes made on this working branch will be overwritten by the changes made on the parent branch. + </li> + </ol> + </li> + <li>Select the + <i>more complicated</i> of the two changes to populate the Merge Artifact: + <b>Populate with Source Data</b> or + <b>Populate with Destination Data</b>. The Merged Value column on the + <i>Merge Manager</i> tab and the top-most icon in the + <i>Edit the attribute</i> window will update to display "S" or "D" based upon this selection. + </li> + <li>Select + <b>Edit Merge Artifact</b> to open the merge document for editing. + </li> + <li>Re-implement the changes from the + <i>simpler</i> change report. + </li> + <li>If at any time the merge effort needs to be cleared or re-started, select + <b>Clear the Merge Artifact</b>. + </li> + <li>The following selections may be used to review and confirm the changes made during the merge. Prior to updating the Merge Artifact, these selections will not provide accurate information. + <ol> + <li> + <b>Show Source/Merge Diff</b> displays the additional changes beyond those made on the working branch. + </li> + <li> + <b>Show Destination/Merge Diff</b> displays the additional changes beyond those made on the parent branch. + </li> + </ol> + </li> + <li>Select + <b>Finish</b> + </li> + <li>Under the Conflict Resolution column on the + <i>Merge Manager</i> tab, check the box so that the resolution status updates from "Modified" to "Resolved". + </li> + <li>Once all artifact conflicts have been addressed, the + <i>Merge Manager</i> tab will report "All Conflicts Are Resolved." At this point, the user can return to the Workflow tab and re-initiate committing the branch. + </li> + <li>OSEE will display the + <i>Commit Branch</i> window to confirm the conflicts have been resolved via the Merge Manager. + </li> + <li>Select + <b>Ok</b> to finish committing the branch. + </li> + </ol> + <p> + <img width="320" alt=" center" border="0" src="images/Complete2.JPG_"/> + </p> + <h2 id="Test_Run_View">Test Run View</h2> + <p>The Test Run View provides an integration point with OTE (OSEE Test Environment). The test run view is used for viewing test run results. It can view a summary of output files that exist on a file system and it will upload those output files to the OSEE data store. It can also be used to view previous test runs that have been uploaded to the OSEE data store. </p> + <p> + <img align="middle" border="0" src="images/TestRunView.jpg"/> + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Features.html" title="Features"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="Features.html" title="Features"> + <img alt="Features" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Search.html" title="Search"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Features</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Search</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/Wizards.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/Wizards.html new file mode 100644 index 00000000000..06b58236cc1 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/Wizards.html @@ -0,0 +1,68 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Features - Wizards</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Wizards</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Search.html" title="Search"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Services.html" title="Services"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Search</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Services</td> + </tr> + </table><hr/> + <h1 id="Wizards">Wizards</h1> + <h2 id="Artifact_Import_Wizard">Artifact Import Wizard</h2> + <table class="wikitable" style="border:1"> + <tr style="background:#CCCCCC"></tr> + <tr> + <td>top]] + <img border="0" src="images/artifact_import_wizard.jpg"/> + </td> + </tr> + <tr></tr> + </table><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Search.html" title="Search"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="Features.html" title="Features"> + <img alt="Features" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Services.html" title="Services"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Search</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Services</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/Accept.gif b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/Accept.gif Binary files differnew file mode 100644 index 00000000000..9cacb96dca9 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/Accept.gif diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/ArtifactEditor.jpg b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/ArtifactEditor.jpg Binary files differnew file mode 100644 index 00000000000..52d8f82ddc2 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/ArtifactEditor.jpg diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/ArtifactExplorer.jpg b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/ArtifactExplorer.jpg Binary files differnew file mode 100644 index 00000000000..462ad337432 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/ArtifactExplorer.jpg diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/Artifact_explorer.gif b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/Artifact_explorer.gif Binary files differnew file mode 100644 index 00000000000..23b46a83e46 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/Artifact_explorer.gif diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/Artifact_import_selection.jpg b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/Artifact_import_selection.jpg Binary files differnew file mode 100644 index 00000000000..cf7c5d947ee --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/Artifact_import_selection.jpg diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/Artifact_import_wizard.jpg b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/Artifact_import_wizard.jpg Binary files differnew file mode 100644 index 00000000000..151441b9bc5 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/Artifact_import_wizard.jpg diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/Artifact_search.gif b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/Artifact_search.gif Binary files differnew file mode 100644 index 00000000000..799d3d5686c --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/Artifact_search.gif diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/Artifact_search.jpg b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/Artifact_search.jpg Binary files differnew file mode 100644 index 00000000000..799d3d5686c --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/Artifact_search.jpg diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/Artifact_search_page.gif b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/Artifact_search_page.gif Binary files differnew file mode 100644 index 00000000000..3b4ddb4eee6 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/Artifact_search_page.gif diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/Authenticated.gif b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/Authenticated.gif Binary files differnew file mode 100644 index 00000000000..c9170d9ca9c --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Features/images/Authenticated.gif diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/Getting-Started.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/Getting-Started.html new file mode 100644 index 00000000000..1ad60f5109e --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/Getting-Started.html @@ -0,0 +1,49 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Introduction</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Introduction</th> + </tr> + <tr> + <td style="width: 20%" align="left"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Installation-and-Initialization.html" title="Installation and Initialization"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Installation and Initialization</td> + </tr> + </table><hr/> + <h1 id="What_is_OSEE.3F">What is OSEE?</h1> + <p>The + <a href="http://www.eclipse.org/osee" target="osee_external">Open System Engineering Environment (OSEE)</a> project provides a tightly integrated environment supporting lean principles across a product's full life-cycle in the context of an overall systems engineering approach. The system captures project data into a common user-defined data model providing bidirectional traceability, project health reporting, status, and metrics which seamlessly combine to form a coherent, accurate view of a project in real-time. By building on top of this data model, OSEE has been architected to provide an all-in-one solution to configuration management, requirements management, testing, validation, and project management. All of these work together to help an organization achieve lean objectives by reducing management activities, eliminating data duplication, reducing cycle-time through streamlined processes, and improving overall product quality through work flow standardization and early defect detection. + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Installation-and-Initialization.html" title="Installation and Initialization"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Installation and Initialization</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/Installation-and-Initialization.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/Installation-and-Initialization.html new file mode 100644 index 00000000000..02ec2a2221c --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/Installation-and-Initialization.html @@ -0,0 +1,433 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Introduction - Installation and Initialization</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Installation and Initialization</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Getting-Started.html" title="Introduction"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Screencasts.html" title="Screencasts"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Introduction</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Screencasts</td> + </tr> + </table><hr/> + <h1 id="Installation_and_Initialization">Installation and Initialization</h1> + <h2 id="Requirements">Requirements</h2> + <ul> + <li>System with at least 4GB of RAM</li> + <li>Java Runtime Environment (JRE) 1.6</li> + <li> + <a href="https://www.eclipse.org/downloads/packages/release/Kepler/SR2" target="osee_external">Eclipse Kepler 4.3.2</a> + </li> + <li>Relational Databases: OSEE comes bundled with H2. For additional database support, see + <a href="Supported_Databases" title="OSEE/Users_Guide/Getting_Started#Supported_Databases">Supported Databases</a>. + </li> + </ul> + <h2 id="Eclipse_Installation">Eclipse Installation</h2> + <p>To install OSEE: Start by downloading the OSEE Application Server and the OSEE Client Update Archive from the + <a href="http://www.eclipse.org/osee/downloads/" target="osee_external">downloads</a> page. + </p> + <h3 id="Quick_Server_Installation">Quick Server Installation</h3> + <p>If you are interested in a quick start, and are not setting up a custom database installation, setting up the OSEE server with the bundled HSQLDB database is simple.</p> + <ul> + <li>Create a directory to place your server in, and unzip the downloaded server zip file (e.g. org.eclipse.osee.x.server.runtime.zip) into that directory.</li> + </ul> + <p>You should end up with the following files and directories:</p> + <dl> + <dd>configuration</dd> + <dd>demo</dd> + <dd>eclipse</dd> + <dd>etc</dd> + <dd>plugins</dd> + <dd>runDemo.bat</dd> + <dd>runDemo.sh</dd> + <dd>runHsql.sh</dd> + <dd>runPostgreSqlLocal.sh</dd> + </dl> + <ul> + <li>Edit the desired startup script file (e.g. "runDemo.bat") to provide the server the link to the binary data.</li> + </ul> + <p>For example, if you were using Windows, and you installed to C:/UserData/OseeDemo, you would change the line in the batch file to:</p> + <ul style="list-style: square"> + <li> + <ul style="list-style: square"> + <li>Dosee.application.server.data="C:/UserData/OseeDemo/demo/binary_data"</li> + </ul> + </li> + <li>change to the etc directory, and edit the osee.hsql.json file.</li> + </ul> + <p>Set the jdbc.server.db.data.path to the location of the hsql db. + Following the example above, for instance, you would change the line in the json file to:</p> + <dl> + <dd>"jdbc.server.db.data.path": "file:c:/UserData/OseeDemo/demo/hsql/osee.hsql.db",</dd> + </dl> + <p>That completes the simple server setup. + Run the server by setting up a command window, then running the script file to start the server. + For example, if you were running with Windows, you would start a windows command shell, then run the "runDemo.bat" batch script. See + <a href="Installation-and-Initialization.html#Launch_Application_Server">Launch Application Server</a> for details on running the server. + </p> + <h3 id="Client_Installation">Client Installation</h3> + <p>The OSEE client can be installed from within Eclipse like any other Eclipse plugin.</p> + <ol> + <li>Start Eclipse and select the menu item + <b>Help > Install New Software...</b> <!-- + <img border="0" src="images/Find_and_install.png"/>--> + </li> + <li>Select the + <i>Available Software</i> tab group and click the + <i>Add...</i> button. + <br/> + <img width="500" border="0" src="images/Add_site.png"/> + <img border="0" src="images/New_update_site.png"/> + <br/> + </li> + <li>In the + <i>Add Repository</i> dialog, choose the Archive button, then navigate the file browser to the Client Update file downloaded in step one. + <b>Please note that the use of the software you are about to access may be subject to third party terms and conditions and you are responsible for abiding by such terms and conditions.</b> + </li> + <li>Click on the + <i>OK</i> button to store update site information. + </li> + <li>Select the OSEE update site entry and all features listed under its category. Click the + <i>Next</i> button. + <img border="0" src="images/AvailableSoftware.png"/> + </li> + <li>The update manager calculates dependencies and offers you a list of features to install. Select the needed ones and click the + <i>Next</i> button. + </li> + <li>Accept terms of license agreement and click the + <i>Finish</i> button in order to start the installation of selected features. + <img border="0" src="images/AcceptTerms.png"/> + </li> + <li>To apply installation changes click on the + <i>No</i> button and shutdown Eclipse. It is important that you don't restart Eclipse until you have completed the database initialization steps below. + </li> + </ol> + <p> + <img border="0" src="images/Restart_dialog.png"/> + If you are using the default demo database and did the server quick start above, you just need to make one change to the eclipse eclipse.ini file - add the line + </p> + <ul style="list-style: square"> + <li> + <ul style="list-style: square"> + <li>Dosee.application.server= + <a href="http://localhost:8089" target="osee_external">http://localhost:8089</a> to the end of the file. + </li> + </ul> + </li> + </ul> + <p>Your installation is complete. </p> + <ul> + <li>If you chose the quick server installation above, you can check to make sure the server is running in the command window, then start the OSEE client.</li> + <li>If you are using a custom database, then configure the database and initialize it before running the client.</li> + </ul> + <h2 id="Additional_Configuration_Options">Additional Configuration Options</h2> + <ol> + <li>The following instructions apply if you are setting up a custom database, or if you are configuring OSEE for use by multiple users.</li> + <li>Custom Data Base: Follow the instructions at + <a href="Installation-and-Initialization.html#Supported_Databases">Supported Databases</a> to complete this step. + </li> + <li>Initialize the database with default OSEE data. See + <a href="Installation-and-Initialization.html#Database_Initialization">Database Initialization</a> + </li> + <li>Setup config.ini and launch eclipse to start using OSEE + <a href="Installation-and-Initialization.html#Launch_.26_Configuration">Launch and Configuration</a> + </li> + <li>You can find different OSEE perspectives, such as Define and ATS, and views in correspondent dialogs, activated by menu items + <i>Window > Open Perspective > Other...</i> and + <i>Window > Show View > Other...</i>. + </li> + </ol> + <p><table border="0" cellpadding="5" cellspacing="0"> +<tr><td valign="top"> + <img border="0" src="images/Open_perspective.png"/></td> +<td valign="top"> + <img border="0" src="images/Show_view.png"/></td></tr> +</table> + </p> + <h2 id="Server_Installation">Server Installation</h2> + <ol> + <li>Download the server zip file from + <a href="http://www.eclipse.org/osee/downloads/" target="osee_external">downloads</a>. + </li> + <li>Unzip the file</li> + <li>Set up the database (as described below)</li> + </ol> + <h2 id="Supported_Databases">Supported Databases</h2> + <p>Data created and managed by OSEE is persisted into a data store divided into two sections. A relational database to store type, configuration, and small content (< 4000 bytes) and a remote file system to store larger binary content.</p> + <p>Before you can use OSEE, you will need to select and install a relational database suited for your needs and identify a file system path for binary content storage. OSEE provides support for the databases listed below. For launch and configuration instructions visit + <a href="Installation-and-Initialization.html#Launch_.26_Configuration">Launch and Configuration</a>. + </p> + <h3 id="PostgreSQL_Installation">PostgreSQL Installation</h3> + <p> + <b>Prerequisites</b> + </p> + <ul> + <li>Ensure you have selected the best database for your needs</li> + </ul> + <p> + <b>Instructions</b> + </p> + <ol> + <li>Download PostgreSQL from + <a href="http://www.postgresql.org/download" target="osee_external">http://www.postgresql.org/download</a> + </li> + <li>Follow PostgreSQL installation instructions</li> + <li>By default, the PostgreSQL database server is configured to allow only local connections. If remote connections are to be allowed, edit postgresql.conf and pg_hba.conf to set the necessary permissions. (To setup an unsecured database instance set listen_address to * in the postgresql.conf file and add the following line to the pg_hba.conf file: host all all 0.0.0.0/0 trust)</li> + <li>Configure PostgreSQL for OSEE + <ol> + <li>Launch pgAdmin (in windows Start->All Programs->PostgreSQL*->pgAdmin III)</li> + <li>Double click on PostgreSQL Database Server (listed under Servers on the left hand side) + <ol> + <li>If you are prompted for a password type the password selected during installation (user should be postgres by default)</li> + </ol> + </li> + <li>Create an "osee" user + <ol> + <li>Right-click on Login Roles (at the bottom of the tree on the left hand side) and select "New Login Role..."</li> + <li>Enter the following in the dialog: + <ol> + <li>Role Name: osee</li> + <li>"Can login" should be checked</li> + <li>Password: osee</li> + <li>Password (again): osee</li> + <li>Role Privileges--select all of the following: + <ol> + <li>Inherits rights from parent roles</li> + <li>Superuser</li> + <li>Can create database objects</li> + <li>Can modify catalog directly</li> + </ol> + </li> + </ol> + </li> + <li>Click 'OK'</li> + <li>You should now have an "osee" user under Login Roles</li> + </ol> + </li> + <li>Expand the "Databases" item in the tree + <ol> + <li>Create the "OSEE" database by right-clicking on "Databases" and selecting "New Database..."</li> + <li>Enter the following in the dialog: + <ol> + <li>Name: OSEE</li> + <li>Owner: osee</li> + <li>Encoding: UTF-8</li> + </ol> + </li> + <li>Click 'OK'</li> + <li>You should now have an "OSEE" Database under Databases</li> + </ol> + </li> + <li>Click on "OSEE" and then expand it, then expand "Schemas" + <ol> + <li>Create the "osee" schema: + <ol> + <li>Right click on "Schemas" and select "New Schema..."</li> + <li>Enter the following in the dialog: + <ol> + <li>Name: osee</li> + <li>Owner: osee</li> + </ol> + </li> + <li>Click 'OK'</li> + <li>You should now have an "osee" schema under schemas</li> + </ol> + </li> + <li>The relational database is now configured. Proceed to OSEE Database Initialization</li> + </ol> + </li> + </ol> + </li> + </ol> + <h2 id="Launch_Application_Server">Launch Application Server</h2> + <p> + <b>Prerequisites</b> + </p> + <ul> + <li>Database has been installed</li> + </ul> + <p> + <b>Instructions</b> + </p> + <ul> + <li>Execute the launch script for your database and OS (if running from microdoc: + <a href="http://osee.microdoc.com/node/2" target="osee_external">http://osee.microdoc.com/node/2</a>) - typical launch script names are + <i>runPostgresqlLocal.sh</i> for a local Postgres on Unix and + <i>runH2.sh</i> for H2 on Unix. It is straightforward to convert the downloaded scripts to Windows batch files. + <ul> + <li>If running PostgreSQL, be sure to add the driver bundle ( + <a href="http://www.eclipse.org/osee/downloads/" target="osee_external">downloads</a>) to the server installation. Unzip the files into the server installation and add org.postgresql.driver@start to the bundles in config.ini. + </li> + </ul> + </li> + <li>Wait until server finishes the startup procedure - + <b>do not close the console</b> + </li> + <li>To check that the server has connected successfully to the database, enter the command osgi> osee server_status</li> + <li>You should see results similar to:</li> + </ul> + <p> + <a href="http://wiki.eclipse.org/File:ServerStatus.jpg" title="File:ServerStatus.jpg" target="osee_external">File:ServerStatus.jpg</a> + </p> + <h2 id="Database_Initialization">Database Initialization</h2> + <p> + <b>Prerequisites</b> + </p> + <p>Visit the 'User's Guide' if you need more information about any of the pre-requisites below. </p> + <ul> + <li>Database has been installed </li> + <li>Database server is running </li> + <li>A file system path has been selected for binary data storage. The system default the user's home directory. </li> + <li>An application server is running. See 'Application Server Launch' for more info.</li> + </ul> + <p> + <br/>' + <b>'Warning: This process will delete all data from OSEE Data Store. Make sure you are certain before running this process.</b>'' + </p> + <p> + <br/> + </p> + <p> + <b>Instructions</b> + </p> + <p> + <br/> + </p> + <ul> + <li>Ensure database connection information matches database installation. OSEE is pre-configured to work with a PostgreSQL server running on port 5432. If you need a specialized database connection see the 'Configuring Database Connection' section.</li> + <li>If using PostgreSQL, make sure the driver bundle has been installed on the client eclipse (available at + <a href="http://www.eclipse.org/osee/downloads/" target="osee_external">downloads</a>). + <ul> + <li>The zip file can be dragged and dropped on the install new software window.</li> + <li>Uncheck the "Group items by category" for it to show up.</li> + </ul> + </li> + <li>In a console from the client installation, launch the database initialization application by entering the following:</li> + </ul> + <p> + <br/> + </p> + <table style="background:rgb(230,230,230);color:black; border:1px solid gray; font-family: fixedsys;text-align: left"></table> + <p> + <br/> + </p> + <ul> + <li>When prompted select "Y" </li> + <li>Wait for initialization to complete</li> + </ul> + <h2 id="Messaging_Service">Messaging Service</h2> + <p>OSEE utilizes the + <a href="http://en.wikipedia.org/wiki/Java_Message_Service" target="osee_external">Java Message Service (JMS) API</a> for loosely coupled, reliable, and asynchronous communication with OSEE clients. You will need an implementation of this API such as + <a href="http://activemq.apache.org" target="osee_external">ActiveMQ</a> in order for clients to receive updates to cached artifacts that were modified by another client (remote events). Download the latest version from + <a href="http://activemq.apache.org/download.html" target="osee_external">here</a>. + </p> + <h4 id="Install">Install</h4> + <p>General installation + <a href="http://activemq.apache.org/getting-started.html#GettingStarted-InstallationProcedureforUnix" target="osee_external">instructions</a>. + </p> + <p>If you are downloading a release of ActiveMQ from the terminal and need to use an http proxy, this command will set up your proxy:</p> + <pre> +$ export http_proxy=http://proxy.host.com:1234 +</pre> + <h4 id="Start">Start</h4> + <p>General instructions on how to start ActiveMQ are + <a href="http://activemq.apache.org/getting-started.html#GettingStarted-StartingActiveMQ" target="osee_external">here</a>. + </p> + <p>To direct the OSEE client to use this service, in your launcher ini file, include the following Java system property:</p> + <pre> +-Dosee.default.broker.uri=tcp://<localhost_or_your_server>:61616 +</pre> + <h2 id="Launch_.26_Configuration">Launch & Configuration</h2> + <p>Before you can launch OSEE, you will need the address of an arbitration server or an application server to access the OSEE data store. If you have questions regarding client/server interactions, visit 'Client/Server Overview'. If everything is on the same machine, the following examples will work. + + <br/> + + <br/> + </p> + <p> + <b>Prerequisites</b> + </p> + <ul> + <li>Database has been installed</li> + <li>Database server is running</li> + <li>A file system path has been selected for binary data storage. The system default the user's home directory.</li> + </ul> + <p> + <br/> + + <b>Application Server Launch Instructions</b> + </p> + <table style="background:rgb(230,230,230);color:black; border:1px solid gray; font-family: fixedsys;text-align: left"></table> + <p> + <br/> + For PostgreSQL: + + <br/> + </p> + <table style="background:rgb(230,230,230);color:black; border:1px solid gray; font-family: fixedsys;text-align: left"></table> + <p> + <br/> + </p> + <p> + <b>OSEE Client Launch Instructions</b> + </p> + <table style="background:rgb(230,230,230);color:black; border:1px solid gray; font-family: fixedsys;text-align: left"></table> + <h2 id="Configure_a_New_Project_in_OSEE">Configure a New Project in OSEE</h2> + <ol> + <li>Create baseline branch + <ol> + <li>From the Branch Manager's select parent branch -> open context menu -> select "branch" and enter new branch name</li> + <li>From the Branch Manager's select new branch -> open context menu -> access control + <ol> + <li>Add system administrators with Full Access</li> + <li>Add Everyone with Read Access</li> + </ol> + </li> + </ol> + </li> + </ol><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Getting-Started.html" title="Introduction"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="Getting-Started.html" title="Introduction"> + <img alt="Introduction" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Screencasts.html" title="Screencasts"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Introduction</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Screencasts</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/Screencasts.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/Screencasts.html new file mode 100644 index 00000000000..01d98678f8d --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/Screencasts.html @@ -0,0 +1,96 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Introduction - Screencasts</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Screencasts</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Installation-and-Initialization.html" title="Installation and Initialization"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Updating-This-Document.html" title="Updating This Document"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Installation and Initialization</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Updating This Document</td> + </tr> + </table><hr/> + <h1 id="Screencasts">Screencasts</h1> + <p>The following screencasts provide an effective way to quickly learn what OSEE is and how it can be applied to your engineering project. + + <br/> + <br/> + </p> + <ul> + <li>The + <a href="http://www.eclipse.org/downloads/download.php?file=/technology/osee/1.0%20OSEE%20Demo%20Introduction%20Screencast.zip" target="osee_external">OSEE Demo Introduction Screencast</a> presents preliminary material and introduces the other available screencasts. + </li> + </ul> + <ul> + <li>The + <a href="http://www.eclipse.org/downloads/download.php?file=/technology/osee/2.0%20OSEE%20Overview%20Screencast.zip" target="osee_external">OSEE Overview</a> provides an overview of OSEE, including the driving forces that led to its creation, its architecture, the maturity of the application framework, and the status and maturity of the different applications that use the framework. + </li> + </ul> + <ul> + <li>The + <a href="http://www.eclipse.org/downloads/download.php?file=/technology/osee/3.0%20OSEE%20Skynet%20Introduction.zip" target="osee_external">OSEE Application Framework</a> screencast introduces the application framework that OSEE applications use to persist their shared data. It also gives an introduction to the generic views and editors that are available to all OSEE applications. + </li> + </ul> + <ul> + <li>The + <a href="http://www.eclipse.org/downloads/download.php?file=/technology/osee/4.0%20OSEE%20Demo%20Data%20Introduction%20Screencast.zip" target="osee_external"> OSEE Demo Data Introduction</a> introduces the data that is loaded into the OSEE Demo database for use by these screencasts. This helps the user understand how the data for an engineering environment fits into Application Framework and will help clarify the OSEE Define and OSEE ATS screencast demos. + </li> + </ul> + <ul> + <li>The + <a href="http://www.eclipse.org/downloads/download.php?file=/technology/osee/5.0%20OSEE%20Define%20Introduction%20Screencats.zip" target="osee_external">OSEE Define</a> screencast introduces OSEE Define, the requirements and document management application that is built into OSEE. It will discuss the difference between requirements and document management and how both types are imported into OSEE. It will also introduce editing artifacts directly on the main branch, using working branches and show the basics of relating artifacts to each other. + </li> + </ul> + <ul> + <li>The + <a href="http://www.eclipse.org/downloads/download.php?file=/technology/osee/6.0%20OSEE%20ATS%20Introduction%20Screencast.zip" target="osee_external">OSEE ATS</a> screencast introduces OSEE ATS, the integrated configuration management/change request application built into OSEE. It will introduce the purpose of creating an integrated change management system, the terms and objects used in ATS, the benefits of integrated processes and configured workflows in an integrated environment and the scenarios of creating and transitioning an action to completion. It will also walk through a simple configuration of ATS for a new product and briefly introduce the peer review framework that is available. + </li> + </ul> + <p> + <a href="http://wiki.eclipse.org/Category:OSEE" title="Category:OSEE" target="osee_external">Category:OSEE</a> + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Installation-and-Initialization.html" title="Installation and Initialization"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="Getting-Started.html" title="Introduction"> + <img alt="Introduction" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Updating-This-Document.html" title="Updating This Document"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Installation and Initialization</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Updating This Document</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/Updating-This-Document.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/Updating-This-Document.html new file mode 100644 index 00000000000..07ebd38e1dc --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/Updating-This-Document.html @@ -0,0 +1,55 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Introduction - Updating This Document</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Updating This Document</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Screencasts.html" title="Screencasts"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"></td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Screencasts</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top"></td> + </tr> + </table><hr/> + <h1 id="Updating_This_Document">Updating This Document</h1> + <p> This document is maintained in a collaborative wiki. If you wish to + update or modify this document please visit + + <a href="http://wiki.eclipse.org/OSEE/Users_Guide/Getting_Started" target="osee_external">http://wiki.eclipse.org/OSEE/Users_Guide/Getting_Started</a> + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Screencasts.html" title="Screencasts"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="Getting-Started.html" title="Introduction"> + <img alt="Introduction" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"></td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Screencasts</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top"></td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/images/AcceptTerms.png b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/images/AcceptTerms.png Binary files differnew file mode 100644 index 00000000000..0478ed7dbb3 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/images/AcceptTerms.png diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/images/Add_site.png b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/images/Add_site.png Binary files differnew file mode 100644 index 00000000000..0901c067d99 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/images/Add_site.png diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/images/AvailableSoftware.png b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/images/AvailableSoftware.png Binary files differnew file mode 100644 index 00000000000..cba0a936ff8 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/images/AvailableSoftware.png diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/images/New_update_site.png b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/images/New_update_site.png Binary files differnew file mode 100644 index 00000000000..c3f965d90d1 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/images/New_update_site.png diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/images/Open_perspective.png b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/images/Open_perspective.png Binary files differnew file mode 100644 index 00000000000..8146be85c1c --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/images/Open_perspective.png diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/images/Restart_dialog.png b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/images/Restart_dialog.png Binary files differnew file mode 100644 index 00000000000..ed42f071aab --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/images/Restart_dialog.png diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/images/ServerStatus.jpg b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/images/ServerStatus.jpg Binary files differnew file mode 100644 index 00000000000..e2a8bc38ae5 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/images/ServerStatus.jpg diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/images/Show_view.png b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/images/Show_view.png Binary files differnew file mode 100644 index 00000000000..892fd208e60 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Getting_Started/images/Show_view.png diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/New/Highlighted-Changes.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/New/Highlighted-Changes.html new file mode 100644 index 00000000000..86a7025e3a5 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/New/Highlighted-Changes.html @@ -0,0 +1,93 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>New - Highlighted Changes</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Highlighted Changes</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="New.html" title="New"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Updating-This-Document.html" title="Updating This Document"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">New</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Updating This Document</td> + </tr> + </table><hr/> + <h1 id="Highlighted_Changes">Highlighted Changes</h1> + <h2 id="ATS_-_Action_Tracking_System">ATS - Action Tracking System</h2> + <p>Highlight of ATS bug fixes:</p> + <ul> + <li>Corrected Task in task search window not saving after refresh</li> + <li>Fixed issue where the zoom out icon is identical to the zoom in icon</li> + <li>Created ability to subscribe for emails when action is written against an Actionable Item or Team Definition</li> + <li>Fixed Promoted Date not being updated issue</li> + <li>Added trailing "/" in search for view comparison view</li> + <li>Allow way to reset an attribute to its default value</li> + <li>Fixed issue where favorite branches are not saved when OSEE is restarted</li> + </ul> + <h2 id="Define">Define</h2> + <ul> + <li>Merge Manager Changes + <ul> + <li>Issues when merging Native Artifacts have been resolved.</li> + <li>A bug in the GUI not being able to display a conflict where an attribute was deleted and modified. </li> + <li>Side by side comparison for merging string attributes other than Word content </li> + <li>A bug that introduced false positives conflicts has been identified and resolved.</li> + </ul> + </li> + <li>Improved Revision History View with filtering.</li> + <li>Native artifacts now have a preview menu option.</li> + <li>Resolved Remote Event Service client synchronization issues</li> + <li>Fixed tracked change errors causing infinite loop on saving</li> + </ul> + <h2 id="Help_System">Help System</h2> + <ul> + <li>The OSEE Online Help is now dynamically generated from the + <a href="http://wiki.eclipse.org/OSEE" target="osee_external">Wiki page content</a> as part of the build process. + </li> + </ul> + <p> + <a href="http://wiki.eclipse.org/Category:OSEE" title="Category:OSEE" target="osee_external">Category:OSEE</a> + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="New.html" title="New"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="New.html" title="New"> + <img alt="New" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Updating-This-Document.html" title="Updating This Document"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">New</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Updating This Document</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/New/New.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/New/New.html new file mode 100644 index 00000000000..e3df5ec4bf9 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/New/New.html @@ -0,0 +1,69 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>New</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">New</th> + </tr> + <tr> + <td style="width: 20%" align="left"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Highlighted-Changes.html" title="Highlighted Changes"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Highlighted Changes</td> + </tr> + </table><hr/> + <p>__NOTOC__</p> + <h1 id="Planned_Capabilities_for_OSEE_Release_0.8.2">Planned Capabilities for OSEE Release 0.8.2</h1> + <p>This release of OSEE concentrated on major bug fixes. However, an effort to improve our ability to support our customer base had also been initiated. This effort required selected customers to reevalute the actions they have originated and determine if these actions can be retracted (cancelled), particularly if they fall into any of the following categories:</p> + <ol> + <li> + <i>Overcome by events/no longer valid.</i> + </li> + <li> + <i>Not backed up by a requirement (e.g. development of an emulator/model).</i> + </li> + <li> + <i>Of relatively low importance or priority.</i> + </li> + <li> + <i>Limited applicability to the user community.</i> + </li> + <li> + <i>Duplicates.</i> + </li> + </ol> + <p>Thanks to all who participated and helped us bring down the number of active actions so we can reasonably assess their relative importance and subsequently, get them into a release sometime in the future. </p> + <p> + <b>Results:</b> Total Actions: 529; Total Cancelled: 324; Total Completed:188; Pending: 17 + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Highlighted-Changes.html" title="Highlighted Changes"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Highlighted Changes</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/New/Updating-This-Document.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/New/Updating-This-Document.html new file mode 100644 index 00000000000..b7d5675f137 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/New/Updating-This-Document.html @@ -0,0 +1,55 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>New - Updating This Document</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Updating This Document</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Highlighted-Changes.html" title="Highlighted Changes"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"></td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Highlighted Changes</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top"></td> + </tr> + </table><hr/> + <h1 id="Updating_This_Document">Updating This Document</h1> + <p> This document is maintained in a collaborative wiki. If you wish to + update or modify this document please visit + + <a href="http://wiki.eclipse.org/OSEE/Users_Guide/New" target="osee_external">http://wiki.eclipse.org/OSEE/Users_Guide/New</a> + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Highlighted-Changes.html" title="Highlighted Changes"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="New.html" title="New"> + <img alt="New" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"></td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Highlighted Changes</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top"></td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Tips/Artifact-Explorer.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Tips/Artifact-Explorer.html new file mode 100644 index 00000000000..36f036d9b01 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Tips/Artifact-Explorer.html @@ -0,0 +1,62 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Tips - Artifact Explorer</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Artifact Explorer</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Branch-Manager.html" title="Branch Manager"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Search-Tips.html" title="Search Tips"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Branch Manager</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Search Tips</td> + </tr> + </table><hr/> + <h1 id="Artifact_Explorer">Artifact Explorer</h1> + <h2 id="How_do_I_create_another_Artifact_Explorer">How do I create another Artifact Explorer</h2> + <p>Select the artifact explorer menu bar icon to create another view. Each Artifact Explorer can be set to it's own branch.</p> + <h2 id="How_do_I_quickly_search_from_Artifact_Explorer">How do I quickly search from Artifact Explorer</h2> + <p>Select the Quick Search menu bar icon to open the Quick Search view. This will also set the Quick Search view "Selected Branch" to the branch from the Artifact Explorer you choose.</p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Branch-Manager.html" title="Branch Manager"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="Tips.html" title="Tips"> + <img alt="Tips" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Search-Tips.html" title="Search Tips"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Branch Manager</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Search Tips</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Tips/Branch-Manager.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Tips/Branch-Manager.html new file mode 100644 index 00000000000..0c20ea13b44 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Tips/Branch-Manager.html @@ -0,0 +1,62 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Tips - Branch Manager</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Branch Manager</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Tips.html" title="Tips"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Artifact-Explorer.html" title="Artifact Explorer"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Tips</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Artifact Explorer</td> + </tr> + </table><hr/> + <h1 id="Branch_Manager">Branch Manager</h1> + <h2 id="How_do_I_quickly_find_branches_I_care_about">How do I quickly find branches I care about</h2> + <p>In branch manager, you can select any branch, right-click and add as favorite. You can then select, via toolbar pull-down menu, to "Show Favorites First". This will sort your favorite branches to the top of the Branch Manager and any branch selection dialog.</p> + <h2 id="How_do_I_quickly_select_a_branch">How do I quickly select a branch</h2> + <p>Selecting "Select Branch", you can type in the filter to filter out the branch you wish. Once your filter filters out all but a single branch, it will be automatically selected for you and you can press enter.</p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Tips.html" title="Tips"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="Tips.html" title="Tips"> + <img alt="Tips" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Artifact-Explorer.html" title="Artifact Explorer"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Tips</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Artifact Explorer</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Tips/MS-Word-Tips.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Tips/MS-Word-Tips.html new file mode 100644 index 00000000000..aa11036f5e3 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Tips/MS-Word-Tips.html @@ -0,0 +1,360 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Tips - MS Word Tips</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">MS Word Tips</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Search-Tips.html" title="Search Tips"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Updating-This-Document.html" title="Updating This Document"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Search Tips</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Updating This Document</td> + </tr> + </table><hr/> + <h1 id="MS_Word_Tips">MS Word Tips</h1> + <h2 id="Where_is_the_Tools_Menu_in_Office_2007.3F">Where is the Tools Menu in Office 2007?</h2> + <p>In Office 2007, the Options command which was located on the + <b>Tools</b> menu has been moved under the + <b>Office Button</b> + <img border="0" src="images/officeButton.jpg"/>. Click the + <b>Office Button</b> + <img border="0" src="images/officeButton.jpg"/> to open the + <b>Options Dialog</b>. This dialog is similar to the sub-menu located under the + <b>File</b> menu in Office 2003. To open the user preference dialog, you have to click on the + <b>Word Options</b> button located on the lower left corner of the + <b>Office Button Dialog</b>. + </p> + <p> + <img border="0" src="images/officeDialog.jpg"/> + </p> + <p> + <img width="500" border="0" src="images/wordOptions.jpg"/> + </p> + <h2 id="What_format_should_Word_Documents_be_stored">What format should Word Documents be stored</h2> + <p>OSEE does not support Word 2007 XML format. Documents should be saved using + <b>Word 2003 XML Document</b> format. + </p> + <h2 id="What_user_preferences_should_I_set_when_using_Word_2007.3F">What user preferences should I set when using Word 2007?</h2> + <ol> + <li>[[#Stop Word from raising a "Convert File" prompt |' + <i>Disable Word from raising a "Convert File" prompt</i>']] + </li> + <li>[[#Make XML Tags Visible|' + <i>Always Show Smart Tags</i>']] + </li> + <li>[[#Stop Word from adding Smart Tags|' + <i>Disable Smart Tag Document Embedding</i>']] + </li> + </ol> + <h2 id="Where_can_I_find_support_for_Word_2007_features.3F">Where can I find support for Word 2007 features?</h2> + <p>[ + <a href="http://office.microsoft.com/en-us/training/CR100654561033.aspx" target="osee_external">http://office.microsoft.com/en-us/training/CR100654561033.aspx</a> + <b>Office 2007 How-To Demos</b>] + </p> + <h2 id="Do_I_have_to_use_Microsoft_Word_to_enter_my_requirements.3F">Do I have to use Microsoft Word to enter my requirements?</h2> + <p>Quick Answer: No</p> + <p>This question comes up when users find out that OSEE is integrated with Microsoft Word as one method to enter artifact data such as requirements.</p> + <p>OSEE uses Artifacts, Attributes and Relations to store information in its data store. The Attributes associated with a certain Artifact can be boolean, text, date, float or any newly created attribute type. One such attribute type is a "Word Content" attribute. This allows word content to be added as an attribute to an Artifact. This attribute, however, is not required to be used. One could define a "Software Requirement" to be any set of Attribute types that must/can be entered. Although, Word 2003 XML is more tightly integrated into OSEE, the architecture provides for other editing applications to be plugged in. We are actively working on adding tight integration with Open Office to edit requirements.</p> + <p>In addition to this specific type of Attribute, OSEE does allows any operating system file to be dragged in and created as an Artifact. This artifact, when opened, will extract its data and present it to the operating system to allow viewing and editing. This allows things like requirements to be specified by other modeling, diagraming or even mathematical applications that OSEE doesn't know about. These artifacts can have their own metadata associated and also be related to other artifacts in the system.</p> + <h2 id="Importing_Microsoft_Word.28c.29_documents_into_OSEE">Importing Microsoft Word(c) documents into OSEE</h2> + <p>Yes. OSEE will import existing Word 2003 XML documents and atomize them by their paragraph sections. The Word styles "Heading (1...9)" are used to determine the breakout into individual artifacts and their position in the document hierarchy.</p> + <h2 id="How_are_MS_Word_styles_and_formatting_handled.3F">How are MS Word styles and formatting handled?</h2> + <p>Whole MS Word documents can be stored and edited as an artifact like any other native file type without any formatting restrictions of any kind. However, to use the more tightly integrated support such as editing many artifacts in a single Word document or the document generation capabilities, then the file format needs to be MS Word 2003 XML. Since OSEE supports user defined Word XML templates for editing, previewing, comparing, and publishing, the user has complete control over the Word styles (and all other formatting) through the rendering templates. The only formmatting requirements for Word content are that when importing the Word styles "Heading (1...9)" are used to determine the breakout into individual artifacts and their position in the document hierarchy.</p> + <h2 id="Stop_Word_from_raising_a_.22Convert_File.22_prompt">Stop Word from raising a "Convert File" prompt</h2> + <h3 id="Office_2013">Office 2013</h3> + <ol> + <li>Click the + <b>FILE</b> menu + </li> + <li>Click the + <b>Options</b> menu option + </li> + <li>Select + <b>Advanced</b> from the topics panel on the left + </li> + <li>Scroll to the + <b>General</b> settings section + </li> + <li>Uncheck + <b>Confirm file format on open</b> + </li> + </ol> + <h3 id="Office_2007">Office 2007</h3> + <ol> + <li>Click the + <b>Office Button</b> located on the upper left corner + </li> + <li>Click the + <b>Word Options</b> button to open the options dialog + </li> + <li>Select + <b>Advanced</b> from the topics panel on the left + </li> + <li>Scroll to the + <b>General</b> settings section + </li> + <li>Uncheck + <b>Confirm file format on open</b> + </li> + </ol> + <h3 id="Office_2003">Office 2003</h3> + <ol> + <li>Open + <b>Tools > Options... > General</b> + <ol> + <li>Uncheck + <b>Confirm conversion at Open</b> + </li> + <li>Click + <b>OK</b> + </li> + </ol> + </li> + </ol> + <h2 id="Stop_Word_from_adding_Smart_Tags">Stop Word from adding Smart Tags</h2> + <h3 id="Office_2003_2">Office 2003</h3> + <ol> + <li>Open + <b>Tools > AutoCorrect Options… > Smart Tags</b> + <ol> + <li>Uncheck + <b>Label text with smart tags</b> + </li> + <li>Click + <b>Save Options...</b> + <ol> + <li>Uncheck + <b>Embed Smart Tags</b> + </li> + <li>Click + <b>OK</b> + </li> + </ol> + </li> + <li>Click + <b>Remove Smart Tags</b> if the button is not grayed out + </li> + <li>Click + <b>OK</b> + </li> + </ol> + </li> + </ol> + <h3 id="Office_2007_2">Office 2007</h3> + <ol> + <li>Click the + <b>Office Button</b> located on the upper left corner + </li> + <li>Click the + <b>Word Options</b> button to open the options dialog + </li> + <li>Select + <b>Advanced</b> from the topics panel on the left + </li> + <li>Scroll to the + <b>Preserve fidelity when sharing this document</b> section + </li> + <li>Select + <b>All New Documents</b> from the drop-down located next to the section title + </li> + <li>Uncheck + <b>Embed Smart tags</b> + </li> + <li>Uncheck + <b>Embed Linguistic data</b> There appears to be a bug in MS Word 2007: + <a href="http://support.microsoft.com/kb/925174" target="osee_external">http://support.microsoft.com/kb/925174</a> + </li> + </ol> + <h2 id="Make_XML_Tags_Visible">Make XML Tags Visible</h2> + <p>To toggle viewing of XML tags, press Ctrl+Shift+X. You should enable these unless you have a good reason not to.</p> + <h3 id="Office_2007_Preference_Settings">Office 2007 Preference Settings</h3> + <ol> + <li>Click the + <b>Office Button</b> located on the upper left corner + </li> + <li>Click the + <b>Word Options</b> button to open the options dialog + </li> + <li>Select + <b>Advanced</b> from the topics panel on the left + </li> + <li>Scroll to the + <b>Show Document</b> settings section + </li> + <li>Check + <b>Show Smart Tags</b> + </li> + </ol> + <h2 id="Make_tracked_changes_in_Word_appear_inline_instead_of_in_balloons">Make tracked changes in Word appear inline instead of in balloons</h2> + <ol> + <li>Open the + <b>Show</b> dropdown menu within the Reviewing Toolbar and select + <b>Options...</b>. + </li> + <li>Within the + <b>Track Changes</b> window that just appeared change the + <b>Insertions</b> and + <b>Deletions</b> colors to Blue and Red, respectively. + </li> + <li>Change the + <b>Use Balloons</b> dropdown menu from + <b>Always</b> to + <b>Only for comments/formatting.</b> + </li> + <li>Click OK.</li> + </ol> + <h2 id="Keep_MS_Word_from_prompting_to_save_Normal.doc">Keep MS Word from prompting to save Normal.doc</h2> + <ol> + <li>Upgrade to Office 2007 (required by OSEE)</li> + <li>On the Tools menu, click Options.</li> + <li>Click the Save tab.</li> + <li>Clear the Prompt to save Normal template check box.</li> + </ol> + <h2 id="What_do_I_do_when_I_am_seeing_some_characters_.28such_as_smart_quotes_and_.21.3D_signs.29_show_up_as_a_little_black_rectangle_instead.3F">What do I do when I am seeing some characters (such as smart quotes and != signs) show up as a little black rectangle instead?</h2> + <ol> + <li>In Word, goto Tools->AutoCorrect Options + <ol> + <li>In the "Replace text as you type" table , delete the "straight quotes with smart quotes" option</li> + <li>In the "AutoFormat as you Type" Tab deselect the Replace as you type "straight quotes with smart quotes" selection</li> + <li>In the "AutoFormat" Tab deselect the Replace "straight quotes with smart quotes" selection</li> + </ol> + </li> + </ol> + <h3 id="Office_2007_Preference_Settings_2">Office 2007 Preference Settings</h3> + <ol> + <li> + <a href="Windows">Button</a>--> Proofing --> in the AutoCorrect options block --> AutoCorrect Options... + </li> + <li>In the "AutoFormat as you Type" Tab deselect the Replace as you type "straight quotes with smart quotes" selection</li> + <li>In the "AutoFormat" Tab deselect the Replace "straight quotes with smart quotes" selection</li> + </ol> + <h2 id="Configure_MS_Word_.282003.2F2007.29_so_it_does_NOT_auto-format_bulleted_and_numbered_lists">Configure MS Word (2003/2007) so it does NOT auto-format bulleted and numbered lists</h2> + <p>As you may have already seen, Word will take the following: + (A) -> XXX + And turn it into some type of numbered list, such as: </p> + <ul style="list-style: square"> + <li>> XXX, or A. -> XXX, or 1 -> XXX, etc.</li> + </ul> + <p>This will cause incorrect formatting, because Word will automatically create styles that are not part of the templates used for rendering and publishing in OSEE. Ultimately this auto-numbering leads to the need for fix RPCRs. Additionally when introduced using Word 2003, it can cause compatibility issues. </p> + <ol> + <li>Close all instances of Word </li> + <li>Open either MS Word 2007 or 2003 (whichever you prefer to work with) + <ul> + <li>Word 2007: + <ol> + <li>Select + <i>Office</i> (top-left corner) + </li> + <li>Go to + <i>Word Options</i> => + <i>Proofing</i> => + <i>AutoCorrect Options</i> + </li> + </ol> + </li> + <li>Word 2003: + <ol> + <li>Go to + <i>Tools</i> => + <i>AutoCorrect Options...</i> + </li> + </ol> + </li> + </ul> + </li> + <li>Select + <i>AutoFormat As You Type</i> + </li> + <li>Under + <i>Apply as you type</i> clear the checkboxes: + <i>Automatic bulleted lists</i> and + <i>Automatic numbered lists</i> + </li> + <li>Restart MS Word</li> + </ol> + <h2 id="Restarting_a_numbered_list_in_an_OSEE_Artifact">Restarting a numbered list in an OSEE Artifact</h2> + <ol> + <li>Menu Item in Word: Insert->Quick Parts->Field->ListNum</li> + <li>Enable Level in list: 1 </li> + <li>Enable Start-at value: 0</li> + <li>Click Ok</li> + <li>To not show the 'dot' character in the document + <ul> + <li>Highlight the dot, right click -> Font</li> + <li>Enable Hidden</li> + <li>Click Ok</li> + </ul> + </li> + <li>If you need to see the field code simply click on the Show/Hide icon</li> + </ol> + <h2 id="Creating_Cross-References_between_Multiple_Word_Artifacts_having_OLE_Data">Creating Cross-References between Multiple Word Artifacts having OLE Data</h2> + <p> + <b>Issue:</b> OSEE is unable to open Word Artifacts containing OLE Data for multi-edit. Therefore, I am unable to create cross-references between sections of artifacts. + </p> + <h3 id="Method1:_Use_single_edit">Method1: Use single edit</h3> + <ol> + <li>Open each artifact for edit separately.</li> + <li>In the artifact with the figure, ensure the figure has an associated auto-reference number (i.e., the figure has a title/caption paragraph with a field code for the auto-reference). Create one if it does not already have one using normal MSWord procedure (right-click on the figure and select Insert Caption, etc.).</li> + <li>In the artifact with the figure, create a temporary paragraph with a temporary sentence that says “As shown in .”</li> + <li>At the end of the temporary sentence, insert an auto-reference to the figure using normal MSWord procedure (use the References tab and select Cross-reference, etc.). The temporary sentence should now say, “As shown in Figure x” where x is the figure number.</li> + <li>Copy the field code from the temporary sentence (i.e., the part that says “Figure x” and which will turn gray when selected) from the artifact with the figure in it to the other artifact that you want to reference the figure from. This copy/paste will result in copying the field code for the figure over to the other artifact. Copy it to the text location where it is needed in the other artifact.</li> + <li>Once edits are complete, delete the temporary paragraph that was put into the artifact with the figure in it. </li> + <li>Save both artifacts (there is no need to save the artifact with the figure in it unless you made substantive changes, such as adding the title/caption paragraph to the figure per Step 2 above).</li> + </ol> + <h3 id="Method2:_Separate_contents_and_reference_with_hyperlinks">Method2: Separate contents and reference with hyperlinks</h3> + <ol> + <li>Create a separate artifact for the section that needs to be referenced. </li> + <li>Create hyperlinks to the new artifact from the referencing artifact.</li> + </ol> + <h2 id="Word_XML_opening_in_XML_editor_instead_of_Word">Word XML opening in XML editor instead of Word</h2> + <p>Sometimes, the registry settings for what to open XML documents can get set incorrectly. A common symptom is that links to Word documents in OSEE open in an XML editor or IE. To fix this, modify the registry entry: + <b>Computer\HKEY_CLASSES_ROOT\xmlfile\shell\open\command</b> to the correct version of Office. For Office 2013, the value would be: + <b>"C:\Program Files (x86)\Common Files\Microsoft Shared\OFFICE15\MSOXMLED.EXE" /verb open "%1"</b> (with quotes) + </p> + <p> + <a href="http://wiki.eclipse.org/Category:OSEE" title="Category:OSEE" target="osee_external">Category:OSEE</a> + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Search-Tips.html" title="Search Tips"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="Tips.html" title="Tips"> + <img alt="Tips" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Updating-This-Document.html" title="Updating This Document"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Search Tips</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Updating This Document</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Tips/Search-Tips.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Tips/Search-Tips.html new file mode 100644 index 00000000000..935a8819613 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Tips/Search-Tips.html @@ -0,0 +1,77 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Tips - Search Tips</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Search Tips</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Artifact-Explorer.html" title="Artifact Explorer"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="MS-Word-Tips.html" title="MS Word Tips"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Artifact Explorer</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">MS Word Tips</td> + </tr> + </table><hr/> + <h1 id="Search_Tips">Search Tips</h1> + <h2 id="Searching_for_all_artifacts_of_a_given_type">Searching for all artifacts of a given type</h2> + <ol> + <li>From the pulldown menu, open + <b>Search > Search...</b> + </li> + <li>Select the + <b>Artifact Search</b> tab + </li> + <li>Select the branch you wish to search on</li> + <li>Select + <b>Artifact Type</b> in the first pulldown under + <b>Create a Filter</b> + </li> + <li>Select the artifact type you wish to search for</li> + <li>Select "Add Filter" (make sure no other filters exist from your last search)</li> + <li>Press + <b>Search</b> + </li> + </ol><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Artifact-Explorer.html" title="Artifact Explorer"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="Tips.html" title="Tips"> + <img alt="Tips" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="MS-Word-Tips.html" title="MS Word Tips"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Artifact Explorer</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">MS Word Tips</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Tips/Tips.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Tips/Tips.html new file mode 100644 index 00000000000..7aecb630eab --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Tips/Tips.html @@ -0,0 +1,73 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Tips</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Tips</th> + </tr> + <tr> + <td style="width: 20%" align="left"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Branch-Manager.html" title="Branch Manager"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Branch Manager</td> + </tr> + </table><hr/> + <h1 id="Frequently_Asked_Questions">Frequently Asked Questions</h1> + <h2 id="Do_I_have_to_create_a_new_database_table_for_every_type_of_Artifact_that_I_want_to_use.3F">Do I have to create a new database table for every type of Artifact that I want to use?</h2> + <p>Quick Answer: No</p> + <p>The OSEE Architecture Framework uses a common table structure to store all types of artifacts, attributes and relations. This allows the users to dynamically create and start using new objects without major database modification.</p> + <h2 id="Do_I_have_to_use_the_Artifact_types_that_are_built_into_OSEE.3F">Do I have to use the Artifact types that are built into OSEE?</h2> + <p>Quick Answer: No</p> + <p>All Artifact Types, Attribute Types and Relation Types (with a few exceptions) are fully customizable. Although OSEE was initially built for capturing all data throughout the lifecycle of a large avionics systems engineering project, it was architected to store any data by simply defining a different data model to use.</p> + <p>In addition, these data models can be dynamically modified. New Artifacts, Attributes and Relations can be specified at anytime (and even by end users if allowed). Modification and deletion of these can be performed with some administrative back-end tools with the understanding that you would need to determine what to do with the removed data.</p> + <h2 id="How_do_I_delete_artifact_types.3F">How do I delete artifact types?</h2> + <p>There is a BLAM called "Purge Artifact Type" that is used to permanently remove all traces of an artifact type from the OSEE database. The BLAM allows the user to select one or more artifact types to purge. If any artifact instances of the doomed artifact type exist, a different artifact type can be specified; these artifacts will be converted to the new type. Otherwise, the BLAM will abort upon discovering an artifact that is of a type to be purged; that is, the BLAM will never delete any artifacts.</p> + <h2 id="Can_OSEE_be_used_offline_and_later_sync.27d_up.3F">Can OSEE be used offline and later sync'd up?</h2> + <p>Although OSEE does not currently provide the capability to download database artifacts, work offline and then sync up when re-connected, it was certainly a consideration in the design. The most complex part would be resolving conflicts that may occur to artifacts edited in both disconnected OSEE's. Since OSEE already has the capability to run on multiple databases and the capability to export and import artifacts, it would just take some effort to provide the first versions of this feature. This would be a great area for collaboration.</p> + <h2 id="Can_I_import_existing_traceability_into_OSEE.3F">Can I import existing traceability into OSEE?</h2> + <p>Quick Answer: Yes</p> + <p>Since traceability is usually defined in a way that is specific to it's use and the objects that are being traced, there is currently no "generic" traceability importing in OSEE, however OSEE provides BLAM that would enable traceability to be imported from existing applications, documents, excel spreadsheets. This capability has already been used a number of times to successfully import traceability from legacy documents and systems on projects OSEE has been deployed to.</p> + <h2 id="Can_I_import_from_Microsoft_Excel.26copy.3B.3F">Can I import from Microsoft Excel&copy;?</h2> + <p>Quick Answer: Yes</p> + <p>Through OSEE's BLAM tool, users can import from other applications, documents and spreadsheets.</p> + <h2 id="How_do_I_publish_documents_from_OSEE.3F">How do I publish documents from OSEE?</h2> + <p>The majority of the work in publishing out of OSEE has been in the format of Microsoft Word© documents. The user can create a Word template that "describes" the format, headers, footers and what data maps into the specified areas in the template. A BLAM is then run where the user can specify the branch and what artifacts are to be published. Upon execution, the documents are created. This method has successfully generated documents in excess of 10,000 pages that were delivered to the customer.</p> + <p>The OSEE architecture also supports other methods of publishing including web and open document formats. Depending on the level of complexity, some work would be done to provide further export capabilities.</p> + <p>Another form of publishing that OSEE was architected for is delivery of OSEE and the database. Although OSEE can publish documents and reports, it was decided early on that the vendors and customers would want and need the same navigation and exportation capabilities that OSEE provides. Instead of delivering generated documents, one of the projects that OSEE is deployed on delivers a copy of OSEE with a sanitized database (confidential data removed). This has been very successful from both the program and customer's point of view.</p> + <h2 id="What_databases_can_be_used_with_OSEE.3F">What databases can be used with OSEE?</h2> + <p>OSEE was architected to be database independent and should run on any SQL-99 compliant DB that has a JDBC driver. It is currently runs on Oracle 10g and 11g and PostgreSQL 8.2. In the past, OSEE has also been run on Derby and MySQL. The current release of OSEE would need to be tested for compatibility with Derby, MySQL, or any other database. If desired, the OSEE Team could work with the user/developers to help perform this task.</p> + <h2 id="Is_OSEE_Compatible_with_Office_2007.3F">Is OSEE Compatible with Office 2007?</h2> + <p>Yes, OSEE is compatible. When storing word content in XML format make sure to use + <b>Word 2003 XML Document (*.xml)</b> format. + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Branch-Manager.html" title="Branch Manager"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Branch Manager</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Tips/Updating-This-Document.html b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Tips/Updating-This-Document.html new file mode 100644 index 00000000000..2910f30c3f1 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Tips/Updating-This-Document.html @@ -0,0 +1,55 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Tips - Updating This Document</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Updating This Document</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="MS-Word-Tips.html" title="MS Word Tips"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"></td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">MS Word Tips</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top"></td> + </tr> + </table><hr/> + <h1 id="Updating_This_Document">Updating This Document</h1> + <p> This document is maintained in a collaborative wiki. If you wish to + update or modify this document please visit + + <a href="http://wiki.eclipse.org/OSEE/Users_Guide/Tips" target="osee_external">http://wiki.eclipse.org/OSEE/Users_Guide/Tips</a> + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="MS-Word-Tips.html" title="MS Word Tips"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="Tips.html" title="Tips"> + <img alt="Tips" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"></td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">MS Word Tips</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top"></td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Tips/images/OfficeButton.jpg b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Tips/images/OfficeButton.jpg Binary files differnew file mode 100644 index 00000000000..7fcb32a98a4 --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Tips/images/OfficeButton.jpg diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Tips/images/OfficeDialog.jpg b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Tips/images/OfficeDialog.jpg Binary files differnew file mode 100644 index 00000000000..476e5a9ff1c --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Tips/images/OfficeDialog.jpg diff --git a/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Tips/images/WordOptions.jpg b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Tips/images/WordOptions.jpg Binary files differnew file mode 100644 index 00000000000..f87fa3a454c --- /dev/null +++ b/plugins/org.eclipse.osee.framework.help.ui/OSEE/Users_Guide/Tips/images/WordOptions.jpg |
