Report Tool documentation is only technical

[mfrasca]

Expected behaviour

I want to know how to use the report tool.

Actual behaviour

the docs tell me how to write a template, or how to install the engine

Opinions and suggestions

while we are at it, we might just as well finally review this messy interface of the report tool, so I suggest that the docs describe what we want, not what we have.

Original report

3ce0138d7a2390a1a93d5568a8950498157982e0

[mfrasca]

related to issue #395. @RoDuth, you know what? I opened the XSL options and I realize I never really looked at it.
As you recently remarked, the docs are worthless for any user. Not only for users you know! I rely on the docs as a description of the functionality. And I agree: this part is empty or worthless. I don't know how I do not manage to make myself understood by you on this point: if you want the tool to stay in the next version, I need some user documentation. formal, informal, stuffed with grammar and orthography mistakes, incomplete, just in the form of a template, just random notes, I don't care, I will review and if necessary rewrite, but without any user documentation, I'm afraid I'm going to drop it from 3.1, not because I hate XSL, but because I am reorganizing the user interface and I am starting from reviewing the documentation, and then implement what is documented. What is not documented will stay out. I take care of documenting the Mako part, which I am familiar with, and which I advise to new users.

[mfrasca]

@RoDuth as you can see, I've been rewriting the report function in branch 3.1. I think it makes a lot more sense now, and I am able to describe the user interface. I don't know if it breaks things for you, I hope not. your use cases are always welcome.

[RoDuth]

No real time for this right now but have commented on #395

[mfrasca]

whenever you can. I won't break documented features, but I can't promise my changes won't affect the rest.