Extension talk:Collection

From MediaWiki.org

Jump to: navigation, search

This is the talk page for the MediaWiki page about the Collection extension. It is not a support forum for problems with the extension itself or with the accompanying Python libraries mwlib and mwlib.rl. Please note that this is not rude behavior, this decision is just based on the fact that the discussion of software problems or architectural discussions is far too complex to take place on a single talk page.

There is a Google Group for support and discussion of mwlib, mwlib.rl and the Collection extension. There is also an issue tracker on code.pediapress.com.

Please use those for questions regarding the software and - do not use this talk page. However, if you have comments regarding the contents of the MediaWiki page associated with this talk page, you are welcome to drop your comments. He!ko 10:28, 3 July 2008 (UTC), Jbeigel 21:05, 14 July 2008 (UTC)

Contents

[edit] Add Copyright Info to PDF Books

I really want to add my copyright info to the PDFs, but I can't find any way to do it.

Do I need to do something with LocalSettings.php, or to create some kind of template?


[edit] Add a link to the "print/export" box at the Sidebar

When I install the Collection extension to my MW 1.15.1, it creates the "print/export" box to the Sidebar automatically, which is very good.

Now, I'd like to add the link of Category:Books (bookshelf) to the "print/export" box, but I can't figure out how to do it.


[edit] How to Remove the References Section from Every Downloaded PDF

I can't figure out how to remove the section “References” that is automatically appended to every downloaded PDF? I don’t need contributors’ names to appear on the PDFs.

[edit] How to Enable Adding Pages to Book without Visiting Them

I can see this feature enabled at http://en.wikipedia.org/w/index.php?title=Special:Book&bookcmd=book_creator&referer=Main+Page

If you simply hover on a linked article, a small box will pop up with the message "Add linked wiki page to your book". Click on this link, and the linked article will be added to your book.

I like this feature very much, but I couldn't find a way to enable (or configure) it.

With help from Johannes, I have figured out the 2-step solution as below:
1) Modify the Gadget-popups.js file coming from Collection extension under extensions/Collection/js/, replace
return 'wiki'; // line 6026
with
return 'kiwi'; // where 'kiwi' is in my URL http://my.host.com/kiwi/.
2) Add $wgCollectionNavPopups = true; to LocalSettings.php.
The README says the default is true, but it seems not true.
It works great, and is system wide. I like this feature.

[edit] Block Access to non Authenticated users

I am wondering if the feature could be added to block access to non authenticated users? The $wgCollectionPortletForLoggedInUsersOnly does not block access to the Collection SpecialPage.

[edit] Mediawiki Version is not anymore supported

I think you missed to change the supported Mediawiki Version as 1.13 and lower are not supported anymore. The SkinMonoBook::link() function is (as far as i know) just implemented in 1.14+

[edit] Bug in collection.body.php line 516

