Technologies communautaires/Amélioration de l'export des livres électroniques

This page is a translated version of the page Community Tech/Ebook Export Improvement and the translation is 2% complete.
Checked.svg

This page documents a project the Wikimedia Foundation's Community Tech team has worked on or declined in the past. Technical work on this project is complete.

We invite you to join the discussion on the talk page.

Other languages:
Deutsch • ‎English • ‎dansk • ‎español • ‎français • ‎polski • ‎日本語

Le projet d'amélioration de l'export des livres électroniques est une évolution du fonctionnement des livres électroniques dans Wikisource. Dans le système actuel, contributeurs et lecteurs sont confrontés à plusieurs difficultés, notamment de fiabilité des exports, de formatage des textes, d'affichage des modèles, et d'expérience utilisateur. Ces problèmes ajoutent de la complexité et de la frustration au processus d'export classique de Wikisource, et dissuadent beaucoup de contributeurs de s'investir pleinement dans le projet Wikisource. Ce projet a été élu souhait n°1 de la Community Wishlist Survey 2020.

De manière générale, l'export des livres électroniques depuis Wikisource a un énorme potentiel auprès du public, mais le fonctionnement devrait être amélioré pour rencontrer un succès plus large encore. Au cours du projet, nous chercherons et identifierons les problèmes-clés, nous collaborerons avec les différentes communautés de Wikisource et développerons des solutions pour soutenir et améliorer l'export des livres électroniques. Nous lirons avec intérêt les réactions de la communauté dans la page de discussion.

Pourquoi exporter des livres électroniques ?

Habituellement, l'export des livres électroniques est une part centrale de l'expérience de Wikisource, et les utilisateurs qui exportent des livres électroniques le font pour de nombreuses raisons. D'abord, ils peuvent exporter des livres électroniques pour contourner leurs problèmes d'accessibilité à Internet. Avec des livres disponibles hors ligne, ils peuvent lire facilement leur choix de textes sur toute une gamme de liseuses, peu importe la qualité de la connexion à Internet (lente, intermittente ou peu fiable).

Second, users may want to read the book on a device that is optimized for ebooks. For example, devices such as the Kindle or Kobo allow users customize the interface, add notes, look up words, and have a long battery life. Consequently, many users choose to export an ebook into a compatible file format, which can then be transferred to an eReader device.

Third, users may want to share an ebook with someone in an easily accessible format. For this reason, they may choose to export the ebook in a preferred format, which they can share with the recipient. This process is generally more flexible than sharing a web link to Wikisource.

Fourth, the user may work in a professional setting, such as an educational institution, archive, or museum, and they want to store an offline copy for general reference or educational purposes. The export of an ebook allows them to integrate the content into their own files and workflow, rather than having to consistently access Wikisource.

How Ebook Exports Work

In Wikisource, there are four primary methods to download an ebook: directly via WSExport, via the left side panel, via links on the main page (such as a featured book), or via the links above texts. There is also a fifth method (create a book), which is technically available, but very uncommonly used. We will discuss all of the methods below. However, it is important to understand that not all wikis have the same download options. Some have only one download option, while others have many options.

#1: WSExport

First, WSExport is the primary tool for exporting ebooks on Wikisource. This tool, originally developed by user Tpt for French Wikisource, permits downloads in a variety of formats, such as EPUB and PDF. To access WS Export, one can navigate to the left side-panel and click on “Choose format,” under the “Download/print” section. Alternatively, users can directly visit ws-export.wmcloud.org

When using WSExport, the user must specify certain things to generate an ebook export. These include the language code, the title of the page, fonts included (if any), and whether images should be included. The user must manually type in the language code and page name, but they can select the file format and fonts via drop-down. Once the user clicks “Export,” the tool will provide a downloadable version of the page in the user’s specified format. Further documentation on the tool can be found on Wikisource:WSexport.

It should be noted that the “Include fonts” section has different use cases, depending on the language selection. For Latin-scripted languages, the user is generally selecting a font, such as “Free Serif.” However, for Indic languages, the user must often specify an actual script, which is required to properly export the ebook.

 
Example of WSExport page, when exporting an EPUB file in English with no fonts

#2: Export via the left side panel

Second, users can access ebook exports via the left side panel (“Download/print”). With this method, the user can see all file formats available for download. For example, in the screenshot below, the user has the option to download a PDF, EPUB, or MOBI file of The Jungle.

When using the side panel, the default option available is typically only single-part PDFs, which are downloaded via ElectronPDF. If you want to download a multi-part book in the side panel, you need to enable WSExport in Preferences > Gadgets > Interface > “Add a print/export link to download pages as EPUB files using the WSExport tool.” This will add the EPUB and MOBI option to the navigation menu, so that you can directly download multi-part books. In the example below, you can see that the user can download the entire contents, since they have enabled multi-part book downloads.

 
Example of multi-part book, which can be downloaded as an EPUB file

#3: Export via links on the main page

Third, users can download books via links on the main page. For example, in the screenshot below, you will see that “April’s Featured Article” has a section called “Grab a download!” One can choose from four main file formats, which are specified if the user hovers over each icon. This user can click an icon, which automatically triggers a download that uses the WSExport tool.

 
Example of direct download icon links on main page (English Wikisource)

#4: Export via links at the top of text

Fourth, users can sometimes access download links at the top of text. For example, in the screenshot  below, download options are presented for a text in Bengali Wikisource. Like the side panel, the user sees the file formats that are available for download, and the downloads are conducted with the WSExport tool.

 
Example of direct download links at the top of the page (Bengali Wikisource)

#5: “Create a book”

Fifth, you can create a book as an ODT and ZIM file. To do this, go to the “Create a book” link in the side panel, which will redirect you to Special:Book, also known as “Manage your book.” On this page, you can manually specify each page that you want in your book, which you will need to do repeatedly until you have specified all the pages. It should be noted that this process was designed for Wikipedia users who want to create source texts. It is not convenient for Wikisource users, so it is rarely used for Wikisource-related purposes.

The Primary Issues with Current Ebook Exports

There are many issues with the current ebook export process, which we will divide into three categories: reliability, formatting and styles, and user experience.

Reliability

The WSExport tool is not consistently reliable. Users report frequent downtime and timeout issues, which prevent them from exporting books. Some of these issues have been documented in Phabricator tickets, such as T250614 and T219330#5060262. In 2019, this issue became the #4 wish in the 2019 Community Wishlist Survey. As a result, the Community Tech team launched the Ebook Export Reliability project, which aimed to improve the export experience. By the completion of the project, WSExport had 99.42% average monthly update (recorded on June 20, 2019), and downtime went from 941 minutes total (between May 1-15, 2019) to 179 minutes (between June 1-15, 2019). Further data on Wikisource reliability after the team’s changes can be found in T226136.

Despite these improvements, issues persisted for the Wikisource community. Users continued to experience issues, such as those detailed Problems detected in epub generated with Wsexport, compiled by Viticulum on French Wikisource. For example, on September 30, 2019, WSExport was inoperable for about 12 hours. In total, 13 outages were reported, with many of them lasting for hours. Furthermore, recent tests conducted by the Community Tech team have identified intermittent problems when trying to download MOBI files. The timeout message currently only appears when on the WSExport page (not via download links), as well. In total, this situation can be very frustrating for Wikisource users, and they often don’t know how to respond to such issues.

Formatting & Styles

Ebook exports often have formatting and style issues. These issues vary, but they may include: missing or altered text, duplicated text, poor pagination, missing table titles, incorrect capitalization, incorrect border styles, incorrect content alignment, incorrect table alignment, and incorrect table styles. In some cases, the words themselves are altered. These errors can be confusing and concerning to users. They also go against the Wikisource policy of mirroring the source text. Below, we have provided some examples of the issues we’re seeing. This isn’t an exhaustive list, but it can give some idea of common errors.

Example #1: Page split between 2 pages

In the screenshot below, you will see that the content is divided into two pages. However, in the original version in English Wikisource, it was displayed on one page.

 
Content split into 2 pages (1st page)
 
Content split into 2 pages (2nd page)

Example #2: Fonts not rendered

In the screenshots below, you will see that the files are not properly exported from Tamil Wikisource (bottom left) or Kannada Wikisource (bottom right). Rather, the text displays as rectangles. This is due to the fact that Kannada is not included in the “Include fonts” section, which creates various issues, such as the one below. Meanwhile, Tamil is included in “Include Fonts,” but there are still issues.

 
First page of book exported from Tamil Wikisource, which fails to render the characters, even after including Tamil fonts.
 
Kannada Wikisource. The font is not rendered because the Kannada font is not available.

Example #3: Consonant conjuncts incorrectly rendered

