Bug #1512

TBX: 0.7.7, deal with structures properties in commands

Added by Matthieu Decorde almost 4 years ago. Updated 3 months ago.

Status:New Start date:09/04/2015
Priority:Normal Due date:
Assignee:- % Done:

50%

Category:Import Spent time: -
Target version:TXM 0.8.1

Description

"text" structure in editors

Current TXT+CSV import module builds a 'path' property for 'text' structures that one can see in various command results disturbing the user who has never named any source data with that name.

For example after importing the 'voeux-txt' sample corpus without any metadata, the Description command displays:

Propriétés des structures (max 20 valeurs)

p
   id (1) = 0.
s
   n (59) = 22, 23, 24, 25, 26, 27, 28, 29, 3, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43.
text
   id (3) = t0015, t0022, t0036.
   path (1) = "".

That property must not be shown to the user, in:
  • Description command
  • the first page of the Edition of each text
  • Concordance references display choice
  • Sub-corpus selection
  • etc.
    or must not be build.

'text' structure properties in partition dialog

Currently, the Partition command parameters dialog box lists the 'base', 'path' and 'project' structure property for the 'text' structure.

Those supposely internaly used properties are unknown and unusable by the user, so it is confusing the user.

It should not be displayed here.

Note: those informations have been noticed in the Partition command parameters, but they must probably also be hidden in other components like Sub-corpus parameters, Concordance reference display parameters, etc.

'txmcorpus' structure

Currently, the Partition command parameters dialog box lists the 'txmcorpus' structure.

That supposely internaly used propertiy is unknown and unusable by the user, so it is confusing the user.

It should not be displayed here.

Solution 1

For all ancillary/internal/private structure properties build (and needed?) by TXM:
  • use a secure non colliding name (to prevent conflicts with user's structure properties space name)
    • for example prefix the name by 'Txm' in camelback naming policy
  • filter processing and display depending on context of every ancillary data name to prevent the user to discover or to have to deal with it
Another wording:
  • rename the 'base', 'path' and 'project' internal properties in a reserved namespace of TXM. For example prefix them by 'txm-' (if we only remove any properties of those names, we prevent any corpus to use those property names);
  • rename the 'txmcorpus' structure by 'txm-corpus' (to prevent conflict with any corpus sources)

Solution 3

A supplementary development could add a boolean preference to show/hide 'internal structures and properties' in parameters dialog boxes for advanced users?

This - of course - supposes to document those internal properties and structures in the Javadoc and in a developer manual.

History

#1 Updated by Matthieu Decorde almost 4 years ago

  • Description updated (diff)

#2 Updated by Serge Heiden almost 4 years ago

  • Description updated (diff)

#3 Updated by Sebastien Jacquot 12 months ago

  • Target version changed from TXM 0.8.0a (split/restructuration) to TXM 0.8.0

#4 Updated by Matthieu Decorde 3 months ago

  • Target version changed from TXM 0.8.0 to TXM 0.8.1

Also available in: Atom PDF