[runSofa] improve the html DocBrowser #540

damienmarchal · 2017-12-12T14:02:47Z

Small improvement on the view of html file associated with scenes. We can now navigate (with backward) between and starting Sofa scene directly with hyperlinks. The windows can also be hidden/displayed and its location preserved.

I cannot prevent myself to also clean small things in RealGUI and SetDirectory/FileSystem.
But this is very minor.

I made a quick & dirty video to show the results so that you don't need to compile it:
https://youtu.be/5uumC9f-wzo

This PR:

builds with SUCCESS for all platforms on the CI.
does not generate new warnings.
does not generate new unit test failures.
does not generate new scene test failures.
does not break API compatibility.
is more than 1 week old (or has fast-merge label).

Reviewers will merge only if all these checks are true.

There was one in SetDirectory but I see ne reason to have that here. So for consistency I move it in FileSystem. Backward compatibility is preserved.

…ted by the "static" SceneLoaderFactory.

…ces.

…e moved.

Refactor the way the html documentation associated with Sofa scene are handled. The doc browser now have an history and link to sofa scene are correctly handled to load the sofa scene. This is very practical to make self documenting libraries. The DocBrowser can be displayed from the Help menu.

…ons.

guparan · 2017-12-19T14:17:36Z

It would be nice to have this in v17.12
If [ci-build] is OK, let's merge :-)

guparan · 2017-12-20T09:44:39Z

applications/sofa/gui/qt/GuiDataRepository.cpp

+{
+namespace qt
+{
+    sofa::helper::system::FileRepository GuiDataRepository("RUNSOFA_DATA_PATH", "../share/sofa/runSofa/ressources/");


Why not using current resources dirs (e.g. share/icons)?
BTW, only one S for resources ;-)

Good question.

This is to make things modular as I see no reason why the icons specific to a given end user application (here runSofa) should be in the data directory of the base framework. Said differently, If the user don't care about runSofa (or runSofa2) why its data repository should be polluated by these resources ?

So each project/plugin specific resources should reside in its own directory not in share/

I agree with the modular idea but SofaGuiQt is not runSofa so I think it would better be sofa::helper::system::FileRepository runSofaDataRepository("RUNSOFA_DATA_PATH", "../share/sofa/runSofa/ressources/"); created in applications/projects/runSofa or sofa::helper::system::FileRepository GuiDataRepository("GUI_DATA_PATH", "../share/sofa/gui/ressources/"); in applications/sofa/gui.
What do you think?

Plugins examples...are in the example sub-directory of the plugin directory and not in share.
Icon sets of external UI 'project' (like runSofa2) are in their project directory.
Actually even before this PR the icons of runSofa were not in share but in the runSofa dir...so please don't change that and let's keep a single rule that is clear to understand: specific per 'project' (or 'plugins') files have to stay in their project (plugin) directory.

Yep, that's exactly what I was saying in my second post. So what about my proposal?

Sorry I miss-understood you last comment.

I see no problem in making things more consistent by renaming things as long as the files stays separated from the sofa/share.
Can you do that..caus .I'm focused on something else.

guparan · 2017-12-21T15:31:39Z

[ci-build] (testing)

damienmarchal · 2017-12-21T17:07:36Z

[ci-build][with-scene-tests]

damienmarchal · 2017-12-22T06:47:45Z

[ci-build]

damienmarchal · 2017-12-22T10:25:41Z

[ci-build][with-scene-tests] do you really work ?

guparan · 2017-12-22T10:26:23Z

Yep, I just fixed it ;)

damienmarchal · 2018-01-10T10:38:23Z

[ci-build][with-scene-tests]

Because Sofa is such an HQ software that we cannot live with mispelling in our pathnames ;)

guparan · 2018-01-11T16:08:41Z

[ci-build][with-scene-tests]

damienmarchal · 2018-01-12T08:34:01Z

[ci-build][with-scene-tests]

guparan · 2018-01-12T10:48:06Z

@damienmarchal Did you notice the unit test failures? It's about PSL.

damienmarchal · 2018-01-12T15:30:30Z

@guparan thank you for pointing that.The problem is that the CI machine *_pr3 does not have the python module 'hjson' installed consequently psl tests failed.

EDIT: So you can safely ignore them...& merge the PR.

guparan · 2018-01-12T16:01:58Z

Ok I'm gonna fix that, I'll also fix the missing timeout command on the mac_pr3 VM.

guparan · 2018-01-12T16:41:56Z

Done! [ci-build][with-scene-tests]

damienmarchal · 2018-01-12T18:10:24Z

The fails again... the mac_clang-3.4 succeeded (I restarted but the previous build was here
https://ci.inria.fr/sofa-ci/job/mac_clang-3.4_options_pr3/25/console)
And the additional failure in test scenes is because some machines still don't have the libjpeg/tiff library installed (se macos pr3 ) :)

@guparan, @hugtalbot if you are passing by please considere merging the PR because we need it monday morning for our group writing of tutorials for Sofa :)

