hypertopic / porphyry

Corpus analyses confrontation

PORPHYRY – Corpus analyses confrontation

Contact: [email protected]

Home page: https://github.com/Hypertopic/Porphyry

How to test the development version

Requirements:

• git
• curl
• wget
• node and npm
• docker and docker-compose

Install and start backend with test data

wget -qO- "https://github.com/Hypertopic/Argos/archive/v4.tar.gz" | tar xvz
cd Argos-4
docker-compose up -d
cd ..

Argos is now available at http://localhost/

Create test user

curl --silent -X PUT localhost:5984/_users
curl --silent -X PUT localhost:5984/_users/org.couchdb.user:alice -H 'Accept:application/json' -H 'Content-Type:application/json' -d '{"name":"alice", "password":"whiterabbit", "roles":[], "type":"user"}'

Install and start frontend

git clone https://github.com/Hypertopic/Porphyry.git
cd Porphyry
npm install
npm start

Porphyry is now available at http://localhost:3000/ Please note that the terminal is devoted to the process until it is canceled.

Install test tools

Add this function to your profile:

function cucumber() {
  (docker run --rm -v "$(pwd)":/app --tty --net="host" --env APP_HOST="http://host.docker.internal:3000" benel/cucumber-capybara "$@")
}

Type the following command:

cucumber --help

Run tests

From the Porphyry folder:

cucumber --fail-fast --quiet

How to enable plugins

Enable comments

1. Sign up to Disqus,
2. Choose Install Disqus on my site,
3. Set your Website data and create site. Remember its short name.
4. Edit public/config.yml and paste the short name as the value of disqus setting.

Enable world map

1. Sign up to GoogleMaps,
2. Create an API key to be used with geocoding and dynamic map services
3. Edit public/config.yml and paste the API key as the value of map/key setting,
4. If necessary, switch geocoding API URI from GoogleMaps to GeoXene.
5. If necessary, add layers (vases is here the ID of the portfolio):

  portfolio:
    vases:
      layers:
        - uri: https://steatite.utt.fr/picture/405e66c63060b595c02e6590a8f6abbda104cb03
          bounds:
            south: 37.977910
            west: 23.718200
            north: 37.978780
            east: 23.719010
        - uri: https://steatite.utt.fr/picture/78e81db6ee77decd3e40cf3124c04a6aaaaa2fc4
          bounds:
            south: 37.97862453543905
            west: 23.716649743986387
            north: 37.978755
            east: 23.716789

Enable building maps

Edit public/config.yml and add:

portfolio:
  vitraux:
    visitMap: true

where vitraux is the ID of your portfolio.

porphyry's Issues

Sort items according to the values of a given attribute

Phase 1

• Scenarios (Gherkin)
• Mockups
• Implementation strategy

Phase 2

• Acceptance tests (Capybara)
• Implementation

Application blocked with Java 7

Since Java 7 update 51, self-signed applications are blocked by default.

Unfortunately academic certificates (CNRS) are not valid for Java. Moreover we cannot afford a 150$ yearly fee to a commercial trusted third party.

A workaround is to modify your java settings so that our download server is a trusted server.

Move as an upper topic

• Scénarios (Fangxu)
• Maquettes (Yuanjia)
• Tests automatisés
• Implémentation

Java 7 cache problem

When used with Java 7, Porphyry returns errors message such as java.lang.RuntimeException: java.lang.NullPointerException
Those messages occurs namely when the user tries to connect to a (Dolomite) password-protected Cassandre server.

When the console is open, a complementary message gives :
CacheEntry : updateAvailable=false,lastModified=Wed Nov 25 11:12:25 CET 2009,length=-1

Create a sibling to a topic

as easily as in an outliner.

Faulty HTTP requests should not be sent again and again

The simple cache policy in RESTDatabase – caching only successful requests – together with a "lazy object mapping" strategy in HypertopicMap causes faulty resources to be requested on HTTP again and again.

Get similar items according to an item's topic

