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? |