Book tool/nl

This page is a translated version of the page Book tool and the translation is 40% complete.
Printed Wikipedia-books

It is planned to roll out the Collection Extension in more WMF projects, which allows article collation and PDF conversion. This page aims to guide communities to a successful deployment of this extension. It thereby focuses on Wikipedia in its various languages. To get an impression on how this tool works visit and look for "Print/export" > "create a book" in the sidebar.


Dit hulpmiddel staat gebruikers instaat om persoonlijke selecties van pagina's samen te stelen in boekvorm. Boeken kunnen worden:

  • bewerkt & gestructureerd door gebruik van hoofdstukken

persisted & loaded, shared

  • gerenderd als PDF (voorbeeld)
  • geëxporteerd als ODF tekstdocument
  • besteld als een geprint boek met PediaPress (voorbeeld)

Zie dit persbericht Wikis Go Printable voor meer informatie over dit project. De extensie wordt getest op * sinds oktober 2008 en is geactiveerd op de Duitse Wikipedia sinds 27 januari 2009. Verder uitbreidingen zijn gepland.




You may be visiting this page since you were notified your Wikipedia will deploy this extension soon. Some things need to be setup and these pages (see all) try to be a guide.

Translating the Book tool quick tutorial page

Book tool text page

Regarding the Feedback page, there will probably be lots of feedback and you need to find a way to filter and forward translated issues to the English Feedback page on meta. See #Reporting Bugs, Collecting Feedback & Getting Help for more info. Furthermore, some users often use the Help page discussion to comment on the tool, not on the Help.

  • Een link naar de feedbackpagina bovenaan de overlegpagina lost dit probleem op.

Hint for translators: Give this extension a test drive at to get a better understanding of functions and concepts used with this extension. Also be mindful when translating the word "page" as it may refer to a wiki page (or article) as well as to a page in a PDF or printed book.

Create other related pages, categories and templates. Best once extension deployed, see #Pages used by this extension.

Collect a list of templates with content that should be omitted in PDFs, see #Templates to exclude in offline exports.

Once these basics are done there are some optional improvements possible:


verwijst meestal naar een collectie van pagina's (hoofdstukken, titel en subtitel zijn optioneel), kan ook verwijzen naar een afgeleid PDF, een geprint boek of een opgeslagen boek.
tijdelijk boek
een collectie van artikelen, opgeslagen in de huidige browsersessie. De lijst van artikelen van een tijdelijk boek is te zien op [[Speciaal:Boek]].
opgeslagen boek
een opgeslagen collectie van artikels staat op een normale wikipagina. Ofwel in de gebruikersnaamruimte ([[Gebruiker:Naam/Boeken/Boeknaam]]), ofwel in de hoofdnaamruimte ([[Wikipedia:Boeken/Boeknaam]]). Opgeslagen boeken kunnen worden geladen. Het tijdelijk boek is dan een kopie van het opgeslagen boek.

book page

usually refers to [[Special:Book]] where all articles of a transient book are listed and the book can be modified, saved, ordered, exported. May also refer to a stored book.

(book) portlet

"create book" entitled box in the sidebar (encapsulates 'add/remove article'-, 'Show book (N articles)'-, 'Load book'-, 'remove book'-, 'Books help'-links).

book help

The main [[Help:Books]] page linked from the portlet.

"offline export", "export", "in print", "print version", ...

refers to an export of a book either digitally (PDF, ODF) or physically (printed book).

"Suggestions", "Suggested pages"

refers to a feature that suggests pages that are related to the current set of pages in the book.


Changing the localization


Try to get concepts right. For example "Show Book (19 pages)" may be misinterpreted as if the PDF will have 19 pages although it will be based on 19 articles and probably will have lots more pages in a PDF or printed book. What does clear book refer to if one just loaded a stored book which now is also a transient book?

If you need to change messages, either change them in (ext-collection) (effective after the next software update) or change them for the wiki by visiting [[Special:Allmessages]] and filtering for "coll-*" to see all related messages. A quick look at the source may help to find the right message identifier if in doubt.

Note: The metaphor book works good for most wikis. But it does not on * where it clashes with their concept of book. If you alter translations in it might be good to notify all projects (e.g. wikibook) using the same language.

The localization of messages used in generated PDFs can also be change in (mwlibrl).

Double check with to verify all system messages used in this extension are translated for your language.


Pages used by this extension


List of all pages, categories, templates that should be created.


[[Special:Book?bookcmd=book_creator]] (requires no creation)

A special introduction page (the page shown when a user clicks on "Create a book") which allows to enable the "book creator" and transcludes a short help page. The name of this help page can be set in coll-book_creator_text_article The default is: Help:Books/Book creator text i.e. a subpage of the configured help page named "Book creator text".

