Project

General

Profile

Actions

User story #3292

closed

User story #2947: A special textarea-type field should exist for the Techniques that automatically escapes some characters

Document the new behaviour of directive field

Added by Nicolas CHARLES almost 12 years ago. Updated over 9 years ago.

Status:
Rejected
Priority:
1 (highest)
Assignee:
Jonathan CLARKE
Category:
Documentation
Target version:
UX impact:
Suggestion strength:
User visibility:
Effort required:
Name check:
Fix check:
Regression:

Description

Based on what has been changed on #3281, we need to document :
  1. how the fields are automatically escaped
  2. how to not have them escaped
  3. complete the technique syntax description

Subtasks 1 (0 open1 closed)

User story #3321: Add a warning in the Rudder documentation to tell that values inserted in directive should be manually escapedReleasedJonathan CLARKE2013-02-26Actions
Actions #1

Updated by Nicolas CHARLES over 11 years ago

  • Status changed from New to In progress
  • Assignee set to Nicolas CHARLES
Actions #2

Updated by Nicolas CHARLES over 11 years ago

Hum, actually there is nothing in the documentation about this topic.
I've edited the wiki ( http://www.rudder-project.org/foswiki/bin/view/Development/TechniqueXML ) to explain the new field and the change of behaviour, and I add a warning in older version of documentation

Actions #3

Updated by Nicolas CHARLES over 11 years ago

  • Status changed from In progress to Discussion
  • Assignee changed from Nicolas CHARLES to Jonathan CLARKE

Jon, i'm a bit worried about how to document this.

The reference documentation has a very high level overview of the directive : it only explains it's based on a Technique, and is used in Rules
And nothing else (no multivalued section, priority, etc).
This very light doc fits nicely in the begin of the doc, where concept are introduced, but it lacks a more comprehensive doc.
Would it fit in the Reference Manual ? If so, where ?
Or in the wiki only ?

Actions #4

Updated by Nicolas PERRON over 11 years ago

  • Target version changed from 2.6.0~beta1 to 2.6.0~rc1
Actions #5

Updated by Matthieu CERDA over 11 years ago

  • Target version changed from 2.6.0~rc1 to 2.6.0
Actions #6

Updated by Jonathan CLARKE over 11 years ago

  • Target version changed from 2.6.0 to 2.6.1
Actions #7

Updated by Nicolas PERRON over 11 years ago

  • Target version changed from 2.6.1 to 2.6.2
Actions #8

Updated by Nicolas PERRON over 11 years ago

  • Target version changed from 2.6.2 to 2.6.3
Actions #9

Updated by Nicolas PERRON over 11 years ago

Its user story issue is released but not this issue ? It looks like this ticket should not be linked to its user story

Actions #10

Updated by Nicolas PERRON over 11 years ago

  • Target version changed from 2.6.3 to 2.6.4
Actions #11

Updated by Jonathan CLARKE about 11 years ago

  • Assignee changed from Jonathan CLARKE to Nicolas CHARLES

Oops, looks like I forgot to answer here... Sorry about that!

Since this is only of interest for users of old versions (with newer versions it just works as expected out of the box, no manual escaping needed), I suggest adding a FAQ entry to the website, including the versions this affects.

Actions #12

Updated by Nicolas PERRON about 11 years ago

  • Target version changed from 2.6.4 to 2.6.5
Actions #13

Updated by Nicolas PERRON about 11 years ago

  • Target version changed from 2.6.5 to 2.6.6
Actions #14

Updated by Nicolas PERRON about 11 years ago

  • Target version changed from 2.6.6 to 2.6.7
Actions #15

Updated by Nicolas PERRON about 11 years ago

  • Target version changed from 2.6.7 to 2.6.8
Actions #16

Updated by Nicolas PERRON about 11 years ago

  • Target version changed from 2.6.8 to 2.6.9
Actions #17

Updated by Nicolas CHARLES about 11 years ago

  • Status changed from Discussion to 8
Actions #18

Updated by Nicolas PERRON about 11 years ago

  • Target version changed from 2.6.9 to 2.6.10
Actions #19

Updated by Vincent MEMBRÉ almost 11 years ago

  • Target version changed from 2.6.10 to 2.6.11
Actions #20

Updated by Nicolas CHARLES almost 11 years ago

  • Status changed from 8 to Discussion
  • Assignee changed from Nicolas CHARLES to Jonathan CLARKE

Since it does not affect any version supported, shouldn't we reject this ticket ?

Actions #21

Updated by Jonathan CLARKE almost 11 years ago

  • Status changed from Discussion to Rejected

Agreed.

Actions #22

Updated by Benoît PECCATTE over 9 years ago

  • Tracker changed from 6 to User story
Actions

Also available in: Atom PDF