ISTEX - Demonstrateur

diff --git a/.gitignore b/.gitignore index c5d12c9..cb1f751 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,4 @@ node_modules /nbproject +js/parameters.json +js/parameters.js \ No newline at end of file diff --git a/index.html b/index.html index 588ece4..f901324 100644 --- a/index.html +++ b/index.html @@ -7,479 +7,477 @@ - + - - - - ISTEX - Demonstrateur - - + + + + ISTEX - Demonstrateur + + - - - - - + + + + + - - - - - + + + + + - - + + -

+

-

-

-

-

-

-

+

+

+

+

+

+

- - -

-

-

-

- -

+ + +
+
+
+
+ +
Bienvenue sur le démonstrateur de l'API ISTEX!
-
-
-
Avant toute chose, ce site ne constitue pas une portail sur l'API. Il s'agit ici de montrer les différents aspects de l'API ISTEX. Le corps du site peut cependant être matière de base à la construction d'un portail. Le code sera bientôt disponible publiquement.
-
- Pour effectuer une recherche : -
-
- -
Entrer votre requête simplement dans le champs "Titre ou mot clef". La recherche se lance dès que ce champ est renseigné. Vous pouvez également sélectionner "Recherche avancée" pour mieux préciser votre recherche. Il est dans ce cas nécessaire de cliquer sur l'icone en forme de loupe pour démarrer la recherche.
-
- Pour comprendre comment ces résultats sont obtenus : -
-
- -
Une fois la requête effectuée, il est possible de consulter la réponse brute fournie par l'API en cliquant sur le bouton correspondant. La requête envoyée est également visible à gauche du bouton précédent.
-
-
Pour toute aide supplémentaire ou suggestion, vous pouvez nous écrire à istex@inist.fr (lien disponible en bas de page).
-
-
- +
+
+
Avant toute chose, ce site ne constitue pas une portail sur l'API. Il s'agit ici de montrer les différents aspects de l'API ISTEX. Le corps du site peut cependant être matière de base à la construction d'un portail. Le code sera bientôt disponible publiquement.
+
+ Pour effectuer une recherche : +
+
+ +
Entrer votre requête simplement dans le champs "Titre ou mot clef". La recherche se lance dès que ce champ est renseigné. Vous pouvez également sélectionner "Recherche avancée" pour mieux préciser votre recherche. Il est dans ce cas nécessaire de cliquer sur l'icone en forme de loupe pour démarrer la recherche.
+
+ Pour comprendre comment ces résultats sont obtenus : +
+
+ +
Une fois la requête effectuée, il est possible de consulter la réponse brute fournie par l'API en cliquant sur le bouton correspondant. La requête envoyée est également visible à gauche du bouton précédent.
+
+
Pour toute aide supplémentaire ou suggestion, vous pouvez nous écrire à istex@inist.fr (lien disponible en bas de page).
+
+
+ +

+

-

+

+

-

-

- -

-

- - + -

+

-

-

-

- Requête - +

+

+

+ Requête + - + -

- -

-

- -

- + + -

-

+

+

-

+

Affiner les résultats

-

+

-

-

-

+
+
+
Corpus
-
-
-
-
+
+
+
+
+

-
-
-
Corpus
-
Cette facette permet de préciser le corpus éditeur sur lequel porte la requête.
-
Les choix proposés par les facettes dépendent de vos critères de recherche et de recherche avancée
-
-
+
+
Corpus
+
Cette facette permet de préciser le corpus éditeur sur lequel porte la requête.
+
Les choix proposés par les facettes dépendent de vos critères de recherche et de recherche avancée
+
+
ISTEX API Documentation:
-
-
- +
+
+ Recherche par corpus -
-
- +
+
+ Facettes -
-
- +
+
+ Liste des éditeurs disponible via l'API -
-
-
-
-
-
Morceau de la requête généré par la facette:
-
- -
+ + +
+
+
+
Morceau de la requête généré par la facette:
+
+ +
+

-
-
-
-
+
+
+
Copyright -
-
-
-
-
- Entre : - -
-

