Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Render related web links to be more user friendly #10

Open
msorens opened this issue Nov 30, 2015 · 3 comments
Open

Render related web links to be more user friendly #10

msorens opened this issue Nov 30, 2015 · 3 comments

Comments

@msorens
Copy link
Contributor

msorens commented Nov 30, 2015

I have yet to find any related links in standard .NET cmdlets that are not links to other PowerShell topics, but at least XmlDoc2CmdletDoc provides support for standard web links as well. The issue, though, is just the output rendering. Say you have two links, one a web link and one a plain link:

/// <para type="link" uri="http://tempuri.org">My Web Page</para>
/// <para type="link">about_Gizmos</para>

They will render as:

My Web Page http://tempuri.org
about_Gizmos

The web link is technically correct but hard to visually discern the parts. It would be easier on the user--as well as allow for easier post-processing should the occasion arise--if the output was in standard markdown format, clearly delineating what is attached to the link:

[My Web Page](http://tempuri.org)
about_Gizmos

My recommendation then is: if the link is recognized as a weblink in GetCommandRelatedLinksElement() then output it in markdown format as shown; otherwise output it "as is".

@ChrisLambrou
Copy link
Contributor

Perhaps we could do this for all links, wherever they occur?

@msorens
Copy link
Contributor Author

msorens commented Nov 30, 2015

By all means, Chris, I like that idea!

@ChrisLambrou
Copy link
Contributor

Actually, now I think about it, I don't think there are any other places where we can derive both a url and meaningful link text. D'oh!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants