wikimedia/mediawiki-extensions-Cite
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Cite synced 2024-11-11 16:49:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge "Rename function to getIndexLabel to clarify that it's presentation"

Browse source
This commit is contained in:
jenkins-bot 2024-08-01 06:33:30 +00:00 committed by Gerrit Code Review
parent 5390af6c37 baedd6c44c
commit 8ef86b2f0f
6 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
modules/ve-cite/ve.ce.MWReferencesListNode.js
View file

@ -275,7 +275,7 @@ ve.ce.MWReferencesListNode.prototype.renderListItem = function ( nodes, internal
);
const $li = $( '<li>' )
.css( '--footnote-number', `"${ this.docRefs.getIndexNumber( refGroup, key ) }."` )
.css( '--footnote-number', `"${ this.docRefs.getIndexLabel( refGroup, key ) }."` )
.append( this.renderBacklinks( keyedNodes, refGroup ), ' ' );
// Generate reference HTML from first item in key

6
modules/ve-cite/ve.dm.MWDocumentReferences.js
View file

@ -114,14 +114,14 @@ ve.dm.MWDocumentReferences.static.contentLangDigits = function ( num ) {
};
/**
* @deprecated Should be refactored to store index numbers as a simple property
* in each ref node after document transaction.
* @deprecated Should be refactored to store formatted index numbers as a simple
* property on each CE ref node after document transaction.
* @param {string} groupName Ref group without prefix
* @param {string} listKey Ref key with prefix
* @return {string} Rendered index number string which can be used as a footnote
* marker or reflist item number.
*/
ve.dm.MWDocumentReferences.prototype.getIndexNumber = function ( groupName, listKey ) {
ve.dm.MWDocumentReferences.prototype.getIndexLabel = function ( groupName, listKey ) {
return ( this.cachedByGroup[ 'mwReference/' + groupName ] || {} )[ listKey ];
};

2
modules/ve-cite/ve.dm.MWReferenceNode.js
View file

@ -339,7 +339,7 @@ ve.dm.MWReferenceNode.static.getIndexLabel = function ( dataElement, internalLis
ve.dm.MWReferenceNode.static.findIndexNumber = function ( dataElement, internalList ) {
return ve.getProp( dataElement, 'internal', 'overrideIndex' ) ||
ve.dm.MWDocumentReferences.static.refsForDoc( internalList.getDocument() )
.getIndexNumber( dataElement.attributes.refGroup, dataElement.attributes.listKey );
.getIndexLabel( dataElement.attributes.refGroup, dataElement.attributes.listKey );
};
/**

2
modules/ve-cite/ve.ui.MWReferenceSearchWidget.js
View file

@ -170,7 +170,7 @@ ve.ui.MWReferenceSearchWidget.prototype.buildSearchIndex = function () {
const listKey = node.getAttribute( 'listKey' );
// remove `mwReference/` prefix
const group = groupName.slice( 12 );
const footnoteNumber = docRefs.getIndexNumber( group, listKey );
const footnoteNumber = docRefs.getIndexLabel( group, listKey );
const citation = ( group ? group + ' ' : '' ) + footnoteNumber;
// Use [\s\S]* instead of .* to catch esoteric whitespace (T263698)

8
tests/qunit/ve-cite/ve.dm.MWDocumentReferences.test.js
View file

@ -17,8 +17,8 @@ QUnit.test( 'first simple test', ( assert ) => {
assert.strictEqual( firstListKey, 'auto/0' );
assert.strictEqual( fooGroupListKey, 'auto/2' );
assert.strictEqual( docRefs.getIndexNumber( '', firstListKey ), '1' );
assert.strictEqual( docRefs.getIndexNumber( 'foo', fooGroupListKey ), '1' );
assert.strictEqual( docRefs.getIndexLabel( '', firstListKey ), '1' );
assert.strictEqual( docRefs.getIndexLabel( 'foo', fooGroupListKey ), '1' );
} );
QUnit.test( 'extends test', ( assert ) => {
@ -35,10 +35,10 @@ QUnit.test( 'extends test', ( assert ) => {
const firstListKey = groupedRefs[ '' ][ 0 ].getAttribute( 'listKey' );
assert.strictEqual( firstListKey, 'auto/1' );
// FIXME: Documents incorrect behavior, should be '2'.
assert.strictEqual( docRefs.getIndexNumber( '', firstListKey ), '1' );
assert.strictEqual( docRefs.getIndexLabel( '', firstListKey ), '1' );
const subrefListKey = groupedRefs[ 'literal/ldr' ][ 0 ].getAttribute( 'listKey' );
assert.strictEqual( subrefListKey, 'auto/0' );
// FIXME: Documents incorrect behavior, should be '1.1'.
assert.strictEqual( docRefs.getIndexNumber( '', subrefListKey ), '2.1' );
assert.strictEqual( docRefs.getIndexLabel( '', subrefListKey ), '2.1' );
} );

2
tests/qunit/ve-cite/ve.ui.MWReferenceSearchWidget.test.js
View file

@ -11,7 +11,7 @@ function getInternalListMock( groups, mockWithNode ) {
const refDocMock = {
getAllGroupNames: () => ( Object.keys( groups ) ),
getGroupRefsByParents: () => ( { '': [ node ] } ),
getIndexNumber: () => ( 1 ),
getIndexLabel: () => ( '1' ),
getItemNode: () => ( node )
};
const docMock = {