Feature #2715

"Magic links" to notes

Added by Ве Fio over 3 years ago. Updated 22 days ago.

Status:Closed Start date:2009-02-11
Priority:Normal Due date:
Assignee:Jean-Philippe Lang % Done:

0%
Category:Text formatting
Target version:1.4.0
Resolution:Fixed

Description

This was part of Feature #391, but the issue was closed.
e.g. #391.1 -> http://www.redmine.org/issues/show/391#note-1

Edit:

The syntax implemented in Redmine for 1.4.0 is:

#2715#note-41

or the short version:

#2715-41

issue_note_link.patch - v2 (4.4 kB) Magnifier Etienne Massip, 2011-04-09 15:03

Related issues

related to Feature #391: Links to notes/comments/replies in issues. Closed
duplicated by Feature #6368: Create a syntax for links to comments Closed 2010-09-12

Associated revisions

Revision 8877
Added by Jean-Philippe Lang 3 months ago

Adds support for "Magic links" to notes (#2715).

History

#1 Updated by threexk threexk over 2 years ago

I'm also interested in this feature. It would be handy to have a simple way to refer to a note on the current issue other than writing "see note 24" or making a full URL link.

#2 Updated by Eric Davis over 2 years ago

  • Category set to Text formatting

#4 Updated by Fernando Hartmann almost 2 years ago

+1

#5 Updated by Burt Culver over 1 year ago

+1

#6 Updated by Martin Hartung over 1 year ago

+1

#7 Updated by Hajime Fujita over 1 year ago

+1

#8 Updated by Yasir Arsanukaev over 1 year ago

+1

#9 Updated by Lucas CORBEAUX over 1 year ago

+1

#10 Updated by Max Rozenoer over 1 year ago

+1. I was used to this in Trac :)

#11 Updated by Etienne Massip about 1 year ago

  • File issue_note_link.patch added

threexk threexk wrote:

I'm also interested in this feature. It would be handy to have a simple way to refer to a note on the current issue other than writing "see note 24" or making a full URL link.

I agree this could be very useful.

Hope we could include this soon, here's a patch.

#12 Updated by Etienne Massip about 1 year ago

  • Target version set to Candidate for next major release

#13 Updated by Etienne Massip about 1 year ago

  • File deleted (issue_note_link.patch)

#14 Updated by Etienne Massip about 1 year ago

Cleaner patch with test.

All test pass.

Syntax is #2715-14 for note 14 of issue #2715.

#15 Updated by Gilles Cornu about 1 year ago

+1

#16 Updated by Martin Denizet about 1 year ago

I think it's a must have.
My users use #<note-id> to make references to notes which actually makes links to issues.
It creates a lot of confusion.
I agree with the syntax #2715-14, thank you Etienne for the patch!

#17 Updated by Ling Li 12 months ago

I tested the patch from Etienne Massip on 1.1.2 and (with some manual fiddle to fix the failed patching) it works well. Thanks!

While we are at this, can we add yet another syntax to refer to notes within the same issue? I.e.,

  • note:5 refers to note 5 of the same issue. I used ":" instead of "-" since the former is in the spirit of "commit:f30e13e43" and "source:some/file"
  • #2715-14 (or maybe we should use #2715:14 for consistency) refers to note 14 of issue #2715.

What do you think?

#18 Updated by Ling Li 12 months ago

Or, if people like the syntax to be compact/terse:
  • #:5 refers to note 5 of the same issue
  • #2715:14 refers to note 5 of issue #2715.

#19 Updated by Etienne Massip 12 months ago

I like the last one. What about a period or a 'n' instead of a semicolon ?

That is :

  • #.5 refers to note 5 of the same issue
  • #2715.14 refers to note 5 of issue #2715

or

  • #n5 refers to note 5 of the same issue
  • #2715n14 refers to note 5 of issue #2715.

#20 Updated by Ling Li 12 months ago

I see a period or an 'n' makes the parsing easier than a colon ':'. I like the period version (now we kinda get back to the initial suggestion in Description).

#21 Updated by Terence Mill 12 months ago

+1

#22 Updated by Leonids Maslovs 11 months ago

+1

#23 Updated by Frotran Def 11 months ago

+1