In the example below, you will see that the text is incorrectly displayed. In the original version in Bengali Wikisource, the user will see “প্রথম.” However, in the ebook export, the word is changed to “পরথম.” This particular error shows conjunct consonants, which is when two consonants are usually clustered together in a word. In these examples, the consonants are separated due to issues with font rendering. This issue occurs for users in many Indic languages.

 
Consonant conjuncts incorrectly rendered in Wikisource

Example #4: Incorrect text wrap

In the example below, you will see that the text is wrapped around the image. However, in the original version on Bengali Wikisource, the text is displayed below the image with no text-wrap.

 
Example of incorrect text wrap (text should be below image)

Example 5: Content alignment altered

In this example below, you will see that content is aligned to the left in the PDF. However, in the original text from Armenian Wikisource, the content is centered on the page.

 
Content aligned to the left, rather than centered

Accessibility & User Experience

The ebook export process is not very inviting to newcomers. There are many quirks and exceptions that one must learn. The WSExport tool is not easily discoverable, and it doesn't provide an intuitive user experience. For example, it doesn’t include all scripts in the “Include fonts” section (such as Bengali). Even if a language script is included in “Include fonts,” the export may still experience language errors. Meanwhile, in the sidebar, it’s confusing to determine how to download multi-part ebooks for new users, among other issues. If we want Wikisource to expand, we need the experience to be intuitive and accessible newcomers. For this reason, the UX considerations involved in the ebook export process may be investigated for improvement as well.

Open Questions

  • Have we covered the main reasons why people export ebooks?
  • Have we covered the main methods to export ebooks?
  • Have we covered the main problems experienced when exporting ebooks?
  • Which formatting and style issues are the most common and frustrating, in your opinion?
  • Which user experience issues are the most common and frustrating, in your opinion?
  • Which problems, overall, do you find the most critical to fix, and why?
  • Anything else you would like to add?

We look forward to reading your feedback on the Talk page! Thank you!

Status Updates

March 31, 2021: Final update

Hello, everyone! We are now thrilled to announce that the Ebook Export Improvement project is complete. This has been a tremendously rewarding experience, and we have really enjoyed collaborating with the diverse and passionate Wikisource community. Below, we will share a summary of the work we did and the impact it has had. Thank you again for all of your collaboration!

Reliability

We knew that, in order for our work to be impactful, Wikisource Export needed to be a more reliable and efficient tool. For this reason, we focused on improving the overall health of the code that supports the tool. We also tackled multiple issues that were contributing to slow or error-laden downloads. The technical details of this work can be found in previous updates. Now, we’re excited to share the final results:

  • The Uptime Robot Dashboard shows that WS Export is nearly always up (as of 31 March 2021):
    • Last 24 hours: 99.139%
    • Last 7 days: 99.768%
    • Last 30 days: 99.834%
    • Last 90 days: 99.896%
  • The median export time for books is 3 seconds, as found from one month of data, recorded between 17 February to 17 of March (source). We don’t know the median export time before our changes, since we only recently began logging this data.
  • There are many more exports being successfully generated:
    • Within a 30 day period, our data recorded 1,168,667 successful exports after our changes (source) vs. 71,613 successful exports before our changes (source). This shows 16 times as many successful exports after the changes.
    • Within a 60 day period, our data recorded 1,513,486 successful exports after our changes (source) vs. 160,433 successful exports before our changes (source). This shows 9.4 times as many successful exports after the changes.
    • Within a 90 day period, our data recorded 1,628,523 successful exports after our changes (source) vs. 249,924 successful exports before our changes (source). This shows 6.5 times as many successful exports after the changes.
    • Note: It makes sense that the greatest growth happened within 30 days, since we have released the most changes within the last few months. However, it should be noted that some of the ebook exports (both before and after the changes) may be from bots, and we cannot easily determine which downloads are from bots.
  • The error rate of ebook exports is significantly lower:
    • We have decreased the likelihood of encountering an ebook error by approximately 12 times (within a 30 day period). Here is the breakdown of the data:
      • Before our changes, we recorded a total of about 46,000 errors per 71,613 successful exports within a 30 day period. This was calculated because we had found a total of 22,982 errors in a 14-day period, which we can roughly double to be about 46,000 errors in a 30 day period (source). This means that, for every 1.5 downloads, there was one exception thrown.
      • After our changes, we recorded a total of 63,921 exception errors per 1,168,667 successful exports within a 30 day period (source). This means that, for every 18 successful ebook exports, there was 1 exception thrown. This is a 12 times improvement over the previous ratio. This is based on the data recorded in a 30 day period after our changes.
      • Note: There isn’t a 1:1 relationship between exports and exceptions. In other words, one unsuccessful export can generate multiple exception errors.
  • We expect that the error rate will drop even lower very soon:
    • In our new data, the most common error type is DriverException, which accounts for 46% of all exception errors. This is a new error type, which isn’t even present in our old data. This is because this error type was brought on by our replicas work.
    • There is already a fix for DriverException errors that will be deployed soon. Once this fix is released, the total error rate should be even lower.
  • We have added a new option for problematic exports: download without credits.
    • We determined that one common cause of slow or problematic book downloads was the credits displayed in the “About” section. The credits can take a lot of time to generate and may cause ebook export issues. For this reason, you can now choose to “Exclude editor credits” in the Wikisource Export page.

