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

[feature] Hyperlinks to URLs #165

Open
kvid opened this issue Sep 10, 2020 · 0 comments
Open

[feature] Hyperlinks to URLs #165

kvid opened this issue Sep 10, 2020 · 0 comments
Milestone

Comments

@kvid
Copy link
Collaborator

kvid commented Sep 10, 2020

@martonmiklos has created PR #164 to remove HTML links from the input attributes. I like his idea, but I also want to discuss hyperlinks to URLs in general.

The user might want to add hyperlinks to several kinds of external references when documenting a harness:

  • Other documents in the same project.
  • Entries in a part number system.
  • Product pages or main page of manufacturer, supplier, etc.

The different output formats can support hyperlinks in different ways:

It might be possible to specify URLs in at least two ways in the YAML input:

I see no major conflicts between the two alternatives above. The first one supports more than one hyperlink per BOM entry and custom link texts, The second one supports more output formats, and both can be allowed for full flexibility. I therefore suggest accepting PR #164 when it is ready (supporting hyperlinks in the HTML BOM). A new PR can be created to add attributes and supporting more output formats, like #168.

@kvid kvid changed the title Hyperlinks to URLs [feature] Hyperlinks to URLs Sep 10, 2020
@formatc1702 formatc1702 added this to the v0.3 milestone Oct 17, 2020
@formatc1702 formatc1702 modified the milestones: v0.3, v0.4 and later Oct 7, 2021
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

2 participants