#24 Updated by Colin Mollenhour 9 months ago

+1

Fyi, the patch applied cleanly (except for the unit tests) to my installation of 1.2.1 and works wonderfully. Thanks Etienne!

#25 Updated by Dmitry Salashnik 9 months ago

+1

I also think period is better separator :)

#26 Updated by Vagner Santos 8 months ago

+1

#27 Updated by Anton Lukashev 7 months ago

+1

#28 Updated by Nayuta Taga 7 months ago

+1

#29 Updated by Nick Bolton 7 months ago

#30 Updated by Sergei Danilov 6 months ago

+1
It's easy way to link timelog comment with issue note

#31 Updated by ohcibi ohcibi 6 months ago

+1

#32 Updated by Daniel Ritz 4 months ago

+1

Etienne Massip wrote:

  • #n5 refers to note 5 of the same issue
  • #2715n14 refers to note 5 of issue #2715.

That's the format I like the most.

#33 Updated by Stéphane Gourichon 4 months ago

+1 whatever the syntax finally kept (letter, punctuation etc).

Why 'n' ? If a letter at all, since it's a link to a comment 'c' seems more natural than 'n', e.g. #2715c14 .

#34 Updated by pasquale [:dedalus] 3 months ago

Stéphane Gourichon wrote:

#2715c14 .

+1: behaves as bugzilla

#35 Updated by Jean-Philippe Lang 3 months ago

  • Assignee set to Jean-Philippe Lang
  • Target version changed from Candidate for next major release to 1.4.0

Everyone is OK with #2715c14?

#36 Updated by Martin Hartung 3 months ago

Lacking Ruby skills I did not check the patch itself, but am very much ok with the suggested synax.
The original example was #2715-14 and that's how it should be in my point of view.

#37 Updated by Etienne Massip 3 months ago

Jean-Philippe Lang wrote:

Everyone is OK with #2715c14?

What about the use of a generic #<issue number>#<html anchor name> which would allow to refer to any anchor in the page (like for references to wiki pages), including #note-<note number>?

#38 Updated by Jean-Philippe Lang 3 months ago

Actually, I don't really like #2715c14 much. I would prefer #2715-14 or even #2715:14. But I agree that #2715#note-14 makes a lot of sense, it's just that it's less compact.

#39 Updated by Etienne Massip 3 months ago

Jean-Philippe Lang wrote:

Actually, I don't really like #2715c14 much.

Agree, the c is not readable; what would be great as it has been suggested is a syntax which is also usable to refer to a note in this issue, e.g. #-39 for this note.

#2715#note-14 (or #2715/note-14, #2715:note-14, etc.) has the merit that it is understood when reading it that it refers to a specific comment of a specific issue and not anything else related to the issue. That would make #note-14 the link to the in-issue note 14, which seems great too.

#40 Updated by Simon Edwards 3 months ago

Etienne Massip wrote:

#2715#note-14 (or #2715/note-14, #2715:note-14, etc.) has the merit that it is understood when reading it that it refers to a specific comment of a specific issue and not anything else related to the issue. That would make #note-14 the link to the in-issue note 14, which seems great too.

I agree that this syntax does make the most sense, even though it's less compact. Having the links within the issue being #note-n agrees with the current anchor format, so it's the most intuitive method. This approach gets my vote.

#41 Updated by Gilles Cornu 3 months ago

Since there is so much different tastes around, why not:
  • support more than a unique separator pattern (:,-,.,c,n,-note,...).
    • Personally, we deployed the patch with '-' syntax (e.g. #2715-41), and I find it quite nice, intuitive and convenient
  • make the pattern(s) configurable/overridable in Redmine settings ?
    • (okay, it's maybe overkill feature, but it has the advantage to stop this discussion ;-)

I don't think there is any drawback to support more than one possible syntax. Is there any?

#42 Updated by Jean-Philippe Lang 3 months ago

  • Status changed from New to Closed
  • Resolution set to Fixed

Feature is added in r8877 and accepts the 2 syntaxes:

#2715#note-41

or the short version:

#2715-41

I don't think it's a good thing to make it configurable. This should be the same across all Redmine instances.

#43 Updated by Jean-Philippe Lang 3 months ago

  • Description updated (diff)

Also available in: Atom PDF