Pairviewer - Revision history

Amuritna at 01:34, 9 December 2018

2018-12-09T01:34:55Z

Amuritna: /* Navigating the user interface */

2018-12-08T17:02:54Z

Navigating the user interface

Amuritna at 16:12, 8 December 2018

2018-12-08T16:12:57Z

Amuritna at 16:06, 8 December 2018

2018-12-08T16:06:47Z

Amuritna at 15:45, 8 December 2018

2018-12-08T15:45:47Z

Amuritna: move content from Pair viewer (with space)

2018-12-08T05:20:39Z

move content from Pair viewer (with space)

Firespeaker at 15:59, 5 November 2013

2013-11-05T15:59:59Z

Firespeaker at 15:00, 5 November 2013

2013-11-05T15:00:11Z

Firespeaker: Created page with ''''Pairviewer''' is an html/javascript/jquery application developed originally during GCI 2012 that displays available language pairs in apertium as a graph. The code lives in s…'

2013-11-05T14:51:36Z

Created page with ''''Pairviewer''' is an html/javascript/jquery application developed originally during GCI 2012 that displays available language pairs in apertium as a graph. The code lives in s…'

New page

'''Pairviewer''' is an html/javascript/jquery application developed originally during GCI 2012 that displays available language pairs in apertium as a graph.

The code lives in svn at [https://svn.code.sf.net/p/apertium/svn/trunk/apertium-tools/pairviewer https://svn.code.sf.net/p/apertium/svn/trunk/apertium-tools/pairviewer].

A test installation is available at [http://apertium.vm.bytemark.co.uk/~firespeaker/apertium-tools/pairviewer/apertium.html http://apertium.vm.bytemark.co.uk/~firespeaker/apertium-tools/pairviewer/apertium.html].

@@ Line 23: / Line 23: @@
 You should see something like this on your terminal window.
-<pre>Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/) <---- copy-paste this URL!</pre>
+<pre>Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/)</pre>
 ===Open on browser===
