-
Notifications
You must be signed in to change notification settings - Fork 41
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
Uri clarification #2531
Uri clarification #2531
Conversation
Note that "fragment identifier" is the technical name for the id following # https://en.wikipedia.org/wiki/Fragment_identifier Whereas anchor is the anchor-point in the hypertext: https://en.wikipedia.org/wiki/HTML_element#Anchor Closes modelica#2445
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems to be according to decision.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we standardize it the other way round? That is
- anchors are possible
- we have the four predefined anchors for info etc
- renaming can be applied to avoid collisions
Doesn't sound like a bad idea, so if we don't do it this time, we can keep it in mind when working on the new Modelica URI design (#2387). |
Lower case Co-Authored-By: Dietmar Winkler <dietmar.winkler@dwe.no>
Ok, but I found it confusing that we discuss "Modelica" scheme and then use "modelica://".
|
I find it similar to HTTP using the |
We should follow the RFC 3986 Scheme which clearly states:
So really discourage the use of |
Ok, I see the point, and tried to rephrase it a bit. |
chapters/annotations.tex
Outdated
the HTML link command using scheme \lstinline!Modelica!, e.g., | ||
\begin{lstlisting}[language=modelica] | ||
<a href="modelica://MultiBody.Tutorial">MultiBody.Tutorial</a> | ||
\end{lstlisting} | ||
\begin{nonnormative} | ||
The name of the scheme is case-insensitive, but the lower-case variant (in this case "modelica") is recommended. | ||
\end{nonnormative} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This still looks to me as if we are giving the same rule in two different places. I suggest that we make the recommendation in autoref{external-resources}
normative, and add a reference to this rule in the current context instead of repeating the rule:
Using scheme \lstinline!Modelica! (using its lower case form in the URI, see \autoref{external-resources}), e.g.,
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great.
Allow user defined fragments, and state that they may be renamed.
Closes #2445