Outils pour utilisateurs

Outils du site


Panneau latéral

public:specs_dev_gwt:api_js_txm

API JS d'appel de commandes TXM

L'API propose d’accéder aux commandes de TXM comme le font les liens internes des pages du portail c'est à dire comme si l'utilisateur cliquait sur un bouton de l'interface (menu contextuel ou toolbar) mais en pré-paramétrant les calculs.

de ce fait, il est possible dans une page du portail de définir, par exemple, sa propre interface de recherche qui ouvre une concordance sur un corpus avec une requête CQL construite.

L'API expose 1 méthode “callTXMCommand” qui prend en entrée un ensemble de clé-valeur transporté dans une chaîne formatée en Json.

Les clés-valeurs sont les même que les liens internes&extrnes et son défini dans le manuel administrateur de portail voir le tableau de la section 1.7 (liens externes) et la section 1.9c (liens internes). Exemple JSon :

{"path":"/TDM80J", "command":"concordance","query":"voyage"}

Exemple basique, d'une interface de recherche :

<html>
<body>
	<script>
	lemmaSearch = function(query) {
		var args = '{"path":"/TDM80J",
							"command":"concordance",
			  				"query":query
						 }'
		callTXMCommand(args);
	}
	</script>
	<!-- function(cmd, path, textid, query, editions, page, wordids, props, login)
	<button onclick="callTXMCommand('concordance', '/GRAAL', '', 'je', '', '', '', 'word', '');">TEST</button>
	 -->
	<form>
	<input id="query">voyage</input>
	<button onclick="lemmaSearch(document.getElementById('query').value);">TEST</button>
	</form>
 
</body>
</html>
public/specs_dev_gwt/api_js_txm.txt · Dernière modification: 2021/11/10 10:48 par matthieu.decorde@ens-lyon.fr