MyStrings Plugin

From Sit

Jump to: navigation, search
MyStrings Plugin
Plugin.png
Current version v0.01
Maintainer Ivan Lucas
Release status stable
This plugin is stable and ready for use on your production system.


This example plugin uses plugin internationalisation to change all mentions of the word 'Customer' within SiT! to 'Client'. By using a plugin to do this we ensure that strings are not lost when SiT! is upgraded.

mystrings.php

<?php
$PLUGININFO['mystrings']['version'] = 0.01;
$PLUGININFO['mystrings']['description'] = 'MyStrings';
$PLUGININFO['mystrings']['author'] = 'Ivan Lucas';
$PLUGININFO['mystrings']['legal'] = 'Copyright © 2009 Ivan Lucas. GPL v2 or later';
$PLUGININFO['mystrings']['sitminversion'] = 3.50;
$PLUGININFO['mystrings']['sitmaxversion'] = 3.80;

// This plugin makes no functional changes to SiT!
// The plugin has a custom language file that overrides some of the strings that
// come with SIT!

// This example simply replaces all mention of the word 'Customer' with 'Client'
// but you can modify and build upon this to change any of the strings within
// SiT to meet your individiual needs.

// Note that this example only replaces english (british) strings, if you intend
// for your app to be international you should repeat this process with the other
// language files from the main /i18n/ directory.  (Of course this requires you
// to be multi-lingual - good luck)

?>


Note: You will need to create the directory mystrings/ inside your plugins/ directory and also an i18n/ directory within that, place this file into the mystrings/i18n/ directory.

mystrings/i18n/en-GB.inc.php

<?php
// My custom strings for the MyStrings Plugin

// This example replaces all mention of 'Customer' and replaces it with 'Client' this has been done by extracting
// all the strings from the main SiT! i18n/en-GB.inc.php file to this file and then modifying the strings to our
// needs.

// It is best not to copy more strings from the original language file than we need. That is we have only copied
// the strings that we needed to modify.

$strAwaitingCustomerAction = 'Awaiting Client Action';
$strBillingCustomerPeriod = 'Client Period';
$strCallFromCustomer = 'Phone call from client';
$strCallToCustomer = 'Phone call to client';
$strContractAreYouSure = 'This incident will be logged against the clients CONTRACT. Are you sure you want to continue?';
$strCustomer = 'Client';
$strCustomerFeedback = 'Client Feedback';
$strCustomerFeedbackReportSiteMsg = 'This report shows client responses and a percentage figure indicating the overall positivity of clients toward incidents logged by the user(s) shown';
$strCustomerExport = 'Client Export';
$strCustomerImpact = 'Client Impact';
$strCustomerReference = 'Client Ref';
$strCustomerReferenceDate = 'Client Ref Date';
$strCustomerReminded = 'Client has been reminded';
$strCustomerRemindedByPhone = 'Client has been reminded by phone';
$strCustomerReminderUpdate = 'Was this a client reminder?';
$strCustomerRequestedClosure = 'Client Requested Incident Closure';
$strCustomers = 'Clients';
# Visible for customers
$strCustomerVisible = 'Client visible';
$strEmailFromCustomer = 'Email from client';
$strEmailToCustomer = 'Email to client';
$strEmailIncidentUpdatedCustomerDesc = 'Sent to a client when an engineer updated an incident';
$strFirstCustomerVisibleUpdate = 'The first client visible update in the incident log';
$strListsAllTheCustomersProducts = 'Lists all the clients products regardless of selections made above';
$strMarketingMailshotDesc = 'This report is a list of details for all clients that currently (or previously) have contracts for the products you selected but none of the products excluded';
$strProblemDescriptionCustomerText = 'As much information as possible about the problem, enough for an engineer to begin researching the issue without having to contact you.';
$strProblemReproductionCustomerText = 'Does the problem exist with more than one machine? What steps will an engineer need to take to reproduce this issue?';
$strRemindByPhone = 'Remind client by phone';
$strRemindCustomer = 'Remind client';
$strSendEmailExplainingIncidentClosure = 'Send an email to the client explaining that the incident has been (or will be) closed.';
$strSiteAreYouSure = 'This incident will be logged against the clients SITE and NOT against a contract, you will be prompted to choose a service level. Are you sure you want to continue?';
$strThisListShowsCustomers = 'This list shows clients that matched your search, if site-support is available you can add incidents for the site.';
$strVisibleToCustomer = 'Visible To Client';
$strWaitingForCustomer = 'Waiting for client';
?>
Personal tools
project