Prerequisite: #35.

Assign a topic to an item from a personal viewpoint

Description

What is the valuable outcome that cannot be achieved with current features?

For which stakeholder (people, role, project, domain) is it important?

Which user action should be enabled (or restricted)? For who?

Prerequisite: being logged in.

Additional details (solutions you think about, or workarounds you tried)

Deliverables status

Phase 1

• Scenarios (Gherkin)
• Mockups
• Implementation strategy

Phase 2

• Acceptance tests (Capybara)
• Implementation

Phase 3

• Screencast

Rename a viewpoint

• Scénarios
• Maquette
• Tests automatisés
• Implémentation

Comment (or share with friends) an item

• Scénarios
• Maquettes
• Tests automatisés
• Implémentation

with discussion threads, links to sources, and maybe uploaded documents.

While a bit too much "post-modern" for science, comments could be "liked" by peers.

Comments could also be shared optionally on social networks to get visibility on one's work. This would also benefit the platform by dragging in additional contributors.

As an example of APIs that could be developed or integrated, here are:

• Facebook's social plugin,
• Disqus comment plugin.

List user's corpora from multiple servers

Two unexpected results have been reported:

• an empty list,
• a single concatenated name.

Create a child to a topic

as

easily as in an outliner.

Prerequisite: #42.

• Scénarios (Fangxu)
• Maquettes
• Tests automatisés
• Implémentation

French localization

Rename a topic

as easily as in an outliner

• Scénarios (Jie JI)
• Maquettes (Ruolin ZHENG)
• Tests automatisés
• Implémentation

Remove a topic from the selection

Update an item's attribute

• Scénarios (Meng Ruolin Fangxu)
• Maquettes (David Lorraine Yuanjia)
• Tests automatisés (Jie)
• Implémentation (Ruolin Fangxu)

Given an attribute `a:X` (including `corpus`), set another attribute `b:Y` to every matching item

Description

What is the valuable outcome that cannot be achieved with current features?

For which stakeholder (people, role, project, domain) is it important?

Which user action should be enabled (or restricted)? For who?

Additional details (solutions you think about, or workarounds you tried)

Deliverables status

Phase 1

• Scenarios (Gherkin)
• Mockups
• Implementation strategy

Phase 2

• Acceptance tests (Capybara)
• Implementation

Phase 3

• Screencast

Collapse and expand viewpoint

This feature already existed in Porphyry v5.

Unassign a topic from an item

• Scénarios (Valentin Porcellini @Sallaa , Léo Schneider @leoschneider)
• Maquettes (Aurore Thomas @aurorethomas, Audrey Henriette @Audreyhrtt)
• Tests automatisés (Corentin Laithier @corentinlthr)
• Implémentation (Florent Pergoud @flopshoubox)

Changing the order of services should be neutral.

For now, using Cassandre BEFORE Argos is broken.

Close viewpoint

This feature existed in Porphyry v5.

Show links between topics

This feature already was in v5.

Unset an item's attribute

• Scénarios (Meng Ruolin Fangxu)
• Maquettes (David Lorraine Yuanjia)
• Tests automatisés (Ruolin Fangxu)
• Implémentation(Yuanjia)

Related viewpoints IDs displayed instead of names

Corpus browsing

... with selecting and displaying/counting of attributes values.

Open whole resources by clicking on items

This feature was already implemented in v5.

Start Porphyry and open a corpus with a single click

Similar to what was implemented on Porphyry v5 for viewpoints.

Assign an existing topic to an item

• Scénarios ( Leo Schneider @leoschneider, Valentin Porcelini @Sallaa, Jianwei Zheng)
• Maquettes (Aurore Thomas @aurorethomas, Audrey Henriette @Audreyhrtt, David Galante @folowbaka)
• Tests automatisés (Corentin Laithier @corentinlthr )
• Implémentation (Florent Pergoud @flopshoubox)

Add a topic to the selection

Show links between items and topics (and vice versa)

