Wiki export

General plugins (Local) ::: local_wikiexport
Maintained by DavoDavo Smith
This plugin adds the ability to export Moodle wikis as either PDFs or epub documents.
Latest release:
104 sites
26 downloads
13 fans
Current versions available: 3

Wiki export

This plugin adds the ability to export Moodle wikis as either PDFs or epub documents. It was commissioned by the Judicial Institute for Scotland, originally for their Totara LMS implementation, with Synergy Learning as the chosen partner, with Davo Smith providing the development work.

Many thanks to Jackie Carter - Learning Technology Manager, and the rest of the team, at the Judicial Institute for contributing this development back in to the Moodle community.

Further development of this plugin is planned for early 2015.

Usage

Once the plugin is installed, you can visit a wiki, then click on the new 'Export as epub' or 'Export as PDF' links that appear in the activity administration block (with javascript enabled, similar links are inserted on the top-right corner of the page).

Users with the 'mod/wiki:managewiki' capability also get a 'Sort pages for export' link, that allows them to choose the order in which pages will appear in the export.

There is an additional global setting which allows a copy of any wikis on the site to be sent (as a PDF) to a given email address, whenever they are updated (note, this will not export all wikis on the site the first time it is configured, it only sends those that have been updated since the email address was first entered).

Customising

If you want to add your organisation's logo to the front page of the exported wiki, please replace the file local/wikiexport/pix/logo.png with your logo. Do not alter the file dimensions, it must remain 514 by 182 pixels.

Customise the following language strings, to alter the embedded export information:
'publishername' - set the PDF 'publisher' field
'printed' - set the description on the front page 'This doucment was downloaded on [date]'

(see https://docs.moodle.org/en/Language_customization for more details)

Contact

Any enquiries, including custom Moodle development requests, should be sent to info@synergy-learning.com

Screenshots

Screenshot #0
Screenshot #1
Screenshot #2

Contributors

Davo
Davo Smith (Lead maintainer)
Please login to view contributors details and/or to contact them

Comments RSS

Comments

  • David Mudrák
    Fri, 10 Oct 2014, 6:39 PM
    Hi Davo. Thanks a lot for sharing this awesome plugin. It definitely extends the Wiki's features. I like the way it's implemented and documented and I would be happy to approve it right now. There is one thing though that I would like to discuss before we make this public.

    I was thinking about your modification of the wiki_pages table. As a rule, any plugin that modifies core or other plugin's tables go to the Other category here, and I would like to avoid it for many reasons. Although it's documented here in the plugin description and, as you say, should not cause any troubles, it's not conceptually clean. And actually I believe it's not even needed. I do agree that sort order is a natural property of a wiki page and in fact, that column should have been added to core. But on the other hand, it's your plugin that is interpreting this value and makes use of it. Why not to have a table in your plugin's scope that would keep this sorting info? It should not be difficult to rewrite those $DB methods that use it to use wiki_pages joined with your own table. I do understand that your approach is more pragmatic. Yet I am interested to see what you think about my proposal.

    Looking forward to hear from you.

    p.s. If you rename README.txt to README.md, it will make your Github repository page look a bit more Githubbish wink
  • Davo
    Fri, 10 Oct 2014, 6:44 PM
    Yes, I agree that modifying core tables is a bad idea (when originally developed for the customer, this was less of an issue, than now it is being released). I could look at writing a version which uses a separate table - if you leave off the approval for a few days, I'll see what I can do.
  • David Mudrák
    Fri, 10 Oct 2014, 7:05 PM
    Great. I'm going to put this into "Needs more work" state. Please schedule for re-approval once the new version is available. Thanks a lot.
  • Anthony Borrow
    Tue, 21 Oct 2014, 11:01 PM
    Davo - Thanks for updating the plugin to use local_wikiexport table. I am going to go ahead and approve so folks can start using it. Peace - Anthony
  • David Mudrák
    Tue, 4 Nov 2014, 5:12 AM
    I set the status of this to "Needs more work" unless a permission to publish it is granted (details in e-mail communication between me and Davo). Davo, please let me know if you prefer to actually remove this plugin completely for now.
  • Davo
    Tue, 4 Nov 2014, 5:13 AM
    Thanks, that is very much appreciated (and sorry again for the messing around - I hope this plugin is able to be released soon).
  • David Mudrák
    Tue, 25 Nov 2014, 9:48 PM
    Thanks Davo for letting me know about the runway free for landing this. Welcome back to the Plugins directory!
  • Francis Feytout
    Tue, 10 Nov 2015, 9:59 PM
    Hi, does this plugin still modify the core tables ? Thanks
  • Davo
    Tue, 10 Nov 2015, 10:03 PM
    Francis, no it does not.
Please login to post comments