Comments (11)
MSL documentation is online, but not on modelica.org or svn.modelica.org from what I can tell.
https://rawgithub.com/modelica/Modelica/release/Modelica%203.2.1/Resources/help/index.html
https://build.openmodelica.org/Documentation/Modelica.html
I am sure Dietmar could unzip part of the release and keep it on modelica.org...
As for the specification. It is still in Word format. It really could use some nice text-based book formatting language that can be translated to multiple formats...
from modelicabook.
Two points. First, I think it is important to host on modelica.org (and keep it maintained). Second, I'm thinking that it would be good to use some redirections here. For example, with the specification it would be really nice if the URL I described redirected to something like:
https://www.modelica.org/documents/ModelicaSpec33.pdf#page=221&zoom=auto,0,191
from modelicabook.
There is a problem with that. If you disable pdf plugins in your browser or it doesn't support bookmarks like that, you won't have any use for links to a specific page of a pdf (was introduced in Acrobat 7).
Having the spec as html would be much nicer because then I could google the specification instead of try to search for text in pdf (which doesn't work as well as one would hope sometimes).
from modelicabook.
Spec in HTML would be huge (ideally via docbook). But we don't have that and I cannot imagine getting people to agree to that.
If you disable that support in your browser, then we would indeed be stuck. But the user can control that at least.
from modelicabook.
One other problem I find with the page links appending a link to a PDF is that the whole PDF gets downloaded each time even if the PDF is already present and opened. So having it as HTML would really be better. Since I don't see a near future switch to DocBook or similar we might refresh the discussion by saying that the Spec should not just be published as PDF but also as HTML. I mean Word can export HTML right (even though it would not be a perfect HTML but something that we could work with).
from modelicabook.
I looked into what LibreOffice+tidy would create: spec 3.3r1 html
It's only sort of readable, but it beats pdf. The images are embedded instead of separate, which is mildly annoying. The anchors would need to be renamed in some post-processing to have user-friendly names like section-1.4
. Writing the whole thing in docbook or so would be nicer though (text-based diffs from svn so you can see what changes people made).
from modelicabook.
The HTML documentation of the Standard library is available here (I think @dietmarw put it online?):
https://modelica.github.io/Modelica/
https://github.com/modelica/Modelica
@sjoelund has first rst version of the language specification
https://github.com/sjoelund/MLS-rst-spec
https://modelica.readthedocs.org/en/latest/
from modelicabook.
Possibly relevant here, too:
http://stackoverflow.com/a/125650/874701
Instead of linking to pdf pages, it is also possible to link to named destinations like section.17.1 if such named destinations are present in the pdf. Currently, the pdfs from modlica.org do not have such named destinations.
from modelicabook.
There has been considerable discussion about trying to change the way the specification is developed to support this kind of linking. No actually decisions as of yet though.
from modelicabook.
Long discussion indeed, tried to add my 2 cents to it.
I hope the rst or markdwon people win. :-)
from modelicabook.
Spec in HTML would be huge
It is here: https://specification.modelica.org/v3.4/MLS.html
But only v3.4 is available as HTML, which also would require to update the book to that version, see e.g., #401.
from modelicabook.
Related Issues (20)
- broken link to references HOT 1
- Library version has not been updated since 0.5.0 HOT 3
- https://mbe.modelica.university/behavior/functions/func_def/CallingFunctions HOT 1
- Update ModelicaByExample to MSL v4.0.0? HOT 2
- this video is unavailable HOT 2
- InverseQuadratic is wrong
- Mismatch between code block and text in Non-Linearities
- Example of 2nd order derivative annotation is wrong
- Example accesses protected element
- Wrong units in Rod_ForLoop HOT 2
- Wrong in the surface area of each section
- OnOffControl access to commanded setpoint.
- Unit issue in EvaluationTest1 and Differentiation2
- Strange Header Size HOT 1
- Plot Lines Obscured HOT 4
- Change in Equilibrium Solutions HOT 3
- Missing Units HOT 6
- Missing Signal
- Strange spikes HOT 1
- mbe.modelica.university appears to be down HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from modelicabook.