Vote #64634: "Magic links" to notes - redmineorg-copy202205 - Redmine

編集操作

リンクをコピー

Vote #64634

完了

"Magic links" to notes

Admin Redmine さんが3年以上前に追加. 3年以上前に更新.

ステータス:

Closed

優先度:

通常

担当者:

カテゴリ:

Text formatting_26

対象バージョン:

1.4.0_40

開始日:

2009/02/11

期日:

進捗率:

予定工数:

Redmineorg_URL:

https://www.redmine.org/issues/2715

category_id:

version_id:

issue_org_id:

2715

author_id:

3906

assigned_to_id:

comments:

status_id:

tracker_id:

plus1:

affected_version:

closed_on:

affected_version_id:

ステータス-->[Closed]

引用

説明

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

journals

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

--------------------------------------------------------------------------------
+1
--------------------------------------------------------------------------------
+1
--------------------------------------------------------------------------------
+1
--------------------------------------------------------------------------------
+1
--------------------------------------------------------------------------------
+1
--------------------------------------------------------------------------------
+1
--------------------------------------------------------------------------------
+1
--------------------------------------------------------------------------------
+1. I was used to this in Trac :)
--------------------------------------------------------------------------------
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.
--------------------------------------------------------------------------------

--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
Cleaner patch with test.

All test pass.

Syntax is #2715-14 for note 14 of issue #2715.
--------------------------------------------------------------------------------
+1
--------------------------------------------------------------------------------
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!
--------------------------------------------------------------------------------
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?
--------------------------------------------------------------------------------
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.
--------------------------------------------------------------------------------
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

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

--------------------------------------------------------------------------------
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).
--------------------------------------------------------------------------------
+1
--------------------------------------------------------------------------------
+1
--------------------------------------------------------------------------------
+1
--------------------------------------------------------------------------------
+1

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

I also think period is better separator :)

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.

--------------------------------------------------------------------------------
+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 .

--------------------------------------------------------------------------------
Stéphane Gourichon wrote:
> #2715c14 .

+1: behaves as bugzilla

--------------------------------------------------------------------------------
Everyone is OK with @#2715c14@?
--------------------------------------------------------------------------------
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.
--------------------------------------------------------------------------------
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>@?
--------------------------------------------------------------------------------
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.
--------------------------------------------------------------------------------
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.
--------------------------------------------------------------------------------
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.

--------------------------------------------------------------------------------
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?
--------------------------------------------------------------------------------
Feature is added in r8877 and accepts the 2 syntaxes:

or the short version:

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

--------------------------------------------------------------------------------

related_issues

relates,Closed,391,Links to notes/comments/replies in issues.
relates,Closed,12912,Issue-notes Redmine links: append actual note reference to rendered links
duplicates,Closed,6368,Create a syntax for links to comments
duplicates,Closed,5326,Wiki shortcuts for linking directly to issue comments?