From dc84ca7963205f8abf736a9e3be0ee402eae4fc4 Mon Sep 17 00:00:00 2001
From: Jared Hancock <jared@osticket.com>
Date: Thu, 8 May 2014 15:46:02 -0500
Subject: [PATCH] review: Final review of new help tip content
---
.../help/tips/dashboard.system_logs.yaml | 13 ++--
.../i18n/en_US/help/tips/settings.pages.yaml | 4 +-
.../i18n/en_US/help/tips/settings.system.yaml | 69 +++++++++----------
.../i18n/en_US/help/tips/settings.ticket.yaml | 45 +++++-------
include/staff/settings-system.inc.php | 6 +-
include/staff/settings-tickets.inc.php | 8 ++-
6 files changed, 64 insertions(+), 81 deletions(-)
diff --git a/include/i18n/en_US/help/tips/dashboard.system_logs.yaml b/include/i18n/en_US/help/tips/dashboard.system_logs.yaml
index 7667d5f4a..cfafe4f49 100644
--- a/include/i18n/en_US/help/tips/dashboard.system_logs.yaml
+++ b/include/i18n/en_US/help/tips/dashboard.system_logs.yaml
@@ -16,9 +16,8 @@
system_logs:
title: System Logs
content: >
- If there is anything that is not working correctly, this is the place to
- start. This is where you will find any troubleshooting related logging
- activity (e.g., Errors, Warnings, or Bugs).
+ This is where you will find any troubleshooting related logging
+ activity (e.g., Errors, Warnings, or Bugs).
links:
- title: Customize what type of activity is logged by changing the <br /><span class="doc-desc-title">Default Log Level</span>.
href: /scp/settings.php?t=system
@@ -26,15 +25,15 @@ system_logs:
date_span:
title: Date Span
content: >
- Narrow your calendar range that you would like to view in the <span
+ Select your calendar range that you would like to view in the <span
class="doc-desc-title">System Logs</span>.
type:
title: Type
content: >
- Choose an option to narrow your focus on a specific type of activity.
- <span class="doc-desc-opt">Debug</span> represents the least
- severity, and <span class="doc-desc-opt">Error</span> represents
+ Choose an option to narrow your focus on a specific type of activity.
+ <span class="doc-desc-opt">Debug</span> represents the least
+ severity, and <span class="doc-desc-opt">Error</span> represents
the greatest severity.
showing_logs:
diff --git a/include/i18n/en_US/help/tips/settings.pages.yaml b/include/i18n/en_US/help/tips/settings.pages.yaml
index 45b2e6091..b019aeda1 100644
--- a/include/i18n/en_US/help/tips/settings.pages.yaml
+++ b/include/i18n/en_US/help/tips/settings.pages.yaml
@@ -60,6 +60,6 @@ upload_a_new_logo:
title: Upload a new logo
content: >
Choose an image in the .gif, .jpg or .png formats. We will proportionally
- resize the display of your image. We will not however resize the image’s
+ resize the display of your image. We will not, however, resize the image’s
data. Therefore, to speed load times, it is recommended that you keep your
- image close to the default image (817x170).
+ image close to the default image size (817px × 170px).
diff --git a/include/i18n/en_US/help/tips/settings.system.yaml b/include/i18n/en_US/help/tips/settings.system.yaml
index 826d8de46..fd89cbaea 100644
--- a/include/i18n/en_US/help/tips/settings.system.yaml
+++ b/include/i18n/en_US/help/tips/settings.system.yaml
@@ -13,18 +13,13 @@
# must match the HTML #ids put into the page template.
#
---
-general_settings:
- title: General Settings
- content: >
- Offline mode will disable client interface and only allow admins to login to
- Staff Control Panel.
-
helpdesk_status:
title: Helpdesk Status
content: >
- If the status is changed to Offline, the client interface will be disabled.
- This does not however affect any normal Agent interaction with the Agent
- Panel.
+ If the status is changed to <span
+ class="doc-desc-opt">Offline</span>, the client interface will be
+ disabled. This does not however affect any normal Agent interaction
+ with the Agent Panel.
helpdesk_url:
title: Helpdesk URL
@@ -35,63 +30,61 @@ helpdesk_url:
helpdesk_name_title:
title: Helpdesk Name/Title
content: >
- This appears in the browser tab when a <span class="doc-desc-title">client
- </span> goes to your help desk. If your help desk page is bookmarked (i.e.,
- in your favorites), this will be the title/name of the site page.
+ This is the title that appears in the browser tab. If your help desk
+ page is bookmarked, this will be the title/name of the site page.
default_department:
title: Default Department
content: >
- Determines the default <span class="doc-desc-title">department</span> for
- tickets submitted that do not have a department auto-assigned by help topic
- or incoming email.
+ Choose a default <span class="doc-desc-title">department</span>
+ for tickets that are not automatically routed to a department.
+ <br/><br/>
+ Ticket can be routed base on help topic, incoming email and ticket
+ filter settings.
default_page_size:
title: Default Page Size
content: >
- How many Tickets would you like to see per page in the Ticket Tables in the
- Staff Panel? Each Agent can also customize this number for their own
+ Choose the number of items shown per page in the Ticket Queues in the
+ Staff Panel. Each Agent can also customize this number for their own
account under <span class="doc-desc-title">My Preferences</span>.
default_log_level:
title: Default Log Level
content: >
- Determines to what minimum level of issues that will be recorded in the
+ Determine the minimum level of issues which will be recorded in the
<span class="doc-desc-title">system log</span>. <span
class="doc-desc-opt">Debug</span> represents the least severity, and <span
- class="doc-desc-opt">Error</span> represents the greatest severity. So, if
- you want to see all issues in the <span class="doc-desc-title">System
- Logs</span>, choose <span class="doc-desc-opt">Debug</span>.
+ class="doc-desc-opt">Error</span> represents the greatest severity.
+ For example, if you want to see all issues in the <span
+ class="doc-desc-title">System Logs</span>, choose <span
+ class="doc-desc-opt">Debug</span>.
purge_logs:
title: Purge Logs
content: >
- How long would you like to store the <span class="doc-desc-title">System
- Logs</span> until they are deleted? You may also choose to <span
- class="doc-desc-opt">Never Purge Logs</span>.
+ Determine how long you would like to keep <span
+ class="doc-desc-title">System Logs</span> before they are deleted.
default_name_formatting:
title: Default Name Formatting
content: >
- Formatting technique used to format names throughout the system.
- Email templates will use the format for names if no other format is
- specified in the place holder.
+ Choose a format for names throughout the system. Email templates
+ will use it for names if no other format is specified in the
+ variable.
-# Date and time options
-date_and_time:
- title: Localized Date Formats
- You may choose from various formats in which names throughout the system
- will be displayed. This is also the format that will be used by Emails if
- no other format is established in the <span class="doc-desc-title">Email
- Template</span>.
+ links:
+ - title: Supported Email Template Variables
+ href: http://osticket.com/wiki/Email_templates
+# Date and time options
date_time_options:
title: Date & Time Options
content: >
- The following settings will alter the Date & Time settings Clients. You can
- change how these appear by following the PHP date format characters. The
- following examples are not realtime; they simply display the format for the
- values in the text input fields to their left.
+ The following settings define the Date & Time settings for
+ Clients. You can change how these appear by following the PHP date
+ format characters. The dates shown below simply illustrate the
+ result of their corresponding values.
links:
- title: See the PHP Date Formatting Table
href: http://www.php.net/manual/en/function.date.php
diff --git a/include/i18n/en_US/help/tips/settings.ticket.yaml b/include/i18n/en_US/help/tips/settings.ticket.yaml
index b47755b4e..b9d3fee67 100644
--- a/include/i18n/en_US/help/tips/settings.ticket.yaml
+++ b/include/i18n/en_US/help/tips/settings.ticket.yaml
@@ -13,26 +13,10 @@
# must match the HTML #ids put into the page template.
#
---
-global_ticket_settings_options:
- title: Global Ticket Settings & Options
- content: >
- These settings are <span class="doc-desc-title">global,</span> in that they
- apply until they are overridden by other possible system settings (e.g., a
- <span class="doc-desc-title">Department’s SLA Plan</span> overrides the
- <span class="doc-desc-title">Global Default SLA Plan</span> set below).
- links:
- - title: Select a Department to edit its Default SLA Plan
- href: /scp/departments.php
-
-ticket_ids:
- title: Ticket IDs
- content: >
- Choose between Random (Recommended) or Sequential numbers for tickets.
-
default_sla:
title: Default SLA
content: >
- Choose the default Service Level Agreement to manage how long a Ticket
+ Choose the default Service Level Agreement to manage how long a ticket
can remain Open before it is rendered Overdue.
links:
- title: Create more SLA Plans
@@ -41,25 +25,28 @@ default_sla:
default_priority:
title: Default Priority
content: >
- Choose between Low, Normal, High & Emergency for all tickets not
- auto-assigned to a Help Topic or Department.
+ Choose a default <span class="doc-desc-title">priority</span> for
+ tickets not assigned a priority automatically.
+ <br/><br/>
+ Prioriy can be assigned via the help topic, routed department, or
+ ticket filter settings.
maximum_open_tickets:
title: Maximum Open Tickets
content: >
Enter the maximum <em>number</em> of <span class="doc-desc-title">Open
- Tickets</span> a Client is permitted to have simultaneously. This will help protect
+ Tickets</span> a Client is permitted to have simultaneously. This will help protect
against spam and enable email flood control. Enter <span class="doc-desc-opt">0
</span> if you prefer to disable this limitation.
agent_collision_avoidance:
title: Agent Collision Avoidance
content: >
- Enter the length of time after an Agent stops ticket-response activity that a
- lockout period takes affect. This lockout prevents other Agents from sending
- a ticket response to the Client. It does not however prevent others from
- composing a draft. If the locking Agent sends their response, then any other
- Agent’s draft will be deleted. Enter <span class="doc-desc-opt">0</span>
+ Enter the length of time after an Agent stops ticket-response activity that a
+ lockout period takes affect. This lockout prevents other Agents from sending
+ a ticket response to the Client. It does not however prevent others from
+ composing a draft. If the locking Agent sends their response, then any other
+ Agent’s draft will be deleted. Enter <span class="doc-desc-opt">0</span>
to disable the lockout feature.
email_ticket_priority:
@@ -76,7 +63,7 @@ show_related_tickets:
human_verification:
title: Human Verification
content: >
- Enable CAPTCHA on the Client Portal to verify an incoming ticket is the
+ Enable CAPTCHA on the Client Portal to verify an incoming ticket is the
result of human activity.
claim_tickets:
@@ -94,9 +81,9 @@ assigned_tickets:
answered_tickets:
title: Answered Tickets
content: >
- Show tickets that have been answered by an Agent in the
- <span class="doc-desc-title">Open Queue</span>. If this is not enabled,
- answered tickets will be display in the <span class="doc-desc-title">Answered
+ Show tickets that have been answered by an Agent in the
+ <span class="doc-desc-title">Open Queue</span>. If this is not enabled,
+ answered tickets will be display in the <span class="doc-desc-title">Answered
Tickets Queue</span>.
staff_identity_masking:
diff --git a/include/staff/settings-system.inc.php b/include/staff/settings-system.inc.php
index 77c80619b..f7eb33822 100644
--- a/include/staff/settings-system.inc.php
+++ b/include/staff/settings-system.inc.php
@@ -12,7 +12,7 @@ $gmtime = Misc::gmtime();
<tr>
<th colspan="2">
<h4>System Settings & Preferences</h4>
- <em><b>General Settings</b> <i class="help-tip icon-question-sign" href="#general_settings"></i></em>
+ <em><b>General Settings</b></em>
</th>
</tr>
</thead>
@@ -21,10 +21,12 @@ $gmtime = Misc::gmtime();
<tr>
<td width="220" class="required">Helpdesk Status:</td>
<td>
+ <span>
<label><input type="radio" name="isonline" value="1" <?php echo $config['isonline']?'checked="checked"':''; ?> /> <b>Online</b> </label>
<label><input type="radio" name="isonline" value="0" <?php echo !$config['isonline']?'checked="checked"':''; ?> /> <b>Offline</b></label>
- <font class="error"> <?php echo $config['isoffline']?'osTicket offline':''; ?></font>
+ <font class="error"><?php echo $config['isoffline']?'osTicket offline':''; ?></font>
<i class="help-tip icon-question-sign" href="#helpdesk_status"></i>
+ </span>
</td>
</tr>
<tr>
diff --git a/include/staff/settings-tickets.inc.php b/include/staff/settings-tickets.inc.php
index d970bc959..84ae8d8b6 100644
--- a/include/staff/settings-tickets.inc.php
+++ b/include/staff/settings-tickets.inc.php
@@ -11,8 +11,8 @@ if(!($maxfileuploads=ini_get('max_file_uploads')))
<thead>
<tr>
<th colspan="2">
- <h4>Ticket Settings</h4>
- <em>Global ticket settings and options. <i class="help-tip icon-question-sign" href="#global_ticket_settings_options"></i></em>
+ <h4>Global Ticket Settings</h4>
+ <em>System-wide default ticket settings and options.</em>
</th>
</tr>
</thead>
@@ -22,7 +22,7 @@ if(!($maxfileuploads=ini_get('max_file_uploads')))
<input type="radio" name="random_ticket_ids" value="0" <?php echo !$config['random_ticket_ids']?'checked="checked"':''; ?> />
Sequential
<input type="radio" name="random_ticket_ids" value="1" <?php echo $config['random_ticket_ids']?'checked="checked"':''; ?> />
- Random <em>(highly recommended)</em> <i class="help-tip icon-question-sign" href="#ticket_ids"></i>
+ Random
</td>
</tr>
@@ -31,6 +31,7 @@ if(!($maxfileuploads=ini_get('max_file_uploads')))
Default SLA:
</td>
<td>
+ <span>
<select name="default_sla_id">
<option value="0">— None —</option>
<?php
@@ -45,6 +46,7 @@ if(!($maxfileuploads=ini_get('max_file_uploads')))
?>
</select>
<span class="error">* <?php echo $errors['default_sla_id']; ?></span> <i class="help-tip icon-question-sign" href="#default_sla"></i>
+ </span>
</td>
</tr>
<tr>
--
GitLab