Funcionalidade de leitura/Site/PDF

From MediaWiki.org
< Reading‎ | Web
Jump to: navigation, search
This page is a translated version of the page Reading/Web/PDF Functionality and the translation is 43% complete.

Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎polski • ‎português • ‎tarandíne • ‎русский • ‎中文

Update September 2017[edit]

Our current PDF rendering service, the offline content generator (OCG), is no longer maintainable. Simply put, it's breaking down. The Reading team at the Wikimedia Foundation has been working towards replacing it for months. Originally created by a third party, OCG has been running on outdated code which may introduce security vulnerabilities and other major issues in the future. Over the last three months, we’ve had banners on the PDF creation page asking for feedback on the prototype for our new renderer. The new renderer will have improved capabilities from OCG – it will be able to print tables and infoboxes and will contain styling focused on better readability. We've gathered a lot of good feedback on the prototype and are working on making the required updates to our new PDFs.

Later addendum: Turning PDF book rendering OFF for the short term[edit]

Unfortunately, major issues with our old renderer (OCG) will require us to remove it as a rendering option prior to completing the necessary updates for the books feature. This is earlier than we wanted. By the time we remove OCG, the work for rendering of single articles will be completed. However, the rendering of books will be paused while we evaluate and complete the necessary work. Our initial choice of renderer for the replacement, the Electron rendering service, is not capable of supporting PDFs of larger sizes and fails when attempting to render a book with multiple articles. We will be working to select a new rendering system for books which can handle the size of the files and support our requirements. This is not how we planned to do this. We never aimed to temporarily remove the book PDF functionality.

Timeline:

  • Release of full-featured renderer for single articles (print to pdf) – Oct 1, 2017
  • Pausing book PDF rendering – Oct 1, 2017
  • Sunsetting of OCG renderer – Oct 1, 2017
  • Release of full-featured books renderer – Nov–Dec, 2017 (tentative based on research results into alternative rendering systems)

Functionality:

For a full list of current and upcoming functionality, see below.

In addition to this page being updated, this will be communicated in a banner on PDF creation page, in Tech News and on some Wikimedia mailing lists.

Introdução[edit]

O nosso actual serviço de visualização de PDF, o offline content generator, deixou de ser suportado, isto é, está disfuncional. Originalmente criado por terceiros, actualmente roda um código desactualizado que pode inserir vulnerabilidades e outros problemas sérios no futuro. Se nós tivermos que ter a funcionalidade PDF, nós infelizmente temos de substituí-la, ou seremos seremos surpreendidos por uma situação em que teríamos de retirar repentinamente a funcionalidade do ar, sem aviso prévio, ou nenhuma previsão.

Além disso, esta funcionalidade não suporta o número de solicitações vindo da comunidade, a principal sendo a A capacidade de visualizar tabelas. Nós seleccionamos um novo serviço, the electron rendering service, como um substituto favorável. O nosso próximo passo será duplicar a funcionalidade fornecida pela OCG utilizando o electron rendering service. Abaixo, descreveremos as porções principais da funcionalidades que identificamos como necessárias. Gostaríamos de convidar acerca das funcionalidades que possam estar em falta, e que acredita que possam ser adicionadas por serem úteis, ou o que dispensável, na lista fornecida. Nós gostaríamos igualmente de realçar sobre os nossos futuros planos para o visualizador de PDF para juntar a conversação de abordagem.

História[edit]

  • A visualização de artigos e livros das páginas da Wikipedia são feitas por um serviço chamado OCG. Quando estiver a visualizar "livros" através do book creator, utiliza o OCG como um sistema inserido com a extensão Collection. OCG has multiple issues, especialmente com tabelas.
  • Múltiplos problema com OCG estã identificados, incluindo os abordados pela comunidade à volta da inabilidade de mostrar tabelas do OCG.
  • Visualizador de tabelas, classifica-se como o número 9 na lista de Comunidade Germânica da Technical Wishlist - German-speaking Community Techical Wishlist.
  • A Wikimedia Deutschaland começa a trabalhar na solução para o visualizador de tabelas em PDF's, e introduz o Electron. Eles fazem-no para rodar junto do OCG, e não para substituí-lo.
  • Ao mesmo tempo que Wikimedia Deutschaland está trabalhado no serviço Electron, os manutensores responsáveis do serviço OCG na Wikimedia Foundation chegam a conclusão que o OCG tem de ser substituído.
  • A WMF Reading Team que assumiu a responsabilidade de manutenção a longo termo do visualizador de PDF, começa por planear a implementação do visualizador de tabelas sobre todos os projectos.
  • O Reading team lança a Comunidade de consulta para juntar os retornos das conversas em relação ao Electron.
  • A Reading Infrastructure and Web teams começam por delimitar o trabalho necessário para portabilizar a funcionalidade OCG sobre o serviço Electron.

Update After Consultation[edit]

Proposed PDF and print styles based on feedback from 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[edit]

A seguinte e a proposta para escopo da funcionalidade necessária para visualizar o PDF.

  • Artigos individuais serão visualizados em PDF utilizando o link Download as PDF na barra lateral.
  • Múltiplos artigos serão visualizados para PDF utilizando a ferramenta Book Creator.
  • Todos os artigos contêm atribuição para textos e imagens.
  • Todos os PDFs mostrados poderão imprimir tabelas.
    • Utilizadores poderão personalizar o layout dos respectivos PDFs (opcional).

Diferenças entre a actual e a futura implementação[edit]

OCG Novo Serviço Notas
Mostrando artigos individuais Sim Sim
Mostrando múltiplos artigos utilizando o Book Creator Sim Sim
Contém tabela de conteúdos para múltiplos artigos Sim Sim
Visualizador de tabelas Não Sim
Atribuição Sim Sim Questões abertas: local de atribuição dentro do novo serviço
Caracterização Latex Novos estilos
N-column layout Sim Não
Default 2-column layout Sim Tentative Predefinição para o layout de "uma coluna" ou "duas-colunas" será escolhida baseado no retorno da conversação, os teste quantitativos e quantitativos.
Formato de saída PDF, Plaintext PDF Apenas

Desenho[edit]

Os novos estilos PDF serão desenhados por incremento de legibilidade. Baseado no retorno da conversação da comunidade e dos testes qualitativos e quantitativos, o suporte para layout de 2-colunas poderão ser construídos para o criador do livro e/ou PDFs individuais.

Planos de Desenvolvimento e Lançamento[edit]

A seguinte e realce provisório dos planos de desenvovimento e lançamento. Está sujeito à alterações.

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


Current Functionality Requirements[edit]

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.

Single Articles[edit]

  • 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

Books[edit]

Functionality available in October, 2017[edit]

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[edit]

  • 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

Styles for books will be updated for improved readability