jenkins-bot has submitted this change and it was merged.

Change subject: Add icons for pref, next and index navigation links to the 
Vector skin
......................................................................


Add icons for pref, next and index navigation links to the Vector skin

Improve also the documentation of the JS part

Change-Id: I0aa1e1118857d338804f912decdc2f6d388c13ce
---
M ProofreadPage.body.php
D leftarrow.png
M modules/page/ext.proofreadpage.page.css
M modules/page/ext.proofreadpage.page.edit.js
M modules/page/ext.proofreadpage.page.js
A modules/page/images/leftarrow.png
A modules/page/images/rightarrow.png
A modules/page/images/uparrow.png
D rightarrow.png
D uparrow.png
10 files changed, 133 insertions(+), 43 deletions(-)

Approvals:
  Tpt: Looks good to me, approved
  Rtdwivedi: Looks good to me, but someone else must approve
  jenkins-bot: Verified



diff --git a/ProofreadPage.body.php b/ProofreadPage.body.php
index 061b655..32f48db 100644
--- a/ProofreadPage.body.php
+++ b/ProofreadPage.body.php
@@ -843,46 +843,9 @@
                if( !$title->inNamespace( self::getPageNamespaceId() ) ) {
                        return true;
                }
-               
                $page = ProofreadPagePage::newFromTitle( $title );
-               $indexPage = $page->getIndex();
-               if ( $indexPage ) {
-                       list( $prevTitle, $nextTitle ) = 
$indexPage->getPreviousAndNextPages( $page->getTitle() );
 
-                       if ( $prevTitle !== null ) {
-                               if( !$prevTitle->exists() ) {
-                                       $prevLink = $prevTitle->getEditURL();
-                               } else {
-                                       $prevLink = $prevTitle->getLinkUrl();
-                               }
-                               $links['namespaces']['proofreadPagePrevLink'] = 
array(
-                                       'class' => '',
-                                       'href' => $prevLink,
-                                       'text' => wfMessage( 
'proofreadpage_prevpage' )->plain()
-                               );
-                       }
-
-                       $indexLink = $indexPage->getTitle()->getLinkUrl();
-                       $links['namespaces']['proofreadPageIndexLink'] = array(
-                               'class' => '',
-                               'href' => $indexLink,
-                               'text' => wfMessage( 'proofreadpage_index' 
)->plain()
-                       );
-
-                       if ( $nextTitle !== null ) {
-                               if( !$nextTitle->exists() ) {
-                                       $nextLink = $nextTitle->getEditURL();
-                               } else {
-                                       $nextLink = $nextTitle->getLinkUrl();
-                               }
-                               $links['namespaces']['proofreadPageNextLink'] = 
array(
-                                       'class' => '',
-                                       'href' => $nextLink,
-                                       'text' => wfMessage( 
'proofreadpage_nextpage' )->plain()
-                               );
-                       }
-               }
-
+               //Image link
                $image = $page->getImage();
                if ( $image ) {
                        $transformAttributes = array(
@@ -895,17 +858,56 @@
                                }
                        }
                        $handler = $image->getHandler();
-                       if( $handler && $handler->normaliseParams( $image, 
$transformAttributes ) ) {
+                       if ( $handler && $handler->normaliseParams( $image, 
$transformAttributes ) ) {
                                $thumbName = $image->thumbName( 
$transformAttributes );
                                $imageUrl = $image->getThumbUrl( $thumbName );
                                $links['namespaces']['proofreadPageScanLink'] = 
array(
                                        'class' => '',
                                        'href' => $imageUrl,
-                                       'text' => wfMessage( 
'proofreadpage_image')->plain()
+                                       'text' => wfMessage( 
'proofreadpage_image' )->plain()
                                );
                        }
                }
 