[[Special:Book]] (requires no creation)

A special page which allows all major interactions on transient books.

[[Special:Book/rendering]] (requires no creation)

The rendering page shows a progress while the document is generated. Once finished it shows a download link to the document. It might also show an error if the rendering failed. Text can be configured in coll-rendering_text, coll-rendering_article, coll-rendering_status, coll-rendering_page, coll-rendering_finished_text, coll-is_cached, coll-excluded_templates, coll-blacklisted_templates.

[[Special:Book/load_collection]] (requires no creation)

Used when loading stored books. Visible to the user only if one wants to load a book although another one exists in the session. Text can be configured in coll-load_overwrite_text, coll-overwrite, coll-append, coll-cancel


Main help page (example) for this tool, linked from the portlet. Its location can be configured in the system message coll-helppage

All templates linked from this page will be excluded in print. It is recommended to not use this feature as it is a centralized and inflexible approach. The [[Category:Exclude in print]] is suggest instead (see below). Location can be changed in coll-template_blacklist_title.


[[Category:Wikipedia:Book tool]]

Used to store all documentation and related pages and templates.


Category which tracks all stored books. This category is special as all included pages can be loaded as a book by a "load book"-link which appears in the portlet if one visits a page in this category. That said stored books are automatically added at creation time, while non-stored book pages should not exist in this category. Can be configured by coll-bookscategory. You probably want to change this message to "Wikipedia:Books" (category "Books" is the default).

[[Category:Exclude in print]]

Used to track all templates that inject information which is useless or distracting in exports (see below for some motivation). Can be configured by coll-exclusion_category_title.


[[Template:Saved book]]

This template (example) is automatically included at the top of every stored book. It can be customized to make a stored book-page more appealing and to hold some metadata. Location can be configured by coll-savedbook_template.

[[Template:Hide in print]]

This template (example) returns all markup that was passed in the first parameter (read: does nothing). If added to the [[Category:Exclude in print]] it allows to selectively omit content in printed books or PDFs. Very handy! You can name this whatever you like, but don't forget to add it to the category and document/link it in the expert's help. Note: This template received quick adoption and soon was one of the most included templates, so you might want to protect it.

[[Template:Only in print]] and [[Template:PrintOnly in print]]

This template (example) returns none of the markup that was passed in the first parameter, while the corresponding [[Template:Only in print/Print]] (example) returns the passed markup. See Help for experts for more on the */Print-subpage used to substitute templates in print. The prefix which is used to substitute templates in print can be configured by coll-print_template_prefix.


Setting a custom license source


Some communities may want to add some extra text to the license in the PDF.

The license to be included in the PDF is configurable by setting MediaWiki:Coll-license_url to a URL which points to the raw wikitext that shall be used to render the license. By default on public Wikimedia sites this is set to


Templates to exclude in offline exports


There are many templates with content which should be excluded in print versions. There are at least three major types:


They are useless and distracting in offline exports as one can not contribute if offline. Examples: Maintenance, Cleanup...

Warning & hinting messages

They are useless and distracting in offline exports as users noticed them when selecting the content and choose to add it anyway. Examples: Sources of articles, Disputes, Deletion, General...

Navigatie inhoud

Navigation links are useless and distracting in exports. Examples: Compact TOC, Wikimedia sister projects...

Zulke sjablonen moeten worden gemarkeerd met de CSS class noprint.

Het wordt aanbevolen om relevante sjablonen te identificeren en deze vroegtijdig toe te voegen tot deze categorie - voor uitbreiding mogelijk is. Op de Duitse Wikipedia waren we in staat om snel 130 sjablonen te identificeren door naar gerelateerde categorieën te kijken. We rangschikten ze allemaal op een pagina en gebruikte een bot om deze categorie toe te wijzen. Slechts 14 sjablonen werden nadien geïdentificeerd waarbij handmatig toevoeging nodig was. Hint: Sommige sjablonen dienen als sjabloon voor andere. In zulke gevallen "moet" het voldoende zijn om dit (ouder)sjabloon aan de categorie toe te voegen; resulterend in het uitsluiten van een hele groep sjablonen.


Communicating the availability of the book creator and printed books


It is possible to transclude a page at the PDF rendering page which is seen by a user if she clicks on Download as PDF. At this page users (who are obviously in some offline desiring state) can be introduced to the book creator and the option to get 'printed books.

See en:Help:Books/Rendering page info text for an example of this page on en.wp and here to see how it looks at the PDF rendering page.

