From: Siebrand Mazeland <s.mazeland@xs4all.nl>
Date: Thu, 24 Mar 2011 11:09:50 +0000 (+0100)
Subject: Translator documentation updated.
X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=e0cccfc40d9789408cc427c1de8822ab7b7a9765;p=quix0rs-gnu-social.git

Translator documentation updated.
i18n/L10n updates.
Superfluous whitespace removed.
Add FIXME for missing class documentation.
---

diff --git a/actions/shownotice.php b/actions/shownotice.php
index b8927372bb..f6074faddc 100644
--- a/actions/shownotice.php
+++ b/actions/shownotice.php
@@ -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
  * @link     http://status.net/
  */
-
 class ShownoticeAction extends OwnerDesignAction
 {
     /**
      * Notice object to show
      */
-
     var $notice = null;
 
     /**
      * Profile of the notice object
      */
-
     var $profile = null;
 
     /**
      * Avatar of the profile of the notice object
      */
-
     var $avatar = null;
 
     /**
@@ -74,7 +70,6 @@ class ShownoticeAction extends OwnerDesignAction
      *
      * @return success flag
      */
-
     function prepare($args)
     {
         parent::prepare($args);
@@ -90,8 +85,10 @@ class ShownoticeAction extends OwnerDesignAction
             // Did we used to have it, and it got deleted?
             $deleted = Deleted_notice::staticGet($id);
             if (!empty($deleted)) {
+                // TRANS: Client error displayed trying to show a deleted notice.
                 $this->clientError(_('Notice deleted.'), 410);
             } else {
+                // TRANS: Client error displayed trying to show a non-existing notice.
                 $this->clientError(_('No such notice.'), 404);
             }
             return false;
@@ -100,6 +97,7 @@ class ShownoticeAction extends OwnerDesignAction
         $this->profile = $this->notice->getProfile();
 
         if (empty($this->profile)) {
+            // TRANS: Server error displayed trying to show a notice without a connected profile.
             $this->serverError(_('Notice has no profile.'), 500);
             return false;
         }
@@ -116,7 +114,6 @@ class ShownoticeAction extends OwnerDesignAction
      *
      * @return boolean true
      */
-
     function isReadOnly($args)
     {
         return true;
@@ -130,7 +127,6 @@ class ShownoticeAction extends OwnerDesignAction
      *
      * @return int last-modified date as unix timestamp
      */
-
     function lastModified()
     {
         return max(strtotime($this->notice->modified),
@@ -147,7 +143,6 @@ class ShownoticeAction extends OwnerDesignAction
      *
      * @return string etag
      */
-
     function etag()
     {
         $avtime = ($this->avatar) ?
@@ -167,11 +162,12 @@ class ShownoticeAction extends OwnerDesignAction
      *
      * @return string title of the page
      */
-
     function title()
     {
         $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'),
                        $base,
                        common_exact_date($this->notice->created));
@@ -186,7 +182,6 @@ class ShownoticeAction extends OwnerDesignAction
      *
      * @return void
      */
-
     function handle($args)
     {
         parent::handle($args);
@@ -218,7 +213,6 @@ class ShownoticeAction extends OwnerDesignAction
      *
      * @return void
      */
-
     function showLocalNavBlock()
     {
     }
@@ -230,7 +224,6 @@ class ShownoticeAction extends OwnerDesignAction
      *
      * @return void
      */
-
     function showContent()
     {
         $this->elementStart('ol', array('class' => 'notices xoxo'));
@@ -245,7 +238,8 @@ class ShownoticeAction extends OwnerDesignAction
         $this->xw->startDocument('1.0', 'UTF-8');
         $this->elementStart('html');
         $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->elementStart('body');
         $nli = new NoticeListItem($this->notice, $this);
@@ -259,7 +253,6 @@ class ShownoticeAction extends OwnerDesignAction
      *
      * @return void
      */
-
     function showPageNoticeBlock()
     {
     }
@@ -269,7 +262,6 @@ class ShownoticeAction extends OwnerDesignAction
      *
      * @return void
      */
-
     function showAside() {
     }
 
@@ -280,7 +272,6 @@ class ShownoticeAction extends OwnerDesignAction
      *
      * @return void
      */
-
     function extraHead()
     {
         $user = User::staticGet($this->profile->id);
@@ -323,16 +314,16 @@ class ShownoticeAction extends OwnerDesignAction
     }
 }
 
+// @todo FIXME: Class documentation missing.
 class SingleNoticeItem extends DoFollowListItem
 {
     /**
-     * recipe function for displaying a single notice.
+     * Recipe function for displaying a single notice.
      *
      * We overload to show attachments.
      *
      * @return void
      */
-
     function show()
     {
         $this->showStart();
@@ -363,7 +354,6 @@ class SingleNoticeItem extends DoFollowListItem
      *
      * @return void
      */
-
     function showAvatar()
     {
 	$avatar_size = AVATAR_PROFILE_SIZE;
diff --git a/actions/showstream.php b/actions/showstream.php
index 10085d94d7..1a01812ec5 100644
--- a/actions/showstream.php
+++ b/actions/showstream.php
@@ -65,7 +65,8 @@ class ShowstreamAction extends ProfileAction
         $base = $this->profile->getFancyName();
         if (!empty($this->tag)) {
             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);
             } else {
                 // TRANS: Page title showing tagged notices in one user's stream.
@@ -153,6 +154,8 @@ class ShowstreamAction extends ProfileAction
                                                array(
                                                     'id' => $this->user->id,
                                                     'format' => 'atom')),
+                              // TRANS: Title for link to notice feed.
+                              // TRANS: %s is a user nickname.
                               sprintf(_('Notice feed for %s (Atom)'),
                                       $this->user->nickname)),
                      new Feed(Feed::FOAF,
diff --git a/actions/silence.php b/actions/silence.php
index 09cc480d9e..c44aa3a6d7 100644
--- a/actions/silence.php
+++ b/actions/silence.php
@@ -40,7 +40,6 @@ if (!defined('STATUSNET')) {
  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  * @link     http://status.net/
  */
-
 class SilenceAction extends ProfileFormAction
 {
     /**
@@ -50,7 +49,6 @@ class SilenceAction extends ProfileFormAction
      *
      * @return boolean success flag
      */
-
     function prepare($args)
     {
         if (!parent::prepare($args)) {
@@ -62,6 +60,7 @@ class SilenceAction extends ProfileFormAction
         assert(!empty($cur)); // checked by parent
 
         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.'));
             return false;
         }
@@ -69,6 +68,7 @@ class SilenceAction extends ProfileFormAction
         assert(!empty($this->profile)); // checked by parent
 
         if ($this->profile->isSilenced()) {
+            // TRANS: Client error displayed trying to silence an already silenced user.
             $this->clientError(_('User is already silenced.'));
             return false;
         }
@@ -81,7 +81,6 @@ class SilenceAction extends ProfileFormAction
      *
      * @return void
      */
-
     function handlePost()
     {
         $this->profile->silence();
diff --git a/actions/siteadminpanel.php b/actions/siteadminpanel.php
index 4238b3e85a..29813ca3b9 100644
--- a/actions/siteadminpanel.php
+++ b/actions/siteadminpanel.php
@@ -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
  * @link     http://status.net/
  */
-
 class SiteadminpanelAction extends AdminPanelAction
 {
     /**
@@ -52,10 +51,10 @@ class SiteadminpanelAction extends AdminPanelAction
      *
      * @return string page 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
      */
-
     function getInstructions()
     {
+        // TRANS: Instructions for site administration panel.
         return _('Basic settings for this StatusNet site');
     }
 
@@ -74,7 +73,6 @@ class SiteadminpanelAction extends AdminPanelAction
      *
      * @return void
      */
-
     function showForm()
     {
         $form = new SiteAdminPanelForm($this);
@@ -87,7 +85,6 @@ class SiteadminpanelAction extends AdminPanelAction
      *
      * @return void
      */
-
     function saveSettings()
     {
         static $settings = array(
@@ -130,6 +127,7 @@ class SiteadminpanelAction extends AdminPanelAction
         // Validate 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.'));
         }
 
@@ -138,9 +136,11 @@ class SiteadminpanelAction extends AdminPanelAction
         $values['site']['email'] = common_canonical_email($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.'));
         }
         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.'));
         }
 
@@ -148,6 +148,7 @@ class SiteadminpanelAction extends AdminPanelAction
 
         if (is_null($values['site']['timezone']) ||
             !in_array($values['site']['timezone'], DateTimeZone::listIdentifiers())) {
+            // TRANS: Client error displayed trying to save site settings without a timezone.
             $this->clientError(_('Timezone not selected.'));
             return;
         }
@@ -156,24 +157,28 @@ class SiteadminpanelAction extends AdminPanelAction
 
         if (!is_null($values['site']['language']) &&
             !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']));
         }
 
         // Validate text limit
 
         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
 
         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."));
         }
-
     }
 }
 
+// @todo FIXME: Class documentation missing.
 class SiteAdminPanelForm extends AdminForm
 {
     /**
@@ -181,7 +186,6 @@ class SiteAdminPanelForm extends AdminForm
      *
      * @return int ID of the form
      */
-
     function id()
     {
         return 'form_site_admin_panel';
@@ -192,7 +196,6 @@ class SiteAdminPanelForm extends AdminForm
      *
      * @return string class of the form
      */
-
     function formClass()
     {
         return 'form_settings';
@@ -203,7 +206,6 @@ class SiteAdminPanelForm extends AdminForm
      *
      * @return string URL of the action
      */
-
     function action()
     {
         return common_local_url('siteadminpanel');
@@ -214,35 +216,44 @@ class SiteAdminPanelForm extends AdminForm
      *
      * @return void
      */
-
     function formData()
     {
         $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->li();
-        $this->input('name', _('Site name'),
-                     _('The name of your site, like "Yourcompany Microblog"'));
+        // TRANS: Field label on site settings panel.
+        $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->li();
+        // TRANS: Field label on site settings panel.
         $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->li();
+        // TRANS: Field label on site settings panel.
         $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->li();
+        // TRANS: Field label on site settings panel.
         $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->out->elementEnd('ul');
         $this->out->elementEnd('fieldset');
 
         $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');
         $timezones = array();
 
@@ -253,14 +264,20 @@ class SiteAdminPanelForm extends AdminForm
         asort($timezones);
 
         $this->li();
+        // TRANS: Dropdown label on site settings panel.
         $this->out->dropdown('timezone', _('Default timezone'),
+                             // TRANS: Dropdown title on site settings panel.
                              $timezones, _('Default timezone for the site; usually UTC.'),
                              true, $this->value('timezone'));
         $this->unli();
 
         $this->li();
-        $this->out->dropdown('language', _('Default language'),
-                             get_nice_language_list(), _('Site language when autodetection from browser settings is not available'),
+        $this->out->dropdown('language',
+                             // 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'));
         $this->unli();
 
@@ -268,14 +285,23 @@ class SiteAdminPanelForm extends AdminForm
         $this->out->elementEnd('fieldset');
 
         $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->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->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->out->elementEnd('ul');
         $this->out->elementEnd('fieldset');
@@ -286,9 +312,14 @@ class SiteAdminPanelForm extends AdminForm
      *
      * @return void
      */
-
     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'));
     }
 }