+Type '''localhost:80000/apertium.html''' into your browser's address bar and go.
-Paste in your localhost address (e.g. <nowiki>http://0.0.0.0:80000/</nowiki>) into a browser and run. You should see a directory listing. Click the link with the label '''apertium.html'''.
 This should successfully launch the Pairviewer. This step requires downloading some [https://d3js.org/ D3.js] resources, so if your internet connection is slow, this might take a while.
@@ Line 48: / Line 48: @@
 The collapsible menu on the top left lets you filter languages according to its:
-* progress branch ([[Trunk|trunk]], [[Staging|staging]], [[Nursery|nursery]], or [[Incubator|incubator]])
+* progress stage ([[Trunk|trunk]], [[Staging|staging]], [[Nursery|nursery]], or [[Incubator|incubator]])
 * directionality (unidirectional, bidirectional, and direction missing)
-* stem count (correlated with [[Morphological dictionary|dictionary]] size)
+* [[The_Right_Way_to_count_dix_stems|stem count]] (correlated with [[Morphological dictionary|dictionary]] size)
 * creation date
 * date of last update

@@ Line 39: / Line 39: @@
 === Navigating the user interface ===
 [[File:pairviewer-pair-info.png|right|thumb|Hovering over the language pair line between tha and lao.]]
-Hovering over a graph edge (language pair line) displays its language pair name, repository name, creation date, date of last update, and stem amount.
+Hovering over a graph edge (language pair line) displays its language pair name, repository name, creation date, date of last update, and stem count.
 The nodes (circles representing the languages) can be dragged around to rotate or move the entire graph.
@@ Line 50: / Line 50: @@
 * progress branch ([[Trunk|trunk]], [[Staging|staging]], [[Nursery|nursery]], or [[Incubator|incubator]])
 * directionality (unidirectional, bidirectional, and direction missing)
-* amount of stem count (correlated with [[Morphological dictionary|dictionary]] size)
+* stem count (correlated with [[Morphological dictionary|dictionary]] size)
 * creation date
 * date of last update

@@ Line 1: / Line 1: @@
 [[File:pairviewer.png|right|thumb|350px|The Pairviewer in action.]]
 The Apertium '''Pairviewer''' is a HTML5/[https://d3js.org/ D3.js] tool that depicts all Apertium [[list of language pairs|language pairs]] in an interactive graph initially developed sometime before the [[GCI|Google Code-In]] 2013. Its source code can be [https://github.com/apertium/pairviewer found on GitHub] and an online demonstration is available [http://ilazki.thinkgeek.co.uk/~firespeaker/pairviewer/apertium.html here].
+The [https://github.com/jonorthwash/Apertium-Global-PairViewer Global-Pairviewer] is an implementation of Pairviewer with a three-dimensional globe. See [https://wikis.swarthmore.edu/ling073/User:Cpillsb1/Final_project this].
 == Setting up Pairviewer locally ==

@@ Line 39: / Line 39: @@
 Hovering over a graph edge (language pair line) displays its language pair name, repository name, creation date, date of last update, and stem amount.
-The nodes (circles representing the languages) can be dragged around to rotate the entire graph.
+The nodes (circles representing the languages) can be dragged around to rotate or move the entire graph.
 Stats for the number of languages and language pairs represented in the graph can be found in the bottom-left corner.
+Typing anything will produce a search box in the bottom right. Ctrl+F (find in page) can also be used for search.
 The collapsible menu on the top left lets you filter languages according to its:
 * progress branch ([[Trunk|trunk]], [[Staging|staging]], [[Nursery|nursery]], or [[Incubator|incubator]])
 * directionality (unidirectional, bidirectional, and direction missing)
-* amount of stem count (correlated with dictionary size)
+* amount of stem count (correlated with [[Morphological dictionary|dictionary]] size)
-* last update
 * creation date
+* date of last update
 == How Pairviewer works ==
+The Pairviewer is made of nine components:
+* apertium.css
+** Styling for the whole application, including e.g. configuration for interactive graph edge/line width.
+* apertium.html
+** The main application.
+* codes.json
+** For conversion between three-letter and two-letter language code names to prevent duplicates.
+* colorbrewer.js
+** Interactive graph colorization.
+* languages.json
+** List of all languages to be represented.
+* pairs.json
+** Language pair data.
+* pairs.json.txt
+** Language pair data, used by the main application.
+* reset.css
+** [https://meyerweb.com/eric/tools/css/reset/ Reset CSS].
+* scrape_repo_information.py
+** Run this to update language data.
 == Known bugs ==
 There are a few apparent bugs that should be fixed before the pair viewer goes public.
-* in initial view (sometimes?), quz has no line connecting it to spa
+* sometimes quz has no line connecting it to spa
 * sometimes two- and three-letter codes don't seem to merge
 ** when just trunk and staging are selected, tur/tr and nob/nb are each separate from one another

@@ Line 29: / Line 29: @@
 == Using Pairviewer ==
+=== Updating language data by scraping ===
+Apertium language data are being continuously developed, so it is highly possible that the language data that your Pairviewer were shipped with isn't up to date.
+To scrap new language data (from [https://github.com/apertium Apertium's GitHub]), run:
+<pre>python3 scrape_repo_information.py</pre>
+=== Navigating the user interface ===
+[[File:pairviewer-pair-info.png|right|thumb|Hovering over the language pair line between tha and lao.]]
+Hovering over a graph edge (language pair line) displays its language pair name, repository name, creation date, date of last update, and stem amount.
+The nodes (circles representing the languages) can be dragged around to rotate the entire graph.
+Stats for the number of languages and language pairs represented in the graph can be found in the bottom-left corner.
+The collapsible menu on the top left lets you filter languages according to its:
+* progress branch ([[Trunk|trunk]], [[Staging|staging]], [[Nursery|nursery]], or [[Incubator|incubator]])
+* directionality (unidirectional, bidirectional, and direction missing)
+* amount of stem count (correlated with dictionary size)
+* last update
+* creation date
 == How Pairviewer works ==

@@ Line 1: / Line 1: @@
+[[File:pairviewer.png|right|thumb|350px|The Pairviewer in action.]]
-'''Pairviewer''' is an html/javascript/jquery/d3 application developed originally during GCI 2012 that displays available language pairs in apertium as a graph.
+The Apertium '''Pairviewer''' is a HTML5/[https://d3js.org/ D3.js] tool that depicts all Apertium [[list of language pairs|language pairs]] in an interactive graph initially developed sometime before the [[GCI|Google Code-In]] 2013. Its source code can be [https://github.com/apertium/pairviewer found on GitHub] and an online demonstration is available [http://ilazki.thinkgeek.co.uk/~firespeaker/pairviewer/apertium.html here].
+== Setting up Pairviewer locally ==
-== Location ==
+===Clone the git repository===
-The code lives in svn at [https://svn.code.sf.net/p/apertium/svn/trunk/apertium-tools/pairviewer https://svn.code.sf.net/p/apertium/svn/trunk/apertium-tools/pairviewer].
+Enter into the folder you want it to be in and download [https://github.com/apertium/pairviewer the whole program] by running <pre>git clone https://github.com/apertium/pairviewer.git</pre>
+===Set up a localhost with Python===
-A test installation is available at [http://apertium.vm.bytemark.co.uk/~firespeaker/apertium-tools/pairviewer/apertium.html http://apertium.vm.bytemark.co.uk/~firespeaker/apertium-tools/pairviewer/apertium.html].
+You need to set up a [https://en.wikipedia.org/wiki/Localhost localhost] server before you can locally run Pairviewer.
+''First'', check whether you have Python installed on your system and if so, what version(s) it is. Install preferably the latest one (Python 3) if it had not been done already.
-== Workings ==
+<pre>python -v</pre>
-Pairview loads a pairs.json.txt file from the same dir.  This file is generated by the pairsOut.py script (and supporting get_all_language_pairs.py script) in apertium-tools.
+Then make sure to enter the folder of the git repository you have cloned.
-[[Category:Visual tools]]
+If you have is Python 3, run:
+<pre>python3 -m http.server</pre>
+Otherwise, if you do have Python 2, run:
+<pre>python -m SimpleHTTPServer</pre>
+You should see something like this on your terminal window.
+<pre>Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/) <---- copy-paste this URL!</pre>
+===Open on browser===
+Paste in your localhost address (e.g. <nowiki>http://0.0.0.0:80000/</nowiki>) into a browser and run. You should see a directory listing. Click the link with the label '''apertium.html'''.
+This should successfully launch the Pairviewer. This step requires downloading some [https://d3js.org/ D3.js] resources, so if your internet connection is slow, this might take a while.
+== Using Pairviewer ==
+== How Pairviewer works ==
+== Known bugs ==
+There are a few apparent bugs that should be fixed before the pair viewer goes public.
+* in initial view (sometimes?), quz has no line connecting it to spa
+* sometimes two- and three-letter codes don't seem to merge
+** when just trunk and staging are selected, tur/tr and nob/nb are each separate from one another
+** when trunk, staging, and nursery are selected, nob/nb are merged, but tur/tr are separate
+* when all possible pairs are viewed (including ones with missing stems, etc.), pa doesn't have a line connecting it to ur
+[[Category:Documentation]]
+[[Category:Documentation in English]]

← Older revision		Revision as of 15:00, 5 November 2013
Line 1:		Line 1:
	'''Pairviewer''' is an html/javascript/jquery application developed originally during GCI 2012 that displays available language pairs in apertium as a graph.		'''Pairviewer''' is an html/javascript/jquery/d3 application developed originally during GCI 2012 that displays available language pairs in apertium as a graph.

	The code lives in svn at [https://svn.code.sf.net/p/apertium/svn/trunk/apertium-tools/pairviewer https://svn.code.sf.net/p/apertium/svn/trunk/apertium-tools/pairviewer].		The code lives in svn at [https://svn.code.sf.net/p/apertium/svn/trunk/apertium-tools/pairviewer https://svn.code.sf.net/p/apertium/svn/trunk/apertium-tools/pairviewer].