damienmarchal added 6 commits December 12, 2017 14:46

[SofaKernel] Adds a getExtension function to FileSystem.

22669ea

There was one in SetDirectory but I see ne reason to have that here. So for consistency I move it in FileSystem. Backward compatibility is preserved.

[SofaKernel] Adds a function to get the list of file extension suppor…

10788a7

…ted by the "static" SceneLoaderFactory.

[runSofa] add a ressources directory to hold runSofa specific data.

7669aa1

[runSofa] Adds a GuiDataRepository to manage runSofa specific ressour…

33c3e24

…ces.

[runSofa] Update GraphiListenerQListView to take into account the fil…

9eeaeff

…e moved.

damienmarchal changed the title ~~[runSofa] add a small doc browser~~ [runSofa] improve the html DocBrowser Dec 12, 2017

[runSofa]: fix typos.

44da70f

damienmarchal added this to the v17.12 milestone Dec 12, 2017

damienmarchal added the enhancement About a possible enhancement label Dec 12, 2017

[SofaKernel] Move some functon from .h to .cpp to avoid extra inclusi…

1fd233d

…ons.

damienmarchal added the pr: status to review To notify reviewers to review this pull-request label Dec 12, 2017

guparan added the project: UX label Dec 20, 2017

guparan reviewed Dec 20, 2017

View reviewed changes

damienmarchal added 2 commits January 9, 2018 23:22

[runSofa] Add a new directory to hold ressources for runSofa.

8dfdcbd

[runSofa] Fix the different ressources files & path.

6de8005

[runSofaHQ] rename ressource into resource

678ba9d

Because Sofa is such an HQ software that we cannot live with mispelling in our pathnames ;)

sofa-framework deleted a comment from damienmarchal Jan 11, 2018

guparan merged commit 691c470 into sofa-framework:master Jan 14, 2018

damienmarchal deleted the addDocBrowser branch February 12, 2018 12:53

hugtalbot added pr: status ready Approved a pull-request, ready to be squashed and removed pr: status to review To notify reviewers to review this pull-request labels May 16, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[runSofa] improve the html DocBrowser #540

[runSofa] improve the html DocBrowser #540

damienmarchal commented Dec 12, 2017 •

edited by guparan

Loading

guparan commented Dec 19, 2017

guparan Dec 20, 2017

damienmarchal Dec 20, 2017 •

edited

Loading

guparan Dec 20, 2017

damienmarchal Dec 21, 2017

guparan Dec 21, 2017

damienmarchal Dec 21, 2017

guparan commented Dec 21, 2017

damienmarchal commented Dec 21, 2017

damienmarchal commented Dec 22, 2017

damienmarchal commented Dec 22, 2017

guparan commented Dec 22, 2017

damienmarchal commented Jan 10, 2018

guparan commented Jan 11, 2018

damienmarchal commented Jan 12, 2018

guparan commented Jan 12, 2018

damienmarchal commented Jan 12, 2018 •

edited

Loading

guparan commented Jan 12, 2018 •

edited

Loading

guparan commented Jan 12, 2018

damienmarchal commented Jan 12, 2018 •

edited

Loading

[runSofa] improve the html DocBrowser #540

[runSofa] improve the html DocBrowser #540

Conversation

damienmarchal commented Dec 12, 2017 • edited by guparan Loading

guparan commented Dec 19, 2017

guparan Dec 20, 2017

Choose a reason for hiding this comment

damienmarchal Dec 20, 2017 • edited Loading

Choose a reason for hiding this comment

guparan Dec 20, 2017

Choose a reason for hiding this comment

damienmarchal Dec 21, 2017

Choose a reason for hiding this comment

guparan Dec 21, 2017

Choose a reason for hiding this comment

damienmarchal Dec 21, 2017

Choose a reason for hiding this comment

guparan commented Dec 21, 2017

damienmarchal commented Dec 21, 2017

damienmarchal commented Dec 22, 2017

damienmarchal commented Dec 22, 2017

guparan commented Dec 22, 2017

damienmarchal commented Jan 10, 2018

guparan commented Jan 11, 2018

damienmarchal commented Jan 12, 2018

guparan commented Jan 12, 2018

damienmarchal commented Jan 12, 2018 • edited Loading

guparan commented Jan 12, 2018 • edited Loading

guparan commented Jan 12, 2018

damienmarchal commented Jan 12, 2018 • edited Loading

damienmarchal commented Dec 12, 2017 •

edited by guparan

Loading

damienmarchal Dec 20, 2017 •

edited

Loading

damienmarchal commented Jan 12, 2018 •

edited

Loading

guparan commented Jan 12, 2018 •

edited

Loading

damienmarchal commented Jan 12, 2018 •

edited

Loading