You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Christian Schlichtherle (JIRA)" <ji...@codehaus.org> on 2011/05/18 18:18:22 UTC
[jira] Created: (DOXIA-429) Broken link syntax in APT
Broken link syntax in APT
-------------------------
Key: DOXIA-429
URL: http://jira.codehaus.org/browse/DOXIA-429
Project: Maven Doxia
Issue Type: Bug
Components: Module - Apt
Affects Versions: 1.2
Reporter: Christian Schlichtherle
Priority: Minor
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.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (DOXIA-429) Broken link syntax in APT
Posted by "Christian Schlichtherle (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/DOXIA-429?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=267349#action_267349 ]
Christian Schlichtherle commented on DOXIA-429:
-----------------------------------------------
Nope! I mean
<curly-open-brace/><curly-open-brace/>http://truezip.java.net<curly-close-brace/><curly-close-brace/>
You get it.
> Broken link syntax in APT
> -------------------------
>
> Key: DOXIA-429
> URL: http://jira.codehaus.org/browse/DOXIA-429
> Project: Maven Doxia
> Issue Type: Bug
> Components: Module - Apt
> Affects Versions: 1.2
> Reporter: Christian Schlichtherle
> Priority: Minor
>
> 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.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Updated: (DOXIA-429) Broken link syntax in APT
Posted by "Dennis Lundberg (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/DOXIA-429?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Dennis Lundberg updated DOXIA-429:
----------------------------------
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:
{noformat}
{{http://truezip.java.net}}
{noformat}
Some time later you decide you would prefer a name for the link, but you cannot insert {name} like so:
{noformat}
{{{TrueZIP User Website}http://truezip.java.net}} // BROKEN!
{noformat}
Rather than this, you have to reverse the order and write:
{noformat}
{{{http://truezip.java.net}TrueZIP User Website}}
{noformat}
So the URI effectively moves from
{noformat}
{{URI}}{noformat}
to
{noformat}
{{{URI}NAME}}
{noformat}
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.
was:
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.
> Broken link syntax in APT
> -------------------------
>
> Key: DOXIA-429
> URL: http://jira.codehaus.org/browse/DOXIA-429
> Project: Maven Doxia
> Issue Type: Bug
> Components: Module - Apt
> Affects Versions: 1.2
> Reporter: Christian Schlichtherle
> Priority: Minor
>
> 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:
> {noformat}
> {{http://truezip.java.net}}
> {noformat}
> Some time later you decide you would prefer a name for the link, but you cannot insert {name} like so:
> {noformat}
> {{{TrueZIP User Website}http://truezip.java.net}} // BROKEN!
> {noformat}
> Rather than this, you have to reverse the order and write:
> {noformat}
> {{{http://truezip.java.net}TrueZIP User Website}}
> {noformat}
> So the URI effectively moves from
> {noformat}
> {{URI}}{noformat}
> to
> {noformat}
> {{{URI}NAME}}
> {noformat}
> 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.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Closed: (DOXIA-429) Broken link syntax in APT
Posted by "Lukas Theussl (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/DOXIA-429?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Lukas Theussl closed DOXIA-429.
-------------------------------
Resolution: Won't Fix
Assignee: Lukas Theussl
> Broken link syntax in APT
> -------------------------
>
> Key: DOXIA-429
> URL: http://jira.codehaus.org/browse/DOXIA-429
> Project: Maven Doxia
> Issue Type: Bug
> Components: Module - Apt
> Affects Versions: 1.2
> Reporter: Christian Schlichtherle
> Assignee: Lukas Theussl
> Priority: Minor
>
> 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:
> {noformat}
> {{http://truezip.java.net}}
> {noformat}
> Some time later you decide you would prefer a name for the link, but you cannot insert {name} like so:
> {noformat}
> {{{TrueZIP User Website}http://truezip.java.net}} // BROKEN!
> {noformat}
> Rather than this, you have to reverse the order and write:
> {noformat}
> {{{http://truezip.java.net}TrueZIP User Website}}
> {noformat}
> So the URI effectively moves from
> {noformat}
> {{URI}}{noformat}
> to
> {noformat}
> {{{URI}NAME}}
> {noformat}
> 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.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (DOXIA-429) Broken link syntax in APT
Posted by "Christian Schlichtherle (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/DOXIA-429?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=267433#action_267433 ]
Christian Schlichtherle commented on DOXIA-429:
-----------------------------------------------
Therefore I proposed to introduce a different syntax: [[[NAME]URI]]. This would be an extension to the syntax used for embedding images.
> Broken link syntax in APT
> -------------------------
>
> Key: DOXIA-429
> URL: http://jira.codehaus.org/browse/DOXIA-429
> Project: Maven Doxia
> Issue Type: Bug
> Components: Module - Apt
> Affects Versions: 1.2
> Reporter: Christian Schlichtherle
> Assignee: Lukas Theussl
> Priority: Minor
>
> 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:
> {noformat}
> {{http://truezip.java.net}}
> {noformat}
> Some time later you decide you would prefer a name for the link, but you cannot insert {name} like so:
> {noformat}
> {{{TrueZIP User Website}http://truezip.java.net}} // BROKEN!
> {noformat}
> Rather than this, you have to reverse the order and write:
> {noformat}
> {{{http://truezip.java.net}TrueZIP User Website}}
> {noformat}
> So the URI effectively moves from
> {noformat}
> {{URI}}{noformat}
> to
> {noformat}
> {{{URI}NAME}}
> {noformat}
> 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.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (DOXIA-429) Broken link syntax in APT
Posted by "Christian Schlichtherle (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/DOXIA-429?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=267429#action_267429 ]
Christian Schlichtherle commented on DOXIA-429:
-----------------------------------------------
Yes, that's basically all, but it helps a lot if you have to write large documentation with lots of links.
> Broken link syntax in APT
> -------------------------
>
> Key: DOXIA-429
> URL: http://jira.codehaus.org/browse/DOXIA-429
> Project: Maven Doxia
> Issue Type: Bug
> Components: Module - Apt
> Affects Versions: 1.2
> Reporter: Christian Schlichtherle
> Priority: Minor
>
> 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:
> {noformat}
> {{http://truezip.java.net}}
> {noformat}
> Some time later you decide you would prefer a name for the link, but you cannot insert {name} like so:
> {noformat}
> {{{TrueZIP User Website}http://truezip.java.net}} // BROKEN!
> {noformat}
> Rather than this, you have to reverse the order and write:
> {noformat}
> {{{http://truezip.java.net}TrueZIP User Website}}
> {noformat}
> So the URI effectively moves from
> {noformat}
> {{URI}}{noformat}
> to
> {noformat}
> {{{URI}NAME}}
> {noformat}
> 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.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (DOXIA-429) Broken link syntax in APT
Posted by "Lukas Theussl (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/DOXIA-429?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=267431#action_267431 ]
Lukas Theussl commented on DOXIA-429:
-------------------------------------
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'.
> Broken link syntax in APT
> -------------------------
>
> Key: DOXIA-429
> URL: http://jira.codehaus.org/browse/DOXIA-429
> Project: Maven Doxia
> Issue Type: Bug
> Components: Module - Apt
> Affects Versions: 1.2
> Reporter: Christian Schlichtherle
> Priority: Minor
>
> 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:
> {noformat}
> {{http://truezip.java.net}}
> {noformat}
> Some time later you decide you would prefer a name for the link, but you cannot insert {name} like so:
> {noformat}
> {{{TrueZIP User Website}http://truezip.java.net}} // BROKEN!
> {noformat}
> Rather than this, you have to reverse the order and write:
> {noformat}
> {{{http://truezip.java.net}TrueZIP User Website}}
> {noformat}
> So the URI effectively moves from
> {noformat}
> {{URI}}{noformat}
> to
> {noformat}
> {{{URI}NAME}}
> {noformat}
> 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.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (DOXIA-429) Broken link syntax in APT
Posted by "Christian Schlichtherle (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/DOXIA-429?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=267348#action_267348 ]
Christian Schlichtherle commented on DOXIA-429:
-----------------------------------------------
The first example is shredded by JIRA and should read (cross fingers I now quote correctly):
\{\{http://truezip.java.net\}\}
> Broken link syntax in APT
> -------------------------
>
> Key: DOXIA-429
> URL: http://jira.codehaus.org/browse/DOXIA-429
> Project: Maven Doxia
> Issue Type: Bug
> Components: Module - Apt
> Affects Versions: 1.2
> Reporter: Christian Schlichtherle
> Priority: Minor
>
> 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.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (DOXIA-429) Broken link syntax in APT
Posted by "Lukas Theussl (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/DOXIA-429?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=267435#action_267435 ]
Lukas Theussl commented on DOXIA-429:
-------------------------------------
That would mean two different syntaxes for links, which is confusing too.
> Broken link syntax in APT
> -------------------------
>
> Key: DOXIA-429
> URL: http://jira.codehaus.org/browse/DOXIA-429
> Project: Maven Doxia
> Issue Type: Bug
> Components: Module - Apt
> Affects Versions: 1.2
> Reporter: Christian Schlichtherle
> Assignee: Lukas Theussl
> Priority: Minor
>
> 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:
> {noformat}
> {{http://truezip.java.net}}
> {noformat}
> Some time later you decide you would prefer a name for the link, but you cannot insert {name} like so:
> {noformat}
> {{{TrueZIP User Website}http://truezip.java.net}} // BROKEN!
> {noformat}
> Rather than this, you have to reverse the order and write:
> {noformat}
> {{{http://truezip.java.net}TrueZIP User Website}}
> {noformat}
> So the URI effectively moves from
> {noformat}
> {{URI}}{noformat}
> to
> {noformat}
> {{{URI}NAME}}
> {noformat}
> 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.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (DOXIA-429) Broken link syntax in APT
Posted by "Lukas Theussl (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/DOXIA-429?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=267425#action_267425 ]
Lukas Theussl commented on DOXIA-429:
-------------------------------------
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.
> Broken link syntax in APT
> -------------------------
>
> Key: DOXIA-429
> URL: http://jira.codehaus.org/browse/DOXIA-429
> Project: Maven Doxia
> Issue Type: Bug
> Components: Module - Apt
> Affects Versions: 1.2
> Reporter: Christian Schlichtherle
> Priority: Minor
>
> 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:
> {noformat}
> {{http://truezip.java.net}}
> {noformat}
> Some time later you decide you would prefer a name for the link, but you cannot insert {name} like so:
> {noformat}
> {{{TrueZIP User Website}http://truezip.java.net}} // BROKEN!
> {noformat}
> Rather than this, you have to reverse the order and write:
> {noformat}
> {{{http://truezip.java.net}TrueZIP User Website}}
> {noformat}
> So the URI effectively moves from
> {noformat}
> {{URI}}{noformat}
> to
> {noformat}
> {{{URI}NAME}}
> {noformat}
> 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.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira