How to Wiki: Difference between revisions
Malcolmmcc (talk | contribs) |
mNo edit summary |
||
| (24 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
Welcome to the EUSwiki! Thank you for your interest in helping contribute! There are a lot of ways to tackle a wiki, so on this page we've tried to sum up all best practices used on the EUSwiki. Syntax can be confusing, but stick with it. Copying and pasting code from articles that you like is how a great wiki can be built, there's no shame in that.<br> | Welcome to the EUSwiki! Thank you for your interest in helping contribute! There are a lot of ways to tackle a wiki, so on this page we've tried to sum up all best practices used on the EUSwiki. Syntax can be confusing, but stick with it. Copying and pasting code from articles that you like is how a great wiki can be built, there's no shame in that.<br> | ||
'''''Google is your friend''''', there are better guides out there for specific tips you may be looking for. But here we've grouped tools that are already installed and ready for use. Mediawiki is the format that wikipedias are built on, including that in your search will help.<br> | '''''Google is your friend''''', there are better guides out there for specific tips you may be looking for. But here we've grouped tools that are already installed and ready for use. Mediawiki is the format that wikipedias are built on, including that in your search will help.<br> | ||
| Line 5: | Line 4: | ||
<div class="noautonum">__TOC__</div> | <div class="noautonum">__TOC__</div> | ||
=== Signing Up For An Account === | === Signing Up For An Account === | ||
The Wiki has had some unfortunate run-ins with some very nefarious spam bots and as such now requires new accounts to receive approval. Navigate yourself to the top right hand corner of the wiki and fill out the " | The Wiki has had some unfortunate run-ins with some very nefarious spam bots and as such now requires new accounts to receive approval. Navigate yourself to the top right hand corner of the wiki and fill out the "Create account". Use your personal google account and signing up only takes seconds! | ||
== Text Editing == | == Text Editing == | ||
| Line 12: | Line 11: | ||
You can format your text by using wiki markup. This consists of normal characters like asterisks, apostrophes or equal signs which have a special function in the wiki, sometimes depending on their position. For example, to format a word in ''italic'', you include it in two pairs of apostrophes like <code><nowiki>''this''</nowiki></code>. | You can format your text by using wiki markup. This consists of normal characters like asterisks, apostrophes or equal signs which have a special function in the wiki, sometimes depending on their position. For example, to format a word in ''italic'', you include it in two pairs of apostrophes like <code><nowiki>''this''</nowiki></code>. | ||
{| class="wikitable collapsible alternating" style="width:80%" | |||
{| class="wikitable collapsible alternating | |||
! Description | ! Description | ||
! width=40% | Youtype | ! width="40%" | Youtype | ||
! width=40% | You get | ! width="40%" | You get | ||
|- | |- | ||
! colspan="3" style="background: #ABE" | Character (inline) formatting – ''applies anywhere'' | ! colspan="3" style="background: #ABE" | Character (inline) formatting – ''applies anywhere'' | ||
| Line 124: | Line 122: | ||
Any other start also | Any other start also | ||
ends the list. | ends the list. | ||
</translate> | <nowiki></translate></nowiki> | ||
|- | |- | ||
| Indent text | | Indent text | ||
| Line 136: | Line 134: | ||
::::: Multiple indent | ::::: Multiple indent | ||
|} | |} | ||
===Links=== | |||
{| class="wikitable" border="1" | |||
!Description | |||
!You type | |||
!You get | |||
|- | |||
|Internal link | |||
|<pre> | |||
[[Launchpad]] | |||
</pre> | |||
|[[Launchpad]] | |||
|- | |||
|Piped link | |||
|<pre> | |||
[[EUS Constitution|constitution]] | |||
[[EUS Constitution#TITLE III ELECTIONS|election section]]</pre> | |||
| | |||
[[EUS Constitution|constitution]] | |||
[[EUS Constitution#TITLE III ELECTIONS|election section]] | |||
|- | |||
|External link with specified link text | |||
|<pre>[https://mediawiki.org MediaWiki]</pre> | |||
|[https://mediawiki.org MediaWiki] | |||
|- | |||
|} | |||
===Adding Colors=== | ===Adding Colors=== | ||
[[File:Color.jpg|thumb|100px|right]] | [[File:Color.jpg|thumb|100px|right]] | ||
Mediawiki supports a host of vernacular terms to colorize content without needing to know the hexadecimal values. So, when using 'style', insert one of the names to the right instead of the actual color value. It saves the trouble of remembering those pesky alphanumeric values, and spreads consistency. | Mediawiki supports a host of vernacular terms to colorize content without needing to know the hexadecimal values. So, when using 'style', insert one of the names to the right instead of the actual color value. It saves the trouble of remembering those pesky alphanumeric values, and spreads consistency. | ||
===Redirects=== | |||
Redirects are really important to link different phrases to the same article (not to mention all the [[Acronym Almanac|acronyms]]). Let's use an example: redirecting '''SSF''' to '''Student Space Fund'''. Navigate to SSF, where a blank page should exist. In that blank page, add the text: | |||
<pre>#REDIRECT[[Student Space Fund]]</pre> | |||
Create the page as you would any other. That's it! Unfortunately you cannot add redirect to external websites, and if you redirect to a redirect (e.g. if SSF went to Stude. Space Fund), '''the path would stop''' at the second redirect. | |||
==Templates== | ==Templates== | ||
| Line 152: | Line 182: | ||
background-color: #fcf8e3; | background-color: #fcf8e3; | ||
font-size: 18px;"> | font-size: 18px;"> | ||
This article is a stub. Please consider <span style="color: #66512c">[[How to Central|expanding it]]</span>. | This article is a stub. Please consider <span style="color: #66512c">[[How to Central|expanding it]]</span>. | ||
</div> | </div> | ||
The code is need on many pages. It is therefore added to a new page on the wiki named <code>Template:Stub</code>. Then, once saved, the template can be called upon using double curly brackets around the name of the template, i.e. <strong><nowiki>{{Stub}}</nowiki></strong> . As long as the code is created in a document labeled 'Template:XXXXX', it can then be called upon again by '''<nowiki>{{XXXXX}}</nowiki>'''. <br> | The code is need on many pages. It is therefore added to a new page on the wiki named <code>Template:Stub</code>. Then, once saved, the template can be called upon using double curly brackets around the name of the template, i.e. <strong><nowiki>{{Stub}}</nowiki></strong> . As long as the code is created in a document labeled 'Template:XXXXX', it can then be called upon again by '''<nowiki>{{XXXXX}}</nowiki>'''. <br> | ||
===Good templates=== | ===Good templates=== | ||
| Line 179: | Line 207: | ||
|{{In Progress}} | |{{In Progress}} | ||
|Articles that are currently being developed. | |Articles that are currently being developed. | ||
|- | |||
|[[Template:Retired]] | |||
|{{Retired}} | |||
|Articles of groups that have since retired. | |||
|- | |- | ||
|[[Template:Button]] | |[[Template:Button]] | ||
|{{Button|1=http://wiki.mcgilleus.ca|2=Wiki|3=fa-life-ring|4=Crimson}} | |{{Button|1=http://wiki.mcgilleus.ca|2=Wiki|3=fas fa-life-ring|4=Crimson}} | ||
|''1=Link<br>2=Text<br>3=FontAwesome<br>4=Color''<br>Making buttons instead of links, jumps people's attention! | |There's a heck of a lot of other options: change font color, make it an internal link, and more. Make sure to read [[Template:Button]]<br>''1=Link<br>2=Text<br>3=FontAwesome<br>4=Color''<br>Making buttons instead of links, jumps people's attention! | ||
|- | |- | ||
|[[Template:FinanceBar]] | |[[Template:FinanceBar]] | ||
| Line 203: | Line 235: | ||
|{{EmailIcon|1=faucet@mcgilleus.ca}} | |{{EmailIcon|1=faucet@mcgilleus.ca}} | ||
|''1=emailaddress@gmail.com''<br>A button for the email address of the position/group | |''1=emailaddress@gmail.com''<br>A button for the email address of the position/group | ||
|- | |||
|[[Template:FacebookIcon]] | |||
|{{FacebookIcon|1=http://fb.com/mcgilleus}} | |||
|''1=URL to facebook page''<br> A button to navigate specifically to a groups' Facebook page. | |||
|- | |||
|[[Template:GroupIcon]] | |||
|{{GroupIcon|1=Curator's Choice}} | |||
|''1=Article Name of Group''<br>A button used to link policies back to a groups Wiki article | |||
|- | |||
|[[Template:DriveIcon]] | |||
|{{DriveIcon|1=http://drive.google.com}} | |||
|''1=GoogleDrive Link''<br>A button used to link policies to their official google drive file | |||
|- | |||
|} | |} | ||
See also the [[Launchpad]] templates at | |||
*[[Template:Launchpad Navigation]] | |||
*[[Template:Launchpad Card]] | |||
*[[Template:Launchpad Box]] | |||
== Categories == | == Categories == | ||
Categories can be used to group similar pages through the wiki. For example, <code><nowiki>[[Category:Policies]]</nowiki></code> contains a [[Category:Policies|list of all policies]] that are currently on the wiki. To add any page to the category, include the code <nowiki>[[Category:***]]</nowiki> to all the pages you'd like to add. | Categories can be used to group similar pages through the wiki. For example, <code><nowiki>[[:Category:Policies]]</nowiki></code> contains a [[:Category:Policies|list of all policies]] that are currently on the wiki. To add any page to the category, include the code <nowiki>[[Category:***]]</nowiki> to all the pages you'd like to add. | ||
Generally the EUSwiki does not include the categories on the page themselves, as there's normally a disambiguation page; that is to say, we'd prefer people navigate to [[Policies]] instead of the category page. Thus, it is common practice to '''''hide the category'''''. This can be done by adding the power word <code><nowiki>__HIDDENCAT__</nowiki></code> ''inside the category''. It will then be hidden from all the pages. | Generally the EUSwiki does not include the categories on the page themselves, as there's normally a disambiguation page; that is to say, we'd prefer people navigate to [[Policies]] instead of the category page. Thus, it is common practice to '''''hide the category'''''. This can be done by adding the power word <code><nowiki>__HIDDENCAT__</nowiki></code> ''inside the category''. It will then be hidden from all the pages. | ||
== | == Infoboxes== | ||
Infoboxes are the iconic boxes that can be seen on the top right of nearly every wikipedia page. To learn more about infoboxes, please go [ | Infoboxes are the iconic boxes that can be seen on the top right of nearly every wikipedia page. To learn more about infoboxes, please go [https://en.wikipedia.org/wiki/Template:Infobox here]. | ||
== | == Tabs == | ||
Tabs is an extension that provides a handy way to create multiple tabs and tables. This is very useful for containing nested information, and can be manipulated depending on your understanding of the mechanism. <br>To learn more about Tabs, [https://www.mediawiki.org/wiki/Extension:Tabs/Usage click here]. | Tabs is an extension that provides a handy way to create multiple tabs and tables. This is very useful for containing nested information, and can be manipulated depending on your understanding of the mechanism. <br>To learn more about Tabs, [https://www.mediawiki.org/wiki/Extension:Tabs/Usage click here]. | ||
'''''What you enter''''' | '''''What you enter''''' | ||
: <nowiki><tabs></nowiki><br> | : <nowiki><tabs></nowiki><br> | ||
:: <nowiki><tab name=" | :: <nowiki><tab name="Bingo">This is a test</tab></nowiki><br> | ||
:: <nowiki><tab name=" | :: <nowiki><tab name="Bango">This is also a test</tab></nowiki><br> | ||
: </tabs> | : <nowiki></tabs></nowiki> | ||
'''''What you Get''''' | '''''What you Get''''' | ||
<tabs><tab name= | <tabs><tab name="Bingo">This is a test</tab><tab name="Bango">This is also a test</tab></tabs> | ||
===Collapsed Tabs=== | ===Collapsed Tabs=== | ||
<tab name="Open me!" collapsed> | <tab name="Open me!" collapsed=""> | ||
Nested Tabs are useful for having large amounts of information without overburdening the layout or flow of your article. <br>The syntax is essentially the same as above | Nested Tabs are useful for having large amounts of information without overburdening the layout or flow of your article. <br>The syntax is essentially the same as above | ||
| Line 232: | Line 282: | ||
==Font Awesome== | ==Font Awesome== | ||
<div style="display:inline-block;float:right;">{{Button|1=http://wiki.mcgilleus.ca/index.php/FontAwesome|2=FontAwesome|3=fa-link|4=SteelBlue}}</div>A well known bootstrap based icon pack, '''''FontAwesome''''' is a very easy way to include icons without having to import anything. They're flexible in terms of resizing, color, and placement, and varied enough that you're sure to find the icon you're looking for. To see a complete list of compatible icons, navigate to our [[FontAwesome]] wiki page, which includes how to embed and a few examples. | <div style="display:inline-block;float:right;">{{Button|1=http://wiki.mcgilleus.ca/index.php/FontAwesome|2=FontAwesome|3=fas fa-link|4=SteelBlue}}</div>A well known bootstrap based icon pack, '''''FontAwesome''''' is a very easy way to include icons without having to import anything. They're flexible in terms of resizing, color, and placement, and varied enough that you're sure to find the icon you're looking for. To see a complete list of compatible icons, navigate to our [[FontAwesome]] wiki page, which includes how to embed and a few examples. | ||
==PDFs== | |||
If you'd like to embed a PDF, upload a file as you would any other (lefthand sidebar, [[Special:Upload|Tools>Upload File]]). | |||
You can then embed the pdf using the following code | |||
<code><nowiki><pdf>File:Example.pdf</pdf></nowiki></code> | |||
'''''Note: Please don't upload policies/bylaws as pdfs. Create the page and insert the content as plain text and link to the google drive. This prevents future obsolescence''''' | |||
==Widgets== | ==Widgets== | ||
'''Widgets''' is a blanket term for easy to add HTML pages/elements. They avoid the security problems of raw HTML in editable wiki pages because the privilege to edit in the Widget namespace is managed. Most of the time you would be working with [https://www.mediawikiwidgets.org/Widgets_Catalog pre-written widgets].<br> | '''Widgets''' is a blanket term for easy to add HTML pages/elements. They avoid the security problems of raw HTML in editable wiki pages because the privilege to edit in the Widget namespace is managed. Most of the time you would be working with [https://www.mediawikiwidgets.org/Widgets_Catalog pre-written widgets].<br> | ||