-
-
-
Copyright
-
Cette facette permet de préciser la période de copyright sur laquelle porte la requête.
-
Les choix proposés par les facettes dépendent de vos critères de recherche et de recherche avancée
-
-
+
+
+
+ Entre : + +
+
+
+
+
+
Copyright
+
Cette facette permet de préciser la période de copyright sur laquelle porte la requête.
+
Les choix proposés par les facettes dépendent de vos critères de recherche et de recherche avancée
+
+
ISTEX API Documentation:
-
-
- +
+
+ Facettes -
-
-
-
-
-
Morceau de la requête généré par la facette:
-
- -
+ + +
+
+
+
Morceau de la requête généré par la facette:
+
+ +
+

-
-
-
-
+
+
+
Publication -
-
-
-
-
- Entre : - -
-

-
-
-
Publication
-
Cette facette permet de préciser la période de publication sur laquelle porte la requête.
-
Les choix proposés par les facettes dépendent de vos critères de recherche et de recherche avancée
-
-
+
+
+
+ Entre : + +
+
+
+
+
+
Publication
+
Cette facette permet de préciser la période de publication sur laquelle porte la requête.
+
Les choix proposés par les facettes dépendent de vos critères de recherche et de recherche avancée
+
+
ISTEX API Documentation:
-
-
- +
+
+ Facettes -
-
-
-
-
-
Morceau de la requête généré par la facette:
-
- -
+ + +
+
+
+
Morceau de la requête généré par la facette:
+
+ +
+

-

@@ -526,278 +524,278 @@ Catégorie(s) WOS
-
-
-
-
+
+
+
+
+

-
-
-
Catégorie(s) WOS
-
Cette facette permet de préciser la catégorie Web Of Science (WOS) sur laquelle porte la requête.
-
Les choix proposés par les facettes dépendent de vos critères de recherche et de recherche avancée
-
-
+
+
Catégorie(s) WOS
+
Cette facette permet de préciser la catégorie Web Of Science (WOS) sur laquelle porte la requête.
+
Les choix proposés par les facettes dépendent de vos critères de recherche et de recherche avancée
+
+
ISTEX API Documentation:
-
-
- +
+
+ Facettes -
-
-
+
+
+
Liens externes:
-
-
- +
+
+ Site officiel du Web Of Science -
-
- +
+
+ Web Of Science sur Wikipédia -
-
-
-
-
-
Morceau de la requête généré par la facette:
-
- -
+ + +
+
+
+
Morceau de la requête généré par la facette:
+
+ +
+

-
-
-
-
+
+
+
Qualité
-
-
-
- -
-
Score
-
- Entre : - -
-
-
- -
-
Nombre de mots
-
- Entre : - -
-
-
- -
-
Nombre de caractères
-
- Entre : - -
-
-
- -
-
Version du PDF
-
-
-
-
-
- -
-
Références bibliographiques natives
-
-
-
-
-
-
-
-
-
Qualité
-
Cet ensemble de facettes permet de préciser la qualité du document souhaitée sur laquelle porte la requête. La qualité porte sur le nombre de mots et de caractères dans le texte, ou sur la version du PDF proposé par l'éditeur.
-
Les choix proposés par les facettes dépendent de vos critères de recherche et de recherche avancée
-
-
+
+
+ +
+
Score
+
+ Entre : + +
+
+
+ +
+
Nombre de mots
+
+ Entre : + +
+
+
+ +
+
Nombre de caractères
+
+ Entre : + +
+
+
+ +
+
Version du PDF
+
+
+
+
+
+ +
+
Références bibliographiques natives
+
+
+
+
+
+ +
+
+
+
Qualité
+
Cet ensemble de facettes permet de préciser la qualité du document souhaitée sur laquelle porte la requête. La qualité porte sur le nombre de mots et de caractères dans le texte, ou sur la version du PDF proposé par l'éditeur.
+
Les choix proposés par les facettes dépendent de vos critères de recherche et de recherche avancée
+
+
ISTEX API Documentation:
-
-
- +
+
+ Facettes -
-
-
-
-
-
Morceau de la requête généré par la facette:
-
- -
+ + +
+
+
+
Morceau de la requête généré par la facette:
+
+ +
+

