Thread: [CS-Project-svn_notify] SF.net SVN: cs-project: [678] trunk/templates/help

Brought to you by: crazedsanity

cs-project-svn_notify

[CS-Project-svn_notify] SF.net SVN: cs-project: [678] trunk/templates/help

From: <cra...@us...> - 2007-11-23 18:59:39

Revision: 678
          http://cs-project.svn.sourceforge.net/cs-project/?rev=678&view=rev
Author:   crazedsanity
Date:     2007-11-23 10:58:23 -0800 (Fri, 23 Nov 2007)

Log Message:
-----------
help for tag modifiers.

Added Paths:
-----------
    trunk/templates/help/tags/
    trunk/templates/help/tags/modifier.content.tmpl

Added: trunk/templates/help/tags/modifier.content.tmpl
===================================================================
--- trunk/templates/help/tags/modifier.content.tmpl	                        (rev 0)
+++ trunk/templates/help/tags/modifier.content.tmpl	2007-11-23 18:58:23 UTC (rev 678)
@@ -0,0 +1,25 @@
+
+
+<h2>What is a tag modifier?</h2>
+
+This value comes into play only when an issue is initially created.  The modifier is combined from all the selected tags and added to 9 (base priority) to determine what 
+the initial priority is.  For instance, if the "critical" tag is the only tag added to a new issue, the new issue's beginning priority will be set to 4, assuming the 
+modifier for "critical" is set to -5.
+
+<hr>
+
+<h2>Why use negative values?</h2>
+
+This is done for logical simplicity.  The most critical issue has a priority of 0, while unimportant issues are at 9.  To increase the importance, subtraction must take 
+place.
+
+<hr>
+
+<h2>Why are some tag modifiers negative, some positive, and some zero?</h2>
+
+A tag with a negative value means adding this tag to an issue makes it more important.  A tag with a positive value has the opposite effect; adding a positive tag means 
+it lessens the importance. <br><br>
+
+<b>Example:</b> <i>Suppose a user submits a critical bug that causes massive data corruption, but the user can't recreate the problem.  The issue is created with the tags 
+"critical" (-5) and "cannot reproduce" (+5).</i>
+


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

[CS-Project-svn_notify] SF.net SVN: cs-project: [708] trunk/templates/help

From: <cra...@us...> - 2007-12-19 01:30:46

Revision: 708
          http://cs-project.svn.sourceforge.net/cs-project/?rev=708&view=rev
Author:   crazedsanity
Date:     2007-12-18 17:30:43 -0800 (Tue, 18 Dec 2007)

Log Message:
-----------
Updated help pages.

Modified Paths:
--------------
    trunk/templates/help/index.content.tmpl

Added Paths:
-----------
    trunk/templates/help/helpdesk/
    trunk/templates/help/helpdesk/assigned.content.tmpl
    trunk/templates/help/helpdesk/external_link.content.tmpl
    trunk/templates/help/helpdesk/helpdesk_links.shared.tmpl
    trunk/templates/help/helpdesk/index.content.tmpl
    trunk/templates/help/helpdesk/notified_users.content.tmpl
    trunk/templates/help/helpdesk/priority.content.tmpl
    trunk/templates/help/helpdesk/project_linkage.content.tmpl
    trunk/templates/help/helpdesk/submit_buttons.content.tmpl
    trunk/templates/help/tags/index.content.tmpl

Property Changed:
----------------
    trunk/templates/help/tags/modifier.content.tmpl

Added: trunk/templates/help/helpdesk/assigned.content.tmpl
===================================================================
--- trunk/templates/help/helpdesk/assigned.content.tmpl	                        (rev 0)
+++ trunk/templates/help/helpdesk/assigned.content.tmpl	2007-12-19 01:30:43 UTC (rev 708)
@@ -0,0 +1,9 @@
+
+
+
+<h2>Assigned User</h2>
+
+This is the user that has been assigned the given issue.  Besides administrators, they are the only user that is allowed to solve the issue.
+
+
+{helpdesk_links}
\ No newline at end of file


