From 700018fd09be222d9ec163965fd1a3f277d2b931 Mon Sep 17 00:00:00 2001 From: Siebrand Mazeland Date: Tue, 29 Mar 2011 23:00:29 +0200 Subject: [PATCH] L10n/i18n updated. Translator documentation updated. FIXME added for missing class documentation. Various documentation tweaks. --- actions/approvegroup.php | 5 +++-- actions/approvesub.php | 2 +- actions/cancelsubscription.php | 6 ++++- actions/groupqueue.php | 2 ++ actions/profilesettings.php | 15 ++++++------- classes/Group_join_queue.php | 4 ++-- classes/Profile.php | 5 ++--- classes/Subscription.php | 7 ++---- classes/User.php | 1 - lib/accountprofileblock.php | 13 +++++------ lib/cancelsubscriptionform.php | 9 ++------ lib/mail.php | 4 ++-- lib/router.php | 22 +++++++++---------- lib/subgroupnav.php | 40 ++++++++++++++++++++++------------ 14 files changed, 71 insertions(+), 64 deletions(-) diff --git a/actions/approvegroup.php b/actions/approvegroup.php index 55a0a6c3fd..d46a4451c4 100644 --- a/actions/approvegroup.php +++ b/actions/approvegroup.php @@ -121,6 +121,7 @@ class ApprovegroupAction extends Action if (empty($this->request)) { // TRANS: Client error displayed trying to approve group membership for a non-existing request. + // TRANS: %s is a nickname. $this->clientError(sprintf(_('%s is not in the moderation queue for this group.'), $this->profile->nickname), 403); } @@ -176,10 +177,10 @@ class ApprovegroupAction extends Action $this->elementEnd('head'); $this->elementStart('body'); if ($this->approve) { - // TRANS: Message on page for group admin after approving a join request. + // TRANS: Message on page for group admin after approving a join request. $this->element('p', 'success', _('Join request approved.')); } elseif ($this->cancel) { - // TRANS: Message on page for group admin after rejecting a join request. + // TRANS: Message on page for group admin after rejecting a join request. $this->element('p', 'success', _('Join request canceled.')); } $this->elementEnd('body'); diff --git a/actions/approvesub.php b/actions/approvesub.php index d30da25d32..be07b6e877 100644 --- a/actions/approvesub.php +++ b/actions/approvesub.php @@ -2,7 +2,7 @@ /** * StatusNet, the distributed open-source microblogging tool * - * Leave a group + * Approve group subscription request * * PHP version 5 * diff --git a/actions/cancelsubscription.php b/actions/cancelsubscription.php index 367fbfa138..0cd922ff70 100644 --- a/actions/cancelsubscription.php +++ b/actions/cancelsubscription.php @@ -53,6 +53,7 @@ class CancelsubscriptionAction extends Action StatusNet::setApi(true); } if (!common_logged_in()) { + // TRANS: Client error displayed when trying to leave a group while not logged in. $this->clientError(_('Not logged in.')); return; } @@ -78,6 +79,7 @@ class CancelsubscriptionAction extends Action $other_id = $this->arg('unsubscribeto'); if (!$other_id) { + // TRANS: Client error displayed when trying to leave a group without specifying an ID. $this->clientError(_('No profile ID in request.')); return; } @@ -85,6 +87,7 @@ class CancelsubscriptionAction extends Action $other = Profile::staticGet('id', $other_id); if (!$other) { + // TRANS: Client error displayed when trying to leave a non-existing group. $this->clientError(_('No profile with that ID.')); return; } @@ -103,7 +106,8 @@ class CancelsubscriptionAction extends Action if ($this->boolean('ajax')) { $this->startHTML('text/xml;charset=utf-8'); $this->elementStart('head'); - $this->element('title', null, _('Unsubscribed')); + // TRANS: Title after unsubscribing from a group. + $this->element('title', null, _m('TITLE','Unsubscribed')); $this->elementEnd('head'); $this->elementStart('body'); $subscribe = new SubscribeForm($this, $other); diff --git a/actions/groupqueue.php b/actions/groupqueue.php index c6f54d57d7..7cc32a9c69 100644 --- a/actions/groupqueue.php +++ b/actions/groupqueue.php @@ -161,6 +161,7 @@ class GroupqueueAction extends GroupDesignAction } } +// @todo FIXME: documentation missing. class GroupQueueList extends GroupMemberList { function newListItem($profile) @@ -169,6 +170,7 @@ class GroupQueueList extends GroupMemberList } } +// @todo FIXME: documentation missing. class GroupQueueListItem extends GroupMemberListItem { function showActions() diff --git a/actions/profilesettings.php b/actions/profilesettings.php index 7aa987f3a5..8ce1192579 100644 --- a/actions/profilesettings.php +++ b/actions/profilesettings.php @@ -33,8 +33,6 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); } - - /** * Change profile settings * @@ -46,7 +44,6 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 * @link http://status.net/ */ - class ProfilesettingsAction extends SettingsAction { /** @@ -127,15 +124,15 @@ class ProfilesettingsAction extends SettingsAction // TRANS: Tooltip for field label in form for profile settings. Plural // TRANS: is decided by the number of characters available for the // TRANS: biography (%d). - $bioInstr = sprintf(_m('Describe yourself and your interests in %d character', - 'Describe yourself and your interests in %d characters', + $bioInstr = sprintf(_m('Describe yourself and your interests in %d character.', + 'Describe yourself and your interests in %d characters.', $maxBio), $maxBio); } else { // TRANS: Tooltip for field label in form for profile settings. - $bioInstr = _('Describe yourself and your interests'); + $bioInstr = _('Describe yourself and your interests.'); } - // TRANS: Text area label in form for profile settings where users can provide. + // TRANS: Text area label in form for profile settings where users can provide // TRANS: their biography. $this->textarea('bio', _('Bio'), ($this->arg('bio')) ? $this->arg('bio') : $profile->bio, @@ -146,7 +143,7 @@ class ProfilesettingsAction extends SettingsAction $this->input('location', _('Location'), ($this->arg('location')) ? $this->arg('location') : $profile->location, // TRANS: Tooltip for field label in form for profile settings. - _('Where you are, like "City, State (or Region), Country"')); + _('Where you are, like "City, State (or Region), Country".')); $this->elementEnd('li'); if (common_config('location', 'share') == 'user') { $this->elementStart('li'); @@ -196,7 +193,9 @@ class ProfilesettingsAction extends SettingsAction $this->dropdown('subscribe_policy', // TRANS: Dropdown field label on profile settings, for what policies to apply when someone else tries to subscribe to your updates. _('Subscription policy'), + // TRANS: Dropdown field option for following policy. array(User::SUBSCRIBE_POLICY_OPEN => _('Let anyone follow me'), + // TRANS: Dropdown field option for following policy. User::SUBSCRIBE_POLICY_MODERATE => _('Ask me first')), // TRANS: Dropdown field title on group edit form. _('Whether other users need your permission to follow your updates.'), diff --git a/classes/Group_join_queue.php b/classes/Group_join_queue.php index acf3a13957..38473c9b7c 100644 --- a/classes/Group_join_queue.php +++ b/classes/Group_join_queue.php @@ -63,7 +63,7 @@ class Group_join_queue extends Managed_DataObject if (empty($member)) { // TRANS: Exception thrown providing an invalid profile ID. // TRANS: %s is the invalid profile ID. - throw new Exception(sprintf(_("Profile ID %s is invalid."),$this->profile_id)); + throw new Exception(sprintf(_('Profile ID %s is invalid.'),$this->profile_id)); } return $member; @@ -76,7 +76,7 @@ class Group_join_queue extends Managed_DataObject if (empty($group)) { // TRANS: Exception thrown providing an invalid group ID. // TRANS: %s is the invalid group ID. - throw new Exception(sprintf(_("Group ID %s is invalid."),$this->group_id)); + throw new Exception(sprintf(_('Group ID %s is invalid.'),$this->group_id)); } return $group; diff --git a/classes/Profile.php b/classes/Profile.php index 3d989dd974..032a370656 100644 --- a/classes/Profile.php +++ b/classes/Profile.php @@ -168,7 +168,7 @@ class Profile extends Memcached_DataObject function getFancyName() { if ($this->fullname) { - // TRANS: Full name of a profile or group followed by nickname in parens + // TRANS: Full name of a profile or group (%1$s) followed by nickname (%2$s) in parentheses. return sprintf(_m('FANCYNAME','%1$s (%2$s)'), $this->fullname, $this->nickname); } else { return $this->nickname; @@ -180,7 +180,6 @@ class Profile extends Memcached_DataObject * * @return mixed Notice or null */ - function getCurrentNotice() { $notice = $this->getNotices(0, 1); @@ -443,7 +442,7 @@ class Profile extends Memcached_DataObject { return Subscription::exists($this, $other); } - + /** * Check if a pending subscription request is outstanding for this... * diff --git a/classes/Subscription.php b/classes/Subscription.php index 438f1dfe50..8af414b3a7 100644 --- a/classes/Subscription.php +++ b/classes/Subscription.php @@ -267,8 +267,8 @@ class Subscription extends Memcached_DataObject common_date_iso8601($this->created)); $act->time = strtotime($this->created); - // TRANS: Activity tile when subscribing to another person. - $act->title = _("Follow"); + // TRANS: Activity title when subscribing to another person. + $act->title = _m('TITLE','Follow'); // TRANS: Notification given when one person starts following another. // TRANS: %1$s is the subscriber, %2$s is the subscribed. $act->content = sprintf(_('%1$s is now following %2$s.'), @@ -301,7 +301,6 @@ class Subscription extends Memcached_DataObject * * @return Subscription stream of subscriptions; use fetch() to iterate */ - static function bySubscriber($subscriberId, $offset = 0, $limit = PROFILES_PER_PAGE) @@ -362,7 +361,6 @@ class Subscription extends Memcached_DataObject * * @return Subscription stream of subscriptions; use fetch() to iterate */ - static function bySubscribed($subscribedId, $offset = 0, $limit = PROFILES_PER_PAGE) @@ -420,7 +418,6 @@ class Subscription extends Memcached_DataObject * * @return boolean success flag. */ - function update($orig=null) { $result = parent::update($orig); diff --git a/classes/User.php b/classes/User.php index f395dc1e49..abfcb0e8e2 100644 --- a/classes/User.php +++ b/classes/User.php @@ -965,5 +965,4 @@ class User extends Memcached_DataObject return $apps; } - } diff --git a/lib/accountprofileblock.php b/lib/accountprofileblock.php index 6a4021bf04..1c3a8dc536 100644 --- a/lib/accountprofileblock.php +++ b/lib/accountprofileblock.php @@ -44,7 +44,6 @@ if (!defined('STATUSNET')) { * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0 * @link http://status.net/ */ - class AccountProfileBlock extends ProfileBlock { protected $profile = null; @@ -131,9 +130,9 @@ class AccountProfileBlock extends ProfileBlock $this->out->elementStart('li', 'entity_edit'); $this->out->element('a', array('href' => common_local_url('profilesettings'), // TRANS: Link title for link on user profile. - 'title' => _('Edit profile settings')), + 'title' => _('Edit profile settings.')), // TRANS: Link text for link on user profile. - _('Edit')); + _m('BUTTON','Edit')); $this->out->elementEnd('li'); } else { // someone else's page @@ -160,9 +159,9 @@ class AccountProfileBlock extends ProfileBlock $this->out->elementStart('li', 'entity_send-a-message'); $this->out->element('a', array('href' => common_local_url('newmessage', array('to' => $this->user->id)), // TRANS: Link title for link on user profile. - 'title' => _('Send a direct message to this user')), + 'title' => _('Send a direct message to this user.')), // TRANS: Link text for link on user profile. - _('Message')); + _m('BUTTON','Message')); $this->out->elementEnd('li'); // nudge @@ -288,6 +287,6 @@ class AccountProfileBlock extends ProfileBlock $this->out->element('a', array('href' => $url, 'class' => 'entity_remote_subscribe'), // TRANS: Link text for link that will subscribe to a remote profile. - _('Subscribe')); + _m('BUTTON','Subscribe')); } -} \ No newline at end of file +} diff --git a/lib/cancelsubscriptionform.php b/lib/cancelsubscriptionform.php index 1173152c63..a7b566da7b 100644 --- a/lib/cancelsubscriptionform.php +++ b/lib/cancelsubscriptionform.php @@ -46,7 +46,6 @@ require_once INSTALLDIR.'/lib/form.php'; * * @see UnsubscribeForm */ - class CancelSubscriptionForm extends Form { /** @@ -61,7 +60,6 @@ class CancelSubscriptionForm extends Form * @param HTMLOutputter $out output channel * @param Profile $profile being subscribed to */ - function __construct($out=null, $profile=null) { parent::__construct($out); @@ -74,7 +72,6 @@ class CancelSubscriptionForm extends Form * * @return string ID of the form */ - function id() { return 'subscription-cancel-' . $this->profile->id; @@ -85,7 +82,6 @@ class CancelSubscriptionForm extends Form * * @return string of the form class */ - function formClass() { return 'form_unsubscribe ajax'; @@ -96,7 +92,6 @@ class CancelSubscriptionForm extends Form * * @return string URL of the action */ - function action() { return common_local_url('cancelsubscription', @@ -121,9 +116,9 @@ class CancelSubscriptionForm extends Form * * @return void */ - function formActions() { - $this->out->submit('submit', _('Cancel sub request')); + // TRANS: Button text for form action to cancel a subscription request. + $this->out->submit('submit', _m('BUTTON','Cancel subscription request')); } } diff --git a/lib/mail.php b/lib/mail.php index e8c5d3c4e7..eaef2285b5 100644 --- a/lib/mail.php +++ b/lib/mail.php @@ -641,7 +641,7 @@ function mail_notify_message($message, $from=null, $to=null) } /** - * notify a user that one of their notices has been chosen as a 'fave' + * Notify a user that one of their notices has been chosen as a 'fave' * * Doesn't check that the user has an email address nor if they * want to receive notification of faves. Maybe this happens higher @@ -704,7 +704,7 @@ function mail_notify_fave($other, $user, $notice) } /** - * notify a user that they have received an "attn:" message AKA "@-reply" + * Notify a user that they have received an "attn:" message AKA "@-reply" * * @param User $user The user who recevied the notice * @param Notice $notice The notice that was sent diff --git a/lib/router.php b/lib/router.php index 156bc10c7f..6533e24e57 100644 --- a/lib/router.php +++ b/lib/router.php @@ -41,7 +41,7 @@ class StatusNet_URL_Mapper extends Net_URL_Mapper private function __construct() { } - + public static function getInstance($id = '__default__') { if (empty(self::$_singleton)) { @@ -67,7 +67,7 @@ class StatusNet_URL_Mapper extends Net_URL_Mapper } return $result; } - + protected function _mapAction($action, $path) { if (!array_key_exists($action, $this->_actionToPath)) { @@ -76,19 +76,19 @@ class StatusNet_URL_Mapper extends Net_URL_Mapper $this->_actionToPath[$action][] = $path; return; } - + public function generate($values = array(), $qstring = array(), $anchor = '') { if (!array_key_exists('action', $values)) { return parent::generate($values, $qstring, $anchor); } - + $action = $values['action']; if (!array_key_exists($action, $this->_actionToPath)) { return parent::generate($values, $qstring, $anchor); } - + $oldPaths = $this->paths; $this->paths = $this->_actionToPath[$action]; $result = parent::generate($values, $qstring, $anchor); @@ -147,19 +147,19 @@ class Router /** * Create a unique hashkey for the router. - * + * * The router's url map can change based on the version of the software * you're running and the plugins that are enabled. To avoid having bad routes * get stuck in the cache, the key includes a list of plugins and the software * version. - * - * There can still be problems with a) differences in versions of the plugins and + * + * There can still be problems with a) differences in versions of the plugins and * b) people running code between official versions, but these tend to be more * sophisticated users who can grok what's going on and clear their caches. - * + * * @return string cache key string that should uniquely identify a router */ - + static function cacheKey() { $parts = array('router'); @@ -173,7 +173,7 @@ class Router return Cache::codeKey(implode(':', $parts)); } - + function initialize() { $m = StatusNet_URL_Mapper::getInstance(); diff --git a/lib/subgroupnav.php b/lib/subgroupnav.php index b0ec364bff..bd03fe3e45 100644 --- a/lib/subgroupnav.php +++ b/lib/subgroupnav.php @@ -42,7 +42,6 @@ require_once INSTALLDIR.'/lib/widget.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 SubGroupNav extends Menu { var $user = null; @@ -52,7 +51,6 @@ class SubGroupNav extends Menu * * @param Action $action current action, used for output */ - function __construct($action=null, $user=null) { parent::__construct($action); @@ -64,7 +62,6 @@ class SubGroupNav extends Menu * * @return void */ - function show() { $cur = common_current_user(); @@ -76,23 +73,30 @@ class SubGroupNav extends Menu $this->out->menuItem(common_local_url('showstream', array('nickname' => $this->user->nickname)), - _('Profile'), + // TRANS: Menu item in local navigation menu. + _m('MENU','Profile'), (empty($profile)) ? $this->user->nickname : $profile->getBestName(), $action == 'showstream', 'nav_profile'); $this->out->menuItem(common_local_url('subscriptions', array('nickname' => $this->user->nickname)), - _('Subscriptions'), - sprintf(_('People %s subscribes to'), + // TRANS: Menu item in local navigation menu. + _m('MENU','Subscriptions'), + // TRANS: Menu item title in local navigation menu. + // TRANS: %s is a user nickname. + sprintf(_('People %s subscribes to.'), $this->user->nickname), $action == 'subscriptions', 'nav_subscriptions'); $this->out->menuItem(common_local_url('subscribers', array('nickname' => $this->user->nickname)), - _('Subscribers'), - sprintf(_('People subscribed to %s'), + // TRANS: Menu item in local navigation menu. + _m('MENU','Subscribers'), + // TRANS: Menu item title in local navigation menu. + // TRANS: %s is a user nickname. + sprintf(_('People subscribed to %s.'), $this->user->nickname), $action == 'subscribers', 'nav_subscribers'); @@ -103,8 +107,10 @@ class SubGroupNav extends Menu $this->out->menuItem(common_local_url('subqueue', array('nickname' => $this->user->nickname)), - sprintf(_('Pending (%d)'), $pending), - sprintf(_('Approve pending subscription requests'), + // TRANS: Menu item in local navigation menu. + sprintf(_m('MENU','Pending (%d)'), $pending), + // TRANS: Menu item title in local navigation menu. + sprintf(_('Approve pending subscription requests.'), $this->user->nickname), $action == 'subqueueaction', 'nav_subscribers'); @@ -113,15 +119,21 @@ class SubGroupNav extends Menu $this->out->menuItem(common_local_url('usergroups', array('nickname' => $this->user->nickname)), - _('Groups'), - sprintf(_('Groups %s is a member of'), + // TRANS: Menu item in local navigation menu. + _m('MENU','Groups'), + // TRANS: Menu item title in local navigation menu. + // TRANS: %s is a user nickname. + sprintf(_('Groups %s is a member of.'), $this->user->nickname), $action == 'usergroups', 'nav_usergroups'); if (common_config('invite', 'enabled') && !is_null($cur) && $this->user->id === $cur->id) { $this->out->menuItem(common_local_url('invite'), - _('Invite'), - sprintf(_('Invite friends and colleagues to join you on %s'), + // TRANS: Menu item in local navigation menu. + _m('MENU','Invite'), + // TRANS: Menu item title in local navigation menu. + // TRANS: %s is a user nickname. + sprintf(_('Invite friends and colleagues to join you on %s.'), common_config('site', 'name')), $action == 'invite', 'nav_invite');