Language Support

The original wish focused on WS Export reliability. However, as we consulted with Wikisource communities, we learned about serious language support issues. We made it a project priority to fix these issues. We believe in the power of Wikisource as a global, equitable tool of free knowledge, so it’s absolutely crucial that it’s inclusive of all languages. Here are the results:

  • We upgraded font support in ebook exports: We fixed the issue that previously displayed boxes rather than characters in ebook exports, especially for non-Latin script languages. Now, everyone can download books in their chosen language!
  • The Wikisource Export page has been internationalized: The page used to be in English only. We internationalized it, so it would be available for translation, and it’s now been translated into many languages already.
  • Communities can pick their default fonts for the download button: When we added the new download button, we heard from community members that they wanted the ability to choose the default font that was most suitable for them. We understood the importance of this, so we made this possible.

User Experience

As we wrote above, the original wish focused on reliability issues. However, as we consulted with community members and conducted usability tests, we learned that Wikisource Export needed user experience improvements as well. This way, it could be used (and enjoyed!) by a larger, more diverse group of people. For this reason, we issued a series of improvements. Here are the results:

  • There is now a user-friendly “Download” button: We simplified the user experience by providing a user-friendly “Download” button. We drew from community feedback and usability testing to develop the feature. We also incorporated updates to the tool after sharing the first iteration with community members, such as adding a link to “Other formats” on the WS Export page (thanks for the tip, InductiveLoad!).
  • We simplified the language code process: In the old WS Export page, users needed to manually enter in the language code, which was confusing for newcomers. With our changes, no language code knowledge is required! We provide all of the available languages in the dropdown.
  • We improved support when errors occur: We have implemented greater support for users who encounter ebook export errors. Now, when users encounter errors, they will see suggestions for next steps displayed on the Wikisource Export page. We also worked to ensure that the error messaging is appropriate for the type of error that has occurred.
  • The Wikisource Export page has been revamped: The older version of the Wikisource page was in need of a visual make-over. For this reason, our designer provided a series of recommendations to improve readability, usability, and mobile accessibility. The end result is a much cleaner design, and we hope you love it as much as we do!

Overall, this project is now done. We thank you all for being such fantastic ambassadors and advocates for Wikisource, and we learned so much from all of you! If you have any questions or comments, we invite you to share them on the Talk page. We sincerely hope that we helped improve Wikisource Export, which is at the heart of the Wikisource experience. Up next, we’ll be working on another Wikisource project: OCR Improvements (which we encourage you to check out, if you haven’t already). Thank you everyone, and we look forward to further fruitful collaboration!

March 8, 2021: Updates on recent work

Hello, everyone! We are excited to share with you another update on our recent work on the project. Also, apologies for the delay since our last update! We have been very busy over the past few months with the holiday season, the 2021 Community Wishlist Survey, launching the Wikisource OCR Improvements project, and additional team work. Please check out our update below and share your feedback on the project talk page. Thank you in advance!

