Difference between revisions of "Wiki syntax"

From Inkscape Wiki
Jump to navigation Jump to search
(fixing aria spam)
 
m
 
(36 intermediate revisions by 14 users not shown)
Line 1: Line 1:
You might want to learn simply [[how to start a page]]. If you want the details about how to edit a Wikipedia page, though, you've come to the right place.
Inkscape's wiki uses the MediaWiki software, well known from Wikipedia.
A quick look at the MediaWiki syntax is [http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet available on Wikipedia,] along with [http://en.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page a more comprehensive overview.]


It's very easy to edit a Wiki page.  Simply click on the "edit this page right now!" link at the top or bottom of a Wiki page.  This will bring you to a page with a text box containing the text of that Wiki page.  Then type away, and press "Save" when finished(You can also preview your changes before saving if you like.)
To edit a page, click on the "Edit" link on the side menu (you must be logged in in order for it to become visible).  This will bring you to a page with a text box containing the text of that Wiki page.  Then type away, and press "Save page" when finished (You can also preview your changes before saving if you like.)


What you see in the text box will be mostly plain text, but you will see some special things the Wiki software uses to create links, lists, and other effectsThe rest of this page is a demonstration of how to use these featuresAfter the first few sections, you will have to "teach yourself" by pressing the "edit" link (above or below) to see for yourself how various effects were achieved!  You can practice editing in the [[SandBox]] before taking on other pages if you like.
To make a link to another wiki page, type double square brackets around it <nowiki>[[like this]]</nowiki> and continue editingThat's it!  If the page already exists, a link will be made to itIf the page doesn't exist, a link will be made that allows someone to create it.


<h2>Adding links</h2>
The Wiki software will link to a page title that is the same as the text of your link, except that the first letter will be uppercased.  For example, if you type <nowiki>[[card game]]</nowiki>, it will be linked to a page entitled "Card game".


Let's say that you're editing a page about sports, and you mention soccer.  Well, there's probably a Wiki page about soccer (and if there isn't, there should be) and you want to make the word a link to that articleSimple: type double square brackets around it <code>[[like this]]</code> and continue editing.  That's it! If the page already exists, a link will be made to it.  If the page doesn't already exist, a link will be made that allows someone to create it.
Older versions of the Wiki software only made one-word links LikeThis, and didn't require the brackets to make them linksYou can still do that, but it's generally discouraged because it LooksFunny. It is handy to use singular words like "game" rather than "games", because that makes it easier to create links in other pages.


There are a few rules about making these links that you might run into.  Foreign characters and punctuation cannot be used in the text of a link, so if you want to make a link to "John's Dog", you'll have to leave out the apostrophe.  Also, the Wiki software will link to a page title that is the same as the text of your link, except that the first letter will be uppercased, and spaces may be condensed.  For example, if you type <code>[[card game]]</code>, <br>it will be linked to a page entitled "Card game".
Finally, sometimes the text you would like to make into a link just doesn't make a good page title.  In that case, you can specify both inside the brackets separated by a vertical bar like this: <nowiki>[[Page link|text of link]]</nowiki>.  This will appear as "text of link", but will link to a page entitled "Page link".


Older versions of the Wiki software only made one-word links <code>LikeThis</code>, and didn't require the brackets to make them links.  You can still do that, but it's generally discouraged because it LooksFunny.  It is handy to use singular words like "game" rather than "games", because that makes it easier to create links in other pages.
Examples of good links:
 
:<nowiki>Link to [[important tutorial]]</nowiki>
Finally, sometimes the text you would like to make into a link just doesn't make a good page title.  In that case, you can specify both inside the brackets separated by a vertical bar like this: <code>[[Page link|text of link]]</code>.  This will appear as "text of link", but will link to a page entitled "Page link".
:<nowiki>[[John Smith]]</nowiki>
 
