Defect #21375

Working external URL prefixes (protocols and 'www' host part) not documented in wiki syntax

Added by Till Riedel about 2 years ago. Updated 6 months ago.

Status:ClosedStart date:
Priority:NormalDue date:
Assignee:Jean-Philippe Lang% Done:

0%

Category:Documentation
Target version:3.4.0
Resolution:Fixed Affected version:

Description

As #2953 states /https?:\/\/.*/ and /ftps?:\/\/.*/ links work however documentation on RedmineTextFormatting mentions only http not https,ftp,ftps. Implementation is inconstent with documentations if more than only http works, one would expect other URL schemes to work too as mentioned in #2953.

21375-external-urls-help.diff Magnifier - patch to update wiki_syntax_detailed_*.html (59 KB) Go MAEDA, 2017-03-21 04:24

21375_more_external_urls.patch Magnifier (28.1 KB) Marius BALTEANU, 2017-06-17 13:54

0001-Complement-external-URL-documentation-21375.patch Magnifier (69.6 KB) Mischa The Evil, 2017-06-18 13:17


Related issues

Blocks Redmine - Patch #26188: Documentation (detailed syntax help & code) additions/imp... Closed

Associated revisions

Revision 16447
Added by Jean-Philippe Lang 8 months ago

Working external URLs not documented (#21375).

Patch by Go MAEDA.

Revision 16689
Added by Jean-Philippe Lang 6 months ago

Complement external URL documentation (#21375).

Patch by Mischa The Evil.

History

#1 Updated by Toshi MARUYAMA almost 2 years ago

  • Description updated (diff)

#2 Updated by Toshi MARUYAMA almost 2 years ago

Till Riedel wrote:

As #2953 states /https?:\/\/.*/ and /ftps?:\/\/.*/ links work however documentation on RedmineTextFormatting mentions only http not https,ftp,ftps.

You can update wikis on redmine.org.
This is definition.
source:tags/3.2.0/lib/redmine/wiki_formatting.rb#L113

Implementation is inconstent with documentations if more than only http works, one would expect other URL schemes to work too as mentioned in #2953.

I think #2953 is not related.

#4 Updated by Go MAEDA 9 months ago

This patch updates public/help/*/wiki_syntax_detailed_*.html.

#5 Updated by Go MAEDA 9 months ago

  • Target version changed from Candidate for next major release to 3.4.0

#6 Updated by Jean-Philippe Lang 8 months ago

  • Subject changed from Working External URLs not documented to Working external URL protocols not documented in wiki syntax
  • Status changed from New to Closed
  • Assignee set to Jean-Philippe Lang
  • Resolution set to Fixed

Committed, thanks.

#7 Updated by Mischa The Evil 8 months ago

  • Status changed from Closed to Reopened
Shouldn't we document the following ones explicitly too?

#8 Updated by Jean-Philippe Lang 7 months ago

  • Assignee changed from Jean-Philippe Lang to Mischa The Evil

Mischa The Evil wrote:

Shouldn't we document the following ones explicitly too?

Sure, could you prepare a patch for that?

#9 Updated by Mischa The Evil 6 months ago

Jean-Philippe Lang wrote:

Mischa The Evil wrote:

Shouldn't we document the following ones explicitly too?

Sure, could you prepare a patch for that?

Thanks for the feedback. I'll see what I can do (including the wiki page).

#10 Updated by Marius BALTEANU 6 months ago

Because I really want to see the 3.4.0 released, I took the liberty to create a patch that specify the www, sftp and sftps as URLs. Mischa, the patch matches your expectations? If yes, I'll update the wiki pages, too.

#11 Updated by Mischa The Evil 6 months ago

  • File 0001-Complement-external-URL-documentation-21375.patchMagnifier added
  • Subject changed from Working external URL protocols not documented in wiki syntax to Working external URL prefixes (protocols and 'www' host part) not documented in wiki syntax
  • Assignee changed from Mischa The Evil to Jean-Philippe Lang

Marius BALTEANU wrote:

[...] I took the liberty to create a patch that specify the www, sftp and sftps as URLs. Mischa, the patch matches your expectations? If yes, I'll update the wiki pages, too.

Thanks for chiming in. I've looked at your patch; it seems — with 43 changes — incomplete however1. It seems to be generated with a (too) basic search-and-replace, using an insufficient search string. As such only changing (a part of the) the textile docs only.

I just completed an other patch which changes all the translations, slightly differently:

hits old string new string
54 (http, https, ftp, and ftps) (starting with: www, http, https, ftp, ftps, sftp and sftps)
42 (http, https, ftp and ftps)
2 (http, https, ftp, ftps)
Notes:
  • I changed the order in which the link 'types' are mentioned, starting with 'www' as it's probably the most common nowadays (although even that URL-part is being ditched often these days) and it is a hostname identifier instead of a protocol identifier as all the others (informally) are;
  • I added starting with: in front of the inline list for better clarity;
  • I decided not to add a serial comma to the inline list, as such adhering to British English spelling instead of American English (it's not required for clarity, there is no clear, official Redmine guideline on what spelling to use and it feels just more natural to me [and probably many other EU-based users, though I'm biased as my native Dutch language doesn't dictate use of it]).

I'll attach the patch implementing this change. This patch, against current source:/trunk@16676, is produced using git format-patch which makes it apply-able using "patch -p1 < 0001-...". It is patch 1/5 of a patch serial of which I'll post patches 2 to 5 in a new issue as they are less related to this initial issue.
I'll also change the wiki pages accordingly when the patch has been committed.

Environment:

Environment:
  Redmine version                3.3.3.devel@r16676
  Ruby version                   2.3.3-p222 (2016-11-21) [x86_64-linux]
  Rails version                  4.2.8
  Environment                    production
  Database adapter               Mysql2
SCM:
  Subversion                     1.8.8
  Git                            1.9.1
  Filesystem                     
Redmine plugins:
  no plugin installed

1 Redmine currently supports 49 languages, each having two detailed syntax pages (textile and markdown), which makes a required number of changes of 98.

#12 Updated by Mischa The Evil 6 months ago

  • Blocks Patch #26188: Documentation (detailed syntax help & code) additions/improvements added

#13 Updated by Jean-Philippe Lang 6 months ago

  • Status changed from Reopened to Closed

Committed, thanks.

Also available in: Atom PDF