Recently completed work

  • Implement a new download button: Now when you go to a book on Wikisource, you will see a blue button, labeled “Download.” When you click on the button, a pop-up will appear that enables you to download books in PDF, EPUB, and MOBI formats. You will see information below the file format name, which lets you know which file format is appropriate for your device. We decided to do this work after collecting feedback from the user talk page and on usertesting.com, which confirmed that many people found the current download experience not very user-friendly. This new download button is meant to increase the accessibility of ebook exports on Wikisource.
    • Note: We implemented a simplified version of the initial mockups. Some parts of the original proposal turned out to be too big and complex, so we opted for a trimmed down version, which you can now see on the wikis.
  • Internationalize the WS Export page: The Wikisource Export page used to be in English only, which was obviously a problem. With this change, the page can now be translated into many different languages. Translations have already begun. If you don’t see it translated into your wiki’s language, we invite you to help the translation effort on translatewiki!
  • Replace ElectronPDF with WSExport PDF support: Some wikis previously used ElectronPDF for PDF downloads in their sidebar links. ElectronPDF does not work very well, especially for Wikisource, which led to many people having frustrating download experiences. We replaced ElectronPDF links with WSExport links, so now all wikis can download PDFs via the sidebar with a more reliable service.
  • Migrate WSExport Gadget to to the Wikisource Extension: In the process of consulting with Wikisource users on the project talk page, we learned that some users did not have the ability to click download links (such as "Download as MOBI") via the side panel and other places. This was the case on Czech Wikisource, for example. This was because these wikis did not have the WSExport gadget enabled on their wiki. To fix this issue, we migrated the gadget over to the Wikisource extension, so that all users can now have the same download links available.
  • Cache all API Requests: With this work, we have added another way to improve efficiency of ebook exports. Now, if someone downloads Book A and then someone else wants to download Book A shortly afterward, the generated ebook will already be cached. This means it doesn’t need to be newly regenerated for each request, and the download time will be much quicker the second time around.
  • Migrate API to Parsoid API: This work was recommended by Tpt, and we agreed with the recommendation, after conducting our own investigation. With this work, we now have better long-term support of formatted text on Wikisource exports. Also, this work was inevitable, since Parsoid API will eventually replace the current MediaWiki's native parser. Now that this work is done, we can identify bugs and issues early on, which we can direct to the Parser team. Please note that we are aware that some bugs came out of this work, but since the migration was scheduled to occur either way, we think it’s best to identify the bugs early on.
  • Reinstate OPDS Support: With this support reinstated for OPDS now reinstated, you can now access up-to-date catalogs of Wikisource books that are suitable for download on your device. It should be noted that OPDS export can be set up to work with any category on a wiki. It produces a daily updated file that can be used in software like Calibre, FBReader, and some e-readers to more quickly and easily browse and download available books. The existing categories are just the first ones; others can be made, even multiple per wiki (e.g. "Literature for export" or something).
  • Investigation on how to improve error messaging: We know that many people feel frustrated when there are ebook export errors, since there is typically minimal information or support. The purpose of this investigation was to determine what potential improvements we could implement from a technical perspective. Now that this work is complete, we are now looking into implementing improved support (see next section for details).
  • Various bug fixes: In software development, whenever new work is done, new bugs arise. As a team, we have analyzed and fixed many bugs, such as RTL language support issues, internal links issues, and other bugs. However, as mentioned above, some bugs may be handled by other teams in the future, such as Parsoid-related bugs (which may go to the Parser team).

What's next

We are in the last stages of this project. Here’s the remaining work:

  • Improve language selection on the Wikisource Export page:
    • STATUS: In development. Engineers already have work they are reviewing.
    • SUMMARY: Right now, users need to know the language code of the book (such as “en” for English or “fr” for French) in order to export it on the Wikisource Export page. This is not user-friendly. For this reason, we are implementing a selector, so you can pick the appropriate language from a dropdown
  • Allow communities to choose appropriate fonts for download:
    • STATUS: In development. Engineers already have work they are reviewing.
    • SUMMARY: Wikisource users want a way to select which font is best for their language when downloading books. So, for example, if I am on Hindi Wikisource and I click the blue download button and then choose to download a book, the book should be in the font that the community decided is best for the Hindi language. We are now working to make this possible. This work is already in development.
  • Remove dependency on credit generation:
    • STATUS: In development. Engineers already have work they are reviewing.
    • SUMMARY: When this work is complete, wikis will be able to download books without editor credits, if they want. We decided to do this work because credit generation is often a very intensive process. It can significantly slow down ebook exports. For this reason, if a user is experiencing difficulties downloading a book, they may want to try downloading the book without the credits. We wanted to implement the technical support to make this possible, either for users now or in the future.
  • Create option to disable credits:
  • STATUS: Ready for development and in engineer's backlog. Will be worked on very soon.
    • SUMMARY: Once we have removed the dependency on credit generation, we can create the option to allow ebook exports without credits on the Wikisource Export page. This could be useful in cases when books are particularly difficult to download due to lag time and errors. We could also create a separate page with a list of the book credits, so that even users who choose to download books without the credits can view them within Wikisource Export.
  • Improve messaging about errors:
    • STATUS: In planning stages.
    • SUMMARY: Our investigation found that it would be too much work to implement specific messaging about errors within the pop-up. For this reason, we have decided to improve the error messaging on the Wikisource Export page. The basic idea is that, if you encounter an error via the download button, you will be redirected to the Wikisource Export page. There, you will be told that there was an error and be given proposed next steps. While this may not generate a successful ebook export for all use cases, it will provide more helpful messaging and support for users than the current default behavior.