:<nowiki>[[John's Dog]]</nowiki>
Examples of Good links:
:<code>[[my new page]]</code>
:<code>[[My new page]]</code>
:<code>JohnSmith</code>
:<code>[[Johns Dog]]</code>
:<code>[[Johns Dog|John's Dog]]</code>
Bad links:
Bad links:
:<code>[[my_new_page]]</code> (underscores not necessary)
:<nowiki>Link to [[important_tutorial]]</nowiki> (superfluous underscore)
:<code>[[My_new_page]]</code> (underscores not necessary)
:<nowiki>Link to [[Important tutorial]]</nowiki> (superfluous capitalization)
:<code>johnsmith</code> (needs two capital letters or brackets)
:<nowiki>[[Johns Dog|John's Dog]]</nowiki> (the apostrophe does not need to be left out)
:<code>[[John's Dog]]</code> (will not link to the page you want it to link to)
:<nowiki>[[JohnSmith]]</nowiki> (unnatural name)
See [[naming conventions]] when choosing names for pages!
 
<h2>Making a new page</h2>
 
There are two ways to make a new page:
 
# As mentioned above, while you're editing the text of an old page, you can just put something in brackets.  For example, you would type: <code>[[my page]]</code>.  When you save the page you're editing, if the link you included doesn't exist, you will see a question mark after the text.  Click on that question mark and you will be taken to a newly-created page that you can edit.  Replace "Describe the new page here." with whatever text you want to put on the page!
#Type the URL of the new page in the "address" line of your browser and hit return.  The URL of the new page will be the text of a link, with the first letter uppercased and spaces replaced by underscores (see [[Wiki Canonization]] for more details about this). For example, in the URL above, you would replace
<br><code>http://intranet.pdx.osdl.net/cgi-bin/wiki.pl?How_does_one_edit_a_page</code>
<br>with the new URL
<br><code>http://intranet.pdx.osdl.net/cgi-bin/wiki.pl?Name_of_your_new_page</code>
<br>and then hit return.
 
See also [[how to start a page]].
 
 
<h2>Demonstration area</h2>
 
*What follows is an area for demonstrating the various effects possible using Wiki, such as bold, italics, numbered lists, etc., etc.
*Click "edit" at the top or bottom of this page (i.e., the page you are now reading!) to see how these effects were achieved!!!
*<b>If you don't click "edit" now you won't understand what's going on!!!</b>
 
New paragraphs are made by simply pressing the "enter" or "return" key twice.  If you press it just once,
like this,
a new paragraph ''will not'' be made (as you can see).
 
Here is
<br>the proper way
<br>to make single-spaced lines.
 
:This line is indented.
::This line is indented even farther.
:::Who knows how far it can go?
 
This line is indented by using an initial space,
              but since I didn't use a colon ( : )
  at the beginning of the line, it appears as a monospace font such as "Courier". 
  In other words, if you begin a paragraph with spaces, that
      line will be both indented and in a monospace font.
This is very useful for importing monospace formatted tabular materials, especially source code. Also note that space-indented lines will not wrap!  They will simply increase the width of your window.
 
''This line is in italics.'' (Using double single quote marks!)
<br><i>And so is this one!</i> (Using good old html tags!)
<br><em>And this!</em> (Using still different code!  How versatile!  How confusing!  But any of them will do.)
 
'''This line is bold.''' (Using triple single quote marks!)
<br><b>So is this one!</b> (Using the standard html tag!)
 
Here is a new style link: [[Larry Sanger]] (see [[Free Links]])
<br>Here is an old style link: HomePage
<br>Consider not capitalizing your page names: [[definition of philosophy]]; see [[naming conventions]]
<br>[[HomePage|the text of this link is different from the name of the page it links to]]
<br>[[HomePage|it really doesn't MatterWhat youType in the...link description.  It's all link&eacute;d!]]
<br>An external link: http://www.nupedia.com/about.shtml
<br>Another external
link: [http://www.nupedia.com/about.shtml Nupedia about page]
 
If you type in the URL of a picture, it will be displayed rather than linked to:<br>http://www.wikipedia.com/wikia.gif
 
You don't have to create weird page titles, like [[Platos]], just to make the plural or possessive form of a name.  [[Plato's]] wouldn't work anyway.  You can write: [[Plato]]'s or (more cleverly) [[Plato|Plato's]].  In the old linking system you'd do it like this: JimboWales's homepage (using "").  (Just Say No to the old linking system; after all, you can now link to [[Jimbo Wales]]'s homepage!)  But it ''does'' look like you're stuck with [[Platos Republic]], because [[Plato's Republic]] doesn't work, as you can see, although if you want to type a bit more you can cleverly create [[Platos Republic|Plato's Republic]].
 
Here is a numbered list:
#Item 1
#Item 2
#Item 8
#Notice, this line isn't numbered because it is not flush left.
:#Neither is this line
 
Here is a bulleted list:
*Here's an item
* Here's another item
**We can do bullets within bullets, as it were
*** Pretty nifty, huh?
 
You can make a horizontal "rule" (line) on a page: ----
Or two, if you wish:
----
----
 
There are three ways to display, rather than parse, wiki code:
#<code>you can use the <code> tag</code>
#<pre>you can use the <pre> tag</pre>
#<nowiki>you can use the <nowiki> tag</nowiki>
The difference between <nowiki><code> and <pre></nowiki> is that the pre tag preserves line breaks, while the code tag does not.  The nowiki tag works like the <code><code></code> tag except that it doesn't use a monospace font.  (We made liberal use of the <code><code></code> tag on this page.)
 
Lines that \
end with backslashes \
will wrap if it is the *last* character on the line.
If there is trailing spaces, the backslash won't cause word wrapping.
 
You can create subpages: /Talk
<br>Sorry, but you cannot create sub-subpages: /Talk/TalkAboutTalk
<br>You can link to other subpages: [[Charlize Theron/Filmography]] or even [[charlize Theron/Filmography]].
 
We can do tables the old fashioned HTML way:
<table border=1>
<tr>
<td>Item one</td>
<td>Item two</td>
</tr>
<tr>
<td>Item three</td>
<td>Item four</td>
</tr>
</table>
 
The    preformatted  text    approach  might
be    a              better  way        to
do    columnar      types  of        tables.  ;-)
 
Sometimes you might need to use special characters, like these: ü À &alpha;
 
You can make <sup>superscripts</sup> and <sub>subscripts</sub> and you can control the font <font size=+1>size</font> and <font color=blue>color</font>!
 
*f(x) = a<sub>0</sub> + a<sub>1</sub>x<sub>1</sub> + a<sub>2</sub>x<sub>2</sub><sup>2</sup> + a<sub>3</sub>x<sub>3</sub><sup>3</sup> + ...
 
*<font size=+2 color=red>f(x) = a<sub>0</sub> + a<sub>1</sub>x<sub>1</sub> + a<sub>2</sub>x<sub>2</sub><sup>2</sup> + a<sub>3</sub>x<sub>3</sub><sup>3</sup> + ...</font>
 
If you want to redirect traffic going to one page to another page (with a better title, for example), then use the command <code>#REDIRECT [[pagename]]</code> at the top of the page.  To look at the history of the old page, click on the "<code>(redirected from OldPageName)</code>" link at the top of the new page.
 
Practice editing pages in our SandBox!
 
Then, go forth and [[be bold in updating pages]]!


----
----
This page is borrowed & adapted from [http://www.wikipedia.com/ Wikipedia.com], and is reusable under the terms of the [http://www.gnu.org/copyleft/fdl.html GNU Free Documentation License (FDL)].
This page is borrowed & adapted from [http://www.wikipedia.org/ Wikipedia.org], and is reusable under the terms of the [http://creativecommons.org/licenses/by-sa/3.0/deed Creative Commons Attribution Share-Alike (CC BY-SA)] license.
 
<font color=red> This is what I am trying.... </font>

Latest revision as of 04:51, 28 March 2012

Inkscape's wiki uses the MediaWiki software, well known from Wikipedia. A quick look at the MediaWiki syntax is available on Wikipedia, along with a more comprehensive overview.

To edit a page, click on the "Edit" link on the side menu (you must be logged in in order for it to become visible). This will bring you to a page with a text box containing the text of that Wiki page. Then type away, and press "Save page" when finished (You can also preview your changes before saving if you like.)

To make a link to another wiki page, type double square brackets around it [[like this]] and continue editing. That's it! If the page already exists, a link will be made to it. If the page doesn't exist, a link will be made that allows someone to create it.

The Wiki software will link to a page title that is the same as the text of your link, except that the first letter will be uppercased. For example, if you type [[card game]], it will be linked to a page entitled "Card game".

Older versions of the Wiki software only made one-word links LikeThis, and didn't require the brackets to make them links. You can still do that, but it's generally discouraged because it LooksFunny. It is handy to use singular words like "game" rather than "games", because that makes it easier to create links in other pages.

Finally, sometimes the text you would like to make into a link just doesn't make a good page title. In that case, you can specify both inside the brackets separated by a vertical bar like this: [[Page link|text of link]]. This will appear as "text of link", but will link to a page entitled "Page link".

Examples of good links:

Link to [[important tutorial]]
[[John Smith]]
[[John's Dog]]

Bad links:

Link to [[important_tutorial]] (superfluous underscore)
Link to [[Important tutorial]] (superfluous capitalization)
[[Johns Dog|John's Dog]] (the apostrophe does not need to be left out)
[[JohnSmith]] (unnatural name)

This page is borrowed & adapted from Wikipedia.org, and is reusable under the terms of the Creative Commons Attribution Share-Alike (CC BY-SA) license.