Skip to content

Commit 32686a0

Browse files
committed
Update doc
1 parent 04c9626 commit 32686a0

File tree

1 file changed

+22
-23
lines changed

1 file changed

+22
-23
lines changed

README.md

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Introducing the ElasticSearch View Plugin
22

3-
Elasticsearch provides a fast and simple way to retrieve a document with the [GET API](http://www.elasticsearch.org/guide/reference/api/get.html).
3+
Elasticsearch provides a fast and simple way to retrieve a document with the [GET API](http://www.elasticsearch.org/guide/reference/api/get.html):
44
```
55
curl -XGET 'http://localhost:9200/catalog/product/1'
66
```
@@ -22,34 +22,33 @@ Until now, this API only allows to get the document in JSON format:
2222
}
2323
```
2424

25-
Although this format is really useful, it is not directly presentable to a final user. It is more dedicated to
26-
applications which are in charge of the
27-
The goal of these applications is to generate a graphic result of one or more documents for instance on HTML page. They need a specific executive environment (...) which is necessary to install, configure and maintain. as well as regular deliveries of the application when the graphic content of one document is modified.
25+
Although this format is really useful, it is not directly presentable to a final user. The JSON format is more dedicated
26+
to be used by third party applications located at client or server side. These applications are in charge of
27+
parsing the JSON content, extracting meaningful data and rendering them in a more graphical way, for instance within a
28+
HTML page. With ElasticSearch, anyone who wants to have a graphical rendering of these documents shall install, configure
29+
and maintain such an application, which can become quite complex and require regular redelivery every time the graphic
30+
content of a document is modified
2831

29-
Bien que très pratique, ce format n'est pas directement présentable à un utilisateur final. Il est plutot destiné à être
30-
exploité par des applications tierces dont le rôle est de générer un rendu graphique d'un ou plusieurs documents, par
31-
exemple sur une page HTML. Ces applications tierces nécessitent un environnement d'exécution dédié (serveur
32-
d'application JEE, serveur Apache/IIS etc) qu'il faut installer, configurer et maintenir, ainsi que des livraisons
33-
régulières de l'application lorsque le rendu graphique d'un document est modifié.
32+
The ElasticSearch View Plugin can be used when you don't want to develop a dedicated application or when you wish to
33+
control not only the document searches but also the way the document are displayed.
3434

35-
Lorsqu'il n'est pas souhaitable d'utiliser une telle application, ou lorsque l'on souhaite contrôler non seulement les
36-
recherches de documents mais aussi leur rendu graphique, il est possible d'utiliser le plugin "ElasticSearch View Plugin".
35+
This plugin allows to create views using different templating engines (for now [MVEL](http://mvel.codehaus.org/MVEL+2.0+Basic+Templating)
36+
and [Mustache](http://mustache.github.com/) can be used) in order to generate a HTML (or XML, or anything
37+
which is text) display of your document and access to it threw an URL.
3738

38-
Ce plugin permet de créer des vues en utilisant différents systèmes de templates (actuellement MVEL et Mustache sont
39-
supportés) afin de générer des rendus HTML (ou XML, Markdown ou n'importe quoi tant que c'est du texte) et d'y accéder
40-
par une simple URL.
39+
For example, the plugin can be used to generate a HTML page that displays our product:
40+
http://localhost:9200/_view/catalog/product/1
4141

42-
Par exemple, pour accéder à un rendu HTML de notre produit:
43-
````
44-
````
45-
46-
(exemple HTML)
42+
![HTML view of document #1](https://raw.github.com/tlrx/elasticsearch-view-plugin/gh-pages/samples/render_html.png)
4743

48-
Le plugin permet aussi de créer plusieurs formats de vue pour un même type de document, éventuellement basé sur des
49-
scripts prédéfinis, ou encore de créer une vue sur-mesure pour afficher le résultat de l'exécution de requêtes:
44+
The plugin can also be used to create several formats of views for a same type of document, if necessary with the help of
45+
predefined scripts. It can also be used to generate a specific view to show the results of predefined search queries:
5046

51-
(exemple HTML).
47+
http://localhost:9200/_view/web/pages/home
48+
![HTML view of document #1](https://raw.github.com/tlrx/elasticsearch-view-plugin/gh-pages/samples/render_html_list_brand.png)
5249

50+
In this article, we explain how to install and configure the ElasticSearch View Plugin in order to generate HTML and XML
51+
views of documents indexed in ElasticSearch.
5352

5453

5554
## Installing the plugin
@@ -247,7 +246,7 @@ Preloaded templates are great candidates for code o text that are used in mulitp
247246
## Creating complete views from queries
248247

249248
The plugin allows to create custom views from query hits. Everytime such a view is requested, a set of predefined queries
250-
are executed and the results are used to create the view. Such views are stored in ElasticSearch as documents.
249+
are executed and the results are used to create the view. Such views are stored in ElasticSearch as standard documents.
251250

252251
This kind of view is really powerful and are a simple way to create complete web pages.
253252

0 commit comments

Comments
 (0)