Editing Guidelines

From OSF Wiki
Jump to: navigation, search

NOTE: This page is partially drawn from the Meta-Wiki


When creating a new page, in general, bold the first reference for the page subject in the article, which should also be used in the first sentence. This is basic Wikipedia style.

Basic Text Formatting

You can format the page using Wikitext special characters.

What it looks like What you type

You can italicize text by putting 2 apostrophes on each side.

3 apostrophes will bold the text.

5 apostrophes will bold and italicize the text.

(Using 4 apostrophes doesn't do anything special --
they are just ' left over ones' that are included as part of the text.)

You can ''italicize text'' by putting 2 
apostrophes on each side. 

3 apostrophes will '''bold the text'''. 

5 apostrophes will '''bold''' and ''italicize''
'''''the text'''''.

(Using 4 apostrophes doesn't do anything
special -- <br> they are just ''''left
over ones'''' that are included as part
of the text.)

A single newline generally has no effect on the layout. These can be used to separate sentences within a paragraph. Some editors find that this aids editing and improves the diff function (used internally to compare different versions of a page).

But an empty line starts a new paragraph.

When used in a list, a newline does affect the layout (see below).

A single newline
generally has no effect on the layout.
These can be used to separate
sentences within a paragraph.
Some editors find that this aids editing
and improves the ''diff'' function
(used internally to compare
different versions of a page).

But an empty line
starts a new paragraph.

