From 13991f7eb9c389fccc5fb6c4829d054d8428b42a Mon Sep 17 00:00:00 2001 From: Siebrand Mazeland Date: Mon, 31 Jan 2011 18:16:55 +0100 Subject: [PATCH] * add/update translator documentation. * remove superfluous whitespace. * update punctuation on form validation messages. * L10n tweaks. * add fixme for missing class documentation. --- actions/grouprss.php | 7 ++- actions/groups.php | 14 ++++-- actions/groupsearch.php | 10 ++++- actions/groupunblock.php | 1 + actions/hcard.php | 5 ++- actions/hostmeta.php | 12 ++--- actions/imsettings.php | 94 ++++++++++++++++++++-------------------- actions/inbox.php | 10 ++--- actions/invite.php | 3 +- 9 files changed, 85 insertions(+), 71 deletions(-) diff --git a/actions/grouprss.php b/actions/grouprss.php index 98fdea38de..39dcff83d9 100644 --- a/actions/grouprss.php +++ b/actions/grouprss.php @@ -45,7 +45,6 @@ define('MEMBERS_PER_SECTION', 27); * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 * @link http://status.net/ */ - class groupRssAction extends Rss10Action { /** group we're viewing. */ @@ -56,7 +55,6 @@ class groupRssAction extends Rss10Action * * @return boolean true */ - function isReadOnly($args) { return true; @@ -71,7 +69,6 @@ class groupRssAction extends Rss10Action * * @return boolean success flag */ - function prepare($args) { parent::prepare($args); @@ -88,6 +85,7 @@ class groupRssAction extends Rss10Action } if (!$nickname) { + // TRANS: Client error displayed when requesting a group RSS feed without providing a group nickname. $this->clientError(_('No nickname.'), 404); return false; } @@ -95,6 +93,7 @@ class groupRssAction extends Rss10Action $local = Local_group::staticGet('nickname', $nickname); if (!$local) { + // TRANS: Client error displayed when requesting a group RSS feed for group that does not exist. $this->clientError(_('No such group.'), 404); return false; } @@ -102,6 +101,7 @@ class groupRssAction extends Rss10Action $this->group = User_group::staticGet('id', $local->group_id); if (!$this->group) { + // TRANS: Client error displayed when requesting a group RSS feed for an object that is not a group. $this->clientError(_('No such group.'), 404); return false; } @@ -112,7 +112,6 @@ class groupRssAction extends Rss10Action function getNotices($limit=0) { - $group = $this->group; if (is_null($group)) { diff --git a/actions/groups.php b/actions/groups.php index 8aacff8b0e..958c5921bf 100644 --- a/actions/groups.php +++ b/actions/groups.php @@ -45,7 +45,6 @@ require_once INSTALLDIR.'/lib/grouplist.php'; * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 * @link http://status.net/ */ - class GroupsAction extends Action { var $page = null; @@ -59,9 +58,12 @@ class GroupsAction extends Action function title() { if ($this->page == 1) { - return _("Groups"); + // TRANS: Title for first page of the groups list. + return _m('TITLE',"Groups"); } else { - return sprintf(_("Groups, page %d"), $this->page); + // TRANS: Title for all but the first page of the groups list. + // TRANS: %d is the page number. + return sprintf(_m('TITLE',"Groups, page %d"), $this->page); } } @@ -87,12 +89,15 @@ class GroupsAction extends Action function showPageNotice() { $notice = + // TRANS: Page notice of group list. %%%%site.name%%%% is the StatusNet site name, + // TRANS: %%%%action.groupsearch%%%% and %%%%action.newgroup%%%% are URLs. Do not change them. + // TRANS: This message contains Markdown links in the form [link text](link). sprintf(_('%%%%site.name%%%% groups let you find and talk with ' . 'people of similar interests. After you join a group ' . 'you can send messages to all other members using the ' . 'syntax "!groupname". Don\'t see a group you like? Try ' . '[searching for one](%%%%action.groupsearch%%%%) or ' . - '[start your own!](%%%%action.newgroup%%%%)')); + '[start your own](%%%%action.newgroup%%%%)!')); $this->elementStart('div', 'instructions'); $this->raw(common_markup_to_html($notice)); $this->elementEnd('div'); @@ -104,6 +109,7 @@ class GroupsAction extends Action $this->elementStart('p', array('id' => 'new_group')); $this->element('a', array('href' => common_local_url('newgroup'), 'class' => 'more'), + // TRANS: Link to create a new group on the group list page. _('Create a new group')); $this->elementEnd('p'); } diff --git a/actions/groupsearch.php b/actions/groupsearch.php index 55f4cee625..fce5c2b16a 100644 --- a/actions/groupsearch.php +++ b/actions/groupsearch.php @@ -49,12 +49,14 @@ class GroupsearchAction extends SearchAction { function getInstructions() { + // TRANS: Instructions for page where groups can be searched. %%site.name%% is the name of the StatusNet site. return _('Search for groups on %%site.name%% by their name, location, or description. ' . 'Separate the terms by spaces; they must be 3 characters or more.'); } function title() { + // TRANS: Title for page where groups can be searched. return _('Group search'); } @@ -76,12 +78,17 @@ class GroupsearchAction extends SearchAction $this->pagination($page > 1, $cnt > GROUPS_PER_PAGE, $page, 'groupsearch', array('q' => $q)); } else { + // TRANS: Text on page where groups can be searched if no results were found for a query. $this->element('p', 'error', _('No results.')); $this->searchSuggestions($q); if (common_logged_in()) { - $message = _('If you can\'t find the group you\'re looking for, you can [create it](%%action.newgroup%%) yourself.'); + // TRANS: Additional text on page where groups can be searched if no results were found for a query for a logged in user. + // TRANS: This message contains Markdown links in the form [link text](link). + $message = _('If you cannot find the group you\'re looking for, you can [create it](%%action.newgroup%%) yourself.'); } else { + // TRANS: Additional text on page where groups can be searched if no results were found for a query for a not logged in user. + // TRANS: This message contains Markdown links in the form [link text](link). $message = _('Why not [register an account](%%action.register%%) and [create the group](%%action.newgroup%%) yourself!'); } $this->elementStart('div', 'guide'); @@ -116,4 +123,3 @@ class GroupSearchResults extends GroupList return preg_replace($this->pattern, '\\1', htmlspecialchars($text)); } } - diff --git a/actions/groupunblock.php b/actions/groupunblock.php index ef2380725e..de0af59821 100644 --- a/actions/groupunblock.php +++ b/actions/groupunblock.php @@ -79,6 +79,7 @@ class GroupunblockAction extends Action } $group_id = $this->trimmed('unblockgroup'); if (empty($group_id)) { + // TRANS: Client error displayed when trying to unblock a user from a group without providing a group. $this->clientError(_('No group specified.')); return false; } diff --git a/actions/hcard.php b/actions/hcard.php index 55d0f65c8f..8781f6f882 100644 --- a/actions/hcard.php +++ b/actions/hcard.php @@ -40,7 +40,6 @@ if (!defined('STATUSNET')) { * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3 * @link http://status.net/ */ - class HcardAction extends Action { var $user; @@ -64,6 +63,7 @@ class HcardAction extends Action $this->user = User::staticGet('nickname', $nickname); if (!$this->user) { + // TRANS: Client error displayed when trying to get a user hCard for a non-existing user. $this->clientError(_('No such user.'), 404); return false; } @@ -71,6 +71,7 @@ class HcardAction extends Action $this->profile = $this->user->getProfile(); if (!$this->profile) { + // TRANS: Server error displayed when trying to get a user hCard for a user without a profile. $this->serverError(_('User has no profile.')); return false; } @@ -117,4 +118,4 @@ class ShortUserProfile extends UserProfile { return; } -} \ No newline at end of file +} diff --git a/actions/hostmeta.php b/actions/hostmeta.php index 2587bb6b91..7093a441d7 100644 --- a/actions/hostmeta.php +++ b/actions/hostmeta.php @@ -28,9 +28,9 @@ if (!defined('STATUSNET')) { exit(1); } +// @todo XXX: Add documentation. class HostMetaAction extends Action { - /** * Is read only? * @@ -51,11 +51,11 @@ class HostMetaAction extends Action $xrd->host = $domain; if(Event::handle('StartHostMetaLinks', array(&$xrd->links))) { - $url = common_local_url('userxrd'); - $url.= '?uri={uri}'; - $xrd->links[] = array('rel' => Discovery::LRDD_REL, - 'template' => $url, - 'title' => array('Resource Descriptor')); + $url = common_local_url('userxrd'); + $url.= '?uri={uri}'; + $xrd->links[] = array('rel' => Discovery::LRDD_REL, + 'template' => $url, + 'title' => array('Resource Descriptor')); Event::handle('EndHostMetaLinks', array(&$xrd->links)); } diff --git a/actions/imsettings.php b/actions/imsettings.php index dc72290345..eb3f0cfd15 100644 --- a/actions/imsettings.php +++ b/actions/imsettings.php @@ -54,7 +54,7 @@ class ImsettingsAction extends ConnectSettingsAction */ function title() { - // TRANS: Title for instance messaging settings. + // TRANS: Title for Instant Messaging settings. return _('IM settings'); } @@ -69,7 +69,7 @@ class ImsettingsAction extends ConnectSettingsAction // TRANS: [instant messages] is link text, "(%%doc.im%%)" is the link. // TRANS: the order and formatting of link text and link should remain unchanged. return _('You can send and receive notices through '. - 'Jabber/GTalk [instant messages](%%doc.im%%). '. + 'Jabber/Google Talk [instant messages](%%doc.im%%). '. 'Configure your address and settings below.'); } @@ -86,7 +86,7 @@ class ImsettingsAction extends ConnectSettingsAction { if (!common_config('xmpp', 'enabled')) { $this->element('div', array('class' => 'error'), - // TRANS: Message given in the IM settings if XMPP is not enabled on the site. + // TRANS: Message given in the Instant Messaging settings if XMPP is not enabled on the site. _('IM is not available.')); return; } @@ -98,88 +98,88 @@ class ImsettingsAction extends ConnectSettingsAction 'action' => common_local_url('imsettings'))); $this->elementStart('fieldset', array('id' => 'settings_im_address')); - // TRANS: Form legend for IM settings form. + // TRANS: Form legend for Instant Messaging settings form. $this->element('legend', null, _('IM address')); $this->hidden('token', common_session_token()); if ($user->jabber) { $this->element('p', 'form_confirmed', $user->jabber); - // TRANS: Form note in IM settings form. + // TRANS: Form note in Instant Messaging settings form. $this->element('p', 'form_note', - _('Current confirmed Jabber/GTalk address.')); + _('Current confirmed Jabber/Google Talk address.')); $this->hidden('jabber', $user->jabber); - // TRANS: Button label to remove a confirmed IM address. + // TRANS: Button label to remove a confirmed Instant Messaging address. $this->submit('remove', _m('BUTTON','Remove')); } else { $confirm = $this->getConfirmation(); if ($confirm) { $this->element('p', 'form_unconfirmed', $confirm->address); $this->element('p', 'form_note', - // TRANS: Form note in IM settings form. - // TRANS: %s is the IM address set for the site. + // TRANS: Form note in Instant Messaging settings form. + // TRANS: %s is the Instant Messaging address set for the site. sprintf(_('Awaiting confirmation on this address. '. - 'Check your Jabber/GTalk account for a '. + 'Check your Jabber/Google Talk account for a '. 'message with further instructions. '. '(Did you add %s to your buddy list?)'), jabber_daemon_address())); $this->hidden('jabber', $confirm->address); - // TRANS: Button label to cancel an IM address confirmation procedure. + // TRANS: Button label to cancel an Instant Messaging address confirmation procedure. $this->submit('cancel', _m('BUTTON','Cancel')); } else { $this->elementStart('ul', 'form_data'); $this->elementStart('li'); - // TRANS: Field label for IM address input in IM settings form. + // TRANS: Field label for Instant Messaging address input in Instant Messaging settings form. $this->input('jabber', _('IM address'), ($this->arg('jabber')) ? $this->arg('jabber') : null, - // TRANS: IM address input field instructions in IM settings form. - // TRANS: %s is the IM address set for the site. + // TRANS: IM address input field instructions in Instant Messaging settings form. + // TRANS: %s is the Instant Messaging address set for the site. // TRANS: Do not translate "example.org". It is one of the domain names reserved for use in examples by // TRANS: http://www.rfc-editor.org/rfc/rfc2606.txt. Any other domain may be owned by a legitimate // TRANS: person or organization. - sprintf(_('Jabber or GTalk address, '. + sprintf(_('Jabber or Google Talk address, '. 'like "UserName@example.org". '. 'First, make sure to add %s to your '. - 'buddy list in your IM client or on GTalk.'), + 'buddy list in your IM client or on Google Talk.'), jabber_daemon_address())); $this->elementEnd('li'); $this->elementEnd('ul'); - // TRANS: Button label for adding an IM address in IM settings form. + // TRANS: Button label for adding an Instant Messaging address in Instant Messaging settings form. $this->submit('add', _m('BUTTON','Add')); } } $this->elementEnd('fieldset'); $this->elementStart('fieldset', array('id' => 'settings_im_preferences')); - // TRANS: Form legend for IM preferences form. + // TRANS: Form legend for Instant Messaging preferences form. $this->element('legend', null, _('IM preferences')); $this->elementStart('ul', 'form_data'); $this->elementStart('li'); $this->checkbox('jabbernotify', - // TRANS: Checkbox label in IM preferences form. - _('Send me notices through Jabber/GTalk.'), + // TRANS: Checkbox label in Instant Messaging preferences form. + _('Send me notices through Jabber/Google Talk.'), $user->jabbernotify); $this->elementEnd('li'); $this->elementStart('li'); $this->checkbox('updatefrompresence', - // TRANS: Checkbox label in IM preferences form. - _('Post a notice when my Jabber/GTalk status changes.'), + // TRANS: Checkbox label in Instant Messaging preferences form. + _('Post a notice when my Jabber/Google Talk status changes.'), $user->updatefrompresence); $this->elementEnd('li'); $this->elementStart('li'); $this->checkbox('jabberreplies', - // TRANS: Checkbox label in IM preferences form. - _('Send me replies through Jabber/GTalk '. + // TRANS: Checkbox label in Instant Messaging preferences form. + _('Send me replies through Jabber/Google Talk '. 'from people I\'m not subscribed to.'), $user->jabberreplies); $this->elementEnd('li'); $this->elementStart('li'); $this->checkbox('jabbermicroid', - // TRANS: Checkbox label in IM preferences form. - _('Publish a MicroID for my Jabber/GTalk address.'), + // TRANS: Checkbox label in Instant Messaging preferences form. + _('Publish a MicroID for my Jabber/Google Talk address.'), $user->jabbermicroid); $this->elementEnd('li'); $this->elementEnd('ul'); - // TRANS: Button label to save IM preferences. + // TRANS: Button label to save Instant Messaging preferences. $this->submit('save', _m('BUTTON','Save')); $this->elementEnd('fieldset'); $this->elementEnd('form'); @@ -235,7 +235,7 @@ class ImsettingsAction extends ConnectSettingsAction } else if ($this->arg('remove')) { $this->removeAddress(); } else { - // TRANS: Message given submitting a form with an unknown action in IM settings. + // TRANS: Message given submitting a form with an unknown action in Instant Messaging settings. $this->showForm(_('Unexpected form submission.')); } } @@ -272,14 +272,14 @@ class ImsettingsAction extends ConnectSettingsAction if ($result === false) { common_log_db_error($user, 'UPDATE', __FILE__); - // TRANS: Server error thrown on database error updating IM preferences. + // TRANS: Server error thrown on database error updating Instant Messaging preferences. $this->serverError(_('Could not update user.')); return; } $user->query('COMMIT'); - // TRANS: Confirmation message for successful IM preferences save. + // TRANS: Confirmation message for successful Instant Messaging preferences save. $this->showForm(_('Preferences saved.'), true); } @@ -300,7 +300,7 @@ class ImsettingsAction extends ConnectSettingsAction // Some validation if (!$jabber) { - // TRANS: Message given saving IM address without having provided one. + // TRANS: Message given saving Instant Messaging address without having provided one. $this->showForm(_('No Jabber ID.')); return; } @@ -308,20 +308,20 @@ class ImsettingsAction extends ConnectSettingsAction $jabber = jabber_normalize_jid($jabber); if (!$jabber) { - // TRANS: Message given saving IM address that cannot be normalised. - $this->showForm(_('Cannot normalize that Jabber ID')); + // TRANS: Message given saving Instant Messaging address that cannot be normalised. + $this->showForm(_('Cannot normalize that Jabber ID.')); return; } if (!jabber_valid_base_jid($jabber, common_config('email', 'domain_check'))) { - // TRANS: Message given saving IM address that not valid. - $this->showForm(_('Not a valid Jabber ID')); + // TRANS: Message given saving Instant Messaging address that not valid. + $this->showForm(_('Not a valid Jabber ID.')); return; } else if ($user->jabber == $jabber) { - // TRANS: Message given saving IM address that is already set. + // TRANS: Message given saving Instant Messaging address that is already set. $this->showForm(_('That is already your Jabber ID.')); return; } else if ($this->jabberExists($jabber)) { - // TRANS: Message given saving IM address that is already set for another user. + // TRANS: Message given saving Instant Messaging address that is already set for another user. $this->showForm(_('Jabber ID already belongs to another user.')); return; } @@ -339,7 +339,7 @@ class ImsettingsAction extends ConnectSettingsAction if ($result === false) { common_log_db_error($confirm, 'INSERT', __FILE__); - // TRANS: Server error thrown on database error adding IM confirmation code. + // TRANS: Server error thrown on database error adding Instant Messaging confirmation code. $this->serverError(_('Could not insert confirmation code.')); return; } @@ -348,8 +348,8 @@ class ImsettingsAction extends ConnectSettingsAction $user->nickname, $jabber); - // TRANS: Message given saving valid IM address that is to be confirmed. - // TRANS: %s is the IM address set for the site. + // TRANS: Message given saving valid Instant Messaging address that is to be confirmed. + // TRANS: %s is the Instant Messaging address set for the site. $msg = sprintf(_('A confirmation code was sent '. 'to the IM address you added. '. 'You must approve %s for '. @@ -373,12 +373,12 @@ class ImsettingsAction extends ConnectSettingsAction $confirm = $this->getConfirmation(); if (!$confirm) { - // TRANS: Message given canceling IM address confirmation that is not pending. + // TRANS: Message given canceling Instant Messaging address confirmation that is not pending. $this->showForm(_('No pending confirmation to cancel.')); return; } if ($confirm->address != $jabber) { - // TRANS: Message given canceling IM address confirmation for the wrong IM address. + // TRANS: Message given canceling Instant Messaging address confirmation for the wrong IM address. $this->showForm(_('That is the wrong IM address.')); return; } @@ -387,12 +387,12 @@ class ImsettingsAction extends ConnectSettingsAction if (!$result) { common_log_db_error($confirm, 'DELETE', __FILE__); - // TRANS: Server error thrown on database error canceling IM address confirmation. + // TRANS: Server error thrown on database error canceling Instant Messaging address confirmation. $this->serverError(_('Could not delete IM confirmation.')); return; } - // TRANS: Message given after successfully canceling IM address confirmation. + // TRANS: Message given after successfully canceling Instant Messaging address confirmation. $this->showForm(_('IM confirmation cancelled.'), true); } @@ -412,7 +412,7 @@ class ImsettingsAction extends ConnectSettingsAction // Maybe an old tab open...? if ($user->jabber != $jabber) { - // TRANS: Message given trying to remove an IM address that is not + // TRANS: Message given trying to remove an Instant Messaging address that is not // TRANS: registered for the active user. $this->showForm(_('That is not your Jabber ID.')); return; @@ -428,7 +428,7 @@ class ImsettingsAction extends ConnectSettingsAction if (!$result) { common_log_db_error($user, 'UPDATE', __FILE__); - // TRANS: Server error thrown on database error removing a registered IM address. + // TRANS: Server error thrown on database error removing a registered Instant Messaging address. $this->serverError(_('Could not update user.')); return; } @@ -436,7 +436,7 @@ class ImsettingsAction extends ConnectSettingsAction // XXX: unsubscribe to the old address - // TRANS: Message given after successfully removing a registered IM address. + // TRANS: Message given after successfully removing a registered Instant Messaging address. $this->showForm(_('The IM address was removed.'), true); } diff --git a/actions/inbox.php b/actions/inbox.php index 8330f753ff..3a50f4964f 100644 --- a/actions/inbox.php +++ b/actions/inbox.php @@ -43,7 +43,6 @@ require_once INSTALLDIR.'/lib/mailbox.php'; * @link http://status.net/ * @see MailboxAction */ - class InboxAction extends MailboxAction { @@ -52,13 +51,16 @@ class InboxAction extends MailboxAction * * @return string page title */ - function title() { if ($this->page > 1) { + // TRANS: Title for all but the first page of the inbox page. + // TRANS: %1$s is the user's nickname, %2$s is the page number. return sprintf(_('Inbox for %1$s - page %2$d'), $this->user->nickname, $this->page); } else { + // TRANS: Title for the first page of the inbox page. + // TRANS: %s is the user's nickname. return sprintf(_('Inbox for %s'), $this->user->nickname); } } @@ -72,7 +74,6 @@ class InboxAction extends MailboxAction * * @see MailboxAction::getMessages() */ - function getMessages() { $message = new Message(); @@ -98,7 +99,6 @@ class InboxAction extends MailboxAction * * @return Profile The profile that matches the message */ - function getMessageProfile($message) { return $message->getFrom(); @@ -109,9 +109,9 @@ class InboxAction extends MailboxAction * * @return string localised instructions for using the page */ - function getInstructions() { + // TRANS: Instructions for user inbox page. return _('This is your inbox, which lists your incoming private messages.'); } } diff --git a/actions/invite.php b/actions/invite.php index e9adb3b7f9..a2a0e0714a 100644 --- a/actions/invite.php +++ b/actions/invite.php @@ -19,6 +19,7 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); } +// @todo XXX: Add documentation. class InviteAction extends CurrentUserDesignAction { var $mode = null; @@ -217,7 +218,7 @@ class InviteAction extends CurrentUserDesignAction $this->textarea('addresses', _('Email addresses'), $this->trimmed('addresses'), // TRANS: Tooltip for field label for a list of e-mail addresses. - _('Addresses of friends to invite (one per line)')); + _('Addresses of friends to invite (one per line).')); $this->elementEnd('li'); $this->elementStart('li'); // TRANS: Field label for a personal message to send to invitees.