BREAKING: Add Footer implementation #208

joewalsh · 2019-06-19T19:09:05Z

https://phabricator.wikimedia.org/T217352

To test locally with a local instance of restbase running, use:

pagelib.c1.PageMods.addFooter(
    document,
    'Knight Lore',  // articleTitle
    [pagelib.c1.Footer.MenuItemType.languages, pagelib.c1.Footer.MenuItemType.lastEdited, pagelib.c1.Footer.MenuItemType.pageIssues, pagelib.c1.Footer.MenuItemType.disambiguation, pagelib.c1.Footer.MenuItemType.talkPage],  // menuItems
    { 
        'readMoreHeading': 'Read more',
        'menuDisambiguationTitle': 'Similar pages',
        'menuLanguagesTitle': 'Available in 9 other languages',
        'menuHeading': 'About this article',
        'menuLastEditedSubtitle': 'Full edit history',
        'menuLastEditedTitle': 'Edited today',
        'licenseString': 'Content is available under $1 unless otherwise noted.',
        'menuTalkPageTitle': 'View talk page',
        'menuPageIssuesTitle': 'Page issues',
        'viewInBrowserString': 'View article in browser',
        'licenseSubstitutionString': 'CC BY-SA 3.0',
        'menuCoordinateTitle': 'View on a map'
     }, // localizedStrings
     3,  // readMoreItemCount
     'http://localhost:7231/en.wikipedia.org/v1' // baseUrl for getting ReadMore items
)

And then to add a bookmark icon and text to a single Read more item:

pagelib.c1.PageMods.updateReadMoreSaveButtonForTitle(document, 'Mire Mare', 'Saved for later', true)

Other notes:
This isn't intended to keep working as it did when bundled with the iOS app. The iOS app can stay on an older version of page library and the newer changes should be solely for mobile-html.

berndsi · 2019-06-25T23:01:45Z

Other notes:
This isn't intended to keep working as it did when bundled with the iOS app. The iOS app can stay on an older version of page library and the newer changes should be solely for mobile-html.

@joewalsh What's the main reason to break backwards compatibility for the footer transform?

joewalsh · 2019-06-26T12:06:50Z

@joewalsh What's the main reason to break backwards compatibility for the footer transform?

@berndsi it's not worth investing effort in making the footer transform backwards compatible when it'd only be used for a short while before the iOS app upgrades to mobile-html. It's easier to have a clean break and implement it solely in the best way for mobile-html.

thesocialdev · 2019-07-01T16:35:43Z

src/transform/FooterContainer.css

