* Change translator documentation using _m() as designed together with Brion

* Add more translator documentation

Signed-off-by: Siebrand Mazeland <s.mazeland@xs4all.nl>

3 files changed, 46 insertions, 13 deletions

diff --git a/actions/invite.php b/actions/invite.php
index 848607f96..54b2de62a 100644
--- a/actions/invite.php
+++ b/actions/invite.php
@@ -194,7 +194,8 @@ class InviteAction extends CurrentUserDesignAction
                         _('Optionally add a personal message to the invitation.'));
         $this->elementEnd('li');
         $this->elementEnd('ul');
-        $this->submit('send', _m('Send button for inviting friends', 'Send'));
+        // TRANS: Send button for inviting friends
+        $this->submit('send', _m('BUTTON', 'Send'));
         $this->elementEnd('fieldset');
         $this->elementEnd('form');
     }
diff --git a/actions/useradminpanel.php b/actions/useradminpanel.php
index ce87d090a..ee9c23076 100644
--- a/actions/useradminpanel.php
+++ b/actions/useradminpanel.php
@@ -55,7 +55,8 @@ class UseradminpanelAction extends AdminPanelAction
 
     function title()
     {
-        return _m('User admin panel title', 'User');
+        // TRANS: User admin panel title
+        return _m('TITLE', 'User');
     }
 
     /**
diff --git a/lib/action.php b/lib/action.php
index 039e56961..b26ec8f01 100644
--- a/lib/action.php
+++ b/lib/action.php
@@ -435,41 +435,71 @@ class Action extends HTMLOutputter // lawsuit
         $this->elementStart('ul', array('class' => 'nav'));
         if (Event::handle('StartPrimaryNav', array($this))) {
             if ($user) {
+                // TRANS: Tooltip for main menu option "Personal"
+                $tooltip = _m('TOOLTIP', 'Personal profile and friends timeline');
+                // TRANS: Main menu option when logged in for access to personal profile and friends timeline
                 $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
-                                _m('Main menu option when logged in for access to personal profile and friends timeline', 'Personal'), _m('Tooltip for main menu option "Personal"', 'Personal profile and friends timeline'), false, 'nav_home');
+                                _m('MENU', 'Personal'), $tooltip, false, 'nav_home');
+                // TRANS: Tooltip for main menu option "Account"
+                $tooltip = _m('TOOLTIP', 'Change your email, avatar, password, profile');
+                // TRANS: Main menu option when logged in for access to user settings
                 $this->menuItem(common_local_url('profilesettings'),
-                                _m('Main menu option when logged in for access to user settings', 'Account'), _m('Tooltip for main menu option "Account"', 'Change your email, avatar, password, profile'), false, 'nav_account');
+                                _m('MENU', 'Account'), $tooltip, false, 'nav_account');
                 if ($connect) {
+                    // TRANS: Tooltip for main menu option "Services"
+                    $tooltip = _m('TOOLTIP', 'Connect to services');
+                    // TRANS: Main menu option when logged in and connection are possible for access to options to connect to other services
                     $this->menuItem(common_local_url($connect),
-                                    _m('Main menu option when logged in and connection are possible for access to options to connect to other services', 'Connect'), _m('Tooltip for main menu option "Services"', 'Connect to services'), false, 'nav_connect');
+                                    _m('MENU', 'Connect'), $tooltip, false, 'nav_connect');
                 }
                 if ($user->hasRight(Right::CONFIGURESITE)) {
+                    // TRANS: Tooltip for menu option "Admin"
+                    $tooltip = _m('TOOLTIP', 'Change site configuration');
+                    // TRANS: Main menu option when logged in and site admin for access to site configuration
                     $this->menuItem(common_local_url('siteadminpanel'),
-                                    _m('Main menu option when logged in and site admin for access to site configuration', 'Admin'), _m('Tooltip for menu option "Admin"', 'Change site configuration'), false, 'nav_admin');
+                                    _m('MENU', 'Admin'), $tooltip, false, 'nav_admin');
                 }
                 if (common_config('invite', 'enabled')) {
+                    // TRANS: Tooltip for main menu option "Invite"
+                    $tooltip = _m('TOOLTIP', 'Invite friends and colleagues to join you on %s');
+                    // TRANS: Main menu option when logged in and invitations are allowed for inviting new users
                     $this->menuItem(common_local_url('invite'),
-                                    _m('Main menu option when logged in and invitation are allowed for inviting new users', 'Invite'),
-                                    sprintf(_m('Tooltip for main menu option "Invite"', 'Invite friends and colleagues to join you on %s'),
+                                    _m('MENU', 'Invite'),
+                                    sprintf($tooltip,
                                             common_config('site', 'name')),
                                     false, 'nav_invitecontact');
                 }
+                // TRANS: Tooltip for main menu option "Logout"
+                $tooltip = _m('TOOLTIP', 'Logout from the site');
+                // TRANS: Main menu option when logged in to log out the current user
                 $this->menuItem(common_local_url('logout'),
-                                _m('Main menu option when logged in to log out the current user', 'Logout'), _m('Tooltip for main menu option "Logout"', 'Logout from the site'), false, 'nav_logout');
+                                _m('MENU', 'Logout'), $tooltip, false, 'nav_logout');
             }
             else {
                 if (!common_config('site', 'closed')) {
+                    // TRANS: Tooltip for main menu option "Register"
+                    $tooltip = _m('TOOLTIP', 'Create an account');
+                    // TRANS: Main menu option when not logged in to register a new account
                     $this->menuItem(common_local_url('register'),
-                                    _m('Main menu option when not logged in to register a new account', 'Register'), _m('Tooltip for main menu option "Register"', 'Create an account'), false, 'nav_register');
+                                    _m('MENU', 'Register'), $tooltip, false, 'nav_register');
                 }
+                // TRANS: Tooltip for main menu option "Login"
+                $tooltip = _m('TOOLTIP', 'Login to the site');
+                // TRANS: Main menu option when not logged in to log in
                 $this->menuItem(common_local_url('login'),
-                                _m('Main menu option when not logged in to log in', 'Login'), _m('Tooltip for main menu option "Login"', 'Login to the site'), false, 'nav_login');
+                                _m('MENU', 'Login'), $tooltip, false, 'nav_login');
             }
+            // TRANS: Tooltip for main menu option "Help"
+            $tooltip = _m('TOOLTIP', 'Help me!');
+            // TRANS: Main menu option for help on the StatusNet site
             $this->menuItem(common_local_url('doc', array('title' => 'help')),
-                            _m('Main menu option for help on the StatusNet site', 'Help'), _m('Tooltip for main menu option "Help"', 'Help me!'), false, 'nav_help');
+                            _m('MENU', 'Help'), $tooltip, false, 'nav_help');
             if ($user || !common_config('site', 'private')) {
+                // TRANS: Tooltip for main menu option "Search"
+                $tooltip = _m('TOOLTIP', 'Search for people or text');
+                // TRANS: Main menu option when logged in or when the StatusNet instance is not private
                 $this->menuItem(common_local_url('peoplesearch'),
-                                _m('Main menu option when logged in or when the StatusNet instance is not private', 'Search'), _m('Tooltip for main menu option "Search"', 'Search for people or text'), false, 'nav_search');
+                                _m('MENU', 'Search'), $tooltip, false, 'nav_search');
             }
             Event::handle('EndPrimaryNav', array($this));
         }
@@ -490,6 +520,7 @@ class Action extends HTMLOutputter // lawsuit
         if ($text) {
             $this->elementStart('dl', array('id' => 'site_notice',
                                             'class' => 'system_notice'));
+            // TRANS: DT element for site notice. String is hidden in default CSS.
             $this->element('dt', null, _('Site notice'));
             $this->elementStart('dd', null);
             $this->raw($text);