Difference between revisions of "Help:Contents"

From WikiManual
Jump to: navigation, search
m (Wiki Code)
m
Line 1: Line 1:
=Wiki Code=
+
==Help Editing Wiki Pages==
  
This took me a bit to figure out.
+
# Click on '''Edit this page''' on top of web page or '''edit''' on the right (if available) for a section
 +
# ''Type in text''
 +
# Click on '''Show Preview'''. Modify if required.
 +
# Add summary if required. Click on '''Save page'''.
 +
<br/>
  
  all code simply starts with a space at the start of the line
+
Practice editing in the [[Sandbox]]
 +
 
 +
==Wiki Code==
 +
 
 +
Most basic HTML commands will work, but wiki also has "easier" ways to specify some commands.<br>  
 +
Triple single quotes, like <nowiki>'''Bold'''</nowiki> around text will make it bold, like '''Bold'''. and two single quotes will show ''Italics''.)
 +
 
 +
Also ... there are newer CSS commands to replace outdated HTML. Stay tuned.
 +
 
 +
Some other Wiki things:
 +
 
 +
 
 +
placing a 'space' at the beginning of a line
 +
results in the text being displayed exactly as written
 +
inside this blue box ... wysiwyg.
 +
so this works good for displaying robot code snippets
 +
and other DB code
  
  
Line 26: Line 46:
 
example:
 
example:
 
<pre> <b><i><u> have no effect within the <nowiki><pre></pre> tags.</nowiki> </pre>
 
<pre> <b><i><u> have no effect within the <nowiki><pre></pre> tags.</nowiki> </pre>
 
 
===Indenting===
 
 
One may indent using one or more colons at the beginning of a line ...<br>
 
So this:
 
<pre>
 
:this is one colon
 
::two
 
:::three ... etc.
 
</pre>
 
results in:
 
:this is one colon
 
::two
 
:::three ... etc.
 
 
this also precludes having to place <nowiki><br></nowiki> at the end of a line to break it.
 
 
  
 
===Placing Comments in the Edit Window===
 
===Placing Comments in the Edit Window===
Line 65: Line 67:
 
__TOC__ will manually place the TOC
 
__TOC__ will manually place the TOC
 
</pre>
 
</pre>
 +
 +
===Bullet list===
 +
 +
adding <font color="Red" size =5><B> * </B></font> at the beginning of a line will form a bullet list.
 +
*1st bullet
 +
*2nd bullet
 +
* etc ...
 +
 +
 +
===Number list===
 +
 +
adding <font color="Red" size =3><B> # </B></font> at the beginning of a line will form a number list.
 +
#1st 
 +
#2nd 
 +
# etc ...
 +
 +
===Line Break===
 +
 +
<nowiki>If you put a break command <br> </nowiki> <BR>
 +
at the end of a line you can get a <BR>
 +
single spacing and format your code<BR>
 +
like you wish. 
 +
 +
===Indent===
 +
 +
adding <font color="Red" size =3><B> : </B></font> at the beginning of a line will indent.
 +
 +
no indent
 +
: one indent
 +
:: two
 +
::: three
 +
 +
this also precludes having to place <nowiki><br></nowiki> at the end of a line to break it.
 +
 +
===Font Size=== (using HTML)
 +
 +
<nowiki><font size = 1> Text </font></nowiki> = <font size = 1> Text</font>
 +
<nowiki><font size = 2> Text </font></nowiki> = <font size = 2> Text</font>
 +
<nowiki><font size = 3> Text </font></nowiki> = <font size = 3> Text</font>
 +
<nowiki><font size = 4> Text </font></nowiki> = <font size = 4> Text</font>
 +
<nowiki><font size = 5> Text </font></nowiki> = <font size = 5> Text</font>
 +
 +
Or, instead of using absolute sizes, you can adjust font sizes relative to the ones that the user has chosen.  So for instance, if a user with visual difficulties has already set his or her font sizes to be large, you make them larger and will not accidentally set them smaller than the user can read.
 +
<nowiki><font size = +1> Text </font></nowiki> = <font size = +1> Text</font>
 +
<nowiki><font size = +2> Text </font></nowiki> = <font size = +2> Text</font>
 +
<nowiki><font size = +3> Text </font></nowiki> = <font size = +3> Text</font>
 +
<nowiki><font size = +4> Text </font></nowiki> = <font size = +4> Text</font>
 +
<nowiki><font size = +5> Text </font></nowiki> = <font size = +5> Text</font>
 +
 +
You can also make a font smaller:
 +
<nowiki><font size = -2> Text </font></nowiki> = <font size = -2> Text</font>
 +
 +
 +
===Font Color=== (using HTML)
 +
 +
<nowiki><font color="Red"> Text </font></nowiki>  = <font color="Red"> Text</font>
 +
<nowiki><font color="Green"> Text </font></nowiki> = <font color="Green"> Text</font>
 +
<nowiki><font color="Purple"> Text </font></nowiki> = <font color="Purple"> Text</font>
 +
 +
<nowiki><font color=#FF8800> Text </font></nowiki> = <font color=#0000FF> Text</font>
 +
 +
even
 +
<font face=Comic Sans MS size=5>
 +
<font color=#FF0000><B>R</B></font>
 +
<font color=#FF8800><B>A</B></font>
 +
<font color=#FFFF00><B>I</B></font>
 +
<font color=#88FF00><B>N</B></font>
 +
<font color=#00FF00><B>B</B></font>
 +
<font color=#00FF88><B>O</B></font>
 +
<font color=#00FFFF><B>W</B></font>
 +
<font color=#0088FF><B>C</B></font>
 +
<font color=#0000FF><B>O</B></font>
 +
<font color=#8800FF><B>L</B></font>
 +
