At work we have the need to display an arbitrary string for WikiWord links. The question is how to extend the [[...]] syntax so that it is easy to remember, easy to type and is compatible with the current syntax. Brainstorming on syntax:

• [[text:link]] format. Example:

  You type:	Text [[formatting rules:TWiki.WikiSyntax]]
  You get:	Text formatting rules

• [[text][link]] format. Example:

  You type:	TWiki [[Variables][TWiki.TWikiDocumentation#variables]]
  You get:	TWiki Variables

Should we also allow external links like [[Yahoo][http://www.yahoo.com/]] ?

Opinions?

-- PeterThoeny - 06 Feb 2001

The second one seems better, think of

-- StefanScherer - 07 Feb 2001

OK, lets do the [[text][link]] type of link.

-- PeterThoeny - 10 Feb 2001

Implemented the following syntax and commited to TWikiAlphaRelease: (syntax changed on 01 Mar 2001)

• Edit: [[WebHome][go home]]
• View: go home

• Edit: [[http://www.yahoo.com/][Yahoo!]]
• View: Yahoo!

• Edit: [[TWiki.TextFormattingRules][Wiki syntax]]
• View: Wiki syntax

• Edit: [[TWiki.TWikiDocumentation#TWikiVariables][Variables]]
• View: Variables
  (Details in AutomaticNamedAnchorLinks)

-- PeterThoeny - 24 Feb 2001

Changed the anchor syntax from "@MyAnchor" to "#MyAnchor, e.g. the normal HTML way. The link syntax is not changed, e.g. remains with the nested sqaure brackets, [[link text][WikiLink]].

Above text is fixed, and the change is commited to the TWikiAlphaRelease.

-- PeterThoeny - 28 Feb 2001

I got the feedback that we should reverse the order to have it in line with HTML links, e.g.

• [[WikiLink][link text]].

The reson is to make it less confusing for HTMLers / it does not matter much for people who do not know HTML.

Now is the last change to make the change before it goes into Beta! Opinions?

-- PeterThoeny - 01 Mar 2001

I reversed the order and commited the change to TWikiAlphaRelease and also created a Beta release. Above examples have been corrected.

-- PeterThoeny - 01 Mar 2001

sorry to beat the poor horse again, but i have another requirement that i am going to add - see MoreArbitraryTextForWikiWordLinks

-- SvenDowideit - 01 May 2001

This is just an idea, but I have recently used the [[http://foo.com/][Foo site]] syntax a few times, and found myself leaving out one or more parentheses. Since the first element is always a single word with no spaces in it, why not just use [[http://foo.com/ Foo site]] - or even [http://foo.com/ Foo site]?

This syntax would make it much easier to type - I find that the [[Codev.WebHome]] syntax is very easy to type, so doing an link with just an extra hit of the Space bar is quite attractive. Have a look at this Usemod page for an example of the single-parenthesis syntax. This test version of Usemod also formats all external links to appear in []'s, which is interesting but should probably be optional.

Also, could we make sure that the <verbatim> syntax doesn't do anything to its contents, and that there's a similar embedded version, like <code>? Would make it easier to discuss such snippets, and seems to make more sense for something called 'verbatim'.

-- RichardDonkin - 10 Jun 2001