search

modelica / www.modelica.org

The Modelica Association/Language/Library website
https://modelica.org
2 stars 23 forks source link

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

Open henrikt-ma opened 9 months ago

henrikt-ma commented 9 months ago

The link here is the same as the link for Modelica Libraries, and needs to be fixed: https://github.com/modelica/www.modelica.org/blob/3f2aa3a2a40fc7d421d296c501a9a61ee97f285d/content/_index.html#L30

HansOlsson commented 8 months ago

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 commented 8 months ago

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

henrikt-ma commented 8 months ago

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

beutlich commented 4 months ago

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

Yes, that is the current landing page for MSL, see https://github.com/modelica/ModelicaStandardLibrary/issues/3287.

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

henrikt-ma commented 4 months ago

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 commented 4 months ago

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 commented 4 months ago

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 commented 4 months ago

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 commented 2 weeks ago

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.