Fullscreen
Loading...
 
[Show/Hide Right Column]

Wiki-Syntax Links

In this page, you'll learn how to include links in your Wiki pages, including links to other Wiki pages within the same TikiWiki site, links to an external Wiki site, and links to the Web.



Quick Reference

To... Default Syntax Optional Syntax1
Syntax Requires...
Link to a Wiki page ((Wiki Page Name)) WikiPageName WikiWords2
Link to an external Wiki page ((Ext Wiki Name: Ext Wiki Page Name)) ExtWikiName: ExtWikiPageName WikiWords2
Link to a Web page [http://www.somesite.org] or
[http://www.somesite.org|Some Site!]
http://www.somesite.org AutoLinks3


Image Notes:
  1. Tiki includes two options that modify the default link syntax: WikiWords and Autolink.
  2. To enable WikiWords:
    If the WikiWords feature is disabled, you must use double parenthesis to create a Wiki page link.
  3. To enable AutoLinks:
    • From the Administration: Text Area page, select the General Settings tab. In Tiki 4.x this is renamed to Editing & Plugins.
    • On the General Settings tab, in the Miscellaneous area, enable the AutoLinks option.

    If the AutoLinks features is disabled, you must use the square brackets to create a link to an external page.

Linking Within a Tiki Site

Wiki Pages

When using the WikiWords option, Tiki will automatically detect Wiki page names and correctly format them as hyperlinks

The following are methods of creating links to Wiki pages
  • TheWikiWay
    Two or more words are stuck together (no spaces, but accept - [dash] and _ [underscore]), and each is capitalized. You must enable the WikiWords option to use this mothod.
  • ((The Wiki Way))
    Use double parentheses around the page name to Wiki page names that include spaces or when the WikiWords option is not enabled.
  • (token-name(The Wiki Way))
    Use a token-name reference to link to wiki pages using a semantic link, a qualifier. Semantic links were introduced in Tiki 3.0 and have to be enabled separately. See Semantic Admin for more information. Trick: This can be also used to put a class on a link.

This table lists additional methods for creating links to wiki pages.

To... Syntax Result Comment
Specify link text ((PluginVersions | The Versions Plugin)) The Versions Plugin Use the vertical bar (| [pipe]) to separate the page name from the link text.
Link to a heading or anchor on another page and specify link text ((Using Wiki Pages | #The_Wiki_Menu | The Wiki Menu))
(but no spaces around pipes)
The Wiki Menu Tiki automatically creates anchors for headings on a Wiki page. For the heading or anchor, note the # character and underscores replacing spaces.
[Wiki+Plugin#Plugin_Syntax | Plugin Syntax] Plugin Syntax
Link to a heading on the same page [#Related_Pages|Related Pages] Related Pages Note the # character and underscores replacing spaces.
Link to a page with a specific tab showing [PluginImg&cookietab=3
#Parameters | Params Tab3]

(but no line break before #)
Params Tab3 Works on pages where PluginTabs is used as well as pages with built-in tabs. Linking to a heading in this example also
Use a custom color for the link text ((Wiki-Syntax Text|~~#ff0000:Syntax for Text~~)) Syntax for Text By default, the color is defined by the Tiki theme (CSS). See Wiki-Syntax Text for more information.


Close
tipTip
See PluginAlink and PluginAname for how to set anchors in a page and to link to them. These plugins can be used to create a link to an anchor within the same page.


Image Help!
  • If you save the page but see a question mark (?) after the page name, and you're sure the page exists, search for the page in the Search module to make sure you've typed the name correctly.
  • When using WikiWords, Tiki will try to convert any word with odd capitalization into a Wiki link. Use double, reversed parentheses around a word to indicate that it should not be a wiki link — even when the WikiWords option is enabled. For example:
    ))WordStar(( will not become a link.

Semantic Wiki

Starting from version 3.0, Tikiwiki supports semantic qualifiers on Wiki Links. To add a qualifier to the wiki link, the following syntax must be used:

(qualifier-name(The Wiki Way))

  • Qualifiers may contain lowecase letters (a-z) and dashes.
  • The qualifier name will be added as a CSS class on the link to customize the display.
  • Semantic relationships can be managed by administrators from Semantic Admin. Relationships can be viewed from Module semantic_links.

Articles, Blogs, Forums and Other Pages

For all other types of pages within a TikiWiki site, a shortened address can be used with square brackets. Here are some examples:

Type of Page Syntax Result
Article number 19 [tiki-read_article.php?articleId=19] tiki-read_article.php?articleId=19
[tiki-read_article.php?articleId=19|News from doc.tw.o!] News from doc.tw.o!
Galleries [tiki-galleries.php|Galleries] Galleries
FAQ number 8 [tiki-view_faq.php?faqId=8|FAQ on Images] FAQ on Images
Shadowbox popup [http://doc.tikiwiki.org/tiki-print.php?page=Wiki-Syntax+Links|See this page|shadowbox;title=shadowbox example;]
shadowbox feature must be activated
See this page
File gallery file [tiki-download_file.php?fileId=284|Download PDF file] Download PDF file


Close
tipTip
These are only a few examples - any page within a TikiWiki site can be linked this way, just make note of the last part of the path when you're on that page and use that for the link.


Note: Use [[foo] to display [foo]

To create a link to an attachment to a wiki page, use PluginAttach or PluginFile. If you'd like for an image to act as a link, so that clicking on the image takes you to another page, see the link image tab under Parameters on the PluginImg page.

[img/php.png|Click here to see the image in a popup|shadowbox]
Click here to see the image in a popup


Display a Specific Tab

If PluginTabs is used on a page, the following syntax can be used to display specific tab within that page without refreshing the page:

{HTML()}<a href="#tab2" onclick="tikitabs(2); return false;">Tab 2</a>{HTML}



Here are the key parts of the syntax:
  • tikitabs(2) (with version 7.0) or tikitabs(2,4,1) (before 7.0):
    • 2 means the second tab will be displayed when the link is clicked
    • 4 means there are 4 tabs in total (before 7.0)
    • Always use 1 for the third number (before 7.0)
  • href="#tab2" - this can be any text, except that it should start with a #
  • Tab 2 - this will be the text that shows as a link

Here's an example:
Tab 2


First tab



Here are some plugins that provide navigational links:


Linking to Other Wiki Sites

If the site administrator has enabled this option, shortened links to pages in an external Wiki can be created. You'll need to know the short name that the administrator has set up to use this feature - the information may be documented on the site in a TikiWiki Manual of Style or you can ask your administrator. See External Wikis for a complete explanation as well as the shortcut links for external wikis that have been defined on this site (under the heading List external wiki references).

Linking to Web Pages

You can link to any page on the Web that has a valid URL. By default, Tiki creates a local cache of the page so that it will be available even if the remote Web site is down. Here are some examples of the syntax:

Description Syntax Result
Link to an external web page [http://www.wiki-translation.com] hhttp://www.wiki-translation.com
Specify link text [http://www.wiki-translation.com|Wiki Translation] Wiki Translation
With ))AutoLinks(( enabled http://www.wiki-translation.com http://www.wiki-translation.com
Using a color font [http://www.tikiwiki.org|~~#ff0000:tw~~] tw
Open in new window (if feature activated) [http://tiki.org|hello tiki.org|target] hello tiki.org


See the Quick Reference section above for how to set the AutoLinks administrative option. In addition, two more administrative options related to external links:
  • To open external links in new window:
    Go to Admin Home > Text Area > Features section and check Open external links in new window and click "Change Preferences." If this feature is disabled, external links open in the existing browser window.

  • To disable the external link icon (Image ):
    Go to Admin Home > Editing and Plugins > General Settings > External links and images and uncheck External link icon then click "Change Preferences." With this disabled, the icon (Image ) will no longer appear at the end of any external links. Keeping it enabled allows users to know when they are being directed to another site.

Image Important: If you are linking to a PDF file, a multimedia file, or any file other than an HTML page, please include the nocache directive, as in the following examples:
  • [http://www.somesite.org/docs/chapter1.pdf |nocache]
  • [http://www.somesite.org/docs/chapter1.pdf|Chapter One|nocache]

Image Help!
  • If the link doesn't work, try copying the URL into your browser window, and click Enter. If the page exists, go back and check your typing. Chances are you'll find that you've made a typing error. Did you type both brackets correctly?

You need to add the extra text "|box" (or maybe "|shadowbox" in earlier releases, if box doesn't work for you) after the label of your external link. You can also add some params, if needed, for the external resource, followed by semicolons.

Example1
Show a YouTube video in semitransparent popup (colorbox) in full screen size.

[http://www.youtube.com/v/KBewVCducWw&amp;autoplay=1|You Tube video in their flash player|box]


Which would produce:
You Tube video in their flash player

Example2
Show a YouTube video in semitransparent popup (colorbox) but with defined smaller size than full screen:

[http://www.youtube.com/v/KBewVCducWw&amp;autoplay=1|You Tube video in their flash player|shadowbox;width=405;height=340;]


Which would produce:
You Tube video in their flash player

Linking to Email Addresses

To link to an Email Address, enclose the mailto URL within square brackets, as in the following examples:

  • Type this: [mailto:johndoe@someplace.com | John Doe]
    To get this: John Doe

Tips

  • to enter a text between brackets. Put 2 open brackets, the text and one closing brackets like this [[xxxx] that will output [xxxx]

Formatted Tooltip

Tiki has a built-in class (called tikihelp) that allows you to create a formatted tooltip for a link as follows:

The following syntax:
{HTML()} <a href="HomePage" class="tikihelp" title="Home Page:This links to the home page for doc.tiki.org">Home Page</ a>{HTML}


Would produce on this site:

Home Page

Mouse over the above link to see the formatted tooltip. Here's what's important for the tooltip to appear like this:
  • JQuery must be enabled
  • Set class="tikihelp"
  • First part of the title before the colon is the heading of the tooltip and the text after the colon is the body.

Whenever Tiki finds a link to an external site in a Wiki page the link is cached in the Tiki cache, this allows the Wiki users to visit the page even if the site is offline or the page is removed or changed.

When you make a link in a Wiki page, you can choose to request that it not be cached. This is done by adding the phrase after the link description between the square brackets.
Admins, see
Link Cache.



List of attached files
ID Name desc uploaded Size Downloads Actions
18 gif external_link.gif external link icon Tue 05 May, 2009 06:20 CEST by lindon 79 b 15410 View Download  

doc.tiki.org
[toggle]





Site Language

Keywords

These keywords serve as "hubs" for navigation within the Tiki documentation. They correspond to development keywords (bug reports and feature requests):



Tiki Newsletter

Delivered fresh to your email inbox!
Newsletter subscribe icon
Don't miss major announcements and other news!
Contribute to Tiki