Sorry that I post this issue here (did't found a better place). But there is an anoying bug in Collection.body.php. In Line 516 you write

'timestamp' => wfTimestamp( TS_UNIX, $revsision->mTimestamp ),

But this ist wrong, it should be

'timestamp' => wfTimestamp( TS_UNIX, $revision->mTimestamp ),
Thanks a lot! I've fixed the typo here. Jbeigel 09:56, 14 April 2009 (UTC)

[edit] Lowest supported version of MediaWiki?

Can someone add that please? I think it is a very nice to know... Siebrand 21:35, 4 November 2008 (UTC)

added Jbeigel 11:21, 10 November 2008 (UTC)

[edit] writers

could somebody please give a list of possible configuration for writers, now the only possibility to get it is to install mwlib, by now I just wanted to test it with the given server, but I don't know how to add the writers that are possible --DaSch 00:06, 9 November 2008 (UTC)

As you said, this depends on heavily on the used render server. I've made two changesets to the README of the extension with more explanations about the public render server and custom servers. Jbeigel 11:30, 10 November 2008 (UTC)

[edit] CurrentUsers Extension output doesn't render as pdf

This extension is great but it doesn't render sortable tables when converting to pdf Here is my site: http://whitehat.servehttp.com/mediawiki/index.php/Main_Page Well, at least it works way better than the PDF export extension does. I couldn't get that one to install. --Deo Favente 17:18, 17 January 2009 (UTC)

The problem is actually not related to sortable tables. There is some problem with the template {{CurrentUsers}}. I added a ticket for that at http://code.pediapress.com/wiki/ticket/393 -- Volker.haas 10:56, 19 January 2009 (UTC)
My colleague looked into the issue - I guess we can't fix that. Sorry Volker.haas 11:25, 19 January 2009 (UTC)
What is the reason for this limitation? Also other extensions like <gnuplot> and <graphviz> can't be rendered. On the other hand svg-graphics can (at least it worked on de.wikipedia.org). Ok, I know these are no extensions. matz 16:34, 25 February 2009 (UTC)
There is a thread about handling the graphviz extension on our mailinglist. There is still no solution, but maybe you'd like to participate: Graphviz Extension Discussion -- Volker.haas 10:32, 27 February 2009 (UTC)

[edit] $wgPDFServer Variable

The instructions say "Simply install and configure the Collection extension using the default value http://tools.pediapress.com/cgi-bin/pdf-server.py for $wgPDFServer (see README.txt of the Collection Extension for instructions)". However, I did not find any $wgPDFServer variable in any of the extension files and the README.txt is also silent about this variable. I checked both versions 1.12 and 1.14. Am I missing something? Thanks. -- ok 00:24, 25 March 2009 (UTC)

Thanks for the heads-up: The documentation on this page was outdated, I've corrected it. Jbeigel 09:52, 25 March 2009 (UTC)

[edit] Don't see "Create a Book" portlet menu after extension is installed

I installed this extension in on my mediawiki. I am able to see the "PDF Version" option in my toolbox, and it works. But I can't see the "Create a Book" menu in the sidebar. Is there something additional I need to do to get this to show up? I couldn't find an explanation for it anywhere.

Thanks!

Whoops...never mind. I misread the version number for the skin modification. It must be made for all versions < 1.14. That's likely my issue.


[edit] Better explanation of "Collection" and "PDFWriter" proposal

--82.112.219.246 11:45, 10 April 2009 (UTC) if someone needs, as follows:

[edit] Tools overview

Extension:Collection is an extension allowing mediawiki users to manage custom collections of (mediawiki) wiki pages as "books".

Once you create a "Book", you can:

  • obviously edit, delete, save and share it with other wiki users
  • obtain the book printed on paper (through an online service)
  • convert it other formats, including xml, xhtml, odf and pdf
  • To create and manage Books, and print them through an online service you will need
    • to add the Collection extension into your MediaWiki install
    • to configure it through your LocalSettings.php file
  • To be able to convert Books to other formats you will need to
    • configure the Collection extension to reach a mwlib server
      • available formats, and performance issues are related to the mwlib server configured
      • if the server is remote to your MediaWiki install, performance will depend on your internet connection, too.
    • if you have little conversion needs, or if you just want to test, the Collection extension comes with a default server hosted by the extension author, see: PediaPress ToolServer.
    • if you need a faster or better solution, you can configure the Collection extension to use another mwlib server
    • you can setup your own mwlib server

[edit] Your own server

If you want to have your own mwlib server you will need:

  • a server machine
    • where the mwlib can be installed: there are many requirements and dependencies
    • where mwlib should be always running and available
    • the preferred server is a linux machine. A windows server is possible but there are issues (see mwlib-install)

The server is named mwlib This tool is a Python library for parsing MediaWiki articles. It is currently aimed at developers, who have a need to somehow handle MediaWiki articles. It parses one or more MediaWiki articles (wiki pages), and then allows you to convert them to other standard formats like:

  • mwxml, XML representation of the parse tree
  • xhtml, XHTML 1.0 Transitional
  • odf, OpenDocument Text
  • docbook

It possible to convert to PDF format, too, but it will need another tool: mwlib.rl This tool is a python library for writing pdf documents from mediawiki articles which were parsed by the mwlib library. It uses the Python Reportlab libraries to generate PDF based on a DOM derived from parsing mediawiki-markup using the mwlib parser.

The server can be run in two different ways:

  • launching mw-serve: this acts as a standalone server (reachable from the internet) and can use http protocol itself
    • you will not need a web server
    • you can set, protocol, port, interface. Default port is 8899.
  • through a cgi-bin, mw-serve.cgi

see also Examples

References PediaPress Open Source Repository, Wiki and Bug Tracking System mwlib page mwlibrl page

[edit] Image Quality in PDF

Is there a possibility to set the imagequality for the pdf. I have some nice PDFs with really bad images.

[edit] Stable release?

Hello - when will this release become stable? --Robinson Weijman 10:20, 15 June 2009 (UTC)

I don't really know if we want to have something like a "stable release". While the extension is already deployed on several wikis including several language editions of Wikipedia (e.g. de.wikipedia.org, fr.wikipedia.org, ...), feedback from the community permanently flows back in the development process. We try not to break things in commits and we also try to be as backwards compatible with older MediaWikis as possible (although that's not always achievable, for example when saving collection pages by using the editing API etc.) Jbeigel 13:41, 15 June 2009 (UTC)
Thanks for the prompt reply but I am confused by it. Does this mean that the release will remain permanently Beta? Beta implies (to me) that the testing is not yet finished - am I to understand that you interpret it to mean "stable until we release another version"? If so that's good enough for me! =:-) --Robinson Weijman 13:27, 17 June 2009 (UTC)
This is open-source software: the testing is never finished. (ESR has a few good lines about what 1.0 really means.) Remember, Gmail is still in beta too. :) —Emufarmers(T|C) 02:18, 19 June 2009 (UTC)
=:-) True (about Gmail) but that's not Open Source. And other MediaWiki Extensions are stable. Furthermore, I thought this extension was from a company promoting book publishing? --Robinson Weijman 09:13, 19 June 2009 (UTC)
Extension:Lucene-search is on version 2.1 and it's still marked as beta. Ultimately, it's the developer's choice; I'll leave it at that. —Emufarmers(T|C) 09:00, 20 June 2009 (UTC)

