Reading/Web/PDF Functionality/pt

Update on books, August 17 2018


Here is an updated and more comprehensive sample of the new book renderer. The layout changed quite a from the first version presented at Wikimania. Thanks for all the feedback. The export still has a number of significant issues: page breaks, infoboxes, tables, and math formulas need to be improved substantially. This sample file focusing on international scripts and math formulas reveals some of the problems that still need to be solved. Math formulas are currently rendered using MathML - switching to LaTeX should lead to significant improvements.

Update on books, August 8 2018
We have been working with PediaPress on generating and styling the new books. They have provided us with a sample of the current output, which will be very similar to the final version. We discussed points of improvement with the PediaPress team, which they are addressing currently. If you have any feedback or other comments on these samples, please let us know on the talk page.

Update on books, April 2018
Books functionality will be returning via PediaPress. After investigating the new renderer in depth, we realized that core features of the original book creator (such as page numbers and table of contents) would be very difficult to implement using the new renderer. In addition, we had significant issues with our concatenation code. Thus, we had to look for alternatives in terms of bringing back the PDF books functionality on Wikimedia projects. We reached out to PediaPress, who were the original patrons of books on Wikipedia to see if they would be interested in taking up PDF rendering for books once again. They have agreed and we are currently working on the details and schedule. They will start by working on a temporary solution based on an older technology that has previously been used to create PDF. This might have some drawbacks when it comes to graphical elements, such as maps, but will mean a faster working solution. They then plan to work on a new HTML-to-PDF renderer afterwards, based on feedback on the first implementation.

Atualização de janeiro de 2018
Estamos a preparar testes de desempenho da função de composição de livros em PDF. Teremos mais informação no início de fevereiro.

We're currently preparing performance tests of the PDF to book function. We should know more in early February.

Atualização de setembro de 2017
O nosso serviço atual de composição de PDF, o gerador de conteúdo fora de linha (OCG) deixará de ser mantido. Por outras palavras, irá deixar de funcionar. A equipa de leitura da Wikimedia Foundation trabalha há meses para substituí-lo. O OCG tem funcionado com código desatualizado que pode criar vulnerabilidades de segurança e outros problemas sérios no futuro. Durante os últimos três meses apresentámos banners na página de criação de PDF solicitando comentários sobre o protótipo do nosso novo compositor. O novo compositor terá funcionalidades melhoradas em comparação com o OCG — irá imprimir tabelas e caixas informativas, e elementos estilísticos focados na melhoria da legibilidade. Recebemos uma grande quantidade de comentários sobre o protótipo e estamos a fazer as atualizações necessárias aos nossos novos PDF.

Adenda posterior: Desativação da composição de livros em PDF no curto prazo
Infelizmente, problemas sérios no nosso antigo compositor (OCG) irão obrigar-nos a removê-lo das opções de composição antes de completarmos as atualizações necessárias para a criação de livros. Isto sucede mais cedo do que pretendíamos. Quando removermos o OCG, o trabalho de composição de artigos individuais estará completo. No entanto, a composição de livros será interrompida enquanto avaliamos e concluímos os trabalhos necessários. A nossa escolha inicial do compositor de substituição, o serviço de composição Electron, não suporta ficheiros PDF de tamanhos grandes e falha ao tentar compor um livro com vários artigos. Iremos selecionar um novo sistema de composição de livros que possa suportar o tamanho dos ficheiros e preencha os nossos requisitos. Não era este o nosso plano inicial. Nunca quisemos desativar temporariamente a funcionalidade de composição de livros em PDF.

Cronologia:


 * Lançamento do compositor completo para artigos individuais (imprimir em PDF) - 1 de outubro de 2017
 * Interrupção da composição de livros em PDF - 1 de outubro de 2017
 * Desativação do compositor OCG - 1 de outubro de 2017
 * Lançamento do novo compositor PDF - janeiro de 2018 (data provisória com base nos resultados da pesquisa de sistemas de composição alternativos)

Funcionalidade:

Para uma lista completa das funcionalidades atuais e futuras, veja abaixo.

