Maven Doxia

Broken link syntax in APT

Details

  • Type: Bug Bug
  • Status: Closed Closed
  • Priority: Minor Minor
  • Resolution: Won't Fix
  • Affects Version/s: 1.2
  • Fix Version/s: None
  • Component/s: Module - Apt
  • Labels:
    None
  • Number of attachments :
    0

Description

A common cause of frustration is APT's linking feature. Consider this example: You want to link to an external resource without a name for the link. So you do write:

{{http://truezip.java.net}}

Some time later you decide you would prefer a name for the link, but you cannot insert

{name}

like so:

{{{TrueZIP User Website}http://truezip.java.net}} // BROKEN!

Rather than this, you have to reverse the order and write:

{{{http://truezip.java.net}TrueZIP User Website}}

So the URI effectively moves from

{{URI}}

to

{{{URI}NAME}}

This is really annoying!

I know you can't change this without breaking compatibility. So please provide a new linking feature, probably something like this:

[[URI]] and [[[NAME]URI]] respectively.

Issue Links

is related to

Bug - A problem which impairs or prevents the functions of the product. DOXIA-428 Fix broken fragment links in Doxia

  • Major - Major loss of function.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Christian Schlichtherle added a comment -

The first example is shredded by JIRA and should read (cross fingers I now quote correctly):

http://truezip.java.net\

Show
Christian Schlichtherle added a comment - The first example is shredded by JIRA and should read (cross fingers I now quote correctly): http://truezip.java.net\
Hide
Permalink
Christian Schlichtherle added a comment -

Nope! I mean

<curly-open-brace/><curly-open-brace/>http://truezip.java.net<curly-close-brace/><curly-close-brace/>

You get it.

Show
Christian Schlichtherle added a comment - Nope! I mean <curly-open-brace/><curly-open-brace/> http://truezip.java.net <curly-close-brace/><curly-close-brace/> You get it.
Hide
Permalink
Lukas Theussl added a comment -

So all you want is reverse the order of NAME and URI? Why? The apt format is defined the way it is, if you don't like it just use something else. I will close this as 'Won't fix' unless there is some reasonable objection.

Show
Lukas Theussl added a comment - So all you want is reverse the order of NAME and URI? Why? The apt format is defined the way it is, if you don't like it just use something else. I will close this as 'Won't fix' unless there is some reasonable objection.
Hide
Permalink
Christian Schlichtherle added a comment -

Yes, that's basically all, but it helps a lot if you have to write large documentation with lots of links.

Show
Christian Schlichtherle added a comment - Yes, that's basically all, but it helps a lot if you have to write large documentation with lots of links.
Hide
Permalink
Lukas Theussl added a comment -

Well, if it would be the addition of a new feature without changing the old behaviour that would be fine, but changing the order will just lead to a lot of confusion, so this is definitely 'won't fix'.

Show
Lukas Theussl added a comment - Well, if it would be the addition of a new feature without changing the old behaviour that would be fine, but changing the order will just lead to a lot of confusion, so this is definitely 'won't fix'.
Hide
Permalink
Christian Schlichtherle added a comment -

Therefore I proposed to introduce a different syntax: [[[NAME]URI]]. This would be an extension to the syntax used for embedding images.

Show
Christian Schlichtherle added a comment - Therefore I proposed to introduce a different syntax: [[ [NAME] URI]]. This would be an extension to the syntax used for embedding images.
Hide
Permalink
Lukas Theussl added a comment -

That would mean two different syntaxes for links, which is confusing too.

Show
Lukas Theussl added a comment - That would mean two different syntaxes for links, which is confusing too.

People

  • Assignee:
    Lukas Theussl
    Reporter:
    Christian Schlichtherle
Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: