Wiki editing tips

From AQA Computer Science
Jump to: navigation, search

Wiki Editor

To get the best editor you need to change your preferences on the link in the top right. If you click on the editing tab, and click the boxes shown below: EditOption.GIF

when you edit a page you will see a basic editing app, this has standard icons for Bold, Italics, Embed File etc. Also look at the options under Advanced, this includes bullets & numbering, NoWiki tags, icons for the text size and so on:

Wiki Editor 1.PNG

Check the help section for guidance on how to edit / format a wiki:

Wiki Editor help.PNG

Images & Documents

Any files will need to be uploaded using the Upload File link in the tools section of the sidebar. Remember the files for the wiki are stored in a single location for all pages, so appropriately naming the file is essential. Once you have uploaded the file use the Embedded File icon and enter the name of the file uploaded.

Syntax Highlighting

This wiki will include many fragments of code. Syntax Highlighting will make the code easier to read and understand, most IDE's do this as standard and this wiki can also do it.

You can wrap your code in the following tags:


<syntaxhighlight lang="python"> ... </syntaxhighlight>


or if you want line numbers:


<syntaxhighlight lang="python" line> ... </syntaxhighlight>


The lang can be "csharp" , "vb" , or "vbnet". Many other languages are selectable, but students at TRC are doing the exam in C# therefore they should use the "csharp" option.

Programming Language Tabs

I have installed an extension called Tabber which can create interactive tabs within the content. I want this to be used to provide alternative languages.

The code below is an example of how to use it:

<tabber>

C#=

<syntaxhighlight lang="csharp" line> ... </syntaxhighlight>

|-|

VB=

<syntaxhighlight lang="vbnet" line> ... </syntaxhighlight>

</tabber>


the tabber tags define the extent of the tabs and the |-| is the split between tabs. CSharp= will give this name to the tab and anything after the equals will be within the tab.

Wiki Quiz Example

A quiz is started using the quiz tag, and closes with the closing tag:

<quiz display=simple>       </quiz>

Each question starts with:

{ your question text 
 | type="()" } 

This will create a multiple choice question. Then you need to idenify the correct and incorrect answers (using + or -), and feedback can also be added (using || for the feedback):

 + The correct answer.
 ||feedback for correct answer
 - Distractor.
 ||feedback for distractor
 - Distractor.
 ||feedback for distractor
 - Distractor.
 ||feedback for distractor

Example Question

1. your question text

The correct answer.
feedback for correct answer
Distractor.
feedback for distractor
Distractor.
feedback for distractor
Distractor.
feedback for distractor

Your score is 0 / 0


Multiple Answer

{ your question text 
 | type="[]" } 

This will create a multiple choice question. Notice the []:

 + The correct answer.
 ||feedback for correct answer
 - Distractor.
 ||feedback for distractor
 + Also Correct.
 ||feedback for also correct answer
 - Distractor.
 ||feedback for distractor

Above, notice each correct answer is a +.

Example Question

1. your question text

The correct answer.
feedback for correct answer
Distractor.
feedback for distractor
Also Correct.
feedback for also correct answer
Distractor.
feedback for distractor

Your score is 0 / 0


True or False

You could use this method to create a true or false question:

 <quiz display=simple>
 {Bulgaria and Rumania joined the European Union in 2007. 
 |type="()"}
 + TRUE.
 - FALSE.
 </quiz>

This will create the following question:


1. Bulgaria and Rumania joined the European Union in 2007.

TRUE.
Feedback for true
FALSE.
Feedback for false

Your score is 0 / 0


Short Answer

You can also create short answer questions in which a single word (or very short answer) is checked against options. You need to enter the question text outside of the curly brackets. You then inside curly brackets give the possible correct answers:

 <quiz display=simple>
 {
 |type="{}"}
 Name a famous Greek philosopher. 
 { Aristotle|Plato }
 </quiz>
 

Question Example

1.

Name a famous Greek philosopher.

Your score is 0 / 0


Numerical Range Question

A question could be a numerical answer that allows a range of accuracy:

 <quiz display=simple>
 {How far is the earth from the sun?
 |type="{}"}
 { 91-95 _3 } million miles.
 </quiz>
 

Question Example

1. How far is the earth from the sun?

million miles.
→ calculations show it is between 91-95 million miles

Your score is 0 / 0


Equations

Any equation must be within the <math> </math> tags. For Boolean alegbra the main issue is how to negate a term like:

[math] \overline{a}[/math] or [math] \overline{\overline{a}+b}[/math]

this can be done by adding the following around any term you wish to negate.:

\overline{}  

[math] \overline{a}[/math]

is

\overline{a}

[math] \overline{\overline{a}+b}[/math]

is

\overline{\overline{a}+b}.

Other Symbols

Remember these must be used within the <math> </math> tags:

\lt \gt \le \ge \neq ( [math] \lt \gt \le \ge \neq [/math] )

\times \div ([math]\times \div [/math])

\cdot is a centered dot: ([math]x \cdot y [/math])

\cup \cap \setminus \subset \subseteq \subsetneq \supset \in \notin \emptyset \varnothing ([math]\cup \cap \setminus \subset \subseteq \subsetneq \supset \in \notin \emptyset \varnothing [/math])

\to \rightarrow \leftarrow \Rightarrow \Leftarrow \mapsto ([math]\to \rightarrow \leftarrow \Rightarrow \Leftarrow \mapsto [/math])

\star \ast \oplus ([math]\star \ast \oplus [/math])