added tuto similarity computer

Author: seinecle

docs/index.html

@@ -133,6 +133,14 @@ <h3>English</h3>
                             <a href="generated-pdf/semantic-web-importer-en.pdf">pdf</a>,
                             <a href="https://github.com/seinecle/gephi-tutorials/blob/master/src/main/asciidoc/en/plugins/semantic-web-importer-en.adoc">source</a>)
                         </li>
+                        <li>
+                            A plugin to create a network from a data table in Excel or csv (
+                            <a href="generated-html/similarity-computer-en.html">web</a>,
+                            <a href="generated-slides/similarity-computer-en.html">slides</a>,
+                            <a href="generated-pdf/similarity-computer-en.pdf">pdf</a>,
+                            <a href="https://github.com/seinecle/gephi-tutorials/blob/master/src/main/asciidoc/en/plugins/similarity-computer-en.adoc">source</a>)
+                        </li>
+
                     </ul>
                 </li>
 

pom.xml

@@ -8,7 +8,7 @@
     <version>1.0</version>
     <packaging>jar</packaging>
     <properties>
-        <!--<doc>en/plugins/semantic-web-importer-en.adoc</doc>-->
+        <doc>en/plugins/similarity-computer-en.adoc</doc>
         <medium.publish>false</medium.publish>
     </properties>
     <parent>

src/main/asciidoc/en/plugins/k-partite-bi-partite-graph-en.adoc

@@ -151,7 +151,7 @@ When it’s installed, you should be able to see or display the ** Multimode Net
 
 //ST: !
 
-Then, load the graph and :
+Then, load the graph and:
 
 *   Click on **Load Attributes** and select **Type** on **Attribute Type.**
 *   For left matrix select **Administrator – Company**  and right matrix **Company – Adminstrator**

src/main/asciidoc/en/plugins/semantic-web-importer-en.adoc

@@ -32,7 +32,7 @@ Plugin Author: https://github.com/ErwanDemairy[Erwan Demairy]
 
 Plugin sources: https://scm.gforge.inria.fr/anonscm/git/segviz-public/gephi-plugins.git/[git://scm.gforge.inria.fr/segviz-public/gephi-plugins.git]
 
-Licensed under: Cecill-C
+Licensed under: http://www.cecill.info/licences/Licence_CeCILL-C_V1-en.html[Cecill-C]
 
 
 //ST: Introduction