+
- +
- -
- + -
- - - -
- +
+ + + + - - - -
+ Résultats obtenus : en ms -
-
-
Stats
-
Des statistiques sur le resultat de la requête à l'API Istex peuvent êtres obtenus.
-
-
-
Morceau de la requête:
-
- &stats -
-
-
-
- - - - - -
-
- ⇤ -
-
Première page
-
Le lien firstPageURI dans la réponse de l'API permet d'accéder à la première page des résultats de la requête : firstPageURI: -
-
- ⇠ -
-
Page précédente
-
Le lien prevPageURI dans la réponse de l'API permet d'accéder à la page précédente des résultats de la requête : prevPageURI: -
-
- ⇢ -
-
Page suivante
-
Le lien nextPageURI dans la réponse de l'API permet d'accéder à la page suivante des résultats de la requête : nextPageURI: -
-
- ⇥ -
-
Dernière page
-
Le lien lastPageURI dans la réponse de l'API permet d'accéder à la dernière page des résultats de la requête : lastPageURI: -
-
-
-
- -
-
-
- / - -
-
-
-
- -
-
- -
- Site officiel du projet : - www.istex.fr - -
- - - - - -
- +

-
Pour toute suggestion, vous pouvez nous - écrire ici -
- Favicon réalisé par Freepik sous licence CC BY 3.0 +
+ + +
+
+ ⇤ +
+
Première page
+
Le lien firstPageURI dans la réponse de l'API permet d'accéder à la première page des résultats de la requête : firstPageURI: +
+
+ ⇠ +
+
Page précédente
+
Le lien prevPageURI dans la réponse de l'API permet d'accéder à la page précédente des résultats de la requête : prevPageURI: +
+
+ ⇢ +
+
Page suivante
+
Le lien nextPageURI dans la réponse de l'API permet d'accéder à la page suivante des résultats de la requête : nextPageURI: +
+
+ ⇥ +
+
Dernière page
+
Le lien lastPageURI dans la réponse de l'API permet d'accéder à la dernière page des résultats de la requête : lastPageURI: +

