Editing UCT EE Wiki:Editing

[[Category:Management]]
= Editing Requirements =
For the time being, only users with administered accounts are able to edit and add pages.

= Philosophy of The Wiki =
The goals of this wiki are to:
* Provide a single point of access for staff or students looking for information that could assist them in their studies, research, or teaching activities
* Provide information on tools, software, hardware, and other resources available in the UCT EE Department
* Provide information in a way that is both comprehensive yet summative and can be used beyond just the initial reasons for creating the entry
** Essentially, the information on this wiki should be usable by anyone interested in using the tools

= Data Management and Page Categorization =
Each page should have at least one category. To see what categories are currently on the wiki, visit [[All Pages]]. If you feel creation of a new category is valid, please go ahead and create it.
<strong>Course codes are not to be used as categories.</strong>
== Creating a new Category ==
You can view categories at [[All Pages]].
Categories are added to a page by writing <code><nowiki>[[Category:Name]]</nowiki></code> at the top of the page.

If you're uncertain if a category exists or not, visit [[All Pages]]. If you do create a new category, it won't show in All Pages until you create the category page.

To create a page entry for a new category: 
# Add the category in the editor
# Save your changes
# Scroll down to the bottom of the page
# Click the new category name (it will be in red if it does not yet exist)

= Namespaces =
MediaWiki has the option for something known as "Namespaces". Certain pages can exist within particular namespaces, allowing for separation of user privileges and ideas.
Usually, all pages go within the main namespace. However, when there are multiple pages relating to a single topic, it may be useful to separate these pages in to their own Namespace. For example, the RaspberryPi namespace contains everything that relates to only the Raspberry Pi. 

While any user can create a new category, only administrators can create a new namespace. If you feel a new namespace is worth creating, please email ucteewiki[at]gmail.com

Namespaces are worth considering when there is too much data for a single topic to fit on one page.

= Tips 'n Tricks = 
== Collapsible Sections ==
Collapsible Sections can be quite useful for hiding in-depth content and making a page more "browsable". Collapsible sections are created as follows. Note the use of the "Section" keyword in the span class and div id. It needs to be unique for each collapsible section on your page, otherwise it will collapse or open multiple sections. Setting the "mw-collapsed" class in the div will mean the section starts collapsed.
<pre>
<span class="mw-customtoggle-Section" style="font-size:small; display:inline-block; "><span class="mw-customtoggletext" data-expandtext="Illuminate" data-collapsetext="Deluminate">[Show/hide]</span></span>
<div  id="mw-customcollapsible-Section" class="mw-collapsible mw-collapsed">
Here's collapsible content!
</div>
</pre>
will result in the following:

<span class="mw-customtoggle-Section" style="font-size:small; display:inline-block; "><span class="mw-customtoggletext" data-expandtext="Illuminate" data-collapsetext="Deluminate">[Show/hide]</span></span>
<div  id="mw-customcollapsible-Section" class="mw-collapsible mw-collapsed">
Here's collapsible content!
</div>

== Code Highlighting == 
Code highlighting is supported by the [https://www.mediawiki.org/wiki/Extension:SyntaxHighlight SyntaxHiglight] package. To use it is quite simple. The following code

<pre>
<syntaxhighlight lang="python" line='line'>   
def addition(a, b):   
	return a + b   
</syntaxhighlight>
</pre>

Creates this result:

<syntaxhighlight lang="python" line='line'>
def addition(a, b):
	return a + b
</syntaxhighlight>