Project

General

Profile

Actions

User story #8663

open

Simplify technique format

Added by Benoît PECCATTE over 8 years ago.

Status:
New
Priority:
N/A
Assignee:
-
Category:
Techniques
UX impact:
Suggestion strength:
User visibility:
Effort required:
Name check:
Fix check:
Regression:

Description

Today, metadata.xml is complex and often not very POLA.
Here are some note for what needs to be changed in a future version.
Since this would make techniques incompatible, we should stack them and make a single migration.

Within technique metadata
  • There are to many information:
    • an identifier (the directory name)
    • a name (the name attribute)
    • a description (the DESCRIPTION element)
    • a long description (another element)
  • Compatibility is ignored -> its content is long outdated
  • TML abbreviation for templates, it is the single element that is abbreviated and usually template is abbreviated 'TPL' or 'TMPL', let's call it TEMPLATE
  • TRACKINGVARIABLE means TRACKINGKEY
  • SAMESIZEAS is very very hard to explains and is not intuitive (do we identify a variable based on the number of elements in an array ?)
  • SECTIONS means FORM
  • component means "has reporting"
  • componentKey is camel case (and case sensitive) when we say we shouldn't do that
  • TRACKINGKEY is sometime an array and sometime not (not easy to understand and reuse)
  • INPUT and SELECT seem to come from HTML whereas SELECT1 doesn't
  • ip, integer, string, ... are types whereas regex is not
  • Expected reports are declared within the form whereas they are separate concepts
  • Template output extension is assumed to be .cf by default whereas we should just specify it in the file name (file.cf.st)

No data to display

Actions

Also available in: Atom PDF