Property changes on: trunk/templates/help/helpdesk/assigned.content.tmpl
___________________________________________________________________
Name: svn:eol-style
   + native

Added: trunk/templates/help/helpdesk/external_link.content.tmpl
===================================================================
--- trunk/templates/help/helpdesk/external_link.content.tmpl	                        (rev 0)
+++ trunk/templates/help/helpdesk/external_link.content.tmpl	2007-12-19 01:30:43 UTC (rev 708)
@@ -0,0 +1,7 @@
+<h2>External Links</h2>
+
+When viewing a Helpdesk Issue, there is an "External Link" provided for developers, so they may send a link to users who are not registered.  This URL allows 
+non-registered users to view the link without worrying about having to login.<BR><BR>
+
+
+{helpdesk_links}
\ No newline at end of file


Property changes on: trunk/templates/help/helpdesk/external_link.content.tmpl
___________________________________________________________________
Name: svn:eol-style
   + native

Added: trunk/templates/help/helpdesk/helpdesk_links.shared.tmpl
===================================================================
--- trunk/templates/help/helpdesk/helpdesk_links.shared.tmpl	                        (rev 0)
+++ trunk/templates/help/helpdesk/helpdesk_links.shared.tmpl	2007-12-19 01:30:43 UTC (rev 708)
@@ -0,0 +1,13 @@
+
+<br /><br />
+<h3>Topics:</h3>
+
+<a href="/help/helpdesk"><b>Helpdesk</b></a>
+<ul>
+	<li><a href="/help/helpdesk/assigned">Assigned User</a></li>
+	<li><a href="/help/helpdesk/external_link">External Link</a></li>
+	<li><a href="/help/helpdesk/notified_users">Notified Users</a></li>
+	<li><a href="/help/helpdesk/priority">Priority</a></li>
+	<li><a href="/help/helpdesk/project_linkage">Project Linkage</a></li>
+	<li><a href="/help/helpdesk/submit_buttons">Submit Buttons</a></li>
+</ul>
\ No newline at end of file


Property changes on: trunk/templates/help/helpdesk/helpdesk_links.shared.tmpl
___________________________________________________________________
Name: svn:eol-style
   + native

Added: trunk/templates/help/helpdesk/index.content.tmpl
===================================================================
--- trunk/templates/help/helpdesk/index.content.tmpl	                        (rev 0)
+++ trunk/templates/help/helpdesk/index.content.tmpl	2007-12-19 01:30:43 UTC (rev 708)
@@ -0,0 +1,9 @@
+
+
+<h2>The Helpdesk</h2>
+
+The Helpdesk is a system used to list issues that occur within a given project, whether it is client software, a web application, or just about anything else.  Issues 
+are created to notify developers of bugs or request new features.  Developers and users are notified whenever there is a change, or when the issue has been completed,
+so everybody concerned is kept up-to-date.<BR><BR>
+
+{helpdesk_links}
\ No newline at end of file


Property changes on: trunk/templates/help/helpdesk/index.content.tmpl
___________________________________________________________________
Name: svn:eol-style
   + native

Added: trunk/templates/help/helpdesk/notified_users.content.tmpl
===================================================================
--- trunk/templates/help/helpdesk/notified_users.content.tmpl	                        (rev 0)
+++ trunk/templates/help/helpdesk/notified_users.content.tmpl	2007-12-19 01:30:43 UTC (rev 708)
@@ -0,0 +1,8 @@
+
+
+
+<h2>Notified Users</h2>
+
+This lists all the users that will be notified of changes to an issue.
+
+{helpdesk_links}
\ No newline at end of file


Property changes on: trunk/templates/help/helpdesk/notified_users.content.tmpl
___________________________________________________________________
Name: svn:eol-style
   + native

