Home | Sitemap | Last changes RSS Feed | Wiki help | Wiki tools | SandBox
Preferences | Edit this page | View source | Page history | Referrers
Document last modified: Tue, 15 Jun 2010, 19:28 UTC
Parents: WikiHelp/

Wiki Help/Wiki Links

Note: the term /WikiLinks is actually used for wiki links created by smashing capitalized words together (like this: SourceForge). We've used the term to name this page as well but do not confuse the wiki links with other kinds of links.

1 Wiki links
2 Free links
3 Regular outside links
4 Shortcut outside links

1) Wiki links

These links are created simply by smashing together capitalized words (at least two of them). Example: SourceForge appears as SourceForge. There's nothing special you have to do, just write them like that and the engine will pick them up and render them as wiki links.

However, if the target page doesn't exists the wiki link will not appear as a link. It will appear as the wiki word followed by a question mark. Clicking on the question mark will make you edit that would-be page. Only if you save it it will be created and all wiki links pointing to it will become actual wiki links. Example (don't ruin it by creating the page): ThisPageDoesNotExist appears as ThisPageDoesNotExist?.

If you need to avoid a word to become a wiki link, use /WikiBackticks around it.

If you want to force text which wouldn't become a wiki link on its own to become one, use free links (see below).

2) Free links

Free links are text that is forced to become a wiki link although the engine wouldn't normally acknowledge it as a wiki link. You do this by enclosing text in double round brackets. Example: ((mailhtml)) becomes mailhtml.

You can separate the target of a free link from the displayed text by using a vertical bar inside the double brackets. Example: ((/WikiLinks|wiki links)) becomes wiki links (and actually points to /WikiLinks). This is very useful when you want to create a wiki link but the name of that wiki link is not suggestive enough in that particular context; so you replace it with more appropriate text while keeping the target.

Finally, you can further extend free links by making them point to anchor macros. This is done by adding a sharp sign and the name of the anchor. Example: ((/WikiLinks|About wiki links#about)) will point to the [[Anchor about]] anchor macro on the /WikiLinks page and will show as About wiki links. This is very useful for creating summary links at the top of long pages, so visitors can jump straight to what they need.

Important note: if a wannabe wiki link/page contains characters that have been deemed as "undesirable" by this wiki's administrator, the link will be refused by the wiki engine. In other words, if you use such a character and attempt to make a link out of it, even forcefully, the engine will not do it, and even warn you about it. Example: space is such a character. We don't want pages with spaces in them because it could lead to all kinds of misbehaviour, such as all-spaces page names. Attempting to make a link with a space in it will go like this: we try to force it by inserting ((page name)) and what comes out is {page name}!!.

3) Regular outside links

Links to pages outside the wiki are produced simply by writing an URL. Example: http://google.com becomes http://google.com. The wiki engine spots the http:// at the beginning and makes the text an outside link.

If you enclose an outside link in square brackets, it will become a link to that target, shown as a number in square brackets. The numbers are used only once, so if you have several such links on a page they each have a unique number. Example: search engines [http://google.com] [http://askjeeves.com] becomes: search engines [1] [2]. This is useful when you have multiple references but don't want to waste space with the actual URL's. Note: see also /WikiMacros/RefList to produce a reference list.

If you want an outside link which contains regular text (not an URL) you add that text inside the brackets after the URL. Example: [http://google.com Google search engine] becomes Google search engine*.

4) Shortcut outside links

Shortcut outside links are outside links in a shorthand notation which take a parameter. See InterWiki for details. The most obvious use for them is making links to certain pages on other wikis (such as Wiki:FixBrokenWindows). But they can also be used for other purposes, such as automating a Google search (Google:blackbox) or referencing development tracker items (BlackboxBug:1018238).

Please note that such shortcuts must be registered in the InterWiki page. Until they are, shortcut links using an unregistered shortcut will still render normally, but will point to this site's address instead of the intended target.


eXTReMe Tracker Hosted by SourceForge.net
Document last modified: Tue, 15 Jun 2010, 19:28 UTC
Home | Sitemap | Last changes RSS Feed | Wiki help | Wiki tools | SandBox
Preferences | Edit this page | View source | Page history | Referrers
Hosted by SourceForge. Powered by Wikki Tikki Tavi. About the website. Terms of use.