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

Incorrect root page link for 'Modelica Standard Library' #49

Open
henrikt-ma opened this issue Oct 23, 2023 · 13 comments
Open

Incorrect root page link for 'Modelica Standard Library' #49

henrikt-ma opened this issue Oct 23, 2023 · 13 comments

Comments

@henrikt-ma
Copy link
Contributor

The link here is the same as the link for Modelica Libraries, and needs to be fixed:

<a class="btn btn-lg btn-outline-primary text-nowrap" href="/libraries/"><i class="fa-solid fa-toolbox me-2"></i>Modelica Standard Library</a>

@HansOlsson
Copy link
Contributor

To me the problem seems to be more fundamental:
We don't have a web-page for the Modelica Standard Library.

One possibility would be linking directly to doc.modelica.org or (better) https://doc.modelica.org/Modelica%204.0.0/Resources/helpDymola/Modelica_UsersGuide.html#Modelica.UsersGuide.Overview - but I don't think that overview is an ideal overview for newcomers.

@dietmarw
Copy link
Member

Why not simply linking to the main page https://doc.modelica.org/Modelica%204.0.0/Resources/helpDymola/Modelica.html ?

@henrikt-ma
Copy link
Contributor Author

It is also not ideal to link to a tool-specific page.

@beutlich
Copy link
Member

beutlich commented Mar 16, 2024

One possibility would be linking directly to doc.modelica.org

Yes, that is the current landing page for MSL, see modelica/ModelicaStandardLibrary#3287.

If you prefer, it can be renamed to library.modelica.org to be consistent with specification.modelica.org.

@henrikt-ma
Copy link
Contributor Author

It doesn't make sense to rename it library.modelica.org as long as the first part of the page is Modelica Specification.

It would be nice if https://doc.modelica.org/Modelica%204.0.0/ was a tool-independent landing page for the library. Then this would also be what the Modelica Standard Library Documentation section of https://doc.modelica.org should point to (independently of tool selected in the menu). The menus for selecting library version and tool would then make more sense at the library landing page, and at library.modelica.org I would suggest that we omit the library selection menu, and instead have a section called Library Documentation where there is a table with links to the landing page for each library.

@beutlich
Copy link
Member

It doesn't make sense to rename it library.modelica.org as long as the first part of the page is Modelica Specification.

Guess what, this shall be removed then. doc.modelica.org is legacy in that sense that it both refers to library doc and specification.modelica.org.

@henrikt-ma
Copy link
Contributor Author

Remove the section or the entire page? What would be the problem with a common landing page with sections both for specification and each of the libraries?

@beutlich
Copy link
Member

Hm, I thought this ticket is about a landing page for MSL alone.

I am in favour of having one (and tool-independent) MSL documentation page.

@dzimmer
Copy link
Contributor

dzimmer commented Jul 3, 2024

This ticket was originally about fixing a link.

I agree with @dietmarw. We shall simply link to the best page that we currently have and that seems:
https://doc.modelica.org/Modelica%204.0.0/Resources/helpDymola/Modelica.html

That it was generated by a specific tool, is not so relevant here. The content is tool-independent.
We can still change the link, once we have a better page to link to.

@henrikt-ma
Copy link
Contributor Author

Please make sure there is an issue about creating a better landing page before this is closed.

@casella
Copy link

casella commented Aug 5, 2024

I am in favour of having one (and tool-independent) MSL documentation page.

I agree. Of course we will have to use one specific tool to actually generate the content, but that should be inessential in how we present it..

@henrikt-ma
Copy link
Contributor Author

The landing page should not be generated by any Modelica tool. The page have an official MA look, and provide links to generated MSL documentation for any tool that wants presence on this page.

@beutlich
Copy link
Member

beutlich commented Aug 5, 2024

Meanwhile, the reference to 'Modelica Standard Library' got removed entirely by 279e673.

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

6 participants