Added: trunk/templates/help/helpdesk/priority.content.tmpl
===================================================================
--- trunk/templates/help/helpdesk/priority.content.tmpl	                        (rev 0)
+++ trunk/templates/help/helpdesk/priority.content.tmpl	2007-12-19 01:30:43 UTC (rev 708)
@@ -0,0 +1,21 @@
+
+
+
+<h2>Issue Priority</h2>
+
+Issue priority indicates how important the issue is in and of itself, or as it pertains to a particular project.  The meanings of priorities are 
+roughly as follows:
+<br />
+
+<pre>
+	0   - Critical (causes crash, fatal error, or data corruption)
+	1   - Very Important (no crash, but causes fatal error or data corruption)
+	2-8 - Varying degrees of importance
+	9   - New, not important, or superficial
+</pre><BR>
+
+The priority of an issue is initially based upon the <a href="/help/tags/modifier">modifiers of tags</a> that have been assigned to it.  After 
+creation, registered users can modify this to be whatever they desire.
+
+
+{helpdesk_links}
\ No newline at end of file


Property changes on: trunk/templates/help/helpdesk/priority.content.tmpl
___________________________________________________________________
Name: svn:eol-style
   + native

Added: trunk/templates/help/helpdesk/project_linkage.content.tmpl
===================================================================
--- trunk/templates/help/helpdesk/project_linkage.content.tmpl	                        (rev 0)
+++ trunk/templates/help/helpdesk/project_linkage.content.tmpl	2007-12-19 01:30:43 UTC (rev 708)
@@ -0,0 +1,24 @@
+
+
+<h2>Project Linkage</h2>
+
+Helpdesk Issues are linked to projects to help developers and other registered users understand how they pertain to a project.  
+Take this project hierarchy for example:
+
+<pre>
+Software Project			(running)
+  +--> Version 1.x			(running)
+  |      +--> v1.1			(running)
+  |      +--> v1.2			(pending)
+  +--> Version 2.x			(pending)
+         +--> v2.1			(pending)
+</pre>
+
+
+When somebody creates a new issue, it is important to link this to the appropriate project.  If a bug is being reported, and 
+it is linked to "v1.1", developers will immediately know that it exists in version 1.1 (and possibly in later versions).  
+Assigning the same bug to "Version 2.x" would indicate that it is in the newest version of the software.  This makes a very 
+important difference to the developers, as it indicates where the problem has occurred.   
+
+
+{helpdesk_links}
\ No newline at end of file


Property changes on: trunk/templates/help/helpdesk/project_linkage.content.tmpl
___________________________________________________________________
Name: svn:eol-style
   + native

Added: trunk/templates/help/helpdesk/submit_buttons.content.tmpl
===================================================================
--- trunk/templates/help/helpdesk/submit_buttons.content.tmpl	                        (rev 0)
+++ trunk/templates/help/helpdesk/submit_buttons.content.tmpl	2007-12-19 01:30:43 UTC (rev 708)
@@ -0,0 +1,14 @@
+
+
+<h2>Submit Buttons</h2>
+
+The submit buttons on an issue work as follows:
+
+<ul>
+	<li>Remark: add a remark to the issue (requires info in the "Remark" box).</li>
+	<li>Modify: updates the issue (changes to priority or assigned user).</li>
+	<li>Solve: completes the issue after entering the solution (requires info in the "Solution" box).</li>
+	<li>Re-Open: opens the issue for modification and logs the action.</li>
+</ul>
+
+{helpdesk_links}


Property changes on: trunk/templates/help/helpdesk/submit_buttons.content.tmpl
___________________________________________________________________
Name: svn:eol-style
   + native

Modified: trunk/templates/help/index.content.tmpl
===================================================================
--- trunk/templates/help/index.content.tmpl	2007-12-19 00:14:45 UTC (rev 707)
+++ trunk/templates/help/index.content.tmpl	2007-12-19 01:30:43 UTC (rev 708)
@@ -5,4 +5,6 @@
 
 <ul>
 	<li><a href="/help/lost_password">Lost Password</a></li>