<font color=#FF00FF><B>O</B></font>
 +
<font color=#FF0088><B>R</B></font>
 +
<font color=#FF0000><B>S</B></font>
 +
</font>
 +
are possible
 +
 +
(Font colors may look different on different screens, but the basic colors such as red, green, blue, black and white are fairly consistent.)
 +
 +
 +
===Font color, face, size===
 +
 +
<nowiki><font color=#FF8890 face=Verdana size=5></nowiki>
 +
<font color=#00FF55 face=Verdana size=5>abcdefghijklmnopqrstuvwxyz</font>
 +
 +
<nowiki><font color=#0088CC face=Comic Sans MS size=6></nowiki>
 +
<font color=#0088CC face=Comic Sans MS size=6>abcdefghijklmnopqrstuvwxyz</font>
 +
 +
(If the viewer does not have the font you select on his or her computer, it may not look the way you expect.)
 +
 
 +
===Other HTML Commands===
 +
 +
<nowiki><B> Text </B></nowiki> = <B>Bold Text</B>
 +
<nowiki><I> Text </I></nowiki> = <I>Italic Text</I>
 +
<nowiki><U> Text </U></nowiki> = <U>Underlined Text</U>
 +
<nowiki><S> Text </S></nowiki> = <S>Strikeout Text</S>
 +
or any combination:
 +
<nowiki><U><B> Text </B></U></nowiki> = <U><B>Underline/Bold Text</B></U>
 +
 +
===Math Markup===
 +
Not sure this is ia feature here yet ... will have to experiment.

Revision as of 22:04, 15 October 2005

Help Editing Wiki Pages

  1. Click on Edit this page on top of web page or edit on the right (if available) for a section
  2. Type in text
  3. Click on Show Preview. Modify if required.
  4. Add summary if required. Click on Save page.


Practice editing in the Sandbox

Wiki Code

Most basic HTML commands will work, but wiki also has "easier" ways to specify some commands.
Triple single quotes, like '''Bold''' around text will make it bold, like Bold. and two single quotes will show Italics.)

Also ... there are newer CSS commands to replace outdated HTML. Stay tuned.

Some other Wiki things:


placing a 'space' at the beginning of a line
results in the text being displayed exactly as written
inside this blue box ... wysiwyg.
so this works good for displaying robot code snippets
and other DB code


Here's another way:
Use <pre> and </pre> to bracket your code.
This precludes one having to enter a space at the beginning of every line.
An example:

A handy method for eventually unfixing the stuck bot is:

'will normally unfix bot by restoring .fixpos to zero
'typically I place this in most bots to prevent possible attack and accidental fixing
cond
start
.fixpos *.fixed mult dec
stop

This will also disable any HTML code/tags within the 'box'
allowing one to list them as instructions without activating the tag.
example:

 <b><i><u> have no effect within the <nowiki><pre>
tags.</nowiki> </pre>

Placing Comments in the Edit Window

 
 using <!-- and --> one can place comments in the edit window which will not be visible on the page.
 like so: <!-- place any comments/code examples/reminders here -->

Table of contents (TOC)

For each article with more than three headings, a table of contents (TOC) is automatically generated from the section headings, unless:

  • (for a user) preferences are set to turn it off
  • (for an article) in the edit box the code __NOTOC__ is added

The TOC is put before the first section header unless it is placed manually with the code __TOC__. Thus there may be some introductory text before it, known as the "lead".

__NOTOC__ disables Table of Contents on those short pages which may not require it.
__TOC__ will manually place the TOC

Bullet list

adding * at the beginning of a line will form a bullet list.

  • 1st bullet
  • 2nd bullet
  • etc ...


Number list

adding # at the beginning of a line will form a number list.

  1. 1st
  2. 2nd
  3. etc ...

Line Break

If you put a break command <br>
at the end of a line you can get a
single spacing and format your code
like you wish.

Indent

adding  : at the beginning of a line will indent.

no indent

one indent
two
three

this also precludes having to place <br> at the end of a line to break it.

===Font Size=== (using HTML)

<font size = 1> Text </font> =  Text
<font size = 2> Text </font> =  Text
<font size = 3> Text </font> =  Text
<font size = 4> Text </font> =  Text
<font size = 5> Text </font> =  Text

Or, instead of using absolute sizes, you can adjust font sizes relative to the ones that the user has chosen. So for instance, if a user with visual difficulties has already set his or her font sizes to be large, you make them larger and will not accidentally set them smaller than the user can read.

<font size = +1> Text </font> =  Text
<font size = +2> Text </font> =  Text
<font size = +3> Text </font> =  Text
<font size = +4> Text </font> =  Text
<font size = +5> Text </font> =  Text

You can also make a font smaller:

<font size = -2> Text </font> =  Text


===Font Color=== (using HTML)

<font color="Red"> Text </font>   =  Text
<font color="Green"> Text </font> =  Text
<font color="Purple"> Text </font> =  Text
<font color=#FF8800> Text </font> =  Text

even R A I N B O W C O L O R S are possible

(Font colors may look different on different screens, but the basic colors such as red, green, blue, black and white are fairly consistent.)


Font color, face, size

<font color=#FF8890 face=Verdana size=5>
abcdefghijklmnopqrstuvwxyz

<font color=#0088CC face=Comic Sans MS size=6> 
abcdefghijklmnopqrstuvwxyz

(If the viewer does not have the font you select on his or her computer, it may not look the way you expect.)

Other HTML Commands

<B> Text </B> = Bold Text
<I> Text </I> = Italic Text
<U> Text </U> = Underlined Text
<S> Text </S> = Strikeout Text
or any combination:
<U><B> Text </B></U> = Underline/Bold Text 

Math Markup

Not sure this is ia feature here yet ... will have to experiment.