Difference between revisions of "Team Wiki"

From Leeds Hackspace Wiki
Jump to: navigation, search
(Created a team wiki page)
 
m (More formatting info)
 
Line 1: Line 1:
 
Team Wiki is responsible for maintaining the Wiki backend and ensuring proper access to the wiki
 
Team Wiki is responsible for maintaining the Wiki backend and ensuring proper access to the wiki
  
== Getting an account ==
+
==Getting an account==
 
To get a wiki account, please contact a member of Team Wiki.
 
To get a wiki account, please contact a member of Team Wiki.
  
== Useful syntax ==
+
== Features ==
 +
The full wiki information is visible on the [[Special:Version]] page, but in breif summary
 +
 
 +
* A visual editor (that may occasionally be buggy)
 +
* Citations
 +
* Many parsing extension
 +
* Syntax highlighting
 +
 
 +
==Formating help==
 +
This section includes guides on how to efficiently use the visual editor, and how to understand simple wiki syntax easily
 +
 
 
While the wiki posesses a visual editor (horray); knowing some of the basics of wiki-script is exceptionally usefull, especially for stuff like sub-templates
 
While the wiki posesses a visual editor (horray); knowing some of the basics of wiki-script is exceptionally usefull, especially for stuff like sub-templates
  
=== Linking ===
+
===Linking===
 
Far and away the most usefull wiki syntax is the different kinds of linking syntax
 
Far and away the most usefull wiki syntax is the different kinds of linking syntax
  
==== Internal/Interwiki linking ====
+
In the visual editor you can eithe link by highlighting a piece of text an pressing the Chain icon, or by typing <code>[[</code>
 +
 
 +
====Internal/Interwiki linking====
 
To link to another page on the wiki, you write <nowiki>[[Target Page | Link Text]]</nowiki>. If no link text is given the name itself is shown
 
To link to another page on the wiki, you write <nowiki>[[Target Page | Link Text]]</nowiki>. If no link text is given the name itself is shown
  
Line 17: Line 29:
 
Examples:
 
Examples:
  
* <nowiki>[[Laser Cutter]]</nowiki> -> [[Laser Cutter]]
+
*<code><nowiki>[[Laser Cutter]]</nowiki></code> -> [[Laser Cutter]]
* <nowiki>[[Laser Cutter | Laser]]</nowiki> -> [[Laser Cutter|Laser]]
+
*<code><nowiki>[[Laser Cutter | Laser]]</nowiki></code> -> [[Laser Cutter|Laser]]
* <nowiki>[[wiktionary:Moron | Moron]]</nowiki> -> [[wiktionary:Moron|Moron]]
+
*<code><nowiki>[[wiktionary:Moron | Moron]]</nowiki></code> -> [[wiktionary:Moron|Moron]]
  
==== External linking ====
+
====External linking====
 
External linking is similar to internal linking, but also different (because of course it is)
 
External linking is similar to internal linking, but also different (because of course it is)
  
Line 30: Line 42:
 
Examples:
 
Examples:
  
* <nowiki>[https://bbc.co.uk The BBC]</nowiki> -> [https://bbc.co.uk The BBC]
+
*<code><nowiki>[https://bbc.co.uk The BBC]</nowiki></code> -> [https://bbc.co.uk The BBC]
 +
 
 +
=== Syntax highlighting ===
 +
The wiki supports syntax highlighting; the extension used to do this utilises Pygments. In the visual editor, this can be done easily by going through insert, then selecting Code block
 +
 
 +
In wiki script, one writes <code><nowiki><syntaxhighlight lang="Your language here" line></nowiki></code> to enable it, where your language is something sensible you also need to close that block with <code><nowiki></syntaxhighlight></nowiki></code>
 +
 
 +
To disable the line numbers, ommit the <code>line</code> from the command;
 +
 
 +
Example:<syntaxhighlight lang="python3" line="1" start="8">
 +
def hello():
 +
    print("Hello World!)
 +
   
 +
if __name__ == "__main__":
 +
    hello()
 +
</syntaxhighlight><br />

Latest revision as of 14:18, 25 September 2019

Team Wiki is responsible for maintaining the Wiki backend and ensuring proper access to the wiki

Getting an account

To get a wiki account, please contact a member of Team Wiki.

Features

The full wiki information is visible on the Special:Version page, but in breif summary

  • A visual editor (that may occasionally be buggy)
  • Citations
  • Many parsing extension
  • Syntax highlighting

Formating help

This section includes guides on how to efficiently use the visual editor, and how to understand simple wiki syntax easily

While the wiki posesses a visual editor (horray); knowing some of the basics of wiki-script is exceptionally usefull, especially for stuff like sub-templates

Linking

Far and away the most usefull wiki syntax is the different kinds of linking syntax

In the visual editor you can eithe link by highlighting a piece of text an pressing the Chain icon, or by typing [[

Internal/Interwiki linking

To link to another page on the wiki, you write [[Target Page | Link Text]]. If no link text is given the name itself is shown

You can link to external wikipedia pages using the interwiki functionality; to use this you apply a prefix; these prefixes are listed on the Interwiki list

Examples:

External linking

External linking is similar to internal linking, but also different (because of course it is)

An external link is specified as [http://example.com/test Link Text]. Here the link text is seperated by a space from the url. As above, if no link text is present, it will just show the link, which here just looks bad

The mediawiki will also automatically link any url written; so if you write http://example.comit will auto-create a link

Examples:

  • [https://bbc.co.uk The BBC] -> The BBC

Syntax highlighting

The wiki supports syntax highlighting; the extension used to do this utilises Pygments. In the visual editor, this can be done easily by going through insert, then selecting Code block

In wiki script, one writes <syntaxhighlight lang="Your language here" line> to enable it, where your language is something sensible you also need to close that block with </syntaxhighlight>

To disable the line numbers, ommit the line from the command;

Example:

 8 def hello():
 9     print("Hello World!)
10     
11 if __name__ == "__main__":
12     hello()