[edit] Installation Documentation

Any chance of an idiot's guide installation manual? I've got the read me and I read "PHP with cURL support" (how do I know if I have that?) and "Install and Setup a Render Server" (a what, how?). The configuring of LocalSettings looks more straightforward, however. --Robinson Weijman 11:28, 19 June 2009 (UTC)

cURL will be mentioned in the output from phpinfo() if you have support for it. If not, tell me what operating system your server runs and I'll point you toward an appropriate guide. You don't need to set up a render server if your wiki doesn't get a lot of traffic. —Emufarmers(T|C) 09:00, 20 June 2009 (UTC)
Thanks for the info. So I don't need a render server even if our wiki contains confidential info? (I don't want to send data to PediaPress.) --Robinson Weijman 09:44, 22 June 2009 (UTC)
You'll need to set up the render server, then. —Emufarmers(T|C) 02:00, 23 June 2009 (UTC)

The README.txt needs some updating. As of 1.15 (Maybe 1.14), it no longer appears to require the addition to the MonoBook.php file the portlet code snippet. I was wondering for about 3 days as to why I kept getting two blocks for "create a book". Paranormal Skeptic 15:14, 15 July 2009 (UTC)

[edit] Usage Restrictions?

Since this software is copyrighted by one company, are there any restrictions on its use e.g. by other companies? --Robinson Weijman 11:30, 19 June 2009 (UTC)

The software is licensed under the GPL. Other companies are free to reuse, modify, and redistribute the software in accordance with the terms of the license. —Emufarmers(T|C) 09:00, 20 June 2009 (UTC)
OK, thanks! --Robinson Weijman 09:44, 22 June 2009 (UTC)

[edit] Substituting templates don't work

Was this feature removed, or is this a bug? See b:de:Benutzer:Prog/ Spielwiese and b:en:User:Prog/ Test site for samples. If this is a Bug, than report it please. --Prog 21:13, 25 June 2009 (UTC)

Same problem!--77.78.80.212 14:29, 28 June 2009 (UTC)
meta:Book_tool#Updates, Format is now */Print --Prog 01:48, 29 June 2009 (UTC)

[edit] Layout not good for Wikisource

I too find it disturbing that this extension has been installed at Wikisource without any concertation.
It creates a toolblx entitled "create a book", which is extremely confusing for wikisource users.
ThomasV 12:17, 17 July 2009 (UTC)

[edit] No rendering

Rendering of a small collection of 4 pages used to work quite well using the public render server. The last few times I tried it the progress indicator keeps showing 0% and nothing seems to happen. Right now it has been more than an hour since I hit the Download button.

[edit] Extension:GoogleMaps

Maps created by the Google Maps Extension are not rendered in PDF. Any way to make it work? -- Matthias

[edit] Is there a stable release TAG for this plugin?

For versioning/stability reasons we'd prefer to download a stable TAG even if it doesnt have all the latest bugfixes. Is there a TAG for e.g. v1.4 of this plugin or is it only download from trunk\ that's available?

-- AlanC

Retrieved from "http://www.mediawiki.org/wiki/Extension_talk:Collection"