+               //Prev, Next and Index links
+               $indexPage = $page->getIndex();
+               if ( $indexPage ) {
+                       list( $prevTitle, $nextTitle ) = 
$indexPage->getPreviousAndNextPages( $page->getTitle() );
+
+                       if ( $prevTitle !== null ) {
+                               if ( !$prevTitle->exists() ) {
+                                       $prevLink = $prevTitle->getEditURL();
+                               } else {
+                                       $prevLink = $prevTitle->getLinkUrl();
+                               }
+                               $links['namespaces']['proofreadPagePrevLink'] = 
array(
+                                       'class' => ( $skin->skinname === 
'vector' ) ? 'icon' : '',
+                                       'href' => $prevLink,
+                                       'text' => wfMessage( 
'proofreadpage_prevpage' )->plain()
+                               );
+                       }
+
+                       if ( $nextTitle !== null ) {
+                               if ( !$nextTitle->exists() ) {
+                                       $nextLink = $nextTitle->getEditURL();
+                               } else {
+                                       $nextLink = $nextTitle->getLinkUrl();
+                               }
+                               $links['namespaces']['proofreadPageNextLink'] = 
array(
+                                       'class' => ( $skin->skinname === 
'vector' ) ? 'icon' : '',
+                                       'href' => $nextLink,
+                                       'text' => wfMessage( 
'proofreadpage_nextpage' )->plain()
+                               );
+                       }
+
+                       $indexLink = $indexPage->getTitle()->getLinkUrl();
+                       $links['namespaces']['proofreadPageIndexLink'] = array(
+                               'class' => ( $skin->skinname === 'vector' ) ? 
'icon' : '',
+                               'href' => $indexLink,
+                               'text' => wfMessage( 'proofreadpage_index' 
)->plain()
+                       );
+               }
+
                return true;
        }
 }
diff --git a/leftarrow.png b/leftarrow.png
deleted file mode 100644
index 80b234e..0000000
--- a/leftarrow.png
+++ /dev/null
Binary files differ
diff --git a/modules/page/ext.proofreadpage.page.css 
b/modules/page/ext.proofreadpage.page.css
index 8a9901e..d8decea 100644
--- a/modules/page/ext.proofreadpage.page.css
+++ b/modules/page/ext.proofreadpage.page.css
@@ -22,4 +22,37 @@
 }
 .table-cell-right {
        display:table-cell;
+}
+
+#ca-proofreadPagePrevLink.icon a,
+#ca-proofreadPageNextLink.icon a,
+#ca-proofreadPageIndexLink.icon a {
+       margin: 0;
+       padding: 0;
+       outline: none;
+       display: block;
+       width: 26px;
+       /* This hides the text but shows the background image */
+       padding-top: 3.1em;
+       margin-top: 0;
+       /* Only applied in IE6 */
+       margin-top: -0.8em !ie;
+       height: 0;
+       overflow: hidden;
+       background-position: 50% 70%;
+}
+
+#ca-proofreadPagePrevLink.icon a {
+       /* @embed */
+       background-image: url( 'images/leftarrow.png' );
+}
+
+#ca-proofreadPageNextLink.icon a {
+       /* @embed */
+       background-image: url( 'images/rightarrow.png' );
+}
+
+#ca-proofreadPageIndexLink.icon a {
+       /* @embed */
+       background-image: url( 'images/uparrow.png' );
 }
