Difference between revisions of "Help:Contents"

From ADRIFT 5 Manual Wiki
Jump to: navigation, search
m
(Tables)
Line 189: Line 189:
 
To change the <FONT COLOR=#C00000>color</FONT> of the text you can use a font tag:
 
To change the <FONT COLOR=#C00000>color</FONT> of the text you can use a font tag:
 
<pre><FONT COLOR=#C00000>color</FONT></pre>Where the color is specified as 3 hexadecimal numbers for red-green-blue ie. #RRGGBB
 
<pre><FONT COLOR=#C00000>color</FONT></pre>Where the color is specified as 3 hexadecimal numbers for red-green-blue ie. #RRGGBB
 +
 +
== Tables ==
 +
The symbols <code>{|</code> (left curly bracket followed by a pipe symbol) starts a table.
 +
A class="tabletype" declaration controls how the table looks.
 +
A pipe followed by a minus <code>|-</code> starts each row of the table, and a pipe <code>|</code> by itself starts each cell.
 +
An exclamation mark ! also starts a new cell, but is used to highlight headings in boldface.
 +
The table ends with a pipe and right curly bracket <code>|}</code>.
 +
<pre>
 +
{| class="wikitable"
 +
|-
 +
! Heading 1
 +
! Heading 2
 +
! Heading 3
 +
|-
 +
| Row
 +
| One
 +
| (1)
 +
|-
 +
| and
 +
| Two
 +
| (2)
 +
|}
 +
</pre>
 +
Creates the table:
 +
{| class="wikitable"
 +
|-
 +
! Heading 1
 +
! Heading 2
 +
! Heading 3
 +
|-
 +
| Row
 +
| One
 +
| (1)
 +
|-
 +
| and
 +
| Two
 +
| (2)
 +
|}
 +
If no table class is specified then the table will not have any borders or shading and will look like this:
 +
{|
 +
|-
 +
! Heading 1
 +
! Heading 2
 +
! Heading 3
 +
|-
 +
| Row
 +
| One
 +
| (1)
 +
|-
 +
| and
 +
| Two
 +
| (2)
 +
|}

Revision as of 06:59, 20 December 2011

Adrift Wiki Organisation

The main page is organised into the following sections:

  1. Contents
    • This section is for general information about installation, setup and the user interface.
  2. The Main Items
    • This is reserved for the 10 Adrift "Items". You should not change this list.
  3. Other stuff
    • Articles about specific parts of the user interface such as specific dialog boxes, and about the Runner.
  4. Importing and Exporting
    • Modules and other file types that can be imported into or exported from an Adrift TAF file.
  5. Tutorials
    • Short tutorials should be added to the "How do I...?" tutorial.
    • Large complex tutorials with screen captures should be written to a new page and a page link added to this section.

Not all of the wiki pages are directly linked from the main page, but are linked from other pages.

Expressions are linked from the pages for the Restrictions and Actions that use them.
Alternate Descriptions are linked from the Text Boxes page.

All of the wiki pages that have been written are listed at Special:AllPages.

Pages which have not been written yet, but are wanted (have been linked to) are listed at Special:WantedPages.

Editing Pages

There are four main ways to edit a wiki page.

  1. Click on an existing red page link to create a new page.
  2. Create a new page link on an existing page (see Link button on toolbar described below) then click on it.
  3. Click on the Edit tab at the top of a page to edit the entire page or the section headings.
  4. Click on [edit] to the right of a section heading to edit only that section.

Toolbar

At the top of the editing text box is a toolbar that looks like this:

WikiToolbar.jpg

These buttons simply write a template of wiki formatting characters into the text so you dont have to remember what all of the formatting characters do.


WikiBold.jpg Inserts a boldface code (three apostrophes before and after) at cursor position.

'''Bold text'''

Replace "Bold text" with the text you want shown in boldface.

A semicolon ";" at the start of a line displays the entire line in boldface.


WikiItalic.jpg Inserts the italic code (two apostrophes before and after) at cursor position.

''Italic text''

Insert the text you want shown in Italics between the apostrophes.
5 apostrophes will both bold and italicize the text.


WikiLink.jpg Inserts a link to another page at the cursor position.

[[Link title]]

Replace "Link title" with the name of the page you want to link to. Use a pipe symbol to change the way the link is displayed [[Main_Page|Displayed Text]] creates this link to the main page: Displayed Text.
If the linked page does not exist yet then the link will be displayed red and can be clicked on to create the new page. If the link does exist then it will be displayed blue.


