Feature #2474

RCP: X.X, result creation journal, publication and literate programming

Added by Matthieu Decorde about 1 year ago. Updated about 1 year ago.

Status:New Start date:12/10/2014
Priority:Urgent Due date:
Assignee:Serge Heiden % Done:

0%

Category:UI / Ergonomy Spent time: -
Target version:TXM 0.8.1

Description

The user must be able to keep some results between TXM sessions -> store results.

It would be interesting to also be able to share 'the way to compute' some results with another user -> export results, to be reproduced in a TXM.

It would also be interesting to trace the working session as a journal for reading and publishing -> produce a journal of results to be read (see Gweave below).

A result is the association of a Command name and its Parameters.

Current "Export" command is not the solution because it does not allow to rebuild the result in another TXM session.
-
h3. Solution A

Add a new "Keep/Save" entry in the corpus view contextual menu, toolbar and shortcut.

Add a visual mark that informs the user if the result is kept or not: for example, a "*" = not kept or a pin = kept.

By default a result is not kept.

Saved in a new "session.xml" file, or better ORM+XML import/export.-

Solution B

Store the journal of the results/command calls done in a session in:
  • 'history.xml' file
  • or better history ORM+XML import/export
  • or even better 'history.groovy' (containing Groovy code)
To be implemented in Groovy:
  • the journal needs a maintained Commands API
  • results/command calls could be stored in macros
  • a macro could call several Results/command calls stored in a macro

Solution C

Build a 'Gweave' literate programming and report generating environment similar to: The commands from a journal can be:
  • read for the reference of an experiment
  • shared to be executed in another TXM session
  • edited in a report or article

Solution D

  • Add a new "Share with" entry in the corpus view contextual menu
  • Add a new "Import results/command calls" entry in the Corpus view contextual menu

Linked to tickets

  • lazy loading
  • result properties : author, date, comment...
  • lexical table export/import

History

#1 Updated by Matthieu Decorde about 1 year ago

  • Subject changed from RCP: X.X, result creation journal to RCP: X.X, result creation journal, publication and literate programming

Also available in: Atom PDF