\ No newline at end of file
diff --git a/modules/page/ext.proofreadpage.page.edit.js 
b/modules/page/ext.proofreadpage.page.edit.js
index 8a9ca07..03a163e 100644
--- a/modules/page/ext.proofreadpage.page.edit.js
+++ b/modules/page/ext.proofreadpage.page.edit.js
@@ -1,19 +1,30 @@
 ( function ( mw, $ ) {
        'use strict';
 
+       /**
+        * Show or hide header and footer areas
+        *
+        * @param string speed of the toogle. May be 'fast', 'slow' or undefined
+        */
        function toggleHeaders( speed ) {
                $( '.prp-page-edit-header' ).toggle( speed );
                $( '.prp-page-edit-body label' ).toggle( speed );
                $( '.prp-page-edit-footer' ).toggle( speed );
        }
 
+       /**
+        * Apply user preferences
+        */
        function setupPreferences() {
                if( !mw.user.options.get( 'proofreadpage-showheaders' ) ) {
-                       toggleHeaders( undefined );
+                       toggleHeaders();
                }
                //TODO: scan on top of the edit system
        }
 
+       /**
+        * Init the automatic fill of the summary input box
+        */
        function setupPageQuality() {
                $( 'input[name="wpQuality"]' ).click( function() {
                        var text = mw.msg( 'proofreadpage_quality' + this.value 
+ '_category' );
@@ -21,6 +32,9 @@
                } );
        }
 
+       /**
+        * Add some buttons to the toolbar
+        */
        function addButtons() {
                var iconPath = mw.config.get( 'wgExtensionAssetsPath' ) + 
'/ProofreadPage/modules/page/images/';
                var tools = {
diff --git a/modules/page/ext.proofreadpage.page.js 
b/modules/page/ext.proofreadpage.page.js
index 3a80314..b6f5cf9 100644
--- a/modules/page/ext.proofreadpage.page.js
+++ b/modules/page/ext.proofreadpage.page.js
@@ -1,8 +1,10 @@
 ( function ( mw, $ ) {
        'use strict';
 
-       //init zoom system. The load event is used because the page needs to be 
rendered before calling fitWidth
-       $( document).ready( function() {
+       /**
+        * Init the zoom system
+        */
+       function initZoom() {
                var $image = $( '.prp-page-image img' );
                if( $image.length === 0 ) {
                        return;
@@ -12,6 +14,45 @@
                        $image.panZoom( 'loadImage' );
                        $image.panZoom( 'fitWidth' );
                } );
+       }
+
+       /**
+        * Get the selector for the main tabs container
+        *
+        * @return string
+        */
+       function getTabsContainerSelector() {
+               switch( mw.config.get( 'skin' ) ) {
+                       case 'vector':
+                               return '#p-namespaces ul';
+                       case 'monobook':
+                       case 'modern':
+                               return '#p-cactions ul';
+                       default:
+                               return '';
+               }
+       }
+
+       /*
+        * Improve the tabs presentation
+        */
+       function initTabs() {
+               //Move prev and next links
+               $( getTabsContainerSelector() )
+                       .prepend( $( '#ca-proofreadPageNextLink') )
+                       .prepend( $( '#ca-proofreadPagePrevLink') );
+
+               //add title attribute to links move to icon
+               var tabsToIcon = [ 'proofreadPagePrevLink', 
'proofreadPageNextLink', 'proofreadPageIndexLink' ];
+               $.each( tabsToIcon, function( i, id ) {
+                       var $link = $( '#ca-' + id + '.icon a' );
+                       $link.attr( 'title', $link.text() );
+               } );
+       }
+
+       $( document ).ready( function() {
+               initTabs();
+               initZoom();
        } );
 
 } ( mediaWiki, jQuery ) );
\ No newline at end of file
diff --git a/modules/page/images/leftarrow.png 
b/modules/page/images/leftarrow.png
new file mode 100644
index 0000000..92e1adf
--- /dev/null
+++ b/modules/page/images/leftarrow.png
Binary files differ
diff --git a/modules/page/images/rightarrow.png 
b/modules/page/images/rightarrow.png
new file mode 100644
index 0000000..48b5548
--- /dev/null
+++ b/modules/page/images/rightarrow.png
Binary files differ
diff --git a/modules/page/images/uparrow.png b/modules/page/images/uparrow.png
new file mode 100644
index 0000000..58091bc
--- /dev/null
+++ b/modules/page/images/uparrow.png
Binary files differ
diff --git a/rightarrow.png b/rightarrow.png
deleted file mode 100644
index 6f4f397..0000000
--- a/rightarrow.png
+++ /dev/null
Binary files differ
diff --git a/uparrow.png b/uparrow.png
deleted file mode 100644
index 0702ed3..0000000
--- a/uparrow.png
+++ /dev/null
Binary files differ

-- 
To view, visit https://gerrit.wikimedia.org/r/89170
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: I0aa1e1118857d338804f912decdc2f6d388c13ce
Gerrit-PatchSet: 3
Gerrit-Project: mediawiki/extensions/ProofreadPage
Gerrit-Branch: pagePagesRefactoring
Gerrit-Owner: Tpt <[email protected]>
Gerrit-Reviewer: Rtdwivedi <[email protected]>
Gerrit-Reviewer: Tpt <[email protected]>
Gerrit-Reviewer: jenkins-bot

_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

Reply via email to