When used in a list, a newline ''does'' 
affect the layout ([[#lists|see below]]).

You can break lines
without a new paragraph.
Please use this sparingly.

Please do not start a link or italics or bold on one line and close it on the next.

You can break lines<br>
without a new paragraph.<br>
Please use this sparingly.

Please do not start a link or 
''italics'' or '''bold''' on one line 
and close it on the next.

You should "sign" your comments on talk pages:
- Three tildes gives your signature: Example
- Four tildes give your signature plus date/time: Example 07:46, 27 November 2005 (UTC)
- Five tildes gives the date/time alone: 07:46, 27 November 2005 (UTC)

You should "sign" your comments 
on talk pages: <br>
- Three tildes gives your
signature: ~~~ <br>
- Four tildes give your 
signature plus date/time: ~~~~ <br>
- Five tildes gives the 
date/time alone: ~~~~~ <br>

HTML Tags

You can use some HTML tags too. For a list of HTML tags that are allowed, see HTML in wikitext. However, you should try to master wikitext and avoid HTML if possible.

What it looks like What you type

Put text in a typewriter font. The same font is generally used for computer code.

Put text in a <tt>typewriter
font</tt>. The same font is 
generally used for <code>
computer code</code>.

Strike out or underline text, or write it in small caps.

<strike>Strike out</strike>
or <u>underline</u> text,
or write it <span style=
"font-variant:small-caps">
in small caps</span>.

Superscripts and subscripts: X2, H2O

Superscripts and subscripts:
X<sup>2</sup>, H<sub>2</sub>O
Centered text
  • Please note the American spelling of "center".
<center>Centered text</center>

The blockquote command will indent both margins when needed instead of the left margin only as the colon does.

<blockquote>
The '''blockquote''' command will indent 
both margins when needed instead of the 
left margin only as the colon does.  
</blockquote>

Invisible comments to editors (<!-- -->) appear only while editing the page.

  • If you wish to make comments to the public, you should usually use the talk page.
Invisible comments to editors (&lt;!-- --&gt;)
appear only while editing the page.
<!-- Note to editors: blah blah blah. -->

Organizing Your Writing

What it looks like What you type
Section headings

Headings organize your writing into sections. The Wiki software can automatically generate a table of contents from them.

Subsection

Using more "equals" (=) signs creates a subsection.

A smaller subsection

Don't skip levels, like from two to four equals signs.

Start with 2 equals signs not 1 because 1 creates H1 tags which should be reserved for page title.

== Section headings ==

''Headings'' organize your writing into 
sections. The Wiki software can automatically 
generate a [[table of contents]] from them.

=== Subsection ===

Using more "equals" (=) signs creates a subsection.

==== A smaller subsection ====

Don't skip levels, 
like from two to four equals signs.

Start with 2 equals signs not 1 
because 1 creates H1 tags
which should be reserved for page title.
  • Unordered lists are easy to do:
    • Start every line with a star.
      • More stars indicate a deeper level.
    Previous item continues.
    • A newline
  • in a list

marks the end of the list.

  • Of course you can start again.
* ''Unordered lists'' are easy to do:
** Start every line with a star.
*** More stars indicate a deeper level.
*: Previous item continues.
** A newline
* in a list  
marks the end of the list.
* Of course you can start again.
  1. Numbered lists are:
    1. Very organized
    2. Easy to follow

A newline marks the end of the list.

  1. New numbering starts with 1.
# ''Numbered lists'' are:
## Very organized
## Easy to follow
A newline marks the end of the list.
# New numbering starts with 1.

Here's a definition list:

Word 
Definition of the word
A longer phrase needing definition
Phrase defined
A word 
Which has a definition
Also a second one
And even a third

Begin with a semicolon. One item per line; a newline can appear before the colon, but using a space before the colon improves parsing.

Here's a ''definition list'':
; Word : Definition of the word
; A longer phrase needing definition
: Phrase defined
; A word : Which has a definition
: Also a second one
: And even a third

Begin with a semicolon. One item per line; 
a newline can appear before the colon, but 
using a space before the colon improves 
parsing.
  • You can even do mixed lists
    1. and nest them
    2. inside each other
      • or break lines
        in lists.
      definition lists
      can be
      nested 
      too
* You can even do mixed lists
*# and nest them
*# inside each other
*#* or break lines<br>in lists.
*#; definition lists
*#: can be 
*#:; nested : too
A colon (:) indents a line or paragraph.

A newline starts a new paragraph.
Often used for discussion on talk pages.

We use 1 colon to indent once.
We use 2 colons to indent twice.
3 colons to indent 3 times, and so on.
: A colon (:) indents a line or paragraph.
A newline starts a new paragraph. <br>
Often used for discussion on talk pages.
: We use 1 colon to indent once.
:: We use 2 colons to indent twice.
::: 3 colons to indent 3 times, and so on.

You can make horizontal dividing lines (----) to separate text.


But you should usually use sections instead, so that they go in the table of contents.

You can make horizontal dividing lines (----)
to separate text.
----
But you should usually use sections instead,
so that they go in the table of contents.

You can add footnotes to sentences using the ref tag -- this is especially good for citing a source.

There are over six billion people in the world.[1]
References:
  1. CIA World Factbook, 2006.

For details, see Wikipedia:Footnotes and Help:Footnotes.

You can add footnotes to sentences using
the ''ref'' tag -- this is especially good
for citing a source.

:There are over six billion people in the
world.<ref>CIA World Factbook, 2006.</ref>

References: <references/>

For details, see [[Wikipedia:Footnotes]]
and [[Help:Footnotes]].

See also Wikipedia:Picture tutorial#Forcing a break (not just for pictures).

Links

You will often want to make clickable links to other pages.

What it looks like What you type

Here's a link to a page named Official position. You can even say official position and the link will show up correctly.

Here's a link to a page named [[Official position]].
You can even say [[official position]]s
and the link will show up correctly.

You can put formatting around a link. Example: Wikipedia.

You can put formatting around a link.
Example: ''[[Wikipedia]]''.

The first letter of articles is automatically capitalized, so wikipedia goes to the same place as Wikipedia. Capitalization matters after the first letter.

The ''first letter'' of articles is automatically
capitalized, so [[wikipedia]] goes to the same place
as [[Wikipedia]]. Capitalization matters after the
first letter.

The weather in London is a page that doesn't exist yet. You could create it by clicking on the link.

[[The weather in London]] is a page that doesn't exist
yet. You could create it by clicking on the link.

You can link to a page section by its title:

If multiple sections have the same title, add a number. #Example section 3 goes to the third section named "Example section".

You can link to a page section by its title:

*[[List of cities by country#Morocco]].

If multiple sections have the same title, add
a number. [[#Example section 3]] goes to the
third section named "Example section".

You can make a link point to a different place with a piped link. Put the link target first, then the pipe character "|", then the link text.

Or you can use the "pipe trick" so that text in parentheses or text after a comma does not appear.


*[[Help:Link|About Links]]
*[[List of cities by country#Morocco|
Cities in Morocco]]

*[[Spinning (textiles)|]]
*[[Boston, Massachusetts|]]

You can make an external link just by typing a URL: http://www.nupedia.com

You can give it a title: Nupedia

Or leave the title blank: [1]

You can make an external link just by typing a URL:
http://www.nupedia.com

You can give it a title:
[http://www.nupedia.com Nupedia]

Or leave the title blank:
[http://www.nupedia.com]

Linking to an e-mail address works the same way: mailto:someone@example.com or someone

Linking to an e-mail address works the same way:
mailto:someone@example.com or 
[mailto:someone@example.com someone]

You can redirect the user to another page.

#REDIRECT [[Official position]]

Category links do not show up in line but instead at page bottom and cause the page to be listed in the category.


Add an extra colon to link to a category in line without causing the page to be listed in the category: Category:English documentation

[[Help:Category|Category links]] do not show up in line
but instead at page bottom ''and cause the page to be
listed in the category.''


Add an extra colon to ''link'' to a category in line
without causing the page to be listed in the category:
[[:Category:English documentation]]

The Wiki reformats linked dates to match the reader's date preferences. These three dates will show up the same if you choose a format in your Preferences:

The Wiki reformats linked dates to match the reader's
date preferences. These three dates will show up the
same if you choose a format in your
[[Special:Preferences|]]:
* [[1969-07-20]]
* [[July 20]], [[1969]]
* [[20 July]] [[1969]]

Just Show What I Typed

A few different kinds of formatting will tell the Wiki to display things as you typed them.

What it looks like What you type

The nowiki tag ignores [[Wiki]] ''markup''. It reformats text by removing newlines and multiple spaces. It still interprets special characters: →

<nowiki>
The nowiki tag ignores 
[[Wiki]] ''markup''.
It reformats text by 
removing
newlines    and multiple
 spaces.
It still interprets special
characters: &rarr;
</nowiki>
The pre tag ignores [[Wiki]]
 ''markup''.
It also doesn't     reformat
 text.
It still interprets special
characters: →
<pre>
The pre tag ignores [[Wiki]]
 ''markup''.
It also doesn't     reformat
 text.
It still interprets special
characters: &rarr;
</pre>

Leading spaces are another way to preserve formatting.

Putting a space at the
beginning of each
line stops the text   
from being
reformatted.  It still 
interprets Wiki
markup and special
characters: →
Leading spaces are another way
to preserve formatting.

 Putting a space at the
 beginning of each
 line stops the text   
 from being
 reformatted.  It still 
 interprets [[Wiki]]
 ''markup'' and special
 characters: &rarr;

Images, tables, video, and sounds

After uploading, just enter the filename, highlight it and press the "embedded image"-button of the edit_toolbar.


This will produce the syntax for uploading a file [[Image:filename.png]]

This is a very quick introduction. For more information, see:

What it looks like What you type

A picture, including alternate text:

This Wiki's logo

You can put the image in a frame with a caption:

This Wiki's logo
A picture, including alternate text:

[[Image:Wiki.png|This Wiki's logo]]

The image in a frame with a caption:
[[Image:Wiki.png|frame|This Wiki's logo]]

A link to Wikipedia's page for the image: Image:Wiki.png

Or a link directly to the image itself: Media:Wiki.png

A link to Wikipedia's page for the image:
[[:Image:Wiki.png]]

Or a link directly to the image itself:
[[Media:Wiki.png]]

Use media: links to link directly to sounds or videos: A sound file

Use '''media:''' links to link 
directly to sounds or videos: 
A [[media:Sg_mrob.ogg|sound file]]
This is
a table

See also Help:Table for more on table creation and formats.

{| border="1" cellspacing="0" 
cellpadding="5" align="center"
! This
! is
|- 
| a
| table
|-
|}

Available Formatting Tags

You can use these standard tags within your edits:

Here is the unformatted <blockquote>example of using the <blockquote> tags around content.</blockquote>

Here is the formatted
rendering of using the <blockquote> tags around content.

Here is the unformatted <code>example of using the <code> tags around content.</code> Here is the formatted rendering of using the <code> tags around content.

Here is the unformatted <pre>example of using the <pre> tags around content.</pre>

Here is the formatted
rendering of using the <pre> tags around content.

Here is the unformatted <small>example of using the <small> tags around content.</small> Here is the formatted rendering of using the <small> tags around content.

Available Formatting Classes

In addition, there are some styles already in the default CSS style sheet that you can apply to portions of your text for various highlighting and emphasis. To do so, do the following:

<div class="classname">This is the text or content you want to highlight or emphasize.</div>

If you add such classes, you can also add further styles to the <div> tags, as well (see next section).

Some of the classes require you to "clear" the <div> tags, as follows:

<div style="clear: both"></div>

If required, this addition should be placed immediately after the closing </div> tag for your highlights. The listed classes below that require this addition are noted with the CLEAR indicator.


So, here are the available classes, free for your using!:

Class: 'autocomment' ; this is the example of using that class.
Class: 'blockquote' ; this is the example of using that class.
Class: 'boxGrayDotted' ; this is the example of using that class.
Class: 'boxGraySolid' ; this is the example of using that class.
Class: 'boxBlueDotted' ; this is the example of using that class.
Class: 'boxBlueSolid' ; this is the example of using that class.
Class: 'boxGreenDotted' ; this is the example of using that class.
Class: 'boxGreenSolid' ; this is the example of using that class.
Class: 'boxRedDotted' ; this is the example of using that class.
Class: 'boxRedSolid' ; this is the example of using that class.
Class: 'boxYellowDotted' ; this is the example of using that class.
Class: 'boxYellowSolid' ; this is the example of using that class.
Class: 'center' ; this is the example of using that class.
Class: 'code' ; this is the example of using that class.
Class: 'documentDescription' ; this is the example of using that class.
Class: 'documentByLine' ; this is the example of using that class.
Class: 'error' ; this is the example of using that class.
Class: 'errorbox' ; this is the example of using that class. CLEAR
Class: 'floatleft' ; this is the example of using that class. CLEAR is optional.
Class: 'floatright' ; this is the example of using that class. CLEAR is optional.
Class: 'pBody' ; this is the example of using that class.
Class: 'portlet' ; this is the example of using that class; note restricted width.
Class: 'successbox' ; this is the example of using that class. CLEAR
Class: 'townBox' ; this is the example of using that class. CLEAR
Class: 'usermessage' ; this is the example of using that class. CLEAR

Use of DIVs

If you are fairly comfortable with standard CSS, you can use <div> tags and styles fairly liberally in your edits. This is s great way to just do it!

Mathematical formulas

You can format mathematical formulas with TeX markup. See Help:Displaying a formula.

What it looks like What you type

<math>\sum_{n=0}^\infty \frac{x^n}{n!}</math>

<math>\sum_{n=0}^\infty \frac{x^n}{n!}</math>

Templates

Templates are segments of Wiki markup that are meant to be copied automatically ("transcluded") into a page. You add them by putting the template's name in {{double braces}}. It is also possible to transclude other pages by using {{:colon and double braces}}.

Some templates take parameters, as well, which you separate with the pipe character.

Magic Words

Mediawiki accepts some "magic" words that report statistics, show titles, reformat URLs, etc. etc. See http://www.mediawiki.org/wiki/Help:Magic_words.

Syntax Highlighting

The embedding of code examples uses the ws-box div class. Also, if highlighting is used, the instruction for source needs to include enclose="div". Also see further the Syntax Highlighting article.

Here is an example; view source to see the actual markup:

  /** Create a resultset object instance from the input structXML data */
  var resultset:Resultset = new Resultset(XML(inputData));

  /** Create the sBarChart component*/
  var semanticBarChart:sBarChart = new sBarChart ();

  /** Target type to focus on at load time */
  var targetAttributes:Array = ["http://purl.org/ontology/muni#indicator_1","http://purl.org/ontology/muni#indicator_2",
 "http://purl.org/ontology/muni#indicator_3"];

  /** Create the schema */
  var schema:Schema = new Schema();
  schema.loadSchema("http://schema.file.url");


  /** Initialize the semantic control */
  semanticBarChart.percentWidth = 100;
  semanticBarChart.percentHeight = 100;
  semanticBarChart.semanticDataProvider = resultset;
  semanticBarChart.targetAttributes= targetAttributes;
  semanticBarChart.schema= schema;

  /** Add the sBarChartto the main application */
  this.addChild(semanticBarChart);

Also, text references to code or code variables should be styled as variable.