This feature had disappeared from v5 due to a regression.

Close corpus

This feature existed in Porphyry v5.

Loading related viewpoints should not add additional items to the portfolio

Occurred on "stain glasses" Steatite corpora.
Loading related viewpoints caused older "Jonathan's Bookmark" items to be loaded and processed by ItemSet.

Cache problem

I think you will need to clear the cache in HTTP PUT/POST/DELETE methods.

For example, when you issued a PUT request to modify a viewpoint on CouchDB, then you try to get this viewpoint immediately, you still will get the old data from cache if your listener cannot get the notification from CouchDB in time.

Multi-selection of topics with the mouse

... i.e. without the META key (as in a checkbox field).

Single instance application

To comply with Apple Look and Feel, launching Porphyry when it is already on, should not start another instance but use the first one instead.

N.B. This was already done in Porphyry v5. However this can be done more easily with Java 6 API (javax.jnlp.ServiceManager, SingleInstanceListener, and SingleInstanceService).

Assign a new topic to an item

• Scénarios ( Leo Schneider @leoschneider, Valentin Porcellini @Sallaa)
• Maquettes (Aurore Thomas @aurorethomas, Audrey Henriette @Audreyhrtt, David Galante @folowbaka)
• Tests automatisés (Corentin Laithier @corentinlthr)
• Implémentation (Florent Pergoud @flopshoubox)

How to downgrade to Java 6 on MacOS X ?

If you realize too late that you shouldn't have upgraded to Java 7, there is a way to re-enable Java 6 without reinstalling it from scratch:
http://support.apple.com/kb/HT5559

Get similar items according to an item's attribute value

Similarly to what is done on topics, you could click on an attribute value and open the portfolio page in which every item with this value would be selected (#158) or sorted (#38) (the designers should choose either of the prerequisites).

Phase 1

• Scenarios (Gherkin)
• Mockups
• Implementation strategy

Phase 2

• Acceptance tests (Capybara)
• Implementation

Hypertopic v2 compatibility

For every topic, get the number of selected items assigned to it

Set an item's attribute

• Scénarios (Meng)
• Maquettes (David Lorraine Yuanjia)
• Tests automatisés(Meng)
• Implémentation (Lorraine)

Launch Firefox instead of the default browser

... since LaSuli is a Firefox extension.

Collapsed viewpoints get expanded on updates

... especially on clicking on topics and tabs.

Multiple tag clouds (one per viewpoint)

This feature was already implemented in v5.

Show thumbnails on picture items

This feature was already implemented in v5.

No more viewpoint edition window needed

... since it is now handled by LaSuli.

Move as a subtopic

• Scénarios (Fangxu)
• Maquettes (Yuanjia)
• Tests automatisés
• Implémentation

Browse items (or fragments) from personal viewpoints

Description

What is the valuable outcome that cannot be achieved with current features?

For which stakeholder (people, role, project, domain) is it important?

Which user action should be enabled (or restricted)? For who?

Additional details (solutions you think about, or workarounds you tried)

Deliverables status

Phase 1

• Scenarios (Gherkin)
• Mockups
• Implementation strategy

Phase 2

• Acceptance tests (Capybara)
• Implementation

Phase 3

• Screencast

Switch to fragments mode

Description

What is the valuable outcome that cannot be achieved with current features?

For which stakeholder (people, role, project, domain) is it important?

Which user action should be enabled (or restricted)? For who?

Additional details (solutions you think about, or workarounds you tried)

Deliverables status

Phase 1

• Scenarios (Gherkin)
• Mockups
• Implementation strategy

Phase 2

• Acceptance tests (Capybara)
• Implementation

Phase 3

• Screencast

Integration with research diary and "models"

Everything in Porphyry should be referencable from a text editor, a diagram editor or a mindmapping tool with a URL of this kind:
http://acme.org/.jnlp?service=h1&service=h2&corpus=A&corpus=B&viewpoint=C&viewpoint=D&topic=a&topic=b