Para além da atualização desta página, isto será comunicado num banner na página de criação de ficheiros PDF, em Tech News e nalgumas listas de divulgação por correio eletrónico da Wikimedia.

Introdução
O nosso serviço atual de composição de ficheiros PDF, o gerador de conteúdo fora de linha deixará de ser mantido. Por outras palavras, irá deixar de funcionar. Tendo sido criado originalmente por terceiros, ele funciona atualmente com código desatualizado que pode criar vulnerabilidades de segurança e outros problemas sérios no futuro. Para termos a funcionalidade PDF teremos infelizmente de substituí-lo, senão poderemos vir a ter de retirar subitamente esta funcionalidade sem ter planeado fazê-lo.

Além disso, este serviço não suporta alguns pedidos de composição feitos pela comunidade, sendo o principal a capacidade de compor tabelas. Selecionámos um novo serviço, o serviço de composição Electron, como substituto adequado. O nosso próximo passo será duplicar a funcionalidade fornecida pelo OCG usando o novo serviço de composição Electron. Abaixo, iremos descrever as principais funcionalidades que identificámos serem necessárias. Gostaríamos de fomentar um diálogo acerca das funcionalidades que possam estar em falta, ou sejam supérfluas, na lista fornecida. Gostaríamos também de realçar os nossos planos futuros para composição de ficheiros PDF, de forma a recebermos comentários iniciais.

Known Issues

 * There is currently a bug within Firefox (upstream) that affects the styling of infoboxes displayed across multiple pages. Progress from Mozilla can be tracked here: https://bugzilla.mozilla.org/show_bug.cgi?id=688556.

Userbase
The following table shows a sample of traffic to the Electron "Download as PDF" service for over a 6 hour period. The traffic is broken down by operating system (OS), browser, and the browser major version (e.g. Windows 7, Chrome v61.*).

Note well that the majority of our traffic appears to come from Windows based machines.

Current Functionality Requirements
The following is a list of the current requirements for PDF rendering for single-article PDF's and for books. The requirements different from the current implementation are displayed in bold.

Historial

 * A composição de artigos e livros em PDF a partir das páginas da Wikipédia é feita por um serviço chamado OCG. Ao compor «livros» através do criador de livros, este utiliza o OCG tal como incorporado na extensão Collection. O OCG tem vários problemas, especialmente com tabelas.


 * Rendering PDF articles and books from Wikipedia pages is handled by a service called OCG. When rendering "books" through the book creator, it uses OCG as embedded within the Collection extension. OCG has multiple issues, especially with tables.
 * Estão identificados vários problema com o OCG, incluindo queixas da comunidade motivadas pela incapacidade do OCG de compor tabelas.
 * A composição de tabelas surge no número 9 da Lista de Requisitos Técnicos da Comunidade de Língua Germânica.
 * A Wikimedia Deutschland começa a trabalhar na solução para a composição de tabelas em ficheiros PDF, e introduz o Electron. Fazem-no com a intenção de executá-lo em paralelo com o OCG e não de o substituir.
 * Ao mesmo tempo que a Wikimedia Deutschland trabalha no serviço Electron, os responsáveis pelo serviço de manutenção do serviço OCG da Wikimedia Foundation chegam à conclusão de que o OCG tem de ser substituído.
 * A equipa de leitura da WMF assume a responsabilidade de manutenção a longo prazo do compositor de ficheiros PDF, e começa a planear a implementação da composição de tabelas para todos os projetos.
 * A equipa de leitura lança uma consulta da comunidade para recolher comentários acerca do Electron.
 * As equipas da infraestrutura de leitura e web começam a delimitar o trabalho necessário para transferir a funcionalidade OCG para o serviço Electron.

Update After Consultation


We launched a consultation on the current implementation of the PDF renderer in early June, 2017. After reviewing the consultation responses, we have made the following observations:


 * A larger number of users preferred the single-column format over the double column format
 * Users which prefered the double-column format highlighted that their preference was based in the styling and look and feel of double columns. Some users also expressed concerns with font size and wasting paper when printing PDF's in the single-column option
 * The following feature requests were made:
 * Functional hyperlinks
 * Date and url, 'this page downloaded [date] from [URL]'
 * Customizable css for layout, title, TOC
 * Option for 2 column format
 * Include/exclude images versions
 * Modifiable margins
 * print by section - allows you to remove references, paragraphs you don’t want, index, etc
 * allowing configurable text size

