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

Link elements to documentation pages #2

Open
naturallymitchell opened this issue Oct 17, 2017 · 2 comments
Open

Link elements to documentation pages #2

naturallymitchell opened this issue Oct 17, 2017 · 2 comments

Comments

@naturallymitchell
Copy link

When generating an svg image as part of a handbook, it would be really nice to deep link into the handbook from the source code diagram elements.

@adjivas
Copy link
Owner

adjivas commented Oct 23, 2017

@mitchtbaum: There are two limitations:

digraph ml {
    ndRelation[URL="https://adjivas.github.io/ml/mml/core/item/relation/enum.Relation.html", label="{<<<Enumeration>>>\nRelation|Association\nAggregation\nComposition\nRealization\nDependency\nNone|+ as_style(&self) -> ArrowShape}"][shape="record"];
}
  • The dot crates not implement the URL attribute.

And a question: this rust's comment //! ![uml](ml.svg) is translated by the rustdoc project into <img src="ml.svg" alt="uml">, both text and link from an img's tag are unelectable.

adjivas added a commit that referenced this issue Oct 23, 2017
@naturallymitchell
Copy link
Author

@adjivas: dot's limits prompted me to open #5 as a way around rust-dot, then seeing this SVG Comparison of Pyramids now lead me to believe that dot only helps with one group of side use cases and that SVG fits the primary use case, documentation. If generating it using an intermediary diagramming/graphing library still makes the most sense, then I believe Dia has the expressiveness and interfaces needed.

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