Page MenuHomePhabricator

Remove non-supported options from the book creator UI
Closed, ResolvedPublic

Assigned To
Authored By
ovasileva
Sep 12 2017, 12:33 PM
Referenced Files
F9514685: creator-with-chapter.png
Sep 14 2017, 12:23 AM
F9514667: bookcreator.png
Sep 14 2017, 12:19 AM
F9514674: creator-with-chapter.png
Sep 14 2017, 12:19 AM
F9514482: Artboard Copy.png
Sep 14 2017, 12:07 AM
F9514480: chapter.png
Sep 14 2017, 12:07 AM
F9514483: Artboard Copy 2.png
Sep 14 2017, 12:07 AM
F9512924: book-creator.png
Sep 13 2017, 10:20 PM
F9512908: image.png
Sep 13 2017, 10:18 PM

Description

Background

Since the sunset of OCG (T150871), Special:Book doesn't support PDF formatting options, so they should be removed from the UI.

Acceptance Criteria

Remove the following from the books creator UI (Special: Book)

  • paper size
  • include table of contents
  • columns

Event Timeline

@bmansurov - could you take a look at the a/c - I'm fairly certain that we will not be supporting the entire list, but wanted to double-check

paper size

Electron supports different paper sizes. We can keep this.

include table of contents

Table of contents exists in @Tgr's work. No page numbers though.

columns

Yeah, we can remove this option.

plaintext option (under format)

Yes, remove for now.

Make download option appear prior to Pediapress ordering option.

Why? I think Gergo's work integrates with Pediapress ordering page.

include table of contents

Table of contents exists in @Tgr's work. No page numbers though.

this is the option that lets us exclude the toc - would we still have that? I was under the impression we would have an auto TOC with no option to remove. If we still have it - no problem, we can keep it in.

Make download option appear prior to Pediapress ordering option.

Why? I think Gergo's work integrates with Pediapress ordering page.

Yeah, but users are more likely to print their own book rather than order from Pediapress (we're not removing pediapress, just it's weird that it's before actually downloading). I'll leave this one up to @Nirzar though

We can me showing the table of contents configurable. It's up to you.

Regarding Pediapress, I think I misunderstood you I mean the download page where users are able to order chapters and articles.

We can me showing the table of contents configurable. It's up to you.

Would it be configurable out of the box? If not, we don't really need to.

Regarding Pediapress, I think I misunderstood you I mean the download page where users are able to order chapters and articles.

Got it. Will make description clearer.

Would it be configurable out of the box? If not, we don't really need to.

If we don't code the UI part (i.e. we control it ourselves, and not let the user do it), then it's a simple change.

Here's a mock

Before

image.png (1×2 px, 445 KB)

After

book-creator.png (1×2 px, 469 KB)

Changes

  • Better form elements, textfields, buttons, dropdowns to match WMF styleguide
  • Better sorting and ordering
  • Better heirarchy of the page
  • Prominent call to action to download
  • upsell for pediapress

Yeah, but users are more likely to print their own book rather than order from Pediapress (we're not removing pediapress, just it's weird that it's before actually downloading). I'll leave this one up to @Nirzar though

totally agree, downloading is primary here. it is reflected in the mock

Looks nice! It needs a "create chapter" button though. And it would be nice if the mockup showed how chapters are displayed (the old layout uses an indented list; that probably doesn't look nice with the drag panels).

Looks nice! It needs a "create chapter" button though. And it would be nice if the mockup showed how chapters are displayed (the old layout uses an indented list; that probably doesn't look nice with the drag panels).

Thanks! forgot about that. let me put up another iteration

Updated the RHS a bit as well

chapter.png (1×2 px, 164 KB)

Updated the UI for better hierarchy and layout

Much easier to understand

bookcreator.png (1×2 px, 464 KB)

creator-with-chapter.png (1×2 px, 480 KB)

"Book creator UI" sounds like something that belongs to Collection, not to a rendering engine. Is the component right?

Is there someone working on this? The PDF creator was, somehow, reactivated (with lots of errors still), but creating a book is still impossible.

Is there someone working on this?

No, there is not - the assignee field is empty and the task has "open" status. This applies in general.

Six years with a message claiming that the Book creator is "undergoing changes", but it doesn't seem to undergo anything. Could the team that broke this solve it somehow?

I assume the team does not exist anymore or if it did it had other, more pressing priorities

Yes, I assume that the team doesn't exist anymore. But @ovasileva is still working at the Wikimedia Foundation, and she is the Product Manager of the Web Team, so it would be interesting, just for the accountability of what each one has been doing, to know what steps they have taken in order to unbreak that it was broken by that team. Because there's still a message claiming that the Book creator is "undergoing changes", and that implies that, in fact, it is "undergoing" those changes.

This task was written before the WMF decided to not support multi-article PDF generation (per Reading/Web/PDF Functionality: In terms of books, we've left it in the hands of volunteer developers and PediaPress. We'll be glad to reach out to them with questions, but we're not planning any involvement in terms of the technical implementation.) You can (AFAIK) still buy physical books from PediaPress via the book creator, but few people do so putting effort redesigning the UI probably doesn't make much sense.

The part of this task about removing non-functional options from the UI is still relevant, and should be trivial to do. Probably the "Book Creator is undergoing changes" notice should be removed too, it has been seven years so everyone is quite aware of the changes by now.

Tgr renamed this task from Redesign book creator UI to Remove non-supported options from the book creator UI.Dec 28 2023, 6:58 PM
Tgr updated the task description. (Show Details)
  • plaintext option (under format) - this doesn't seem to exist anymore
  • Make download PDF option appear prior to Pediapress ordering option - not relevant anymore since Special:Book doesn't support multi-article PDF, I think?
  • plaintext option (under format) - this doesn't seem to exist anymore

Actually it does exist, but only shows when $wgCollectionDisableDownloadSection is false, so ignored in Wikimedia production.

but only shows when $wgCollectionDisableDownloadSection is false

Actually not! It just got hidden in site CSS on enwiki (and then that got copied to a ton of other wikis). But it probably should get hidden automatically.

Change 986526 had a related patch set uploaded (by Gergő Tisza; author: Gergő Tisza):

[mediawiki/extensions/Collection@master] Special:Book: Hide download-related options when download disabled

https://gerrit.wikimedia.org/r/986526

Change 986527 had a related patch set uploaded (by Gergő Tisza; author: Gergő Tisza):

[mediawiki/extensions/Collection@master] Remove announcement about retiring OCG

https://gerrit.wikimedia.org/r/986527

@ovasileva weighed in and had no problems with the proposal to remove the banner.
I've left a review on the patch to change the copy and then we can push ahead with the proposed removal of banner to clear up the confusion here.

Removing the banner without solving the problem is quite strange. Like hiding the dust below the carpet. But whatever, if this will continue being broken on purpose forever, the banner makes no sense.

Change 986526 merged by jenkins-bot:

[mediawiki/extensions/Collection@master] Special:Book: Hide download-related options when download disabled

https://gerrit.wikimedia.org/r/986526

Change 986527 merged by jenkins-bot:

[mediawiki/extensions/Collection@master] Special:Book: Remove announcement about retiring OCG

https://gerrit.wikimedia.org/r/986527

Tgr claimed this task.