Based on the feedback, we have incorporated the following into our new print styles:


 * hyperlinks
 * article information
 * smaller font and book-like styling

The remainder of the requests above will be postponed until the second iteration of the PDF renderer, in which we plan to build a settings mode that will allow for customization of the available options.

Proposta
A seguinte é uma proposta de definição do âmbito das funcionalidades necessárias para a composição de ficheiros PDF.

The following is a proposal for the scope of functionality necessary for PDF rendering:


 * Os artigos individuais serão compostos no formato PDF usando a hiperligação Descarregar em PDF da barra lateral.
 * A composição de vários artigos no formato PDF será feita usando a ferramenta «Criador de livros».
 * Todos os artigos contêm atribuição da autoria dos textos e imagens.
 * Todos os ficheiros PDF que forem compostos poderão imprimir tabelas.
 * Os utilizadores poderão personalizar a disposição (layout) dos respetivos PDF (opcional).

Desenho
Os novos estilos para os PDF serão desenhados para melhorar a legibilidade. Com base nos comentários da comunidade e em testes qualitativos e quantitativos, a disposição em duas colunas poderá ser suportada no criador de livros e/ou nos PDF de artigos individuais.

The new PDF styles will be designed for increased readability. Based on community feedback and qualitative or quantitative testing, support for a 2-column layout may be built for the book creator and/or for individual PDFs.

Planos de Desenvolvimento e Lançamento
É fornecida abaixo uma descrição provisória do plano de desenvolvimento e lançamento. Este plano está sujeito a alterações.

The following is a rough outline of the development and deployment roadmap. It is subject to change.


 * 1) Abril - Maio de 2017:
 * 2) The Reading team builds back-end support for functionality identified above
 * 3) Communities are consulted on expanding or shrinking proposed functionality
 * 4) Qualitative test performed for styling
 * 5) June – July 2017:
 * 6) New styles implemented
 * 7) First iteration is launched along with OCG on all projects and performance is compared
 * 8) Iterations based on consultations and identified edge cases
 * 9) August 2017 – September 2017
 * 10) Additional changes made if necessary
 * 11) Outubro de 2017
 * 12) Second iteration launched without OCG on all projects

Single Articles

 * A PDF for a single article will be created by selecting the "Download as PDF" link
 * Upon selecting "Download as PDF", the PDF file will be generated. To download the file, users will select the "Download the file link"
 * Each PDF file will contain the following:
 * Article title and text
 * Infobox (if any)
 * Tables (if any)
 * Single-column layout
 * Page number
 * All article images and captions
 * Links to pages linked from the article (blue links and external links)
 * Text and image sources, contributors, and licenses

Phabricator Tracking
All PDF-related changes including sunsetting OCG, replacing the Electron PDF renderer, and any updates to books or the collections extension are tracked under the phabricator project Proton. The project page will display any recent updates for all tasks related to PDFs.

Functionality available in October, 2017
Note: no changes will be made to the current book creator workflow at this time


 * User will launch the books creator by selecting "Create a book"
 * This will navigate to the current book creation page
 * To download a book, users will select the "download" link from the books page
 * Users may only download books in PDF format
 * Books will contain all elements from single article format as well as:
 * Book title page
 * The references for each article from the book will appear at the end of the article
 * Each article will begin on a new page
 * A single section for text and image sources, contributors, and licenses, that contains the collected contributions from all articles

Functionality available in November - December, 2017
Styles for books will be updated for improved readability
 * Books will contain a table of contents with page numbers
 * Selecting a section from the table of contents will navigate the user to the corresponding section within the book

Alternative
There is an alternative way of exporting MediaWiki to LaTeX, PDF, ODT and EPUB:

http://mediawiki2latex.wmflabs.org/

The computational resources on the server are limited.

If you run Ubuntu Linux and want results faster, you can install the m2l-pyqt or mediawiki2latex packages.

__INDEX__