Ticket #30 (closed defect: fixed)

Opened 3 years ago

Last modified 3 years ago

wiki: AboutMarkdown page shows incorrect inline link syntax

Reported by: pmocek-wiki-comment-deveiate-20051013@… Owned by: deveiant
Priority: normal Milestone: Markdown 1.0.1
Component: MarkdownSyntax Version: 1.0.0
Severity: trivial Keywords: wiki documentation markdown syntax link quote parenthesis
Cc:

Description

On the BlueCloth wiki AboutMarkdown page, the sample Markdown source includes an inline link for which the title is inclosed in parenthesis (instead of single or double quotes as described at http://daringfireball.net/projects/markdown/syntax#link).

i.e., this:

  [1]: http://www.azureva.com/gb/italie/mags/grand-canal.php3 
       (Venice: The Grand Canal)

should be this:

  [1]: http://www.azureva.com/gb/italie/mags/grand-canal.php3 
       "Venice: The Grand Canal"

or this:

  [1]: http://www.azureva.com/gb/italie/mags/grand-canal.php3 
       'Venice: The Grand Canal'

Change History

Changed 3 years ago by deveiant

  • status changed from new to assigned
  • version set to 1.0.0
  • milestone set to Markdown 1.0.1

The syntax in the cited page is actually valid Markdown, though it isn't documented anywhere. You can verify this by pasting the source into the Markdown dingus tool.

That said, it is very confusing to have undocumented syntax in the example, and I thank you for bringing it to my attention. I'll fix it immediately.

Changed 3 years ago by deveiant

  • status changed from assigned to closed
  • resolution set to fixed

Fixed.

Changed 3 years ago by pmocek-wiki-comment-deveiate-20051013@…

Strangely, while the Markdown syntax documentation clearly states that only double quotes or single quotes are used to delimit titles of reference-style links, the Markdown Dingus recognizes double quotes and *parenthesis* -- but not single quotes -- for these titles. Ditto for Markdown command-line utility (version 1.0.1 running on Debian GNU/Linux). I have contacted the author and am awaiting a response.

Changed 3 years ago by pmocek-wiki-comment-deveiate-20051013@…

Markdown author John Gruber writes:

I think all three delimiters should be both supported and documented. That parens aren't mentioned in the docs is an oversight, and that single quotes don't actually work is a bug.

and

I've updated the docs to mention parens and the bug: http://daringfireball.net/projects/markdown/syntax#link

Changed 3 years ago by deveiant

Excellent. Thanks for taking the time to track this down and get the documentation fixed.

Note: See TracTickets for help on using tickets.