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

Online Version implementation #123

Closed
TimShererAtAquent opened this issue Jun 6, 2016 · 5 comments
Closed

Online Version implementation #123

TimShererAtAquent opened this issue Jun 6, 2016 · 5 comments
Assignees
Milestone

Comments

@TimShererAtAquent
Copy link

All topics, for instance, Add-History under Related Links

The Online Version link appears in the Related Links section. According to the PowerShell spec, the -Online switch works by redirecting to the first URL in the Related Topics section. This was handled behind the scenes in Dx, assuring that the first was the link in the list of links.

If people add related topics to the cmdlet in markdown, and if they add them at the top, the -Online switch will go to their new link, not the intended one.

We need to store the online link in the markdown metadata. PlatyPS could check the metadata against the links in the related section (per discussion in today's meeting). If somebody does add a new link over the current links, the MD > MAML conversion could move it back to being first.

(There is also a colon after the words Online Version, which looks bad. I don't know whether it's required by the PS engine, since it appears in the spec.)

@vors
Copy link
Collaborator

vors commented Jun 6, 2016

Ah, thank you for the explanation Tim!
I didn't realise that Get-Help -Online looks for the first link. I though it looks for Online Version: key. Now it start makes more sense. I think it would be best to move it into metadata, indeed.

@vors vors added this to the 0.5.0 milestone Jun 6, 2016
@gerane
Copy link

gerane commented Jun 6, 2016 via email

@vors vors self-assigned this Jun 7, 2016
@vors vors added the schema label Jun 13, 2016
@vors
Copy link
Collaborator

vors commented Jun 13, 2016

Fixed in 00c99ac

@vors vors closed this as completed Jun 13, 2016
@vors
Copy link
Collaborator

vors commented Jun 13, 2016

Forgot to add corresponding logic in markdown generator

@vors vors reopened this Jun 13, 2016
@vors
Copy link
Collaborator

vors commented Jun 13, 2016

Second part fixed via 6534fe3

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

No branches or pull requests

3 participants