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

Uri clarification #2531

Merged
merged 7 commits into from
Mar 19, 2020
Merged

Uri clarification #2531

merged 7 commits into from
Mar 19, 2020

Conversation

HansOlsson
Copy link
Collaborator

Allow user defined fragments, and state that they may be renamed.
Closes #2445

Copy link
Collaborator

@henrikt-ma henrikt-ma left a 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.

chapters/annotations.tex Outdated Show resolved Hide resolved
Copy link
Member

@beutlich beutlich left a 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

@henrikt-ma
Copy link
Collaborator

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).

HansOlsson and others added 2 commits March 17, 2020 11:24
Lower case

Co-Authored-By: Dietmar Winkler <dietmar.winkler@dwe.no>
@HansOlsson
Copy link
Collaborator Author

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).

I agree that the idea from @beutlich is good, but I would prefer to just do the necessary things now, and do that cleanup in #2387

@HansOlsson
Copy link
Collaborator Author

The case insensitivity is already explained in \autoref{external-resources}.

Ok, but I found it confusing that we discuss "Modelica" scheme and then use "modelica://".
I see the following possibilities:

  • Make that parenthesis into non-normative text
  • Revert to using Modelica://
  • (Well, we could change the scheme to "modelica" - but I don't like it.)

@sjoelund
Copy link
Member

I found it confusing that we discuss "Modelica" scheme and then use "modelica://".

I find it similar to HTTP using the http:// scheme.

@dietmarw
Copy link
Member

We should follow the RFC 3986 Scheme which clearly states:

Although schemes are case-insensitive, the canonical form is lowercase and documents that specify schemes must do so with lowercase letters. An implementation should accept uppercase letters as equivalent to lowercase in scheme names (e.g., allow "HTTP" as well as "http") for the sake of robustness but should only produce lowercase scheme names for consistency.

So really discourage the use of Modelica://

@HansOlsson
Copy link
Collaborator Author

So really discourage the use of Modelica://

Ok, I see the point, and tried to rephrase it a bit.

Comment on lines 58 to 64
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}
Copy link
Collaborator

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.,

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok.

Copy link
Collaborator

@henrikt-ma henrikt-ma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great.

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

Successfully merging this pull request may close these issues.

Unspecified HTML anchor in modelica URI needs clarification
6 participants