Feature #8410

Allow users to add hyperlinks in descriptive fields

Added by Jesús García Crespo over 5 years ago. Updated almost 5 years ago.

Status:VerifiedStart date:05/07/2015
Priority:MediumDue date:
Assignee:Dan Gillean% Done:

0%

Category:Menu / navigation
Target version:Release 2.2.1
Google Code Legacy ID: Tested version:
Sponsored:No Requires documentation:

Description

This feature will add a custom syntax for creating links in text area fields in AtoM, instead of using HTML, which can often negatively affect XML exports.

Original formats reviewed:
  • WBG
    {{ Google|http://www.google.ca }}
  • Redmine
    "Google":http://www.google.ca
  • MediaWiki
    [http://www.google.ca Google]
  • Markdown
    [Google](http://www.google.ca)

After extensive testing with a Regex editor, we have decided to implement the Redmine solution, as other options could not always be properly parsed.

"Google":http://www.google.ca

This will be available in most text areas of all major entities in AtoM (e.g. archival descriptions, authority records, accessions, archival institutions, etc), in the large text area boxes.

Some notes on where it will not work:

  • It cannot be used in controlled value fields (e.g. those linked to taxonomies)
  • It cannot be used on static pages - here it is acceptable, and even expected, to use HTML
  • RAD Title notes do not currently support this feature.

Related issues

Related to Access to Memory (AtoM) - Feature #8916: Revise custom linking regex to add support for FTP linking Verified 09/04/2015
Related to Access to Memory (AtoM) - Feature #9184: Update HTML scrub script to replace HTML links with custo... Verified 11/23/2015
Related to Access to Memory (AtoM) - Bug #9351: Custom linking is escaped in Scope and content snippet di... Verified 01/25/2016
Related to Access to Memory (AtoM) - Feature #12149: Convert existing AtoM data to Parsedown syntax Verified 03/13/2018

History

#2 Updated by Jesús García Crespo over 5 years ago

  • Description updated (diff)

#3 Updated by Jesús García Crespo over 5 years ago

First draft implements Redmine's format:

"Foobar":http://foobar.com

Pull request: https://github.com/artefactual/atom/pull/163.

#4 Updated by Jesús García Crespo over 5 years ago

  • Status changed from New to Code Review
  • Assignee changed from Jesús García Crespo to José Raddaoui Marín

#5 Updated by José Raddaoui Marín over 5 years ago

  • Status changed from Code Review to In progress
  • Assignee changed from José Raddaoui Marín to Jesús García Crespo

Awesome! Love the Unit test!

#6 Updated by Jesús García Crespo over 5 years ago

  • Status changed from In progress to QA/Review
  • Assignee changed from Jesús García Crespo to Dan Gillean

#7 Updated by Dan Gillean over 5 years ago

  • Description updated (diff)
  • Status changed from QA/Review to Verified

#8 Updated by Dan Gillean about 5 years ago

  • Related to Feature #8916: Revise custom linking regex to add support for FTP linking added

#9 Updated by Dan Gillean almost 5 years ago

  • Requires documentation set to Yes

#10 Updated by Dan Gillean almost 5 years ago

  • Requires documentation deleted (Yes)

#13 Updated by Dan Gillean almost 5 years ago

  • Related to Feature #9184: Update HTML scrub script to replace HTML links with custom linking formatting used in AtoM added

#14 Updated by Dan Gillean almost 5 years ago

  • Target version changed from Release 2.3.0 to Release 2.2.1

#15 Updated by Dan Gillean almost 5 years ago

  • Related to Bug #9351: Custom linking is escaped in Scope and content snippet displayed in description results stubs added

#16 Updated by Dan Gillean over 2 years ago

  • Related to Feature #12149: Convert existing AtoM data to Parsedown syntax added

Also available in: Atom PDF