@@ -100,7 +100,9 @@ image::en/semantic-web-importer/setup_1.png[align="center", title="Setup endpoin
 //ST: !
 
 Go to *Query* tab, remove the dummy query and put this one:
-```
+
+[source,SQL]
+----
 CONSTRUCT{
   ?person <http://gephi.org/type> "person".
   ?movie <http://gephi.org/type> "movie".
@@ -113,7 +115,8 @@ WHERE
  ?movie ?rel2 ?person.
  ?person a <http://dbpedia.org/ontology/Person>.
 }
-```
+----
+
 //ST: !
 
 Finally, click on *Run*

src/main/asciidoc/en/plugins/similarity-computer-en.adoc

@@ -0,0 +1,149 @@
+=  Creating a network from a table of entities and their attributes
+Clément Levallois <clementlevallois@gmail.com>
+2017-02-22
+
+last modified: {docdate}
+
+:icons: font
+:iconsfont:   font-awesome
+:revnumber: 1.0
+:example-caption!:
+ifndef::imagesdir[:imagesdir: ../../images]
+ifndef::sourcedir[:sourcedir: ../../../../main/java]
+
+:title-logo-image: gephi-logo-2010-transparent.png[width="450" align="center"]
+
+image::gephi-logo-2010-transparent.png[width="450" align="center"]
+
+//ST: 'Escape' or 'o' to see all sides, F11 for full screen, 's' for speaker notes
+
+
+== Presentation of the plugin
+//ST: Presentation of the plugin
+
+//ST: !
+
+This plugin is created by https://www.clementlevallois.net[Clement Levallois].
+
+It converts a spreadsheet or a csv file into a network.
+
+//ST: !
+
+This plugin enables you to:
+
+*   Start from a data table in Excel or csv format
+*   In the data table, nodes are the entities listed in column A
+*   Nodes' attributes must be listed in columns B, C, D, etc.
+*   Connections will be created between nodes, when they have identical attributes.
+*   Attributes can have values, stored in columns right next to the attribute.
+
+//ST: !
+==== 1. The input
+//ST: !
+
+image::https://docs.google.com/drawings/d/1TkShesrj6PsObLdj3fCMLScxTXJgopxTEICPv8CPd4Y/pub?w=840&h=887[align="center", title="An Excel file"]
+
+
+//ST: !
+==== 2. The output
+//ST: !
+
+image::en/similarity-computer/result.png[align="center", title="Resulting network"]
+
+== Installing the plugin
+//ST: Installing the plugin
+//ST: !
+
+image::https://docs.google.com/drawings/d/1dgcXEC-nrQQtLvEtSLCrzKXfAdi2Hy1jCslyf2ky20A/pub?w=956&h=530[align="center", title="Choose the menu Tools then Plugins"]
+
+//ST: !
+
+image::https://docs.google.com/drawings/d/1u4LqlnQby5DQVmq4csZ6f7sq_Z33F33UqtBZ43eh4pc/pub?w=645&h=406[align="center", title="Click on the tab Available Plugins"]
+
+//ST: !
+
+image::https://docs.google.com/drawings/d/18hovYg9G5ek39rILj-aRlEpaWnN6doQeg15iX6lU0aY/pub?w=833&h=543[align="center", title="Install the plugin then restart Gephi"]
+
+== Opening the plugin
+//ST: Opening the plugin
+//ST: !
+
+image::https://docs.google.com/drawings/d/1eu5O9KiGDAXJSkQuXHYq37T8vSvlZCPMgjwpa4C4Bh4/pub?w=1423&h=851[align="center", title="Open the plugin via the menu File - Import"]
+
+== Using the plugin
+//ST: Using the plugin
+
+//ST: !
+==== First panel
+//ST: !
+
+image::https://docs.google.com/drawings/d/1T1MfrbkD-0JXU0gJittis1SzC6oTS3TzN2NqwkKtRVE/pub?w=1412&h=920[align="center", title="Select a file"]
+
+//ST: Is your file with a header?
+
+//ST: !
+
+image::en/similarity-computer/file-without-header-en.png[align="center", title="A file without headers"]
+
+//ST: !
+
+image::en/similarity-computer/file-with-header-en.png[align="center", title="A file with headers"]
+
+//ST: !
+==== Second panel
+//ST: !
+
+image::en/similarity-computer/plugin-4-en.png[align="center", title="Parameter for weight"]
+
+//ST: !
+==== Third panel
+//ST: !
+
+image::en/similarity-computer/plugin-5-en.png[align="center", title="Confirmation panel"]
+
+== How is the similarity computed, exactly?
+//ST: How is the similarity computed, exactly?
+//ST: !
+
+We use the cosine similarity. Sounds complicated, but it is not. http://stackoverflow.com/questions/1746501/can-someone-give-an-example-of-cosine-similarity-in-a-very-simple-graphical-wa[Check here].
+
+The source code for the cosine calculation is in this https://github.com/gephi/gephi-plugins/blob/master-forge/modules/SimilarityComputer/src/main/java/net/clementlevallois/computer/CosineCalculation.java[file], at https://github.com/gephi/gephi-plugins/blob/master-forge/modules/SimilarityComputer/src/main/java/net/clementlevallois/computer/CosineCalculation.java#L110[this place].
+
+== FAQ / special notes on the plugin
+//ST: FAQ / special notes on the plugin
+//ST: !
+
+==== 1. Excel files should be .xlsx, not .xls
+
+Because they represent two slightly different files formats, and the plugin supports only .xlsx
+
+//ST: !
+
+==== 2. csv files are ok.
+
+If you select a http://www.computerhope.com/issues/ch001356.htm[csv file], you will be asked to indicate the field delimiter and optionally the text delimiter.
+
+image::en/similarity-computer/plugin-6-en.png[align="center", title="When a csv file is selected"]
+
+//ST: !
+
+==== 3. You can't use numerical values in the attributes
+
+image::en/similarity-computer/numerical-attributes-en.png[align="center", title="Age is a numerical attribute"]
+
+This is too bad. If there is enough demand for it I'll add this feature, which is not trivial.
+
+//ST: !
+
+==== 4. Each entity should appear only on one line
+
+image::en/similarity-computer/plugin-7-en.png[align="center", title="An entity appearing twice"]
+
+David appears on lines 2 and 5 (because he made two purchases). Only the latest line where David appears (line 5) will be taken into account.
+
+== The end
+//ST: The end!
+
+Visit https://www.facebook.com/groups/gephi/[the Gephi group on Facebook] to get help,
+
+or visit https://seinecle.github.io/gephi-tutorials/[the website for more tutorials]