public inbox archive for pandoc-discuss@googlegroups.com
 help / color / mirror / Atom feed
From: JM Marcastel <jm-hh8AyDY1G20S+FvcfC7Uqw@public.gmane.org>
To: pandoc-discuss <pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org>
Subject: Reference links / label vs title
Date: Sun, 4 Feb 2018 20:40:14 -0800 (PST)	[thread overview]
Message-ID: <78db5f71-ac0e-4b1e-982d-40c0b9a59b84@googlegroups.com> (raw)


[-- Attachment #1.1: Type: text/plain, Size: 2530 bytes --]


*SUGGESTION*

When a title is given in a reference link, display the title in lieu of the 
label in rendered text.

If rejected as a standard behaviour, then could this be a CLI option?

*EXAMPLE*

[mylabel]: https://example.com "Some title"  {.external}

Output Some title <https://example.com> rather than my label 
<https://example.com>.

*MOTIVATION*

Reference links allow for reusability of links. The denomination (or title) 
associated with the link differs from one context to another. A typical 
example is when referencing multiple URLs that pertain to a same subject. 
Giving a consistent naming convention, that provides both a visually 
pleasant and compliant to regular writing conventions in whatever language 
your Markdown text is written, can be quite challenging.

As an example, I often keep track of software I am interested in. I have, 
within a same Markdown document, a table where I keep track of home pages, 
GitHub repository, latest release, etc. Elsewhere is the Markdown document 
I may discuss a given software, sometimes referring to its home page, and 
sometimes referring to its GitHub repository. Take the example of Pandoc:

[pandoc-ws]: https://pandoc.org "Pandoc"
[pandoc-gh]: https://github.com/jgm/pandoc "Pandoc"


Displaying pandoc-gb <http://#> and pandow-ws <http://#> in my tables and 
in the body of my text is clumsy. Using variations like *Pandoc (homepage)* and 
*Pandoc (github)* remains clumsy. Redefining the reference link is even 
more clumsy; reference links are here for reuse not redefinition. With the 
proposed approach I can consistently say Pandoc <http://pandoc-ws> for 
Pandoc's website or Pandoc <http://pandoc-gh> for Pandoc's GitHub 
repository depending of the context in which I am.
 
Implementing an even more flexible solution where the title can be assigned 
at each invocation of the reference link would be ideal. But that probably 
has deeper repercussions on the Markdown syntax.


-- 
You received this message because you are subscribed to the Google Groups "pandoc-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/78db5f71-ac0e-4b1e-982d-40c0b9a59b84%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[-- Attachment #1.2: Type: text/html, Size: 5227 bytes --]

             reply	other threads:[~2018-02-05  4:40 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-02-05  4:40 JM Marcastel [this message]
     [not found] ` <78db5f71-ac0e-4b1e-982d-40c0b9a59b84-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org>
2018-02-07 15:49   ` Daniel Staal

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=78db5f71-ac0e-4b1e-982d-40c0b9a59b84@googlegroups.com \
    --to=jm-hh8aydy1g20s+fvcfc7uqw@public.gmane.org \
    --cc=pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).