search

modelica / ModelicaStandardLibrary

Free (standard conforming) library to model mechanical (1D/3D), electrical (analog, digital, machines), magnetic, thermal, fluid, control systems and hierarchical state machines. Also numerical functions and functions for strings, files and streams are included.
https://doc.modelica.org
BSD 3-Clause "New" or "Revised" License
456 stars 166 forks source link

Sorting PNG files (figures) in Resources/Images #2695

Open tobolar opened 5 years ago

tobolar commented 5 years ago

There is a convention concerning figures' storage which states that

The PNG files should be placed in a folder which exactly represents the package structure.

(see also Modelica.UsersGuide.Conventions.Documentation.Format.Figures).

According to this, the figures collected in Modelica/Resources/Images/ should be stored appropriately. This is already the case for figures used in Modelica.UsersGuide.Conventions, i.e. there is a directory Modelica/Resources/Images/UsersGuide/Conventions containing corresponding subdirectories.

This concerns in particular the following classes:

Modelica.Blocks

For following blocks, figures originate from the Math library. Thus, no relocation needed here.

Modelica.ComplexBlocks

Figures used in ComplexBlocks originate from Blocks or Math library. Thus, no relocation needed here.

Modelica.StateGraph

Modelica.Electrical

Modelica.Magnetic.FluxTubes

Modelica.Magnetic.FundamentalWave

Modelica.Magnetic.QuasiStatic

Modelica.Mechanics.MultiBody

Modelica.Mechanics.Rotational

Modelica.Mechanics.Translational

Modelica.Fluid

Modelica.Media

Modelica.Math

tobolar commented 4 years ago

@AHaumer @christiankral I'm going to proceed here with Electrical and Magnetic in the next days. In order to omit conflicts please let me know when I could start. Or you can of course fix this issue for those two packages on your own.

dietmarw commented 4 years ago

As far as I can tell there are no more open PRs left that would conflict with changes to be done in Electrical and Magnetic

tobolar commented 4 years ago

You are right. But working on this issue is really time consuming and I will not find time to fix this till MSL 4.0.0 fix.

dietmarw commented 4 years ago

Yes. Hopefully @christiankral and @AHaumer can take care of those.

christiankral commented 4 years ago

OK then. @AHaumer I guess we should always indicate in advance what packages we are working on to avoid redundant work.

beutlich commented 4 years ago

You are right. But working on this issue is really time consuming and I will not find time to fix this till MSL 4.0.0 fix.

Remvong milestone.