(anonymous guest) (logged out)

Copyright (C) by the contributors. Some rights reserved, license BY-SA.

Sponsored by the Wiki Symposium and the Nuveon GmbH.

 

Add new attachment

Only authorized users are allowed to upload new attachments.

This page (revision-18) was last changed on 26-Sep-2007 12:33 by ChuckSmith  

This page was created on 15-Jan-2007 08:24 by RadomirDopieralski

Only authorized users are allowed to rename pages.

Only authorized users are allowed to delete pages.

Difference between version and

At line 5 changed one line
There is however a third way -- introducing own link markup format, that wouldn't conflict with markups of existing wikis.
There is however a third way -- introducing own link markup format, that wouldn't conflict with markups of existing wikis. This allows to both stay compliant with Creole, and retain the preferred order of link and description.
At line 7 changed one line
=== Change Proposal ===
=== Addition proposal ===
At line 10 changed one line
[[ description -> link ]]
[[description->link]]
At line 13 added 2 lines
The description is separated from the link with an arrow-like pair of characters "->". If there are multiple such pairs in the description, the last one is considered to be the separator.
At line 16 changed one line
* works better with international [[keyboards]]
* avoids the pipe character, which is not present on all international [[keyboards]]
At line 20 added 5 lines
* doesn't conflict with the default {{{[[link|description]]}}} markup
* provides alternative to the default order of link and description
* doesn't depend on "smart" methods of guessing which part is the link
* doesn't clash with the table markup, or any other existing Creole markup -- doesn't require modyfying existing rules
* two-character long separator makes it easier to scan the raw text and reduces probability of conflict with other markup
At line 22 changed 6 lines
* the '{{{[}}}', '{{{]}}}' and '{{{>}}}' characters are not available on some [[keyboards]], eg. the russian keyboard layout
* slower to type
* really confusing on right-to-left languages like Hebrew (?)
=== Another Change Proposal to Creole ===
* new in Creole
* the '{{{[}}}', '{{{]}}}' and '{{{>}}}' characters are not available on some [[keyboards]], eg. the for russian keyboard layout
* slower to type than the default link syntax
* lacks the intuitive counterpart that would use "<-"
* introduces more than way of making links -- this means that the users need to know //both// ways
* potential source of confusion when the separator is not easy to spot, eg. a | at the end of a complicate url with multiple parameters
* ambiguity with current link syntax:
At line 29 changed one line
[[description|link]]
[[foo|bar->baz]]
At line 31 changed 55 lines
==== Advantages ====
* description before link more intuitive (?)
==== Disadvantages ====
* conflicts with current Creole spec
* is less popular order of description and link on current wikis
=== Add Markdown Style Links to Creole ===
Perhaps an option would be to support the traditional Usemod style of links in addition to Markdown style links. This has the advantage of providing historical support for what most users are familiar with while still providing a more readable alternative for those that care.
{{{
[description](link)
}}}
For those that really care about readability, Markdown's footnote style link syntax might be a welcome addition as well:
{{{
[description][id]
... <arbitrary amount of text> ...
[id]: http://example.com/ "Optional Title Here"
}}}
==== Advantages ====
* Supports description|link style link which can be programatically differentiated from the link|description style
* Description before link more readable (someone from Wikipedia mentions this from experience on this site)
* Footnote style provides even more readability for those that care
* An increasing amount of people are familiar with Markdown syntax
==== Disadvantages ====
* Conflicts with current Creole spec
* Increases complexity with a second linking style
=== Current Syntax in Creole ===
{{{
[[link|description]]
}}}
==== Advantages ====
* currently most used wiki syntax for internal links
* similar to the most popular syntax for external links (minus the pipe)
* faster to type
==== Disadvantages ====
* the order of link and description is not marked
* the '{{{[}}}', '{{{]}}}' and '{{{|}}}' characters are not available on some [[keyboards]], eg. the russian keyboard layout
Is this a link to page "foo" with description "bar->baz", or a link to "baz" with description "foo|bar"?
* inconsistence with the image syntax -- should images also have a similar addition?
Version Date Modified Size Author Changes ... Change note
18 26-Sep-2007 12:33 2.829 kB ChuckSmith to previous restore
17 26-Sep-2007 02:23 2.856 kB 60.32.219.68 to previous | to last
16 26-Sep-2007 02:22 2.842 kB 60.190.243.173 to previous | to last
15 14-Feb-2007 21:14 2.829 kB RadomirDopieralski to previous | to last added advantage
14 14-Feb-2007 20:36 2.706 kB RadomirDopieralski to previous | to last clean up
13 14-Feb-2007 20:35 2.619 kB RadomirDopieralski to previous | to last cleanup
12 06-Feb-2007 15:53 3.374 kB 141.7.56.2 to previous | to last
11 28-Jan-2007 22:40 3.347 kB 198.95.226.230 to previous | to last
10 28-Jan-2007 22:40 3.325 kB 198.95.226.230 to previous | to last
9 17-Jan-2007 16:54 2.238 kB ChuckSmith to previous | to last added new link change proposal as requested
8 17-Jan-2007 10:31 1.954 kB 141.7.56.2 to previous | to last put question mark after right-to-left argument
7 16-Jan-2007 15:31 1.95 kB ChuckSmith to previous | to last disadvantage: right-to-left languages
6 16-Jan-2007 12:55 1.891 kB ChuckSmith to previous | to last speed of typing
5 16-Jan-2007 12:36 1.855 kB RadomirDopieralski to previous | to last
4 16-Jan-2007 12:36 1.819 kB RadomirDopieralski to previous | to last rephrased disadvantages, removed "intuitive" as it's relative
3 16-Jan-2007 12:13 1.686 kB ChuckSmith to previous | to last format fixing ... still getting used to Creole :)
2 16-Jan-2007 12:12 1.684 kB ChuckSmith to previous | to last advantages and disadvantages
1 15-Jan-2007 08:24 0.998 kB RadomirDopieralski to last introduction, please refactor
« This page (revision-18) was last changed on 26-Sep-2007 12:33 by ChuckSmith