Open Questions

  • What do you think of the new "Download" pop-up? Do you find it easy to use?
  • What do you think of our additional work to improve reliability? Are you still seeing improvements in the speed and performance of WS Export?
  • What do you think of our remaining work to disable credits as an option?
  • What do you think of our remaining work to improve messaging and support when there are download errors?
  • Is there anything else you would like to add?

Please share your feedback on the project talk page!

November 18, 2020: Updates & Request for Feedback

Hello, Wikisourcers! We are pleased to share our November update. In this update, we’ll focus on the work we have done so far to improve the ebook export experience. We’ll also share our plans for what we hope to do next and how we plan to do it. We would like to thank everyone for the feedback so far, and we look forward to collecting feedback on this next stage of the project!

Language support improvements

You can now read Wikisource ebook exports that were previously unreadable. For example, issues such as this and this are now solved, due to our changes! Here’s how we did this: After investigating the issue, we realized that WS-Export only supported 4 main fonts. This meant that fonts required to properly render many scripts were not available.

For this reason, we upgraded font support, so that all fonts available in Debian would be available for WS-Export. The end result is that scripts in ebook exports are now largely supported, due to this change. One request: Now that we have made this change, please test out this issue for us. Do you think it is largely resolved? Do you still see boxes (instead of text) popping up anywhere? Please let us know, since we really want to fix this issue. Thanks in advance!

Reliability improvements

#1. Investigation findings

We have conducted four separate investigations to identify how we can improve ebook export reliability. These investigations were as follows: Parsoid HTML for WS-Export, Cache generation for ebooks, Preventing automated book downloads, and Implementing a job queue system. In each case, an engineer was assigned to deeply explore the proposal in question, determine if and how we could make such changes, and what level of improvement we could expect from such changes.

Then, we reviewed the findings as a team to determine next steps. From these investigations, we decided that two proposals should be focused on first: Parsoid HTML and Caching ebooks. In both cases, we felt that the proposed changes would improve reliability and that they were within scope for the team. Work on both of these projects has been launched, which we’ll explain below.

#2. Caching API requests

This work came out of one of our investigations, as described above. We have made great progress, and it is almost complete. When the work has been deployed, we will cache all API requests when exporting Wikisource ebooks. This means that, if someone downloads Book A and then someone else wants to download Book A soon afterward, the ebook will be generated much faster.

This could be helpful in a variety of cases, such as when many people download featured books of the month, when many people download books listed on wiki pages (such as those featured on the homepage on Bengali Wikisource), or when people sequentially download different formats of the same book. We believe that this work can help improve reliability, but we’ll need to conduct some analysis to determine the impact. We’ll share more on the release and impact in our next update.

#3. Integrate Symfony 5 with WS-Export

This work is now complete. Due to this work, we are now able to implement improvements to WS-Export, such as the caching work, on a much faster timeline. Furthermore, Symfony 5 is the same framework we use for other tools, so ongoing maintenance will be easier and quicker in the future. We can also now make use of Symfony components that are battle-tested and require very little work to enable, such as ErrorHandler, Cache, Console, DependencyInjection, DotEnv, and more. Overall, we are modernizing the app and making it easier on ourselves and volunteers in the long run.

#4. Migrate API to Parsoid API

This work is in progress and almost complete. Once complete, this work will help us support proper formatting, such as in footnotes and mathematical equations. It was first recommended to us by Tpt, and our investigations concluded that we should do the work. Here are the technical details: WS-Export was using the MediaWiki parser HTML output using ?action=render to generate its ePubs.

However, Parsoid HTML became available, and it provides much richer data. Additionally, Parsoid API will eventually replace the current MediaWiki's native parser. We want Ws-Export to be up-to-date with the latest parser sooner rather than later. Once this work is complete, HTML output will hopefully be simplified, which will make it easier for us to support formatting of text.