-  padding-top: 35px;
-  font-size: 0.8em;
-  line-height: 0.8em;
-  color: #72777D;
 }

 .pagelib_theme_sepia .pagelib_footer_container_heading {


Any reason to keep those rules empty? Why not delete it?

Not sure. There had been several empty rules in this CSS file before. @joewalsh Any ideas?

I think all these empty rules can be removed. Should remove the classes in the HTML as well. They might need to be re-added depending on design tweaks.

Ok, I'll do that

thesocialdev

Minor nit inline that I don't think is a big deal. Overall, LGTM.

docs/pcs/pcs.md

joewalsh · 2019-07-01T18:48:55Z

I can't officially approve because it was originally my PR, but looks good to me 👍

thesocialdev · 2019-07-01T18:51:07Z

I can't officially approve because it was originally my PR, but looks good to me

LGTM to me too.

berndsi · 2019-07-01T19:12:03Z

@joewalsh Thank you for fixing the docs.

berndsi · 2019-07-01T21:40:48Z

rebased

Parsoid output has the dir=ltr/rtl on the body instead of the root html element.

The update script requires 'request' which should be installed locally. That way this doesn't need to be installed globally anymore.

It's a bit too much code for the high level PageMods to live in, and seems that it could be a separate and optional feature.

Had changed the name, which should be reflected in the documentation.

Also removed the classes in the HTML. We can add those back if we need them in the future. I left the ids in the HTML, though.

berndsi · 2019-07-01T22:01:58Z

rebased again. There were some conflicts that needed to be resolved first.

joewalsh added WIP changes welcome labels Jun 19, 2019

berndsi mentioned this pull request Jun 24, 2019

Add Adjust text size to demo and fix demo to support new abstraction layer #207

Merged

berndsi changed the title ~~addFooter implementation~~ Add Footer implementation Jun 27, 2019

berndsi changed the title ~~Add Footer implementation~~ BREAKING: Add Footer implementation Jun 27, 2019

berndsi removed WIP changes welcome labels Jun 27, 2019

berndsi requested review from montehurd, niedzielski, mdholloway and natharateh June 27, 2019 21:01

thesocialdev reviewed Jul 1, 2019

View reviewed changes

thesocialdev approved these changes Jul 1, 2019

View reviewed changes

joewalsh commented Jul 1, 2019

View reviewed changes

docs/pcs/pcs.md Outdated Show resolved Hide resolved

berndsi force-pushed the ft branch from 70013d1 to 2bdf20f Compare July 1, 2019 21:40

joewalsh and others added 9 commits July 1, 2019 15:57

rough initial addFooter implementation

38baf5f

set margins

98f7bc9

Fix footer menu icons

2a52745

remove background color from footer container

bde549b

simplify footer container

7330330

style adjustments

e894922

remove android footer heading text size override

9a3b7e1

Fix footer menu item CSS to work for Parsoid

19dc04e

Parsoid output has the dir=ltr/rtl on the body instead of the root html element.

use page/related, hardcoded to localhost for now

ec74239

joewalsh and others added 12 commits July 1, 2019 15:57

pass read more base url as a parameter

f62e5a4

update pagelib_footer_readmore for mobile-html

596414e

expose updateSaveButtonForTitle

d74aefa

remove hover text-decoration in the footer

ac36d9c

Add request dev dependency for update script

f5187a3

The update script requires 'request' which should be installed locally. That way this doesn't need to be installed globally anymore.

Move footer functionality to Footer module

3073bdd

It's a bit too much code for the high level PageMods to live in, and seems that it could be a separate and optional feature.

add more parameter descriptions

f06af97

Add setupInteractionHandlers to Footer.js

cad533b

Add documentation for the footer functionality

4608e02

Update documentation for updateReadMoreSaveButtonForTitle

f9a13e3

Had changed the name, which should be reflected in the documentation.

Remove unused CSS rules in footer

32e878a

Also removed the classes in the HTML. We can add those back if we need them in the future. I left the ids in the HTML, though.

Update pcs.md

d4325cd

berndsi force-pushed the ft branch from 2bdf20f to d4325cd Compare July 1, 2019 22:01

berndsi merged commit 83a325b into master Jul 2, 2019

berndsi deleted the ft branch July 2, 2019 03:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

BREAKING: Add Footer implementation #208

BREAKING: Add Footer implementation #208

joewalsh commented Jun 19, 2019 •

edited by berndsi

Loading

berndsi commented Jun 25, 2019

joewalsh commented Jun 26, 2019 •

edited

Loading

thesocialdev Jul 1, 2019

berndsi Jul 1, 2019

joewalsh Jul 1, 2019

berndsi Jul 1, 2019

berndsi Jul 1, 2019

thesocialdev left a comment

joewalsh commented Jul 1, 2019

thesocialdev commented Jul 1, 2019

berndsi commented Jul 1, 2019

berndsi commented Jul 1, 2019

berndsi commented Jul 1, 2019

BREAKING: Add Footer implementation #208

BREAKING: Add Footer implementation #208

Conversation

joewalsh commented Jun 19, 2019 • edited by berndsi Loading

berndsi commented Jun 25, 2019

joewalsh commented Jun 26, 2019 • edited Loading

thesocialdev Jul 1, 2019

Choose a reason for hiding this comment

berndsi Jul 1, 2019

Choose a reason for hiding this comment

joewalsh Jul 1, 2019

Choose a reason for hiding this comment

berndsi Jul 1, 2019

Choose a reason for hiding this comment

berndsi Jul 1, 2019

Choose a reason for hiding this comment

thesocialdev left a comment

Choose a reason for hiding this comment

joewalsh commented Jul 1, 2019

thesocialdev commented Jul 1, 2019

berndsi commented Jul 1, 2019

berndsi commented Jul 1, 2019

berndsi commented Jul 1, 2019

joewalsh commented Jun 19, 2019 •

edited by berndsi

Loading

joewalsh commented Jun 26, 2019 •

edited

Loading