Subversion Repositories DevTools

/*

 ***** HELP TIPS ****

 */

// stdTip: width, Title, Body

function stdTip( w,t,b) {

    return newTip(10,0,w,10,t,b);

}

// newTip( x,y,width,height, title, body)

function newTip(x,y,w,h,t,b) {

    var tip = new Array(x,y,w,h,10);

    tip[4] = '<img src="images/i_help.gif" width="12" height="12" hspace="2" align="absmiddle">' +

    t + '<hr size="1" noshade>' + b;

    return tip;

} 

var formTips = new TipObj('formTips');

with (formTips)

{

 tips.group                = newTip('page.scrollX()', 'page.scrollY()', 150, 10, 'Base&nbsp;View','Move package to a different Base View by selecting it from a dropdown list.<br>' +

                                                                                 'To move package to a new Base View, click on <img src="images/i_new_group.gif" width="17" height="17" align="absmiddle">');

 tips.depsant              = newTip(-150, 0, 150, 10, 'DEPENDENCIES','Paste in <b>sandbox</b> tags.');

 tips.dependencies         = newTip(-150, 0, 150, 10, 'DEPENDENCIES','Paste <b>BuildPackageArchive</b> lines from build.pl file.<br>' +

                                                      'You may use single ( \' ) OR double ( \" ) quotes.');

 tips.addoldpkg            = newTip(-150, 0, 150, 10, 'PACKAGES','Select package(s) and click NEXT. Hold CTRL key to select multiple packages.' +

                                                                 '<br>To add package(s) not shown in the list, click on <img src="images/i_new_pkg.gif" width="17" height="18" align="absmiddle">');

 tips.depnotdef            = newTip(10, 0, 150, 10, 'DEPENDENCIES NOT DEFINED','Dependencies for this package was never defined. Click on DEPENDENCIES link above to define it.');

 tips.pkg_label            = newTip(-150, 20, 150, 10, 'LABEL','Enter the ClearCase label used to tag all the source code in this release.');

 tips.deployable           = newTip(-150, 20, 150, 10, 'DEPLOYABLE','Select YES if this package or certain files of this package have to be deployed to the field.');

 tips.ripple_type          = newTip(-150, 20, 150, 10, 'RIPPLE TYPE','This enables a package to advertise how it will be numbered when rippled.');

 tips.ripple_build         = newTip(-150, 20, 150, 10, 'BUILD INCLUSION','When set to No, this package and all packages which depend on this package will be excluded from the build.');

 tips.advisory_ripple      = newTip(-150, 20, 150, 10, 'ADVISORY RIPPLE','When set to Yes, it will have a benign ripple build impact.');

 tips.src_path             = newTip(-180, 20, 180, 10, 'SOURCE PATH','Enter the path to the source code in a ClearCase VOB. This is used to create a "load rule". ie: /MASS_Dev/%package_name%');

 tips.pubread              = newTip(-150, 0, 150, 10, 'PUBLIC READ','Allow other users to use your view with no permissions to alter.');

 tips.domain_user          = newTip(10, 0, 150, 10, 'DOMAIN USER','Authenticates the username against a Domain. This means that you can use your workstation login.');

 tips.pkg_info_short_desc  = newTip(-150, 20, 150, 10, 'SHORT DESCRIPTION','Describe the meaning of the package name.');

 tips.pkg_info_overview    = newTip(-150, 20, 150, 10, 'PACKAGE OVERVIEW','Describe in a paragraph what does the package do.<br>NOTE: You have to do this only once!');

 tips.build_environment    = newTip(-150, 20, 150, 10, 'BUILD ENVIRONMENT','Select which build environments are used to build this package.');

 tips.ut_test_type         = newTip(-150, 0, 150, 10, 'TEST TYPE','Describes the type of test performed.');

 tips.ut_passed            = newTip(-150, 0, 150, 10, 'PASSED # / Total','Number of tests passed and total number of tests performed (e.g. 9/10).<br>For Coverage test, give the total line coverage for the package in %.');

 tips.ut_summary           = newTip(-150, 0, 150, 10, 'TEST SUMMARY','It is optional if the test document is attached.<br>If not, detail the setup, stimulus, and what to check for.');

 tips.ut_review_comments   = newTip(-150, 0, 150, 10, 'REVIEW COMMENTS','If the package is not accepted, this will be the Issue number that contains the details of what needs to be done.');

 tips.v_ext                = newTip(-150, 0, 150, 10, 'VERSION EXTENSION','Supply version extension if required. <br>(e.g. .mas, .syd, .project)');

 tips.existingVersion      = newTip(-150, 20, 150, 10, 'EXISTING VERSION','Select a version from a list of existing versions.');

 tips.Codestriker          = newTip(-150, 20, 150, 10, 'CODESTRIKER','ClearCase Only.<br>Use this jats command to make a difference report for uploading to codestriker when creating a new code review topic.');

 tips.BeyondCompare        = newTip(-150, 20, 150, 10, 'BEYOND COMPARE','Use this jats command to manually inspect and compare two versions of the package using Beyond Compare.');

 tips.JatsTest             = newTip(-150, 20, 150, 10, 'JATS TEST','Use this jats command to test-build a package before release.');

 tips.PreviousSignificantVcsTag= newTip(-150, 20, 200, 10, 'PREVIOUS SIGNIFICANT VCS TAG',

                                                           'This is a vcs tag of an ancestor version immediately preceding a significant (non-ripple) change that led to the current package version.'+

                                                           '<br><br>NOTE:<br>Derivation of this has no sensitivity to the selected release.');

 tips.PreviousVcsTag       = newTip(-150, 20, 150, 10, 'PREVIOUS VCS TAG','This is a vcs tag of the immediate ancestor version to the current package version.');

 tips.AdditionPending      = newTip(-150, 20, 160, 10, 'ADDITION PENDING', 'This item is pending approval in Release B (the destination release).<p></p><p>'+

                                                                           'Go to the Pending Tab in Release B to approve this and other similar items.</p>');

 tips.RemovalPending       = newTip(-150, 20, 160, 10,  'REMOVAL PENDING',

                                                        'This items removal is pending approval in Release B (the destination release).<p></p><p>'+

                                                        'Go to the Pending Tab in Release B to approve this and other similar items.</p>');

 tips.Top10ChangeCounts    = newTip(-150, 20, 250, 10,  'CHANGE COUNTS',

                                                        'These counts include changes to these packages that may have occured in other releases.<p></p><p>'+

                                                        'The selected and enclosing release is used just to select names of packages, '+

                                                        'and extensions of package versions that are to be included in the metric data set.</p>');

 tips.svn_tag              = newTip(-180, 20, 180, 10,  'SUBVERSION TAG',

                                                        'Enter the Subversion tag. This is a named directory within the packages \'tags\' directory. It may be pegged.');

 tips.svn_source_path      = newTip(-180, 20, 180, 10,  'SUBVERSION SOURCE PATH',

                                                        'Enter the Subversion path to the development branch of the package. <p>The first element will be a symbolic repository reference. '+

                                                        '<p>The last element will be the packages development branch - which may be the trunk.');

 tips.pegged_version       = newTip(-100, 10, 400, 10,  'PEGGED VERSION',

                                                           'If a package version in a release is denoted as pegged, it means: '+

                                                           '<p>The release will use the package at the pegged version, and the package will '+

                                                           'not be ripple built within the release.</p>'+

                                                           '<p>The release will NOT have to contain the dependecies of the pegged package.</p>'+

                                                           '<p>The state (good or otherwise) of the package\'s dependencies will have no effect upon the '+

                                                           'release, or the ability to build packages that depend upon it.</p>' +

                                                           '<p></P><p>Modifying this setting can only be done when editing the ripple properties of an official/released package version</p>');

 tips.advisory_ripple_version= newTip(-100, 10, 400, 10,'ADVISORY RIPPLE VERSION',

                                                           'If a package in a release is marked with advisory ripple, it means that when '+

                                                           'a new version of the package is made official (i.e. released), it will not cause '+

                                                           'higher level packages that depend upon it to be rippled.' +

                                                           '<p></P><p>Modifying this setting can only be done when editing the ripple properties of an official/released package version</p>');

 tips.err1 = newTip(10, 0, 150, 10, 'VERSION NOT FOUND','Specified version was never used before and it will be CREATED for this package.');

 tips.err3 = newTip(10, 0, 150, 10, 'DUPLICATE PACKAGE NAME','Duplicate package names are found. First occurrence will be used and other duplicates will be IGNORED.');

 tips.err4 = newTip(10, 0, 150, 10, 'CIRCULAR&nbsp;DEPENDENCY','This package is dependent on the same package you are trying to update. It could be directly dependent or through a few levels of dependencies.<br>This package will be IGNORED.');

 tips.err5 = newTip(10, 0, 150, 10, 'EXISTS&nbsp;IN&nbsp;THIS&nbsp;RELEASE','This package already exists in your release.<br>This package will be IGNORED.');

 tips.firefox_root_cause = newTip(-300, 10, 400, 100,'ATTENTION FIREFOX USERS',

                                                       'Downloading local files via a UNC path is a security hazard and Firefox (silently) ignores such links by default.<p>'+

                                                       'Please follow this link to read the instructions on how to enable local file downloads in the Firefox browser.');

 tips.RepRDS_pv = newTip(10, 0, 150, 10, 'PACKAGE VERSION FILTER','Specify what type of Release Manager Package Versions to enquire upon, and whether to include versions that do not (yet) have any issues assigned to them.');

 tips.RepRDS_iss = newTip(10, 0, 150, 10, 'ISSUE LIST FILTER','Specify which Release Manager issue list(s) to consider.');

 tips.RepRDS_trav = newTip(10, 0, 350, 10, 'FROM RELEASED FILTER','These options are only relevant when the "From Released" checkbox is checked. '+

                                              '<p>Selecting to traverse ripples forces the report to look back over the history of released package versions until it finds '+

                                              'versions that were not ripple built. It will list the issues it finds in those found versions against the latest ripple versions '+

                                              'in the release.</p><p>Selecting this option can drammatically slow down report generation. To counter this, users are advised to '+

                                              'set the date limit back in time to no more than a few weeks or perhaps 1 month (the default limit)</p>');

 tips.JatsExtraction_SVN  = stdTip(250,'Subversion', 'Various extraction commands.<br>Choose a command that suits the current requirements.' +

                                                     '<p>Default - suits most requirements' +

                                                     '<br>Tag - Trace Tag back to development branch' +

                                                     '<br>Tip - Tip of the development branch' +

                                                     '<br>Work - Default' +

                                                     '<br>Exact - Extract the tagged instance' );

 tips.JatsExtraction_CC   = stdTip(200, 'ClearCase', 'Various extraction commands.<br>Choose a command that suits the current requirements.' +

                                                     '<p>A Project Branch will be displayed if configured, but it may not be suitable for all packages.');

 tips.JatsExtraction_CVS  = stdTip(200,'CVS','Various extraction commands.<br>Choose a command that suits the current requirements.' );

 tips.JatsExtraction_     = stdTip(200,'Unknown Version Control System','Various extraction commands.<br>Choose a command that suits the current requirements.' );

 tips.ad_action       = stdTip(200, 'ACTION', 'The internal name of the access control element.' );

 tips.ad_description  = stdTip(200, 'DESCRIPTION', 'A description of the access control element.' );

 tips.ad_access       = stdTip(200, 'Project Independent Permissions', 'These are the basic permissions before project specific control elements have been applied.' );

 tips.ad_data         = stdTip(200, 'Project Specific Permissions', 'These are the permissions after project-specfic control elements have been applied.' );

 tips.ad_active       = stdTip(200, 'ACTIVE', 'The associated action should be available.<br>Controls do not need to visible for an action to be available.' );

 tips.ad_visible      = stdTip(200, 'VISIBLE', 'The associated action may have a control button that is shown to the user.<br>If the action is not active then the action should not be available to the user.' );

 // TIP TEMPLATE

 template = '<table bgcolor="#000000" cellpadding="1" cellspacing="0" width="%2%" border="0">' +

  '<tr><td><table bgcolor="#FFFFCC" cellpadding="2" cellspacing="0" width="100%" border="0">' +

  '<tr><td height="%3%" class="tipClass">%4%</td></tr></table></td></tr></table>';

}