Translator documentation updated.

i18n/L10n updates.
Superfluous whitespace removed.
Add FIXME for missing class documentation.
This commit is contained in:
Siebrand Mazeland 2011-03-24 12:09:50 +01:00
parent 78edb4bf56
commit e0cccfc40d
4 changed files with 72 additions and 49 deletions

View File

@ -44,25 +44,21 @@ require_once INSTALLDIR.'/lib/feedlist.php';
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/ * @link http://status.net/
*/ */
class ShownoticeAction extends OwnerDesignAction class ShownoticeAction extends OwnerDesignAction
{ {
/** /**
* Notice object to show * Notice object to show
*/ */
var $notice = null; var $notice = null;
/** /**
* Profile of the notice object * Profile of the notice object
*/ */
var $profile = null; var $profile = null;
/** /**
* Avatar of the profile of the notice object * Avatar of the profile of the notice object
*/ */
var $avatar = null; var $avatar = null;
/** /**
@ -74,7 +70,6 @@ class ShownoticeAction extends OwnerDesignAction
* *
* @return success flag * @return success flag
*/ */
function prepare($args) function prepare($args)
{ {
parent::prepare($args); parent::prepare($args);
@ -90,8 +85,10 @@ class ShownoticeAction extends OwnerDesignAction
// Did we used to have it, and it got deleted? // Did we used to have it, and it got deleted?
$deleted = Deleted_notice::staticGet($id); $deleted = Deleted_notice::staticGet($id);
if (!empty($deleted)) { if (!empty($deleted)) {
// TRANS: Client error displayed trying to show a deleted notice.
$this->clientError(_('Notice deleted.'), 410); $this->clientError(_('Notice deleted.'), 410);
} else { } else {
// TRANS: Client error displayed trying to show a non-existing notice.
$this->clientError(_('No such notice.'), 404); $this->clientError(_('No such notice.'), 404);
} }
return false; return false;
@ -100,6 +97,7 @@ class ShownoticeAction extends OwnerDesignAction
$this->profile = $this->notice->getProfile(); $this->profile = $this->notice->getProfile();
if (empty($this->profile)) { if (empty($this->profile)) {
// TRANS: Server error displayed trying to show a notice without a connected profile.
$this->serverError(_('Notice has no profile.'), 500); $this->serverError(_('Notice has no profile.'), 500);
return false; return false;
} }
@ -116,7 +114,6 @@ class ShownoticeAction extends OwnerDesignAction
* *
* @return boolean true * @return boolean true
*/ */
function isReadOnly($args) function isReadOnly($args)
{ {
return true; return true;
@ -130,7 +127,6 @@ class ShownoticeAction extends OwnerDesignAction
* *
* @return int last-modified date as unix timestamp * @return int last-modified date as unix timestamp
*/ */
function lastModified() function lastModified()
{ {
return max(strtotime($this->notice->modified), return max(strtotime($this->notice->modified),
@ -147,7 +143,6 @@ class ShownoticeAction extends OwnerDesignAction
* *
* @return string etag * @return string etag
*/ */
function etag() function etag()
{ {
$avtime = ($this->avatar) ? $avtime = ($this->avatar) ?
@ -167,11 +162,12 @@ class ShownoticeAction extends OwnerDesignAction
* *
* @return string title of the page * @return string title of the page
*/ */
function title() function title()
{ {
$base = $this->profile->getFancyName(); $base = $this->profile->getFancyName();
// TRANS: Title of the page that shows a notice.
// TRANS: %1$s is a user name, %2$s is the notice creation date/time.
return sprintf(_('%1$s\'s status on %2$s'), return sprintf(_('%1$s\'s status on %2$s'),
$base, $base,
common_exact_date($this->notice->created)); common_exact_date($this->notice->created));
@ -186,7 +182,6 @@ class ShownoticeAction extends OwnerDesignAction
* *
* @return void * @return void
*/ */
function handle($args) function handle($args)
{ {
parent::handle($args); parent::handle($args);
@ -218,7 +213,6 @@ class ShownoticeAction extends OwnerDesignAction
* *
* @return void * @return void
*/ */
function showLocalNavBlock() function showLocalNavBlock()
{ {
} }
@ -230,7 +224,6 @@ class ShownoticeAction extends OwnerDesignAction
* *
* @return void * @return void
*/ */
function showContent() function showContent()
{ {
$this->elementStart('ol', array('class' => 'notices xoxo')); $this->elementStart('ol', array('class' => 'notices xoxo'));
@ -245,7 +238,8 @@ class ShownoticeAction extends OwnerDesignAction
$this->xw->startDocument('1.0', 'UTF-8'); $this->xw->startDocument('1.0', 'UTF-8');
$this->elementStart('html'); $this->elementStart('html');
$this->elementStart('head'); $this->elementStart('head');
$this->element('title', null, _('Notice')); // TRANS: Title for page that shows a notice.
$this->element('title', null, _m('TITLE','Notice'));
$this->elementEnd('head'); $this->elementEnd('head');
$this->elementStart('body'); $this->elementStart('body');
$nli = new NoticeListItem($this->notice, $this); $nli = new NoticeListItem($this->notice, $this);
@ -259,7 +253,6 @@ class ShownoticeAction extends OwnerDesignAction
* *
* @return void * @return void
*/ */
function showPageNoticeBlock() function showPageNoticeBlock()
{ {
} }
@ -269,7 +262,6 @@ class ShownoticeAction extends OwnerDesignAction
* *
* @return void * @return void
*/ */
function showAside() { function showAside() {
} }
@ -280,7 +272,6 @@ class ShownoticeAction extends OwnerDesignAction
* *
* @return void * @return void
*/ */
function extraHead() function extraHead()
{ {
$user = User::staticGet($this->profile->id); $user = User::staticGet($this->profile->id);
@ -323,16 +314,16 @@ class ShownoticeAction extends OwnerDesignAction
} }
} }
// @todo FIXME: Class documentation missing.
class SingleNoticeItem extends DoFollowListItem class SingleNoticeItem extends DoFollowListItem
{ {
/** /**
* recipe function for displaying a single notice. * Recipe function for displaying a single notice.
* *
* We overload to show attachments. * We overload to show attachments.
* *
* @return void * @return void
*/ */
function show() function show()
{ {
$this->showStart(); $this->showStart();
@ -363,7 +354,6 @@ class SingleNoticeItem extends DoFollowListItem
* *
* @return void * @return void
*/ */
function showAvatar() function showAvatar()
{ {
$avatar_size = AVATAR_PROFILE_SIZE; $avatar_size = AVATAR_PROFILE_SIZE;

View File

@ -65,7 +65,8 @@ class ShowstreamAction extends ProfileAction
$base = $this->profile->getFancyName(); $base = $this->profile->getFancyName();
if (!empty($this->tag)) { if (!empty($this->tag)) {
if ($this->page == 1) { if ($this->page == 1) {
// TRANS: Page title showing tagged notices in one user's stream. %1$s is the username, %2$s is the hash tag. // TRANS: Page title showing tagged notices in one user's stream.
// TRANS: %1$s is the username, %2$s is the hash tag.
return sprintf(_('%1$s tagged %2$s'), $base, $this->tag); return sprintf(_('%1$s tagged %2$s'), $base, $this->tag);
} else { } else {
// TRANS: Page title showing tagged notices in one user's stream. // TRANS: Page title showing tagged notices in one user's stream.
@ -153,6 +154,8 @@ class ShowstreamAction extends ProfileAction
array( array(
'id' => $this->user->id, 'id' => $this->user->id,
'format' => 'atom')), 'format' => 'atom')),
// TRANS: Title for link to notice feed.
// TRANS: %s is a user nickname.
sprintf(_('Notice feed for %s (Atom)'), sprintf(_('Notice feed for %s (Atom)'),
$this->user->nickname)), $this->user->nickname)),
new Feed(Feed::FOAF, new Feed(Feed::FOAF,

View File

@ -40,7 +40,6 @@ if (!defined('STATUSNET')) {
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3 * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
* @link http://status.net/ * @link http://status.net/
*/ */
class SilenceAction extends ProfileFormAction class SilenceAction extends ProfileFormAction
{ {
/** /**
@ -50,7 +49,6 @@ class SilenceAction extends ProfileFormAction
* *
* @return boolean success flag * @return boolean success flag
*/ */
function prepare($args) function prepare($args)
{ {
if (!parent::prepare($args)) { if (!parent::prepare($args)) {
@ -62,6 +60,7 @@ class SilenceAction extends ProfileFormAction
assert(!empty($cur)); // checked by parent assert(!empty($cur)); // checked by parent
if (!$cur->hasRight(Right::SILENCEUSER)) { if (!$cur->hasRight(Right::SILENCEUSER)) {
// TRANS: Client error displayed trying to silence a user on a site where the feature is not enabled.
$this->clientError(_('You cannot silence users on this site.')); $this->clientError(_('You cannot silence users on this site.'));
return false; return false;
} }
@ -69,6 +68,7 @@ class SilenceAction extends ProfileFormAction
assert(!empty($this->profile)); // checked by parent assert(!empty($this->profile)); // checked by parent
if ($this->profile->isSilenced()) { if ($this->profile->isSilenced()) {
// TRANS: Client error displayed trying to silence an already silenced user.
$this->clientError(_('User is already silenced.')); $this->clientError(_('User is already silenced.'));
return false; return false;
} }
@ -81,7 +81,6 @@ class SilenceAction extends ProfileFormAction
* *
* @return void * @return void
*/ */
function handlePost() function handlePost()
{ {
$this->profile->silence(); $this->profile->silence();

View File

@ -44,7 +44,6 @@ if (!defined('STATUSNET')) {
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/ * @link http://status.net/
*/ */
class SiteadminpanelAction extends AdminPanelAction class SiteadminpanelAction extends AdminPanelAction
{ {
/** /**
@ -52,10 +51,10 @@ class SiteadminpanelAction extends AdminPanelAction
* *
* @return string page title * @return string page title
*/ */
function title() function title()
{ {
return _('Site'); // TRANS: Title for site administration panel.
return _m('TITLE','Site');
} }
/** /**
@ -63,9 +62,9 @@ class SiteadminpanelAction extends AdminPanelAction
* *
* @return string instructions * @return string instructions
*/ */
function getInstructions() function getInstructions()
{ {
// TRANS: Instructions for site administration panel.
return _('Basic settings for this StatusNet site'); return _('Basic settings for this StatusNet site');
} }
@ -74,7 +73,6 @@ class SiteadminpanelAction extends AdminPanelAction
* *
* @return void * @return void
*/ */
function showForm() function showForm()
{ {
$form = new SiteAdminPanelForm($this); $form = new SiteAdminPanelForm($this);
@ -87,7 +85,6 @@ class SiteadminpanelAction extends AdminPanelAction
* *
* @return void * @return void
*/ */
function saveSettings() function saveSettings()
{ {
static $settings = array( static $settings = array(
@ -130,6 +127,7 @@ class SiteadminpanelAction extends AdminPanelAction
// Validate site name // Validate site name
if (empty($values['site']['name'])) { if (empty($values['site']['name'])) {
// TRANS: Client error displayed trying to save an empty site name.
$this->clientError(_('Site name must have non-zero length.')); $this->clientError(_('Site name must have non-zero length.'));
} }
@ -138,9 +136,11 @@ class SiteadminpanelAction extends AdminPanelAction
$values['site']['email'] = common_canonical_email($values['site']['email']); $values['site']['email'] = common_canonical_email($values['site']['email']);
if (empty($values['site']['email'])) { if (empty($values['site']['email'])) {
// TRANS: Client error displayed trying to save site settings without a contact address.
$this->clientError(_('You must have a valid contact email address.')); $this->clientError(_('You must have a valid contact email address.'));
} }
if (!Validate::email($values['site']['email'], common_config('email', 'check_domain'))) { if (!Validate::email($values['site']['email'], common_config('email', 'check_domain'))) {
// TRANS: Client error displayed trying to save site settings without a valid contact address.
$this->clientError(_('Not a valid email address.')); $this->clientError(_('Not a valid email address.'));
} }
@ -148,6 +148,7 @@ class SiteadminpanelAction extends AdminPanelAction
if (is_null($values['site']['timezone']) || if (is_null($values['site']['timezone']) ||
!in_array($values['site']['timezone'], DateTimeZone::listIdentifiers())) { !in_array($values['site']['timezone'], DateTimeZone::listIdentifiers())) {
// TRANS: Client error displayed trying to save site settings without a timezone.
$this->clientError(_('Timezone not selected.')); $this->clientError(_('Timezone not selected.'));
return; return;
} }
@ -156,24 +157,28 @@ class SiteadminpanelAction extends AdminPanelAction
if (!is_null($values['site']['language']) && if (!is_null($values['site']['language']) &&
!in_array($values['site']['language'], array_keys(get_nice_language_list()))) { !in_array($values['site']['language'], array_keys(get_nice_language_list()))) {
// TRANS: Client error displayed trying to save site settings with an invalid language code.
// TRANS: %s is the invalid language code.
$this->clientError(sprintf(_('Unknown language "%s".'), $values['site']['language'])); $this->clientError(sprintf(_('Unknown language "%s".'), $values['site']['language']));
} }
// Validate text limit // Validate text limit
if (!Validate::number($values['site']['textlimit'], array('min' => 0))) { if (!Validate::number($values['site']['textlimit'], array('min' => 0))) {
$this->clientError(_("Minimum text limit is 0 (unlimited).")); // TRANS: Client error displayed trying to save site settings with a text limit below 0.
$this->clientError(_('Minimum text limit is 0 (unlimited).'));
} }
// Validate dupe limit // Validate dupe limit
if (!Validate::number($values['site']['dupelimit'], array('min' => 1))) { if (!Validate::number($values['site']['dupelimit'], array('min' => 1))) {
// TRANS: Client error displayed trying to save site settings with a text limit below 1.
$this->clientError(_("Dupe limit must be one or more seconds.")); $this->clientError(_("Dupe limit must be one or more seconds."));
} }
} }
} }
// @todo FIXME: Class documentation missing.
class SiteAdminPanelForm extends AdminForm class SiteAdminPanelForm extends AdminForm
{ {
/** /**
@ -181,7 +186,6 @@ class SiteAdminPanelForm extends AdminForm
* *
* @return int ID of the form * @return int ID of the form
*/ */
function id() function id()
{ {
return 'form_site_admin_panel'; return 'form_site_admin_panel';
@ -192,7 +196,6 @@ class SiteAdminPanelForm extends AdminForm
* *
* @return string class of the form * @return string class of the form
*/ */
function formClass() function formClass()
{ {
return 'form_settings'; return 'form_settings';
@ -203,7 +206,6 @@ class SiteAdminPanelForm extends AdminForm
* *
* @return string URL of the action * @return string URL of the action
*/ */
function action() function action()
{ {
return common_local_url('siteadminpanel'); return common_local_url('siteadminpanel');
@ -214,35 +216,44 @@ class SiteAdminPanelForm extends AdminForm
* *
* @return void * @return void
*/ */
function formData() function formData()
{ {
$this->out->elementStart('fieldset', array('id' => 'settings_admin_general')); $this->out->elementStart('fieldset', array('id' => 'settings_admin_general'));
$this->out->element('legend', null, _('General')); // TRANS: Fieldset legend on site settings panel.
$this->out->element('legend', null, _m('LEGEND','General'));
$this->out->elementStart('ul', 'form_data'); $this->out->elementStart('ul', 'form_data');
$this->li(); $this->li();
$this->input('name', _('Site name'), // TRANS: Field label on site settings panel.
_('The name of your site, like "Yourcompany Microblog"')); $this->input('name', _m('LABEL','Site name'),
// TRANS: Field title on site settings panel.
_('The name of your site, like "Yourcompany Microblog".'));
$this->unli(); $this->unli();
$this->li(); $this->li();
// TRANS: Field label on site settings panel.
$this->input('broughtby', _('Brought by'), $this->input('broughtby', _('Brought by'),
_('Text used for credits link in footer of each page')); // TRANS: Field title on site settings panel.
_('Text used for credits link in footer of each page.'));
$this->unli(); $this->unli();
$this->li(); $this->li();
// TRANS: Field label on site settings panel.
$this->input('broughtbyurl', _('Brought by URL'), $this->input('broughtbyurl', _('Brought by URL'),
_('URL used for credits link in footer of each page')); // TRANS: Field title on site settings panel.
_('URL used for credits link in footer of each page.'));
$this->unli(); $this->unli();
$this->li(); $this->li();
// TRANS: Field label on site settings panel.
$this->input('email', _('Email'), $this->input('email', _('Email'),
_('Contact email address for your site')); // TRANS: Field title on site settings panel.
_('Contact email address for your site.'));
$this->unli(); $this->unli();
$this->out->elementEnd('ul'); $this->out->elementEnd('ul');
$this->out->elementEnd('fieldset'); $this->out->elementEnd('fieldset');
$this->out->elementStart('fieldset', array('id' => 'settings_admin_local')); $this->out->elementStart('fieldset', array('id' => 'settings_admin_local'));
$this->out->element('legend', null, _('Local')); // TRANS: Fieldset legend on site settings panel.
$this->out->element('legend', null, _m('LEGEND','Local'));
$this->out->elementStart('ul', 'form_data'); $this->out->elementStart('ul', 'form_data');
$timezones = array(); $timezones = array();
@ -253,14 +264,20 @@ class SiteAdminPanelForm extends AdminForm
asort($timezones); asort($timezones);
$this->li(); $this->li();
// TRANS: Dropdown label on site settings panel.
$this->out->dropdown('timezone', _('Default timezone'), $this->out->dropdown('timezone', _('Default timezone'),
// TRANS: Dropdown title on site settings panel.
$timezones, _('Default timezone for the site; usually UTC.'), $timezones, _('Default timezone for the site; usually UTC.'),
true, $this->value('timezone')); true, $this->value('timezone'));
$this->unli(); $this->unli();
$this->li(); $this->li();
$this->out->dropdown('language', _('Default language'), $this->out->dropdown('language',
get_nice_language_list(), _('Site language when autodetection from browser settings is not available'), // TRANS: Dropdown label on site settings panel.
_('Default language'),
get_nice_language_list(),
// TRANS: Dropdown title on site settings panel.
_('Site language when autodetection from browser settings is not available'),
false, $this->value('language')); false, $this->value('language'));
$this->unli(); $this->unli();
@ -268,14 +285,23 @@ class SiteAdminPanelForm extends AdminForm
$this->out->elementEnd('fieldset'); $this->out->elementEnd('fieldset');
$this->out->elementStart('fieldset', array('id' => 'settings_admin_limits')); $this->out->elementStart('fieldset', array('id' => 'settings_admin_limits'));
$this->out->element('legend', null, _('Limits')); // TRANS: Fieldset legend on site settings panel.
$this->out->element('legend', null, _m('LEGEND','Limits'));
$this->out->elementStart('ul', 'form_data'); $this->out->elementStart('ul', 'form_data');
$this->li(); $this->li();
$this->input('textlimit', _('Text limit'), _('Maximum number of characters for notices.')); $this->input('textlimit',
// TRANS: Field label on site settings panel.
_('Text limit'),
// TRANS: Field title on site settings panel.
_('Maximum number of characters for notices.'));
$this->unli(); $this->unli();
$this->li(); $this->li();
$this->input('dupelimit', _('Dupe limit'), _('How long users must wait (in seconds) to post the same thing again.')); $this->input('dupelimit',
// TRANS: Field label on site settings panel.
_('Dupe limit'),
// TRANS: Field title on site settings panel.
_('How long users must wait (in seconds) to post the same thing again.'));
$this->unli(); $this->unli();
$this->out->elementEnd('ul'); $this->out->elementEnd('ul');
$this->out->elementEnd('fieldset'); $this->out->elementEnd('fieldset');
@ -286,9 +312,14 @@ class SiteAdminPanelForm extends AdminForm
* *
* @return void * @return void
*/ */
function formActions() function formActions()
{ {
$this->out->submit('submit', _('Save'), 'submit', null, _('Save site settings')); $this->out->submit('submit',
// TRANS: Button text for saving site settings.
_m('BUTTON','Save'),
'submit',
null,
// TRANS: Button title for saving site settings.
_('Save site settings'));
} }
} }