- +
+
+ +
+ Site officiel du projet : + www.istex.fr + +
+ + + + + +
+ +
+ +
Pour toute suggestion, vous pouvez nous + écrire ici +
+ Favicon réalisé par Freepik sous licence CC BY 3.0 +
+
+
+ + + +
+ + + + + + + + + + + + +
- - - - - - - - - - - - - -
- + \ No newline at end of file diff --git a/js/conf.js b/js/conf.js deleted file mode 100644 index e3766ad..0000000 --- a/js/conf.js +++ /dev/null @@ -1,9 +0,0 @@ -/** - * Created with IntelliJ IDEA. - * User: billey - * Date: 19/02/14 - * Time: 16:11. - / -define({ - apiUrl: "https://api.istex.fr/" -}); diff --git a/js/config.js b/js/config.js new file mode 100644 index 0000000..1c86b08 --- /dev/null +++ b/js/config.js @@ -0,0 +1,5 @@ +define(["js/parameters.js"], function(parameters){ + return { + apiUrl: parameters[parameters.default_api_url] + }; +}); \ No newline at end of file diff --git a/js/controllers/searchPageController.js b/js/controllers/searchPageController.js index 6d3ec92..3692e7a 100644 --- a/js/controllers/searchPageController.js +++ b/js/controllers/searchPageController.js @@ -1,14 +1,20 @@ /global jquery: true, angular: true, $: true, define: true / /jslint node: true, browser: true, unparam: true / /jslint indent: 2 / -define(["../models/searchPage", "../conf", "../vendor/mustache", "../vendor/jsonview/jquery.jsonview.js"], function(searchPage, conf, mustache) { +define(["js/models/searchPage", "js/config", "js/vendor/mustache", "js/vendor/jsonview/jquery.jsonview.js"], function(searchPage, config, mustache) { "use strict"; - var searchPageController = {}; - var timeStamp = null; + var searchPageController = {}, + timeStamp = null, + ctrlScope; + // On récupére le scope du controleur Angular + if (angular) { + ctrlScope = angular.element('[ng-controller=istexAppCtrl]').scope(); + } + ctrlScope.helper.apiUrl = config.apiUrl; (function() { var err = $.ajax({ - url: conf.apiUrl + "corpus", + url: config.apiUrl + "corpus", dataType: "jsonp", success: function(data, status, xhr) { var corpusTemplate = "{{#corpusList}}{{/corpusList}}", @@ -321,6 +327,7 @@ "
{{#lang}}{{key}}{{/lang}}" + "{{docCount}}
{{/aggregations.language.buckets}}"; + $('#nbLangFacet').text(data.aggregations.language.buckets.length); $('#facetLang').append(mustache.to_html(template, data)); if (data.aggregations.language.buckets.length === 1) { @@ -333,6 +340,7 @@ "
{{key}}" + "{{docCount}}
{{/aggregations.wos.buckets}}"; + $('#nbWOSFacet').text(data.aggregations.wos.buckets.length); $('#facetWos').append(mustache.to_html(template, data)); if (data.aggregations.wos.buckets.length === 1) { @@ -342,7 +350,6 @@ // ScoreFacet searchPageController.displayRanges(data, "score", "#slider-range-score", "#amountScore", '', 'float'); - // CopyrightDateFacet searchPageController.displayRanges(data, "copyrightDate", "#slider-range-copyright", "#amountCopyrightDate", '#nbCopyrightFacet', 'integer'); // PubDateFacet @@ -383,7 +390,7 @@ var query = "document/?q=", fields = [], - ctrlScope, + // ctrlScope, minCopyright, maxCopyright, minPubdate, @@ -399,10 +406,6 @@ facetQuery, softHyphen; - // On récupére le scope du controleur Angular - if (angular) { - ctrlScope = angular.element('[ng-controller=istexAppCtrl]').scope(); - } if (searchPage.searchField) { ctrlScope.helper.searchKeys.query = "q=" + searchPage.searchField; @@ -532,8 +535,8 @@ softHyphen = ""; // Construction du contenu des tooltips (sur plusieurs lignes pour la lisibilité) - var tooltipsContent = "
https://api.istex.fr/document/?" + softHyphen; + - "" + (ctrlScope.helper.searchKeys.query || '') + "" + softHyphen + + var tooltipsContent = "
" + config.apiUrl + "document/?" + softHyphen + + "" + (ctrlScope.helper.searchKeys.query || '') + "" + softHyphen + "" + (ctrlScope.helper.corpus.query || '') + "" + softHyphen + "" + (ctrlScope.helper.copyrightDate.query || '') + "" + softHyphen + "" + (ctrlScope.helper.pubDate.query || '') + "" + softHyphen + @@ -546,7 +549,7 @@ $("#request-tooltip-content").html(tooltipsContent); - searchPageController.request(conf.apiUrl + query); + searchPageController.request(config.apiUrl + query); }; searchPageController.request = function(url) { diff --git a/js/main.js b/js/main.js index 0ed0fcd..510fe29 100755 --- a/js/main.js +++ b/js/main.js @@ -7,7 +7,7 @@ var istexApp = angular.module("istexApp", []); -var search = function(searchPage, searchPageController) { +var search = function (searchPage, searchPageController) { searchPage.reaffine = false; searchPage.currentPage = 1; searchPage.searchField = $("#searchField").val(); @@ -26,8 +26,7 @@ searchPage.language = []; searchPageController.search(); }; - -istexApp.controller("istexAppCtrl", function($scope) { +istexApp.controller("istexAppCtrl", function ($scope, $sce) { $scope.helper = { request: {}, @@ -53,7 +52,7 @@ @param Function fn * @returns null */ - $scope.safeApply = function(fn) { + $scope.safeApply = function (fn) { var phase = this.$root.$$phase; if (phase === "$apply" || phase === "$digest") { if (fn && (typeof fn === "function")) { @@ -64,12 +63,12 @@ } }; globalSearchPageController.a = 3; - $scope.search = function() { + $scope.search = function () { search(globalSearchPage, globalSearchPageController); }; }); -$(document).ready(function() { +$(document).ready(function () { /** * Istex tooltip @@ -77,7 +76,7 @@ * Par défaut le tooltip doit étre le premier element frère 'div.istex-tooltip' * sauf si l'attribut 'data-content-text' est précisé avec un selecteur. */ - $("[data-toggle='istex-tooltip']").each(function() { + $("[data-toggle='istex-tooltip']").each(function () { var $this = $(this), dataTooltipTarget = $this.data("tooltip-target"), $targetElement = dataTooltipTarget ? $this.find(dataTooltipTarget) : $this, @@ -114,9 +113,9 @@ /** * Toolip pour les icons des fichiers */ - $(document).on("resultsLoaded", function(e) { + $(document).on("resultsLoaded", function (e) { - $(".downloadFilesTable").find('a').each(function() { + $(".downloadFilesTable").find('a').each(function () { var $this = $(this), $thisImg = $this.children("img"), mimetype = $thisImg.attr("title"); @@ -155,16 +154,16 @@ // } //}); -require(["js/models/searchPage", "js/controllers/searchPageController"], function(searchPage, searchPageController) { +require(["js/models/searchPage", "js/controllers/searchPageController"], function (searchPage, searchPageController) { globalSearchPage = searchPage; globalSearchPageController = searchPageController; - $("#searchform").submit(function(event) { + $("#searchform").submit(function (event) { event.preventDefault(); search(searchPage, searchPageController); }); - $("#advancedSearchForm input").keypress(function(e) { + $("#advancedSearchForm input").keypress(function (e) { if ((e.which && e.which === 13) || (e.keyCode && e.keyCode === 13)) { $("#searchButton").click(); return false; @@ -173,31 +172,31 @@ return true; }); - $("#prev").click(function(e) { + $("#prev").click(function (e) { e.preventDefault(); searchPage.currentPage = searchPage.currentPage - 1; searchPageController.request($("#prev").attr("href")); }); - $("#first").click(function(e) { + $("#first").click(function (e) { e.preventDefault(); searchPage.currentPage = 1; searchPageController.request($("#first").attr("href")); }); - $("#next").click(function(e) { + $("#next").click(function (e) { e.preventDefault(); searchPage.currentPage = searchPage.currentPage + 1; searchPageController.request($("#next").attr("href")); }); - $("#last").click(function(e) { + $("#last").click(function (e) { e.preventDefault(); searchPage.currentPage = searchPage.numberOfPages; searchPageController.request($("#last").attr("href")); }); - $("#facetCorpus").on("click", "input", function() { + $("#facetCorpus").on("click", "input", function () { searchPage.reaffine = true; if (this.checked) { searchPage.editor.push(this.value); @@ -208,44 +207,44 @@ searchPageController.search(); }); - $("#slider-range-copyright").on("slide", function(event, ui) { + $("#slider-range-copyright").on("slide", function (event, ui) { $("#amountCopyrightDate").val(ui.values[0] + " à " + ui.values[1]); }); - $("#slider-range-copyright").on("slidestop", function(event, ui) { + $("#slider-range-copyright").on("slidestop", function (event, ui) { searchPage.reaffine = true; searchPage.copyrightdate = []; searchPage.copyrightdate.push("[" + ui.values[0] + " TO " + ui.values[1] + "]"); searchPageController.search(); }); - $("#slider-range-pubdate").on("slide", function(event, ui) { + $("#slider-range-pubdate").on("slide", function (event, ui) { $("#amountPubDate").val(ui.values[0] + " à " + ui.values[1]); }); - $("#slider-range-pubdate").on("slidestop", function(event, ui) { + $("#slider-range-pubdate").on("slidestop", function (event, ui) { searchPage.reaffine = true; searchPage.pubdate = []; searchPage.pubdate.push("[" + ui.values[0] + " TO " + ui.values[1] + "]"); searchPageController.search(); }); - $("#slider-range-PDFWordCount").on("slide", function(event, ui) { + $("#slider-range-PDFWordCount").on("slide", function (event, ui) { $("#amountPDFWordCount").val(ui.values[0] + " à " + ui.values[1]); }); - $("#slider-range-PDFWordCount").on("slidestop", function(event, ui) { + $("#slider-range-PDFWordCount").on("slidestop", function (event, ui) { searchPage.reaffine = true; searchPage.PDFWordCount = []; searchPage.PDFWordCount.push("[" + ui.values[0] + " TO " + ui.values[1] + "]"); searchPageController.search(); }); - $("#slider-range-PDFCharCount").on("slide", function(event, ui) { + $("#slider-range-PDFCharCount").on("slide", function (event, ui) { $("#amountPDFCharCount").val(ui.values[0] + " à " + ui.values[1]); }); - $("#slider-range-PDFCharCount").on("slidestop", function(event, ui) { + $("#slider-range-PDFCharCount").on("slidestop", function (event, ui) { searchPage.reaffine = true; searchPage.PDFCharCount = []; searchPage.PDFCharCount.push("[" + ui.values[0] + " TO " + ui.values[1] + "]"); @@ -256,18 +255,18 @@ step: 0.3 }); - $("#slider-range-score").on("slide", function(event, ui) { + $("#slider-range-score").on("slide", function (event, ui) { $("#amountScore").val(ui.values[0] + " à " + ui.values[1]); }); - $("#slider-range-score").on("slidestop", function(event, ui) { + $("#slider-range-score").on("slidestop", function (event, ui) { searchPage.reaffine = true; searchPage.score = []; searchPage.score.push("[" + ui.values[0] + " TO " + ui.values[1] + "]"); searchPageController.search(); }); - $("#facetPDFVersion").on("click", "input", function() { + $("#facetPDFVersion").on("click", "input", function () { searchPage.reaffine = true; if (this.checked) { searchPage.PDFVersion.push(this.value); @@ -278,7 +277,7 @@ searchPageController.search(); }); - $("#facetWos").on("click", "input", function() { + $("#facetWos").on("click", "input", function () { searchPage.reaffine = true; var valueHTML = "\"" + this.value.replace(/"/g, '%22').replace(/&/g, '%26').replace(/ /g, '%20') + "\""; if (this.checked) { @@ -313,7 +312,7 @@ searchPageController.search(); }); - $("button.js-resetFacet").on("click", function(event, ui) { + $("button.js-resetFacet").on("click", function (event, ui) { search(searchPage, searchPageController); }); }); \ No newline at end of file diff --git a/js/parameters.json.dist b/js/parameters.json.dist new file mode 100644 index 0000000..e21f5c4 --- /dev/null +++ b/js/parameters.json.dist @@ -0,0 +1,7 @@ +{ + "prod_api_url": "https://api.istex.fr/", + "dev_api_url": null, + "int_api_url": null, + "local_api_url": null, + "default_api_url": "prod_api_url" +} diff --git a/js/postInstall.js b/js/postInstall.js new file mode 100644 index 0000000..93bedc3 --- /dev/null +++ b/js/postInstall.js @@ -0,0 +1,30 @@ +var fs = require("fs"), + _ = require("lodash") + ; + +fs.readFile("js/parameters.json", function (err, data) { +// if (err) { +// return console.log(err); +// } + + var parameters = JSON.parse(data); + + fs.readFile("js/parameters.json.dist", function (err, data) { + if (err) { + return console.log(err); + } + + var distParameters = JSON.parse(data), + parametersFile + ; + + _.defaults(parameters, distParameters); + parametersFile = "define(" + JSON.stringify(parameters) + ");"; + + fs.writeFile("js/parameters.js", parametersFile, function (err) { + if (err) { + return console.log(err); + } + }); + }); +}); \ No newline at end of file diff --git a/package.json b/package.json index f76e9d2..e84ad5b 100644 --- a/package.json +++ b/package.json @@ -4,12 +4,14 @@ "description": "Démonstrateur Istex", "main": "index.html", "dependencies": { + "lodash": "^3.9.3" }, "devDependencies": { "less": "^2.4.0", "less-plugin-clean-css": "^1.5.0" }, "scripts": { + "postinstall": "node ./js/postInstall.js", "test": "echo \"Error: no test specified\" && exit 1" }, "repository": {