+	<li><a href="/help/helpdesk">Helpdesk</a></li>
+	<li><a href="/help/tags">Tags</a></li>
 </ul>

Added: trunk/templates/help/tags/index.content.tmpl
===================================================================
--- trunk/templates/help/tags/index.content.tmpl	                        (rev 0)
+++ trunk/templates/help/tags/index.content.tmpl	2007-12-19 01:30:43 UTC (rev 708)
@@ -0,0 +1,6 @@
+
+
+<h2>What is a Tag?</h2>
+
+A tag is essentially something to help give more information at-a-glance about a given record.  At creation time, a Helpdesk Issue can be linked to several different 
+tags with different <a href="/help/tags/modifier">modifiers</a>, which helps to determine <a href="/help/helpdesk/priority">priority</a>.
\ No newline at end of file


Property changes on: trunk/templates/help/tags/index.content.tmpl
___________________________________________________________________
Name: svn:eol-style
   + native


Property changes on: trunk/templates/help/tags/modifier.content.tmpl
___________________________________________________________________
Name: svn:eol-style
   + native


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

[CS-Project-svn_notify] SF.net SVN: cs-project: [721] trunk/templates/help

From: <cra...@us...> - 2007-12-27 21:07:03

Revision: 721
          http://cs-project.svn.sourceforge.net/cs-project/?rev=721&view=rev
Author:   crazedsanity
Date:     2007-12-27 13:06:59 -0800 (Thu, 27 Dec 2007)

Log Message:
-----------
Specialized header, footer, & main template for help.

Added Paths:
-----------
    trunk/templates/help/footer.shared.tmpl
    trunk/templates/help/header.shared.tmpl
    trunk/templates/help/main.shared.tmpl

Copied: trunk/templates/help/footer.shared.tmpl (from rev 720, trunk/templates/footer.shared.tmpl)
===================================================================
--- trunk/templates/help/footer.shared.tmpl	                        (rev 0)
+++ trunk/templates/help/footer.shared.tmpl	2007-12-27 21:06:59 UTC (rev 721)
@@ -0,0 +1,3 @@
+
+</body>
+</html>
\ No newline at end of file

Copied: trunk/templates/help/header.shared.tmpl (from rev 720, trunk/templates/header.shared.tmpl)
===================================================================
--- trunk/templates/help/header.shared.tmpl	                        (rev 0)
+++ trunk/templates/help/header.shared.tmpl	2007-12-27 21:06:59 UTC (rev 721)
@@ -0,0 +1,16 @@
+<html lang='en'>
+	<head>
+	<title>{html_title}</title>
+	<link rel=stylesheet type='text/css' href='/css/common.css'>
+	<script language="javascript" src="/js/cs-project.js" type="text/javascript"></script>
+	<script language="javascript" src="/js/prototype.js" type="text/javascript"></script>
+	<script language="javascript" src="/js/scriptaculous.js" type="text/javascript"></script>
+	</head>
+	
+<body bgcolor="#e0e0e0" style="margin:1px" {HTMLBODY_EXTRA}>
+
+<table>
+<tr>
+	<td>{error_msg}</td>
+</tr>
+</table>

Copied: trunk/templates/help/main.shared.tmpl (from rev 720, trunk/templates/main.shared.tmpl)
===================================================================
--- trunk/templates/help/main.shared.tmpl	                        (rev 0)
+++ trunk/templates/help/main.shared.tmpl	2007-12-27 21:06:59 UTC (rev 721)
@@ -0,0 +1,8 @@
+{header}
+
+<div id="outerContent" style="padding-left: 20px; padding-right:50px;;">
+	<div id="content" style="border:dotted #000 1px;">
+		{content}
+	</div>
+</div>
+{footer}
\ No newline at end of file


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.