MediaWiki: Difference between revisions

Latest revision as of 00:34, 31 December 2023

Installation

See mediawiki for instructions on deployment.
I have a container image with my preferred extensions at https://github.com/dli7319/docker-mediawiki.

To update, bump your image version and then in your container run:

php maintenance/run.php update

Wikitext

Wikitext is the markup language for Mediawiki pages.

Import/Export

Importing Individual Pages From Wikipedia

Mediawikiwiki: Manual:Importing_Wikipedia_infoboxes_tutorial

Go to Wikipedia's Special:Export

Type in the page you want.

Template:Key press
Template:Key press/doc

Check include templates and download the file
Go to your wiki's Special:Import
Import the file.

Restricting Access

See https://www.mediawiki.org/wiki/Category:Page_specific_user_rights_extensions.
I use the Lockdown extension.

TODO

Find a way to insert text files into mediawiki (either via upload or as text).
- These should be downloadable with a link.
- Bonus if we can get syntax highlighting for code and if WebGL shaders can be made runnable.

Writing Extensions

PHP Hooks

See Mediawikiwiki:Manual:Hooks

ParserAfterTidy

This is only called for new sections of pages, not necessarily the entire page.

JS Hooks

See mw.hook documentation

@@ Line 1: / Line 1: @@
+==Installation==
+See [https://hub.docker.com/_/mediawiki mediawiki] for instructions on deployment.<br>
+I have a container image with my preferred extensions at https://github.com/dli7319/docker-mediawiki.
+To update, bump your image version and then in your container run:
+<pre>
+php maintenance/run.php update
+</pre>
-==Syntax==
+==Wikitext==
-Below are how to typeset and format things in Mediawiki properly
+{{ main | Wikitext}}
-===Code===
+Wikitext is the markup language for Mediawiki pages.
-Inline code can by represented with <nowiki><code></code></nowiki><br>
-Code blocks should be like:
-<pre>
-<syntaxhighlight lang="cpp">
-// ... my code here
-</syntaxhighlight>
-</pre>
-===Math===
+==Import/Export==
-Math is written in standard latex syntax inside of <nowiki><math></math></nowiki>.
+===Importing Individual Pages From Wikipedia===
-* Beware: Do not use <code>||</code>, use <code>\Vert</code> instead.
+[[Mediawikiwiki: Manual:Importing_Wikipedia_infoboxes_tutorial]]
-==Advanced==
-===Importing Templates From Wikipedia===
-[https://www.mediawiki.org/wiki/Manual:Importing_Wikipedia_infoboxes_tutorial Link]<br>
 <ol>
 <li> Go to [https://en.wikipedia.org/wiki/Special:Export Wikipedia's Special:Export]</li>
-<li> Type in the templates you want. E.g.</li>
+<li> Type in the page you want.<br>
 <pre>
 Template:Key press
-Template:Key press/doc</pre>
+Template:Key press/doc</pre></li>
 <li> Check include templates and download the file</li>
 <li> Go to your wiki's [https://wiki.davidl.me/view/Special:Import Special:Import]</li>
@@ Line 32: / Line 29: @@
 ==Restricting Access==
-The best way to restrict access is to create a separate wiki.
+See [https://www.mediawiki.org/wiki/Category:Page_specific_user_rights_extensions https://www.mediawiki.org/wiki/Category:Page_specific_user_rights_extensions].<br>
+I use the Lockdown extension.
+==TODO==
+* Find a way to insert text files into mediawiki (either via upload or as text).
+** These should be downloadable with a link.
+** Bonus if we can get syntax highlighting for code and if WebGL shaders can be made runnable.
+==Writing Extensions==
+===PHP Hooks===
+See [[Mediawikiwiki:Manual:Hooks]]
+====ParserAfterTidy====
+* This is only called for new sections of pages, not necessarily the entire page.
+===JS Hooks===
+See [https://doc.wikimedia.org/mediawiki-core/master/js/#!/api/mw.hook mw.hook documentation]