[Show/Hide Right Column]

Describes the TikiWiki syntax for creating hyperlinks
Print

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


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 ((Using Wiki Pages|#The_Wiki_Menu)) Using Wiki Pages Tiki automatically creates anchors for headings on a Wiki page. For the heading or anchor, note the # character and underscores replacing spaces.
Link to heading or anchor and specify link text ((Using Wiki Pages|#The_Wiki_Menu|The Wiki Menu)) The Wiki Menu
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.


Image 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.




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
with link text
[tiki-read_article.php?articleId=19]
[tiki-read_article.php?articleId=19|News from doc.tw.o!]
tiki-read_article.php?articleId=19
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


Image 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.

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 img Tag heading on the Wiki-Syntax Images page.

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


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 (
    external_link.gif ):
    Go to Admin Home (tiki-admin.php?page=textarea)> Editing and Plugins > General Settings > External links and images and uncheck External link icon then click "Change Preferences." With this disabled, the icon (
    external_link.gif) 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?

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

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.


Contributors to this page: beejay358 points  , tschutter2 points  , tobi_h143 points  , system , sylvie3910 points  , StarRider1 points  , Scot Wilcoxon679 points  , Rick6689 points  , nkoth22 points  , MelanieR18 points  , Michael Davey15 points  , Marc Laporte5242 points  , Fabián Rodríguez6 points  , lphuberdeau326 points  , lindon2179 points  , J471 points  , fivos88 points  , DennisDaniels2 points  , Philippe Cloutier268 points  , CharlieChance15 points  and bpfaffenberger1 points  .
Page last modified on Tuesday 23 February, 2010 04:30:14 UTC by beejay358 points .

Find by Page Name

Exact match

Keywords

The following is a list of keywords that should serve as hubs for navigation within the Tiki documentation and should correspond to development keywords (bug reports and feature requests):

Accessibility (WAI & 508)
Articles & Submissions
Backlinks
Banners
Batch
BigBlueButton audio/video/chat/screensharing (5.x)
Blog
Bookmark
Browser Compatibility
Link Cache
Calendar
Category
Chat
Clean URLs
Comments
Communication Center
Compression (gzip)
Contacts Address book
Contact us
Content template
Contribution 2.x
Cookie
Copyright
Custom Home (and Groups Home Page)
Date and Time
Debugger Console
Directory (of hyperlinks)
Documentation link from Tiki to doc.tikiwiki.org (Help System)
DogFood
Dynamic Content
Dynamic Variable
External Authentication
FAQ
Featured links
File Gallery
Forum
Friendship Network (Community)
Gmap Google maps
Groups
Hotword
HTML Page
i18n (Multilingual, l10n, Babelfish)
Image Gallery
Import-Export
Install
Integrator
Interaction
Inter-User Messages
InterTiki
Kaltura video editing
Karma
Live Support
Login
Logs (system & action)
Look and Feel
Lost edit protection
Mail-in
Map with Mapserver
Menu
Meta Tags
Mobile Tiki and Voice Tiki
Mods
Module
MultiTiki
MyTiki
Newsletter
Notepad
Payment
Performance Speed / Load
Permissions
Platform independence (Linux-Apache, Windows/IIS, Mac, BSD)
Polls
Profiles
Profile Manager
Quicktags
Quiz
Rating
Feeds
Score
Search engine optimization
Search
Security
Semantic links 3.x
Shadowbox
Shadow Layers
Shopping cart
Shoutbox
Slideshow
Smiley
Spam protection (Anti-bot CATPCHA)
Spellcheck
Spreadsheet
Stats
Surveys
Tags 2.x
Task
Tell a Friend, Alert + Social Bookmarking
TikiTests 2.x
Theme CSS & Smarty
Trackers
TRIM
User Administration including registration and banning
User Files
User Menu
Watch
WebHelp
WebDAV 5.x
Webmail
Webservices
Wiki 3D
Wiki History, page rename, etc
Wiki Page Staging and Approval 2.x
Wiki Plugin extends basic syntax
Wiki Syntax
Wiki structure (book and table of content)
Workspace
WYSIWYCA
WYSIWYG 2.x
XMLRPC