User experience improvements: feedback requested

As we shared in our last status update, we repeatedly heard from people that the download experience is confusing, inconsistent, and hard to understand. We agree, and we want to improve the user experience. For this reason, we conducted an investigation to determine how we could improve the user experience, which included team discussions and usability tests. From this investigation, we came up with the mockups (as shown below) and ideas for how we can improve the experience. We encourage you to check them out and share your feedback on the talk page.

Proposed changes

General proposal: We propose to add or replace (depending on the wiki) the top download links on the page with a simple “Download” button. When the user clicks on the download button, a window will open up, which will list the download options for the book (such as, EPUB, MOBI, and PDF) with download icon links. The user will also see information about which file format is recommended for different device types (since we found in our user research that many users don’t know which file format to pick). Once they pick a file format, the download process will begin, which will be indicated by some sort of “in progress” indicator. When the download is completed, the user will see a status indicator to display that it is complete. If there is an error in downloading the book, the user will see an error status indicator.

Potential enhancement for the future -- Auto-download: Once we have implemented the basic behavior, we may consider creating an auto-download function. Under this scenario, if the user has never downloaded a book before, they will manually pick the file format. After that, when the user clicks “Download,” the download will be automatically triggered in the file format that the user last selected. You can see an example of the user flow below.

Usability tests

After we developed the mockups, we conducted some usability tests (with readers who did not know about Wikisource) to see how people responded to the mockups. We'll be updating the mock-ups based on our findings from the tests, as well as the feedback from all of you provided on the talk page.

Open questions

  • What do you think of our recent font support work? Does the issue seem to be largely resolved of boxes appearing rather than text?
  • What do you think of our recent and upcoming reliability work? Do you have any thoughts, concerns, or suggestions to share?
  • What do you think of our proposed improvement to the download user experience overall? Do you like the general idea and user flow?
  • Do you usually download the same file format (e.g., PDF, MOBI, EPUB, etc) every time you download a book, or do you often pick a different format?
  • Is there anything else you would like to share?

Please share your feedback on the project talk page!

October 23, 2020: Engineering work has begun

The engineers have begun taking on work related to improved reliability of the WS-Export tool and improved font support. This work is based off the proposals that we shared on August 11th, as well as the feedback from that update. We are also wrapping up our first stage of research related to improving the user experience, which we'll be sharing soon.

August 11, 2020: Early findings

Hello, everyone! We are very excited to share our first update on the project. We want to thank everyone who has shared feedback on the project talk page, GitHub, or Phabricator so far. Your insights have been critical, and we deeply appreciate them. Once you have read our August update, we invite you to share your feedback on the project talk page.

Lessons from the consultation (so far)

On the project talk page, we discussed with some people how to think about the project overall–in other words, what sort of principles should we be internalizing and following as we begin this work? Here’s what we have found so far:

  1. We should be continually mindful of both contributors and visitors. These groups may have some overlapping needs, but there may also be some important differences for us to investigate, explore, and address.
  2. We should think about user experience improvements (rather than only technical improvements). The process to export ebooks is currently not intuitive for many users. If we can improve this experience, we can potentially retain and nurture a larger base of readers and editors.
  3. We should try to investigate, document, and share best practices for Wikisource. As we have consulted with people, we have learned that some perceived errors are actually not technically “bugs.” Instead, they are rooted in confusion over formatting and best practices. As such, they can potentially be fixed by the community. This is great news, but more people need visibility into these best practices. For this reason, we plan to investigate best practices, and we’ll share our findings with the community.
  4. We won’t be able to fix everything (unfortunately!), but we’ll document all the issues we encounter. For this project, we’ll be focusing on improving core accessibility (i.e., WSExport functionality & reliability) and core readability (i.e., people’s ability to read exported books in their language of choice). If there are issues that don’t fall into these two categories, we’ll still document the issues in Phabricator–but we may not be able to fix them. It is our hope that other people may be able to fix the issues that we can’t get to in the future.

Work we have done so far

