Help:Contents

==General Help==
'''N.B.''' When logged in, set your Wiki preferences in "my preferences" (link at top R/H of Wiki pages).

===Editing the Wiki===
'''''Also see the'' Cruising Wiki's [[Wiki Editors Guide]], [[Style Guide]], and [[Hydrographics]]'''

Important information: Read the [[Cruiserswiki:Copyrights|Copyright Details]]
* In order to contribute to this World Cruising Wiki please REGISTER (it's free, quick and easy) or LOGIN (top R/H corner of this page). This is essential in an attempt to reduce spam.
* Once you are logged in, '''update "My Preferences"''' (menu at top R/H of page).
* When editing, ALWAYS click on "'''Show Preview'''" BEFORE saving the page. This allows you to re-edit/add without unnecessary page-loading. '''Save''' the page when finished.

'''To Edit''':
* Register/Login
* Click the "EDIT" tab at the top of the page to be able to edit the '''whole page'''
* Click the "EDIT" link (R/H, top) of each section to edit '''only that section'''.

[[image:Editpic.jpg|thumb|center|700px|''Click for larger view'']]

* '''The Editor''' opens to allow you to edit/add, etc. 
* After editing, click the "Preview" link to preview your edits - this step affords you the opportunity to do any corrections before finally saving your edit. '''N.B. Do not forget to "SAVE" your edit'''.
* {{Note}} Do not leave a SPACE at the beginning of paragraphs or lines as this will cancel the Wiki text formatting - it will change the text font and make the lines/paragraphs run off the page width'''.

 This is an example of what happens when leaving a space at the beginning of the line or paragraph ...
* {{Red|'''Editing Tip 1'''}}:Prepare your edit/addition in '''MS Notepad''' (using the Wiki formatting below) - then copy/paste this to the Wiki's editor.
* {{Red|'''Editing Tip 2'''}}: Open a well laid out Wiki page/section and click on "Edit" to see how others have formatted the page. "Return" without further edits.
* {{Red|'''Editing Tip 3'''}}: Do not create new pages unless you have gained some editing experience. When you have use the appropriate [[Pagetemplates#Major_Page_Templates|Page Templates]] and consult the sample pages indicated there under '''Notes'''.

* Practice your editing skills in the [[Sandbox|SANDBOX]]

{{TOCleft}}

==Personal Signature to Contributions==
Don't forget to set "My Preferences" - link at top R/H side of page.
* To add your signature and timestamp to your contributions simply type 4 tildes <code>(<nowiki>~~~~</nowiki>)</code><br>This will automatically convert to your username and date, e.g. ([[User:Lighthouse|Lighthouse]] 02:31, 3 November 2007 (MDT))
* To add your signature (username only) to your contributions simply type 3 tildes <code>(<nowiki>~~~</nowiki>)</code><br>This will automatically convert to your username only, e.g. ([[User:Lighthouse|Lighthouse]])
* To add the timestamp only to your contributions simply type 5 tildes <code>(<nowiki>~~~~~</nowiki>)</code><br>This will automatically convert to the timestamp (only) of your contribution, e.g. (02:31, 3 November 2007 (MDT))
* You can also add a country flag icon to your signature - get the flag icon codes from [[List_of_Countries_A_to_Z|'''Flag Icons''']] - (''hover your curser over a flag to see/grab the image filename'')<br/>Example: <code><nowiki>(~~~ [[image:South_Africa_Icon.png]])</nowiki></code> - will convert to: ([[User:Lighthouse|Lighthouse]] [[image:South Africa Icon.png]]) - (''save this code in a handy place to use often'')

==Wiki Page "Discussion" Tab==
* Use the page's "Discussion" tab (top of page) to make any notes or requests about a particular page. A Wiki "Sysop" (Admin) is notified by the system and will attend to matters as soon as possible.
* If you are uncomfortable about adding new sub-pages (like additional ports, marinas, etc.) then use the pages "discussion" tab to request these additions too. Otherwise, just add the names to the lists within the articles (in the format <code><nowiki>* [[Name]]</nowiki></code> ) and a wiki admin will set up the "new" pages. [[User:Lighthouse|Lighthouse]]

<div style="clear: both;"></div>
==Text Formatting==
'''Note''': When editing, (e.g. ''Italic'') it is two apostrophes before and after and NOT quotations. ('''Bold''' would be three apostrophes) 

{| class="nicetable"
|- class="niceheader"
|'''Description'''
|'''You type'''	
|'''You get'''
|-
| colspan="3" align="center" | '''''Applies anywhere'''''
|-
|Italic text
|<tt><nowiki>''italic'' (2 apostrophes - not quotation)</nowiki></tt>
|''italic''
|-
| Bold text
|<tt><nowiki>'''bold''' (3 apostrophes)</nowiki></tt>
|'''bold'''
|-
| Bold and italic
|<tt><nowiki>'''''bold & italic'''''(3 + 2 apostrophes)</nowiki></tt>
|'''''bold & italic'''''
|-
|Escape wiki markup
|<tt><nowiki><nowiki>no "markup"</nowiki></nowiki></tt>
|<nowiki>no ''markup''</nowiki>
|-
|Fixed width text
|
<nowiki><tt>Fixed width text</tt></nowiki>
|
<tt>Fixed width text</tt>
|-
|Colored text
|
<nowiki><font color=red>Red Text:</font></nowiki>
|
<font color=red>Red Text</font>
|-
|Line space (to keep within a section)<br/>''Normally use "Enter" key.
|
<nowiki>...end of line.<br/>New line...</nowiki>
|
...end of line.<br/>New line...
|-
|Double line space (to keep within a section)<br/>''Normally use "Enter" key twice.
|
<nowiki>...end of line.<br/><br/>New paragraph...</nowiki>
|
...end of line.<br/><br/>New paragraph...
|-
| colspan="3" align="center" | '''''Only at the beginning of the line'''''
|-
| Indent text
|
<tt><nowiki>:Single indent</nowiki></tt><br />
<tt><nowiki>::Double indent</nowiki></tt><br />
<tt><nowiki>:::::Multiple indent</nowiki></tt>
|
:Single indent
::Double indent
:::::Multiple indent
|-
|Headings of different levels<br />An article with four or more headings will automatically create a Table of Contents
|
<tt><nowiki>=level 1=</nowiki></tt> Use of a level 1 heading is '''''highly discouraged''''' as it appears with the same formatting and size as the page title, which can be confusing.<br />
<tt><nowiki>==level 2==</nowiki></tt><br />
<tt><nowiki>===level 3===</nowiki></tt><br />
<tt><nowiki>====level 4====</nowiki></tt><br />
<tt><nowiki>=====level 5=====</nowiki></tt><br />
<tt><nowiki>======level 6======</nowiki></tt>
|
<!-- little hack to prevent TOC viewing -->
<span style="font-size: 188%; margin: 0; padding-top: .5em; padding-bottom: .17em; border-bottom: 1px solid #aaa;">Level 1</span><br/><br/>
<span style="font-size: 150%; margin: 0; padding-top: .5em; padding-bottom: .17em; border-bottom: 1px solid #aaa;">Level 2</span><br/><br/>
<span style="font-size: 132%; border-bottom: none; font-weight: bold;">Level 3</span><br/>
<span style="font-size: 100%; border-bottom: none; font-weight: bold;">Level 4</span><br/>
{{DEFAULTSORT:[[[http://www.example.com link title]]#Redirect [[—[[Category:]]]]]}}<span style="font-size: 86%; border-bottom: none; font-weight: bold;">Level 5</span><br/>
<span style="font-size: 80%; border-bottom: none; font-weight: bold;">Level 6</span><br/>
|-
|Horizontal rule
|
<tt><nowiki>---- </nowiki>(Use VERY sparingly)</tt>
|
----
|-
|Bullet list
|
&#42; one<br />
&#42; two<br />
&#42; three<br />
&#42;&#42; three and one-third<br />
&#42;&#42; three and two-thirds<br />
|
* one
* two
* three
** three and one-third
** three and two-thirds
|-
|Numbered list
|
&#35; one<br />
&#35; two<nowiki><br /></nowiki>spanning several lines<nowiki><br /></nowiki>without breaking the numbering<br />
&#35; three<br />
&#35;&#35; three point one<br />
&#35;&#35; three point two<br />
|
# one
# two<br>spanning several lines<br>without breaking the numbering
# three
## three point one
## three point two
|-
| Mixture of bulleted<br /> and numbered lists
|
&#35; one<br />
&#35; two<br />
&#35;&#42; two point one<br />
&#35;&#42; two point two<br />
|
# one
# two
#* two point one
#* two point two
|-
|Definition list
|
&#59;Definition<br />
&#58;item 1<br />
&#58;item 2<br />
|
;Definition
:item 1
:item 2
|-
|Preformatted text
|
&nbsp;&nbsp;preformatted text is done with<br />
&nbsp;&nbsp;a space at the<br />
&nbsp;&nbsp;beginning of the line<br />
|
 preformatted text is done with
 a space at the 
 beginning of the line
|-
|Preformatted text with no indentation
|
&nbsp;<nowiki><pre> some preformatted text with no indentation </pre></nowiki>
|
<pre>
some preformatted
text with no indentation
</pre>
|-
|}

==How to link in Wiki format==
{| class="nicetable"
|- class="niceheader"
|'''Description'''
|'''You type'''	
|'''You get'''
|-
|Internal link
|<tt><nowiki>[[Africa]]</nowiki></tt>
|[[Africa]]
|-
|Category link
|<tt><nowiki>[[:Category:The Yacht]]</nowiki></tt>
|[[:Category:The Yacht]]
|-
|Piped link 
|<tt><nowiki>[[Africa|different text]]</nowiki> (''links to the "Africa" page'')</tt>
|[[Africa|different text]]
|-
|Anchor link 
|<tt><nowiki>[[#External links|Anchor link]]</nowiki></tt>
|[[#External links|Anchor link]]
|-
|External link
|<tt><nowiki>http://www.cruiserswiki.org</nowiki></tt>
|http://www.cruiserswiki.org
|-
|External link from internal image
|<tt><nowiki>[http://targetURL {{Server}}/wiki/images/imagelocation]</nowiki></tt>
|Internal image
|-
|External link,<br />
different title
|<tt><nowiki>[http://www.cruiserswiki.org Cruisers Wiki Home]</nowiki></tt><br/>('''''note "space" between URL and description''''')
|[http://www.cruiserswiki.org Cruisers Wiki Home]
|-
|External link,<br />
unnamed
|<tt><nowiki>[http://www.cruiserswiki.org]</nowiki></tt>
|[http://www.cruiserswiki.org]
|-
|mailto
|<tt><nowiki>mailto:info@example.org</nowiki></tt>
|mailto:info@example.org
|-
|mailto unnamed
|<tt><nowiki>[mailto:info@example.org]</nowiki></tt>
|[mailto:info@example.org]
|-
|mailto named
|<tt><nowiki>[mailto:info@example.org Email]</nowiki></tt>
|[mailto:info@example.org Email]
|-
|redirect
|<tt><nowiki>#REDIRECT [[Africa]]</nowiki></tt>
| &rarr; [[Africa]]
|}

==Table Formatting==
See the [[Pagetemplates|TEMPLATES]] page to copy examples of already formatted tables - easy.

==== Wiki table markup summary (for advanced users)====
{|cellpadding="5" cellspacing="0" border="1" width="60%"
|
 <nowiki>{|</nowiki>
| '''table start'''
|-
|
 <nowiki>|+</nowiki>
| table '''caption,''' ''optional;'' only between '''table start''' and first '''table row'''
|-
|
 <nowiki>|-</nowiki>
| '''table row,''' ''optional on first row'' -- wiki engine assumes the first row
|-
|
 <nowiki>!</nowiki> 
| '''table header''' cell, ''optional.'' Consecutive '''table header''' cells may be added on same line separated by double marks (<code>!!</code>) or start on new lines, each with its own single mark (<code>!</code>).
|- 
|
 <nowiki>|</nowiki>
| '''table data''' cell, ''required!'' Consecutive '''table data''' cells may be added on same line separated by double marks (<code><nowiki>||</nowiki></code>) or start on new lines, each with its own single mark (<code><nowiki>|</nowiki></code>).
|-
|
 <nowiki>|}</nowiki>
| '''table end''' 
|}
*The above marks must '''start on a new line''' except the double <code>||</code> and <code>!!</code> for optionally adding consecutive cells to a line. However, blank spaces at the beginning of a line are ignored.
*'''XHTML attributes.''' Each mark, except table end, optionally accepts one or more XHTML attributes. Attributes must be on the same line as the mark. Separate attributes from each other with a single space. 
**Cells and caption (<code>|</code> or <code>||</code>, <code>!</code> or <code>!!</code>, and <code>|+</code>) hold content. So separate any attributes from content with a single pipe (<code>|</code>). Cell content may follow on same line or on following lines.
**Table and row marks (<code>{|</code> and <code>|-</code>) do not directly hold content. Do ''not'' add pipe (<code>|</code>) after their optional attributes. If you erroneously add a pipe after attributes for the table mark or row mark the parser will delete it ''and'' your final attribute if it was touching the erroneous pipe!
*'''Content''' may (a) follow its cell mark on the same line after any optional XHTML attributes or (b) on lines below the cell mark. Content that uses wiki markup that itself needs to start on a new line, such as lists, headings, or nested tables, must be on its own new line.
*'''Escaping''' to insert a pipe (<code>|</code>) character into a table use the &lt;nowiki&gt; markup

==Posting Images==
'''To post images''':<br>
* <font color=red>'''N.B. RESIZE THE IMAGE FIRST''' - resize to maximum 700px X 700px. (BEFORE uploading)</font> ([http://www.stormdance.net/software/photorazor/software%20overview.htm Recommended free software for resizing images])
* Name the file ('''NEW NAME - DO NOT DUPLICATE existing file names'''): '''Try to keep your "Destination filename" short & descriptive (i.e. "Caribbean12.jpg)'''. 
* Then, [[Special:Upload|upload the file]] to the Cruising WIKI ('''[[Special:Upload|Upload File]]''' link is under "Toolbox" in L/H menu).
* FILL IN THE COPYRIGHT DETAILS IN THE "SUMMARY" WHEN UPLOADING FILES AND NOTE THE USER "DECLARATION".

Or, you can embed images into your article and then upload the image/s to the Cruising Wiki. The easiest and most convenient way of doing this is to do it ''after'' you finish editing the text of your article.
#While you are editing the text, just insert the wiki markup that embeds the image. For example: <nowiki>[[Image:Examplefilename.jpg|Port Justin]]</nowiki>.
#Save or preview your work.
#Now look at the image link in the previewed or saved page. You will see that it is '''RED''' in colour.
#You can now click on the link (in a new browser tab or window) which will bring you to the upload page.
#You will notice that the '''Destination filename:''' field is already filled in. All you have to do is browse to your image on your PC.
#If you go back to your original page and do a browser refresh or a new preview, you will see the image linked.

====Uploaded files====
To use an image or other file which has been uploaded to the Wiki, use:
*<code><nowiki>[[Image:Examplefilename.jpg]]</nowiki></code> (''change "Examplefilename" to the name of the image you have uploaded'') 
If you add a pipe (|) and some text after the filename, the text will be used as alternative text for text-only browsers:
*<code><nowiki>[[Image:Examplefilename.jpg|alternative text]]</nowiki></code>

If you don't want to display the image, you can link to the file's description page, by adding a colon:
*<code><nowiki>[[:Image:Examplefilename.jpg]]</nowiki></code>
You can also make piped links if you want some other text to be used:
*<code><nowiki>[[:Image:Example.jpg|link text]]</nowiki></code>

====Advanced options====
The full syntax for displaying an image is:
 <code><nowiki>[[Image:{name}|{options}]]</nowiki></code>
Where options can be zero or more of the following, separated by pipes:
*<code>thumb</code>, <code>thumbnail</code>, or <code>frame</code>: Controls how the image is formatted
*<code>left</code>, <code>right</code>, <code>center</code>, <code>none</code>: Controls the alignment of the image on the page
*<code>{width}px</code>: Resizes the image to the given width in pixels
*<code>{caption text}</code>
The options can be given in any order. If a given option does not match any of the other possibilities, it is assumed to be the caption text. Caption text can contain wiki links or other formatting.

====A common example will be:====

<code>'''<nowiki>[[Image:filenameofyourimage.jpg|right|thumb|350px|'''Caption''']]</nowiki>'''</code> - (''copy this template if you wish - change to the correct image filename and .jpg, .gif or .png extension that you upload'')

This will insert the image to the RIGHT of the page as a THUMBNAIL, 350 pixels wide with your CAPTION underneath.

See the [[Pagetemplates|Templates]] page for more ready-made options (image galleries, etc).

==Co-ordinates Formatting==
The GPS format of '''Degrees and decimal minutes''' (DD & M.M) is used in this Wiki as this is the format most often used by sailors. Please use this format to maintain consistancy throughout the Wiki.

Enter co-ordinates in a page using the "template-call" as shown below:

<code>'''<nowiki>[[image:World_icon.png]] {{Coord|DD|M.M|N/S|DD|M.M|E/W|}}</nowiki>'''</code>

Copy the above template (in bold) and paste it into the Wiki page editor, fill in the details and SAVE the edit (don't forget to select either '''N''' or '''S''', or '''E''' or '''W'''). This template will automatically give a link to a GeoHack page with various online geo resources related to the position - resources like Google Earth, MapTech (marine chart), GoogleMaps and access to photos of the position's area on Flickr, Panoramio, etc.

Example: '''<nowiki>[[image:World_icon.png]] {{Coord|37|43.6|N|26|50.6|W|}}</nowiki>''' will show as: [[image:World_icon.png]] {{Coord|37|43.6|N|26|50.6|W|}} after saving the edit (with link to the geo resources page).


'''Co-ordinates Conversion Help''' - (D & M & S) - Divide the '''seconds''' by 60 to get the '''decimal''' value of '''minutes''' for the GPS format of |DD|M.M| 


'''Free Tools'''
* [http://www.gpsvisualizer.com/calculators#coordinates Free co-ordinates converter] 
* [http://www.backups.nl/geocoding/ Useful, free Geocoding tool]

==GoogleMaps==
'''GOOGLE MAPS''' - You can generate Google Maps from within the editor (link at right end in the menu on top of the editor). See [http://www.mediawiki.org/wiki/Extension:Google_Maps/Editor%27s_Map#Getting_started INSERTING MAPS] for more help in using this feature.

'''Note''': If screenshots are used, these MUST be saved in .png format to preserve the Google Logo layer (to show the copyright details). Upload as .png to the Wiki with the logo intact.

==Linking Documents==
Use <code>'''<nowiki><download> </download></nowiki>'''</code> tags to add a file to a page (upload file to the Wiki first).

<download>
File:Sample_docx.docx|Sample DOCX file
File:Sample_doc.doc|Sample DOC file
File:Sample_xls.xls|Sample XLS file
File:Sample_xlsx.xlsx|Sample XLSX file
File:Sample_pptx.pptx|Sample PPTX file
File:Sample_ppt.ppt|Sample PPT file
File:Sample_vsd.vsd|Sample VSD file
File:Cruising Guide Singapore to Darwin.pdf|Sample PDF file
</download>

'''Code format''' (''for above'')

<code><nowiki><download></nowiki><br/>
<nowiki>File:Sample_docx.docx|Sample DOCX file</nowiki><br/>
<nowiki>File:Sample_doc.doc|Sample DOC file</nowiki><br/>
<nowiki>File:Sample_xls.xls|Sample XLS file</nowiki><br/>
<nowiki>File:Sample_xlsx.xlsx|Sample XLSX file</nowiki><br/>
<nowiki>File:Sample_pptx.pptx|Sample PPTX file</nowiki><br/>
<nowiki>File:Sample_ppt.ppt|Sample PPT file</nowiki><br/>
<nowiki>File:Sample_vsd.vsd|Sample VSD file</nowiki><br/>
<nowiki>File:Cruising Guide Singapore to Darwin.pdf|Sample PDF file</nowiki><br/>
<nowiki></download></nowiki></code>

'''Example (for a pdf)''' (upload file to the Wiki first)

<download>File:Cruising Guide Singapore to Darwin.pdf|Cruising Guide - Singapore to Darwin (.pdf)</download>

'''Code format''' (''for example above'')

<code><nowiki><download>File:Cruising Guide Singapore to Darwin.pdf|Cruising Guide - Singapore to Darwin (.pdf)</download></nowiki></code>

==Wiki Table of Contents (TOC)==

For each page with more than three headings, a table of contents (TOC) is automatically generated at top of page from the section headings, unless:
* (for a user) preferences are set to turn it off
* (for an article) the magic word <nowiki>__NOTOC__</nowiki> (with two underscores on either side of the word) is added to the article

'''Positioning the TOC'''

<nowiki>When either __FORCETOC__ or __TOC__</nowiki> (with '''two underscores on either side''' <nowiki>of the word) is placed in the wikitext, a TOC is added even if the page has fewer than four headings.</nowiki>

<nowiki>With __FORCETOC__, the TOC is placed before the first section heading. With __TOC__, it is placed at the same position where this code is placed. There may be some introductory text before the TOC, known as the "lead". Although usually a heading after the TOC is preferable, __TOC__ can be used to avoid being forced to insert a meaningless heading just to position the TOC correctly, i.e., not too low.</nowiki>

'''Align TOC to left'''

{| cellspacing=0 cellpadding=0 style="margin-bottom: 0.5em; float: left; margin-right: 0.5em; padding: 0.5em 1.4em 0.8em 0; background-color: transparent; width: 300px"
|
__TOC__
|}

<noinclude><nowiki>Use:</nowiki> <Code>'''<nowiki>{{TOCleft}}</nowiki>'''</code> - placed within the article's body, to have the Table of Contents anchored to the left and restricted to a width of 300px



</noinclude>

==Icons==
Uploaded icons for use within the Wiki.
* [[image:Poe.jpg‎]] = Port of entry <br/> use: '''<nowiki>[[image:Poe.jpg]]</nowiki>'''
* [[image:TopWiki.png]] = Featured article.<br/> use: '''<nowiki>[[image:TopWiki.png]]</nowiki>'''
* [[image:Question_icon.png]] = Article/page link needs data.<br/> use: '''<nowiki>[[image:Question_icon.png]]</nowiki>'''
* [[image:Anchor_Icon.png]] = Anchorage<br /> use: '''<nowiki> [[image:Anchor_Icon.png]]</nowiki>
* [[image:Icon_anchor.png]] = Anchorage<br /> use: '''<nowiki>[[image:Icon_anchor.png]]</nowiki>
* [[image:Icon_marina.png]] = Marina<br/> use: '''<nowiki>[[image:Icon_marina.png]]</nowiki>
* [[image:Marina_icon.png]] = Marina<br/> use: '''<nowiki>[[image:Marina_icon.png]]</nowiki>
* [[Image:NoEntry_Icon.png‎]] = Entry prohibited<br /> use: '''<nowiki>[[Image:NoEntry_Icon.png‎]]</nowiki>
* [[List_of_Countries_A_to_Z|'''Country Flag Icons''']]
* [[General Icons|'''MORE ICONS''']]

==Symbols==
Easy access to common symbols - copy/paste from here:
* Co-ordinate "Degree" symbol - °
* Copyright symbol - ©
* Others - | | - 
*

== Various Editing Code Snippets ==
* Hold vertical space = <code><nowiki><div style="clear: both;"></div></nowiki></code>
* Hold vertical space - <code><nowiki><gallery style="clear: both;"></gallery></nowiki></code>

==More Help==
* [[Style Guide|CRUISER'S WIKI STYLE GUIDE]]
* [http://meta.wikimedia.org/wiki/Help:Contents HELP TOPICS] on how to contribute to Wiki's.
* [http://www.ipbwiki.com/Help:Editing_BBCode HELP WITH BBCode] To use BBCode in this Wiki.
* [http://www.mediawiki.org/wiki/Help:Formatting FORMATTING TEXT] Help with text formatting in the Wiki.
* [http://www.ipbwiki.com/Media_Wiki:Editing#Images MORE IMAGE POSTING HELP]
* [[Help:Page templates|Page templates]]
* [[Help:Embeddable_templates|Embeddable_templates]]


{|id="mp-right" width="100%" cellpadding="2" cellspacing="1" style="vertical-align:top; background:#f5faff; border:1px solid #a3b0bf;"
! <h2 id="mp-itn-h2" style="margin:0; background:#cedff2; font-size:120%; font-weight:bold; border:1px solid #a3b0bf; text-align:left; color:#000; padding:0.2em 0.4em;">Cruising Wiki Navigation</h2>
|-
|style="color:#000;"| | [[World Cruising and Sailing Wiki|HOMEPAGE]] | [[World Cruising Guides|Wiki Contents]] | [[Help:Contents]] |
|}

[[Category:Templates|Help:Contents]]