New module ConsultDoc #13

sophiaab · 2018-06-27T10:51:26Z

Functionnality research, browser OK
Billboard : work in progress

jailln · 2018-06-28T09:33:24Z

Some GUI related comments first:

Document Browser:
- Make it possible to display the browser pane just by checking its check box in the main menu and without having to run a research (to make it possible for users to just navigate through the documents without knowing which documents are stored in the database)
- When a search is issued in the Research pane:
  - Open Document Browser (if not already) with the search results
  - Add a message in the Document Browser such as Documents have been updated according to research criteria
  - Add a button next to the previous message allowing to reset the research (and thus to navigate in all documents of the database from the Document Browser)
- Add a close button similarly to the other modules
- Harmonize the visual appearance of this view (it currently changes when navigating through documents)
- Add numbers allowing to know how many navigable documents there are and which one we are looking at (e.g. 1/4, 2/4, etc.)
Research:
- Please rename 'Referring date start' to 'Start referring date' (same for end date and publication dates)
- Add a close button similarly to the other modules

A few other things:

What is the purpose of DemoController.html (in comparaison to Demo.html for instance ?) ? Do we need to have another Demo ?
Remove billboard related code and GUI elements if not working yet and postpone it to a new pull request (or make it completely work in this PR, depending on the work that still needs to be done on this matter)
Remove unused code related to the old (previous to this PR) organization for Documents handling

I will look deeper in the code after these modifications are ok :)

sophiaab · 2018-06-28T15:07:10Z

About commit 32a66af :
Document Browser:
Close button added
Visual appearance harmonized
Added numbers allowing to know how many navigable documents there are and which one we are looking at (e.g. 1/4, 2/4, etc.)

Research:
Renamed dates
Remove billboard related code and GUI elements

…rameter

sophiaab · 2018-07-02T15:35:02Z

About commits e3d3406 to 5d856f945
don't pay attention
About commit 26d7ea7 :
- Possible to display the browser pane just by checking its check box in the main menu and without having to run a research
- When a search is issued in the Research pane:
  Open Document Browser (if not already) with the search results
- Add close buttons to research window and browser window

jailln · 2018-07-03T08:39:15Z

UDV-Core/examples/Demo.js


