You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-12Lines changed: 13 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,8 @@
1
-
The Memento extension makes it as straightforward to access the past versions of articles as it is to access their current version.
1
+
#Memento MediaWiki Extension
2
2
3
-
The Memento framework allows you to see versions of articles as they existed at some date in the past. With a browser plug-in, like [Memento for Chrome](https://chrome.google.com/webstore/detail/memento-time-travel/jgbfpjledahoajcppakbgilmojkaghgm?hl=en), you can enter a URL of an article in your browser and specify the desired date to view the past version of that article. This way you can browse the Web of the past. The Memento extension will present to you a version of the article as it existed on or close to the selected date. This will only work if previous (archived) versions are available on the Web. Fortunately, MediaWiki is a Content Management System which implies that it maintains all revisions made to an article. This extension leverages this archiving functionality and provides native Memento support for MediaWiki.
3
+
The Memento MediaWiki extension makes it as straightforward to access the past versions of MediaWiki articles as it is to access their current version.
4
+
5
+
The Memento framework allows you to see versions of articles as they existed at some date in the past. With a browser plug-in, like [Memento for Chrome](https://chrome.google.com/webstore/detail/memento-time-travel/jgbfpjledahoajcppakbgilmojkaghgm?hl=en), you can enter a URL of an article in your browser and specify the desired date to view the past version of that article. This way you can browse the Web of the past. The Memento extension will present to you a version of the article as it existed on or close to the selected date. Normally, this will only work if previous (archived) versions are available on the Web. Fortunately, MediaWiki is a Content Management System which implies that it maintains all revisions made to an article. This extension leverages this archiving functionality and provides native Memento support for MediaWiki.
4
6
5
7
This package contains the source code, build scripts, and tests for the Memento MediaWiki Extension.
6
8
@@ -14,7 +16,7 @@ Jones, S.M. & Nelson, M.L. Avoiding Spoilers in Fan Wikis of Episodic Fiction. N
14
16
15
17
Jones, S.M., Nelson, M.L., Shankar, H. & Van de Sompel, H. Bringing Web Time Travel to MediaWiki: An Assessment of the Memento MediaWiki Extension. Norfolk, Virginia; 2014. arXiv:1406.3876. Available from: https://arxiv.org/abs/1406.3876v1
16
18
17
-
# Installation
19
+
##Installation
18
20
19
21
To install this package within MediaWiki perform the following:
20
22
* copy the ``Memento`` directory into the extensions directory of your MediaWiki installation
@@ -23,15 +25,15 @@ To install this package within MediaWiki perform the following:
23
25
wfLoadExtension( 'Memento' );
24
26
```
25
27
26
-
# Configuration
28
+
##Configuration
27
29
28
30
This extension has sensible defaults, but also allows the following settings to be added to LocalSettings.php in order to alter its behavior:
29
31
30
32
*`$wgMementoTimemapNumberOfMementos` - allows the user to alter the number of Mementos included in a TimeMap served up by this extension (default is 500)
31
33
32
34
*`$wgMementoIncludeNamespaces` - is an array of MediaWiki Namespace IDs (e.g. the integer values for Talk, Template, etc.) to include for Mementofication, default is an array containing just 0 (Main); the list of MediaWiki Namespace IDs is at https://www.mediawiki.org/wiki/Manual:Namespace
33
35
34
-
# Packaging
36
+
##Packaging
35
37
36
38
To package the Memento MediaWiki Extension, type the following
37
39
from this directory:
@@ -42,9 +44,9 @@ $ make package
42
44
43
45
This serves to run everything needed to verify the code and package the zip for release.
44
46
45
-
# Automated Deployment and Testing
47
+
##Automated Deployment and Testing
46
48
47
-
## Using Docker
49
+
###Using Docker
48
50
49
51
Easier testing with supported MediaWiki versions is now available via Docker. First change into the directory containing the docker-compose files:
50
52
@@ -80,7 +82,7 @@ $ cd ../../
80
82
Run the tests as stated in the **Integration Testing** section.
81
83
82
84
83
-
## Using your own MediaWiki Installation
85
+
###Using your own MediaWiki Installation
84
86
85
87
To deploy the Memento MediaWiki Extension locally for testing, one must first indicate to the shell where MediaWiki is installed, then run the appropriate make target.
86
88
@@ -95,7 +97,7 @@ To remove the software from a MediaWiki instance, type:
95
97
$ make undeploy
96
98
```
97
99
98
-
# Setting Up Testing and Code Compliance
100
+
##Setting Up Testing and Code Compliance
99
101
100
102
If you have [composer](https://getcomposer.org/) installed, you can install this version of PHPUnit and PHP Code Sniffer by running:
If do not have [composer](https://getcomposer.org/), you will need to ensure that [PHP Unit](https://phpunit.de/) (`phpunit`) and [PHP Code Sniffer](https://pear.php.net/package/PHP_CodeSniffer) (`phpcs`) are in your `PATH`.
108
110
109
-
# Integration Testing
111
+
##Integration Testing
110
112
111
113
Once the code is deployed, the integration tests can be run.
112
114
@@ -120,11 +122,10 @@ To run integration tests, execute the following script from the root of the repo
120
122
$ ./run_default_tests.sh
121
123
```
122
124
123
-
# Code compliance verification
125
+
##Code compliance verification
124
126
125
127
Running the code compliance requires phpcs. If you installed the development dependencies using ``composer`` then type the following from the root of the repository see if the code complies with MediaWiki's coding conventions:
0 commit comments