WikiURL.jpg Insert a link to an external web page at the cursor position.

[http://www.example.com link title]

Change the URL to the page you want to link to, and "link title" to the text you want displayed.


WikiHeading.jpg Inserts a new section heading at the cursor position.

 == Headline text == 

This separates the section being edited into two sections. Replace "Headline text" with the name of the new section.

  • By adding more equal signs (the same number to the beginning and of the heading) you can create lower level headings within the section.


WikiImage.jpg Inserts a .JPG or .PNG image at the cursor position.

 [[File:Example.jpg]] 
This allows you to insert a picture at that point.

Always check the existing images at Special:ListFiles for a suitable image before uploading your own. If the image has not been uploaded yet then the filename will be displayed red instead, and you can click on it to go to the file upload page. Use .PNG for diagrams that have a limited number of colors, .JPG for screen captures and photos.


WikiFile.jpg Inserts a file link at the cursor position.

 [[Media:Example.ogg]] 

This allows you to upload and link to a file, such as an Adrift TAF or module.


WikiNowiki.jpg Inserts nowiki tags at cursor position.

 <nowiki>Insert non-formatted text here</nowiki> 

This allows you to use symbols such as []{}=#;: and * that are normally interpreted as special wiki codes.


WikiSign.jpg Inserts your signature at the cursor position.

 --~~~~ 

This displays your user name and the date and time you saved the page. Only use this on a talk page


WikiLine.jpg Inserts 4 dashes at the cursor position.

 ---- 

This displays a horizontal line:


(Horizontal lines should be used sparingly)

Other wiki formating codes

There are three types of lists: ordered lists, unordered lists, and definition lists. In the following sections, various list types are used for different examples, but other list types will generally give corresponding results.

wikitext rendering
* Lists are easy to do:
** start every line
* with a star
** more stars mean
*** deeper levels
  • Lists are easy to do:
    • start every line
  • with a star
    • more stars mean
      • deeper levels
*A newline
*in a list  
marks the end of the list. Of course
*you can
*start again.
  • A newline
  • in a list

marks the end of the list. Of course

  • you can
  • start again.
# Numbered lists are good
## very organized
## easy to follow
  1. Numbered lists are good
    1. very organized
    2. easy to follow
Definition lists:
; Term : Definition
or
; Term
: Definition
Can be used for more than terms and definitions.

Definition lists:

Term 
Definition

or

Term
Definition

Can be used for more than terms and definitions.

* Or create mixed lists
*# and nest them
*#* like this.
*#*; Fruits
*#*: Apple
*#*: Blueberry
  • Or create mixed lists
    1. and nest them
      • like this.
        Fruits
        Apple
        Blueberry
# A line-break in an item is done with HTML<br />like this.
# Just breaking the line will accidentally end the list
like this.
# This was supposed to be item 3, not a new list.
  1. A line-break in an item is done with HTML
    like this.
  2. Just breaking the line will accidentally end the list

like this.

  1. This was supposed to be item 3, not a new list.
* A new paragraph in an item is also HTML.<p>Like so.</p>
* Same goes for<blockquote>"block quotations"</blockquote>like that.
* Note that these are done without line-breaking the wikicode.
  • A new paragraph in an item is also HTML.

    Like so.

  • Same for
    "block quotations"
    like that.
  • Note that these are done without line-breaking the wikicode.

HTML codes

To change the color of the text you can use a font tag:

<FONT COLOR=#C00000>color</FONT>
Where the color is specified as 3 hexadecimal numbers for red-green-blue ie. #RRGGBB

Tables

The symbols {| (left curly bracket followed by a pipe symbol) starts a table. A class="tabletype" declaration controls how the table looks. A pipe followed by a minus |- starts each row of the table, and a pipe | by itself starts each cell. An exclamation mark ! also starts a new cell, but is used to highlight headings in boldface. The table ends with a pipe and right curly bracket |}.

{| class="wikitable"
|-
! Heading 1
! Heading 2
! Heading 3
|-
| Row
| One
| (1)
|-
| and
| Two
| (2)
|}

Creates the table:

Heading 1 Heading 2 Heading 3
Row One (1)
and Two (2)

If no table class is specified then the table will not have any borders or shading and will look like this:

Heading 1 Heading 2 Heading 3
Row One (1)
and Two (2)