How to Wiki: Difference between revisions

Ilovepubs (talk | contribs)
mNo edit summary
 
(40 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<div class="noautonum">__TOC__</div>
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>
If you need any help, please reach out to the [mailto:wiki.curator@mcgilleus.ca EUS Wiki Curator(s)]. Thank you for your contribution!
If you need any help, please reach out to the [mailto:wiki.curator@mcgilleus.ca EUS Wiki Curator(s)]. Thank you for your contribution!
 
<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 "request account". The Wiki Curator(s) should approve you within 24 hours!
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 collapsed" style="width:80%"
! 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;">
<i class="fa fa-exclamation-triangle" style="font-size: 1.7em" aria-hidden="true"></i>
 
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>
For more information on importing templates used on Wikipedia for example, navigate to [[Infoboxes#Export/Import]]


===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.


==<i class="fa fa-info-circle "></i> Infoboxes==
== 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|here]].
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].


== <i class="fa fa-object-group "></i>  Tabs ==
==   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. 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="Tab 1">This is a test</tab></nowiki><br>
:: <nowiki><tab name="Bingo">This is a test</tab></nowiki><br>
:: <nowiki><tab name="Tab 2", index="2">This is also a test</tab></nowiki><br>
:: <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='Tab 1'>This is a test</tab><tab name='Tab 2', index="2">This is also a test</tab></tabs>  
<tabs><tab name="Bingo">This is a test</tab><tab name="Bango">This is also a test</tab></tabs>  
<h3>Nested Tabs</h3>
===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


<code>''<nowiki> <tab name="Open me!" collapsed> Contents </tob></nowiki>''</code>
<code>''<nowiki> <tab name="Open me!" collapsed> Contents </tob></nowiki>''</code>
</tab>
</tab>


<!--Not Shown, too specific and not very applicable to most people-->
==Font Awesome==
<!--<h3> Attributes </h3>
<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.
Inside of the <nowiki><tab></nowiki> argument, you can include what is known as <code>attributes.</code><br>
==PDFs==
Notice the previous Tab was collapsed when the page loaded: that was accomplished with the ''collapsed tab''. Click below to learn more.
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
<tabs class="class="mw-collapsible mw-collapsed"><tab name="General">
<code><nowiki><pdf>File:Example.pdf</pdf></nowiki></code>
{|class="wikitable"
!Attribute
!Description
|-
|[https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes#title <code>title</code>]
|Determines the tooltip shown (<span title="Example tooltip text">Hover over this text for an example</span>) when hovering over the box.
|-
|[https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes#style <code>style</code>]
|Use this attribute to define any styles for the box. This can also affect the box's label.
|-
|[https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes#class <code>class</code>]
|Adds classes to the box. Different classes are seperated by spaces. Classes are generally used for altering the appearance of the box via CSS.
|-
|[https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes#id <code>id</code>]
|Adds an id to the box. This id must be unique on the page, as per HTML specifications. Ids are generally used for linking scripts to via JavaScript, or they might also be used for altering the appearance of the individual box via CSS.
|}</tab>


<tab name="Specific">
'''''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'''''
 
{|class="wikitable"
!Attribute
!Description
|-
!colspan="2"|For the <code>&lt;tabs&gt;</code> tag
|-
|style="color: darkblue;"|<code>container</code>
|Use this attribute to define any styles for the tabs container. Styles defined here will only affect the container of the tabs, not the labels.
|-
|style="color: darkblue;"|<code>plain</code>
|If this attribute is set, the tab interface will be a much more plain layout, without a border around the container, and with the tab labels just being buttons above it, instead of the typical tab layout. This can be used to get more freedom in styling the interface.
|-
!colspan="2"|For the <code>&lt;tab&gt;</code> tag inside tab menus
|-
|style="color: darkblue;"|<code>inline</code>
|If this attribute is set, the tab's contents can be placed within text without interrupting the flow of the text. The difference between this and the default state of <code>display:inline-block</code> is that with <code>inline-block</code>, the tab's contents are forced to a new line when placed at the end of a new line, when not the whole of the tab's contents fit on the same line. <code>inline</code> tabs however will use up any space that's left at the end of the line, and fit in with the normal flow of the text just like normal text.
|-
|style="color: darkblue;"|<code>block</code>
|Converts the tab's contents to a block element. This can be used to assure the tab's contents will be displayed as a block instead of an inline-block, in cases where the tab's contents should not be placed within a line of text. When both the <code>block</code> and <code>inline</code> attributes are available, the <code>inline</code> attribute will be ignored.
|-
|style="color: darkblue;"|<code>index</code>
|This will determine the index of the tab. This only works if the entered index is already the index of a defined tab. Otherwise, this attribute is ignored. If no valid index or matching name attributes are defined, the index is automatically set to be the next in the list of tabs.
|-
|style="color: darkblue;"|<code>name</code>
|This attribute is used to define the text the label shows for the tab. If the entered name already exists within the tab, the contents of the <code>&lt;tab&gt;</code> tag are automatically assigned to the existing tab. This also means no two tabs can have an identical label. This attribute will be ignored if the <code>index</code> attribute already refers to an existing tab. Whitespace is automatically removed from the start and end of this attribute's value.
|}| name=Specific| index="2"}}
}}</tab>
</tabs>-->
===PDFs===
Many bylaws, policies, agendas, etc. come in the beautiful electronic format '''PDF'''. Better yet, you can slyly embed a PDF into a tab such that it's expandable, while not taking up too much space (''Note: if you wish to place a pdf without the expandable option, negate the tab ends''). To do so, implement the aforementioned "Tag" syntax:<br>
<center><code><nowiki><tab name="I've eaten a PDF" collapsed></nowiki></tab></code></center>
Inside of the Tab you can place a pdf using the following syntax:
<center><code><nowiki><pdf>File:Libraryofbabel1.pdf</pdf></nowiki></code></center>
Put the two together<br>
<center><code><nowiki><tab name="I've eaten a PDF" collapsed><pdf>File:Libraryofbabel1.pdf</pdf></tab></nowiki></code></center>and you get:<br>
<tab name="I've eaten a PDF" collapsed><pdf>File:Libraryofbabel1.pdf</pdf></tab>
==Font Awesome==
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.
==Templates==
===Navigation Bars===
The navigation bars are made using Templates and CSS.
<pre>Templates:Example</pre> can recall the article ''Example'' as a template by being saved the same as a regular article. Once the template is saved, you can recall it in any ''other'' article by adding {{}} and removing the 'Templates:' preface, <br><pre>{{Example}}</pre> ''(neglect the brackets in each case around name)''.<br>
Take for example the [[Template:FinanceBar]], this is the object recalled across each finance related articles. To change the template is to change the navigation bar for finance. This example is made manipulating the [https://www.mediawiki.org/wiki/Manual:CSS common.css].
==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>
Line 330: Line 320:
|width=600
|width=600
|height=750
|height=750
}}
</pre>
</tab>
<tab name='Google Calendar'>
You can display google calendars in the wiki too. Like other google products, just copy the id from the URL of the standalone calendar (which you can get by going to the calendar settings). You can include multiple calendars by inserting multiple id's and colors (processed sequentially). You can change the default view as well to be WEEK or MONTH or AGENDA.
<pre>
{{#widget:Google Calendar
|id=mcgilleus.ca_lee6df3cc2qit6r0dcdhsip2eg@group.calendar.google.com
|color=2952A3
|id=mcgilleus.ca_lee6df3cc2qit6r0dcdhsip2eg@group.calendar.google.com
|color=2952A3
|title=Any title you'd like
|view=WEEK
}}
}}
</pre>
</pre>