12,782
edits
OER in Education:Documentation: Difference between revisions
From OER in Education
no edit summary
No edit summary |
No edit summary |
||
| (14 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{draft}} | |||
= Introduction = | |||
This page documents the setup of this wiki, with particular attention to non-standard features. Some of these changes were made with the help of funding from the Wikimedia Foundation UK, see [[EWTE]], which also provides a narrative and rationale for some of the changes made. | |||
= General setup = | |||
The current wiki version and installed extensions are available on the usual page [[Special:Version]]. | |||
Speed optimisation: | |||
* Optimise the page delivering (more caching) | |||
* Search engine crawling restrictions | |||
Usability: | |||
* Reconfigure the search feature | |||
* Setup social extensions working with togetherJS | |||
* Setup new OCG toolchain with Collection extension (still buggy) (for pdf generation) | |||
* Configure solution for article section prefixing | |||
Offline: | |||
* Setup automatic ZIM generation toolchain | |||
= Optimisation and upgrading = | |||
Reconfigure the mediawiki in a way it make it easy to upgrade | Reconfigure the mediawiki in a way it make it easy to upgrade | ||
* Includes re-configuring the css to be contained in “Mediawiki:Vector.css” | * Includes re-configuring the css to be contained in “Mediawiki:Vector.css” | ||
* Setup the scripts to backup/upgrade easily ← need to document how we can do these updates, including OCG tool chain. | * Setup the scripts to backup/upgrade easily ← need to document how we can do these updates, including OCG tool chain. | ||
== Mediawiki backup & upgrade == | == Mediawiki backup & upgrade == | ||
| Line 23: | Line 31: | ||
To update OCG, Parsoid, mwoffliner and Semantic Mediawiki you should refer to the original documentation. | To update OCG, Parsoid, mwoffliner and Semantic Mediawiki you should refer to the original documentation. | ||
== Caching == | == Caching == | ||
| Line 42: | Line 39: | ||
== Robots == | == Robots == | ||
Have a look to the [http://oer.educ.cam.ac.uk/robots.txt robots.txt] file. | Have a look to the [http://oer.educ.cam.ac.uk/robots.txt robots.txt] file. | ||
== Incremental backup == | == Incremental backup == | ||
The incremental backup is done every day using rsnapshot (and a cron entry). | The incremental backup is done every day using rsnapshot (and a cron entry). | ||
= Offline = | == Custom extensions == | ||
OER has a few extensions which are ''non-standard'' or/and lightly customized. They are available on our server in /var/www/custom/extensions/, and can also be obtained from github, see [[OER:Documentation/customextensions]]. | |||
= Usabilty and accessː Offline = | |||
== PDF == | == PDF == | ||
== ZIM generation == | |||
One time a month a new ZIM file of OER is generated automatically using mwoffliner (and crontab, zimwriterfs, ...) | |||
= Usabilityː General = | |||
== | == Search == | ||
How did we do this? → See LocalSettings.custom.php and “../custom/extensions” directory. | |||
== Social tools == | |||
We have installed TogetherJS on OER using the [https://www.mediawiki.org/wiki/Extension:TogetherJS TogetherJS Mediawiki extension]. | |||
= Navigation = | = Usabilityː Navigation = | ||
== Project navigation: Page banners == | == Project navigation: Page banners == | ||
| Line 91: | Line 95: | ||
The OER Mediawiki is configured in a way to allow to specify a prefix before section titles. This prefix can be set using the [[:Template:SectionPrefix]] and use the [https://www.mediawiki.org/wiki/Extension:CSS extension:CSS]. | The OER Mediawiki is configured in a way to allow to specify a prefix before section titles. This prefix can be set using the [[:Template:SectionPrefix]] and use the [https://www.mediawiki.org/wiki/Extension:CSS extension:CSS]. | ||
= MLEB = | |||
= Future work = | |||
* Potential hackathon | |||
** Investigate improvements to OER4S-ZIM | |||
** Investigate improvements to OCG and pdf. | |||
** Add documentation to wiki for various tools (such as collabJS), as well as basic wiki editing info… Where’s a course on wiki editing? | |||
* Explore collab editor. | |||
Also we are running an event for Faculty, focussing on content production with these new tools (such as visual editor, navigation, etc). | |||
= Also see = | |||
[[EWTE]] | |||