If the page exists at the location configured in this system message Coll-rendering_page_info_text_article (example on en.wp), it will show up on the PDF rendering page.

Opgeslagen boeken organiseren

Hoewel vele plezier zullen hebben met het aanmaken van hun eigen boeken, zullen anderen blij zijn als ze direct toegang hebben tot boeken over een bepaald onderwerp.

De [[Wikipedia:Boeken]]pagina kan gebruikt worden om de beschikbaarheid en bereikbaarheid van opgeslagen boeken te promoten. Er is niet veel ervaring op dit onderwerp momenteel, maar sommige ideeën die bedacht zijn worden hieronder opgesomd in aparte delen.

Bevorderen van het aanmaken van boeken

  • Voorzie in een handleiding hoe een "goed boek" te maken:
    • hoe een passende titel te kiezen;
    • hoe een inleiding toe te voegen;
    • hoe artikelen te kiezen;
    • aanbevolen aantal artikels.
  • Richtlijnen ontwikkelen voor boeken die in de hoofdnaamruimte mogen bestaan.

Deze kunnen inhouden (voorbeelden):

    • een redelijk aantal opgenomen artikelen (bijv. meer dan 5, minder dan 200);
    • een duidelijke titel, subtitel;
    • gefocust op een onderwerp;
    • redelijke kwaliteit van de opgenomen artikels (bijv. geen betwiste artikelen, beginnetjes, kandidaat voor verwijdering, etc.).
  • Coördineer onderwerpen.

Boeken toegankelijke maken

  • Som een aantal boeken van de/het week/maand/jaar op.
  • Label en toon de excellente boeken.
  • Voeg een "Er is een boek over dit onderwerp"-bericht toe aan gerelateerde artikelen, categorieën of portalen.

Link or transclude parts of the bookshelf A-Z.


Stored books are tracked in the category [[Category:Wikipedia:Books]], but this gets crowded rapidly (de.wp is close to 1.000 stored books - mostly in user space - created within 10 days). Further the category view allows not to display metadata or access books by topic. It would be possible to link books to categories but this would either clutter the main categories with books or require/result in a replication of the category tree in a different namespace.

There is a bot that can automatically generate a bookshelf which allows to explore books by title (A-Z) or keywords. Of course a bookshelf can be created manually also. Visit the bookshelf page for more details on the bot approach.


Preparing MainPage


MainPages next to portals are special as they often use a multi column web layout. Such pages look really bad in rendered PDFs (fixed width constraints of portrait-layout pages). But then again this is the page which almost every user new to this tool adds first to his book.

A workaround to avoid premature disappointment is to prepare MainPage to look better in PDFs. This can be done by using the [[Hide in print]] template in a way that MainPage (in printed) has no table at all or consists only of on column.


Another issue is the visibility of the portlet. Visitors (not you) to Wikipedia mostly simply ignore the sidebar. It might help if there is some notice about this new feature and a link to the help page on the MainPage's "News about Wikipedia"-box (if available at all) for a limited time.


Reporting Bugs, Collecting Feedback & Getting Help

== ====

within the wiki


There is a central feedback page at meta (in english) aimed to collect all feature requests, suggestions, bug reports, questions, etc. Non-english Wikipedias may want to setup a similar page (example) on their wiki and define some policy when and how issues are translated and escalated to the feedback page on meta.


Use the component "Collection" on bugzilla.


There is an IRC channel #pediapress for anything related to the book tool.


Experiences from past deployments


Duitse Wikipedia

What worked: Reception of the tool was mostly positive. Many stored books were created in a short period of time. Media quickly covered this topic once there was a press release by the German chapter.

What didn't work: It was planned to limit the new tool to logged-in users for the first week. Somehow this plan was not executed. As a result the feature was activated while documentation and localization were not really finished. For some users the portlet did not show up on some pages, probably due to caching. The MainPage was not print-version friendly (see above). Finally there was a slashdot effect after the popular german online news magazin Heise covered the story. The rendering server collapsed (load close to 300) instead of serving visitors.


Updates - vooral degene die aandacht van de gemeenschap vereisen - zullen hier worden aangekondigd.

  • September 2014: statistics for sales have been updated till the end of 2013, at [1].
  • 3 Mar 2009 - PDF-server update & ColExt update
    • Important Change: The template substitution was changed from a prefix to a suffix */Print. The license to be included in the PDF is now configurable by setting MediaWiki:Coll-license_url
    • updated to mwlib release 0.9.11 (changelog)
    • updated to mwlib.rl release 0.9.8 (changelog)
    • Collection-Extension was updated to trunk (changelog)

mwlib + mwlib.rl are used for rendering documents, Collection-Extension implements the UI in Mediawiki