We have just launched the project, so we haven’t done much work yet. However, we have done some work, which we would like to share now:

  1. We moved WSExport to a Virtual Private Server (VPS): Before this work, the memory and CPU intensive processes of WSExport were too much for the resources on Toolforge. For this reason, we moved the tool to a VPS instance, so that we could improve overall performance.
  2. We upgraded Calibre on WSExport VPSs: The VPS was on Calibre 3.48.0, but the latest version was 4.10.1. For this reason, we performed an upgrade, which helped fix various bugs related to generating PDFs. We will also continue with upgrades when new versions are available.
  3. We conducted a technical analysis and font rendering investigation. Both of these produced lots of interesting proposals (some of which we’ll share in the section below). In addition, we were able to identify four common types of formatting issues for ebook exports, which are: 1) The original HTML of the wiki, 2) The process of converting the wiki HTML into an ePUB XHTML file, 3) The second output formats (such as PDFs, introduced by Calibre), and 4), The rendering of ePUB files by an eReader. While we can’t do much for the last two (since they involve external software/tools), we can try to improve the situation with the first two.
  4. We are currently collecting baseline data on issues related to uptime and errors associated with the WSExport tool, among other data points. This will enable us to compare the original data (i.e., at the beginning of the project) with the data later on (i.e., after changes have been made at the end of the project). This way, we can measure our impact in a meaningful way.
  5. We have begun to organize existing Wikisource tickets. We’re currently in the process of migrating tickets from GitHub to Phabricator, so they can be consolidated in one place. Once the migration is complete, we propose that we group these tickets into categories, so we have a sense of the general “buckets” of work that we can do. In the future, we ask that all new issues are reported on Phabricator. If you want assistance in how to do this, you can reach out and ask on the project talk page.
  6. We have begun to investigate how we can improve the user experience for all Wikisource users. This investigation is currently in development, and it will be the primary focus of our next status update (which is tentatively scheduled for September).

Potential next steps

General reliability
  1. Investigate cache generated ebooks: With this work, we propose to cache files that are produced, so they do not need to be freshly generated whenever someone wants to download them. This would potentially speed up the process of downloading books. We would need to investigate this proposal first, so we could determine the general impact and scope of the work.
  2. Investigate job queue for more efficient ebook generation: With this work, we propose implementing a queue-running system. This process would potentially speed up the current download process and give users more information on the download status of a book. One way it could be done is that a user would submit a request for an ebook, which would add it to the queue. The queue would first generate the ePUB, which would then be immediately available for download, and then it would generate the derivative forms (such as, PDF) and make those available when done. We would need to investigate this proposal first, so we could determine the general impact and scope of the work.
  3. Investigate how to prevent incomplete book downloads: The purpose of this work would be, if possible, to reduce the problem of downloading only a section of a book (when the user expects to download the whole book). We could possibly do this by using subpages from all pages (rather than just from ws-summary) when downloading books. We could also potentially follow subpage redirects, when they exist. We would need to investigate this proposal first, so we could determine the general impact and scope of the work.
Content rendering
  1. Through consulting on the talk page, we have learned that we should also be looking into improving support for mathematical equations. While we covered font rendering issues in our original investigation, we didn’t talk about numbers and equations. We’ll look into mathematical equations, as well.
  2. We have learned through the font rendering investigation that we can switch to a new system of fonts. This would enable us to use fonts from a host system (Debian), which has a much larger library of fonts than our own library. For example, this work would give us access to multiple Kannada fonts (while our current font set offers no specific Kannada support).

Open Questions

We would now love to read your feedback, especially in response to the questions below. Remember that we’ll also have a few round of collecting feedback, so we’ll engaging you again in the future as well. You can add your feedback on the project talk page. Thank you in advance!

  • What are your general thoughts about the guiding principles that we have learned from the consultation so far (i.e., “Lessons from the consultation”)? Is there anything that you think we should add or change?
  • Is there anything you would like to share about the work we have done so far (i.e., VPS work, Calibre upgrade, various investigations, and the consolidation of tickets)? We’re open to any thoughts or suggestions!
  • What do you think of the proposal to investigate cache generated ebooks? Would this be useful and high-priority, in your view? Do you have any concerns?
  • What do you think of the proposal to investigate job queue for more efficient ebook generation? Would this be useful and high-priority, in your view? Do you have any concerns?
  • What do you think of the proposal to investigate how to prevent incomplete book downloads? Would this be useful and high-priority, in your view? Do you have any concerns?
  • What do you think of the proposal to switch to a new system of fonts? Would this be useful and high-priority, in your view? Do you have any concerns?
  • What work or investigations would you like to see that is *not* being addressed or is being addressed in a different way than you would expect? In other words, what do you think we’re overlooking, if anything?
  • Anything else you would like to add?