+var extendedDocumentModel = {


I think this information should be stored in a config file (possibly shared by server side software components ?). Is this planned for another pull request ?

Information is now stored in examples since it runs for a demonstration. I am not sure it should be shared by server side software components.

jailln · 2018-07-03T08:44:41Z

UDV-Core/examples/Demo.js

-documentController = datDotGUI.add( documents, 'docBrowserWindowIsActive'
-                                    ).name( "Documents" ).listen();
-documentController.onFinishChange( function(value) { documents.toggleDocBrowserWindow(); });
+var billboardOption = documentFolder.add( controller.documentBillboard, 'windowIsActive').name("Billboard(soon)").listen();


Please remove this button for the time being as billboard representation of documents has been postponed to a new pull request.

jailln · 2018-07-03T12:39:46Z

UDV-Core/src/Modules/ConsultDoc/DocumentResearch.js

+            ';
+
+        var optionsFilter = "http://rict.liris.cnrs.fr/optionsFilter.json";
+        var schema = "http://rict.liris.cnrs.fr/schemaType.json";


The number of configuration files is growing up, I think that it could be a good idea to list them (along with their roles) and to provide examples in a dedicated page pointed in the README.md.

The Readme.md is in UDV-Core/src/Modules/ConsultDoc

jailln · 2018-07-03T12:54:34Z

UDV-Core/webpack.config.js

@@ -22,6 +22,10 @@ module.exports = {
    plugins: [
        definePlugin,
        new webpack.optimize.CommonsChunkPlugin({ name: 'udvcore' }),
+        new webpack.ProvidePlugin({


Please add a comment saying that this is related to alpaca

jailln · 2018-07-03T12:54:42Z

UDV-Core/webpack.config.js

@@ -62,4 +66,9 @@ module.exports = {
    devServer: {
        publicPath: '/dist/',
    },
+    resolve: {


Could you add a comment saying that this is related to alpaca.

jailln · 2018-07-03T13:01:42Z

General remark:

This is a first step towards a MVC architecture as the code from the views, the controller and the model are separated in different files for the ConsultDoc module.

However the next step to reach a MVC architecture would be that the views and the model don't know about the controller (which is currently not the case). A way to manage this would be by using events triggered by the views and the model and trapped by the controller. The step after that would be to generalize this approach to the other modules (e.g. temporal) and between modules.

This work is postponed to other pull requests and I will merge this one when the remaining asked modifications are done :)

…examples folder

…logs

jailln · 2018-07-05T13:31:43Z

Two remarks:

If I run a research with Subject:subject 1, the 3 documents are still displayed in the Document Browser when they shoudn't be because from what I can see in the browser they don't have a subject defined. Or maybe they do and then it must be displayed in the Document Browser.
Could you limit / harmonize the size of the pictures of documents in the browser ?

EricBoix

Nice work ! We are almost there for this PR.

EricBoix · 2018-07-05T13:23:11Z

UDV-Core/examples/Demo.html

@@ -13,6 +13,7 @@
    <script src="../node_modules/moment/moment.js"></script>
    <script src="../node_modules/three/build/three.js"></script>
    <script src="../src/Externals/dat.gui/dat.gui.min.js"></script>
+    <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.0/jquery.min.js"></script>


The dependency on Jquery is already expressed (with this PR) in package.json.
The import of Jquery thus doesn't need to depend on on an external server (ajax.googleapis.com) to be active.
Use the "classic" import mechanism to remove that URL (and the dependency towards an active external server as well as the need for IP connectivity).

Created issue #15

EricBoix · 2018-07-05T13:31:39Z

UDV-Core/examples/Demo.js

@@ -125,9 +125,42 @@ var help  = new udvcore.HelpWindow({active:true});
 // FIXME For the time being this demo uses the Vilo3D data. Provide a
 // default document for the demo of DocumentHandler class and place it
 // within src/Modules/Documents...


Remove this comment that was associated with the following documents variable (and the Vilo3D/docs.csv data file).
Instead provide a new comment introducing the DocumentController. In particular explain why the DocumentModel, the researchModel (and OptionsResearch) appear at this level (why place it here and not "inisde" the DocumentController). This will take a couple lines of explanation...

EricBoix · 2018-07-05T13:45:44Z

UDV-Core/examples/Demo.js

+docResearch.onFinishChange(function(value){
+  controller.documentResearch.refresh();
+});
+/*


Remove the following commented out code (that will come in an upcoming different PR).

EricBoix · 2018-07-05T14:30:26Z

UDV-Core/examples/DocumentModel.json

@@ -0,0 +1,82 @@
+{


Would it be possible to regroup DocumentModel.json, optionsFilter.json, and schemaFilters.json within an examples/Document (or Contribute?) sub-directory to indicate they work together ?

For the general demo (with all options / functionnalities), the files are in UDV-Core/examples/data
For the demo regarding consultDoc module, they are in: UDV-Core/src/Modules/ConsultDoc/examples

EricBoix · 2018-07-05T14:45:09Z

UDV-Core/examples/Demo.js

-documentController.onFinishChange( function(value) { documents.toggleDocBrowserWindow(); });
+//Document uses a folder
+var documentFolder = datDotGUI.addFolder("Documents");
+var docResearch = documentFolder.add( controller.documentResearch, 'windowIsActive').name("Research").listen();


Respect the (implicit) coding style and the 80 lines wide constraint.
Manually break (newlines) the lines to make the code more readable !

EricBoix · 2018-07-05T14:46:08Z

UDV-Core/src/Modules/ConsultDoc/DocumentBrowser.js

@@ -0,0 +1,273 @@
+
+import * as THREE from 'three';


Same remark as for Demo.js concerning the lines longer than 80 columns.

Well, many lines still look much longer than 80 columns to me. Am I wrong ?

EricBoix · 2018-07-05T14:58:08Z

UDV-Core/src/Modules/ConsultDoc/DocumentController.js

+{
+
+    this.url = "http://rict.liris.cnrs.fr/APIVilo3D/APIExtendedDocument/web/"; //url of the server handling documents
+    //FIXME: to put in a configuration file of the general application


I just created issue #14 to get this fixed in the next PR.
Issues are much more "sticky" (better reminders) than FIXMEs hidden in the code.

…mo. Code made more readable (breaking lines). Fixed image size in browser

jailln · 2018-07-09T14:01:39Z

Good job; we did it! :)

sophiaab and others added 7 commits June 26, 2018 10:47

new ConsultDoc module

453aa44

first draft DocumentBrowser

ad8d31a

modify DocumentBrowser

160da5a

bug fix DocumentBrowser DocumentResearch

81a7cdc

DocumentsBrowser and DocumentController with comments

0c6eeaa

Views and conttroler are clean. V0

6b464ac

properly reformat consultDoc

c0ee3e8

sophiaab force-pushed the reorg branch from fa6672f to c0ee3e8 Compare June 28, 2018 08:34

sophiaab added 2 commits June 28, 2018 11:48

css for DocumentBrowser

42f6130

GUI related fixes

32a66af

sophiaab added 8 commits June 29, 2018 09:21

DocumentBrowser fixes

14e8264

DocumentBrowser update. DocumentController now has a documentModel pa…

bc916fd

…rameter

delete Document module

433e98c

New folder Extensions to hold Contribute module

e3d3406

Contribute module

856f945

Modify DocumentResearch

5d85658

delete Contribute Module. Fixes in ConsultDoc modules

9250141

Fixes about DocumentBrowser and Research

26d7ea7

just one css for the module

4e61d7f

jailln reviewed Jul 3, 2018

View reviewed changes

sophiaab added 4 commits July 3, 2018 15:59

style fixes in bowser + getDocuments

8a73aed

We are now using a configuration file holding the document model, in …

1d3c20b

…examples folder

Readme.md about configuration files

7131731

modification on example config files and deleted undesirable console.…

f063327

…logs

EricBoix mentioned this pull request Jul 5, 2018

[ConsultDoc] Move hard-wired reference to http data server to configuration file #14

Closed

EricBoix requested changes Jul 5, 2018

View reviewed changes

sophiaab added 5 commits July 6, 2018 12:24

new Folder in examples/ that contains the files related to the new de…

3f7c1dc

…mo. Code made more readable (breaking lines). Fixed image size in browser

moved example files to another folder

bc297c5

removed unnecessary comments

8f25885

remove unused button

961d7a0

browser when research is activated

f7ce824

VCityTeam deleted a comment from sophiaab Jul 9, 2018

sophiaab added 5 commits July 9, 2018 12:34

new demos

bdddb35

modif readme.md

3699b9c

import logo LIRIS IMU

b5ecbe5

remove undesired logs

93487ff

fix lines that were too long

67cc054

EricBoix approved these changes Jul 9, 2018

View reviewed changes

jailln merged commit 64c5d15 into VCityTeam:master Jul 9, 2018

jailln mentioned this pull request Jul 9, 2018

Converge to a true MVC architecture #19

Closed

4 tasks

EricBoix mentioned this pull request Aug 29, 2018

Database physical model for multimedia data VCityTeam/UD-SV#35

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New module ConsultDoc #13

New module ConsultDoc #13

sophiaab commented Jun 27, 2018

jailln commented Jun 28, 2018

sophiaab commented Jun 28, 2018 •

edited

Loading

sophiaab commented Jul 2, 2018

jailln Jul 3, 2018

sophiaab Jul 4, 2018 •

edited

Loading

jailln Jul 3, 2018

sophiaab Jul 9, 2018

jailln Jul 3, 2018

sophiaab Jul 9, 2018

jailln Jul 3, 2018

sophiaab Jul 9, 2018

jailln Jul 3, 2018

sophiaab Jul 9, 2018

jailln commented Jul 3, 2018

jailln commented Jul 5, 2018

EricBoix left a comment

EricBoix Jul 5, 2018

sophiaab Jul 9, 2018

EricBoix Jul 5, 2018

sophiaab Jul 9, 2018

EricBoix Jul 5, 2018

sophiaab Jul 9, 2018

EricBoix Jul 5, 2018

sophiaab Jul 9, 2018

EricBoix Jul 5, 2018

EricBoix Jul 5, 2018

sophiaab Jul 9, 2018

EricBoix Jul 9, 2018

sophiaab Jul 9, 2018

EricBoix Jul 5, 2018

jailln commented Jul 9, 2018

New module ConsultDoc #13

New module ConsultDoc #13

Conversation

sophiaab commented Jun 27, 2018

jailln commented Jun 28, 2018

sophiaab commented Jun 28, 2018 • edited Loading

sophiaab commented Jul 2, 2018

Choose a reason for hiding this comment

sophiaab Jul 4, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jailln commented Jul 3, 2018

jailln commented Jul 5, 2018

EricBoix left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jailln commented Jul 9, 2018

sophiaab commented Jun 28, 2018 •

edited

Loading

sophiaab Jul 4, 2018 •

edited

Loading