Back to the main page.

Bug 2697 - make documentation and FAQ more consistent

Reported 2014-09-22 13:24:00 +0200
Modified 2014-09-30 20:54:06 +0200
Product: FieldTrip
Component: documentation
Version: unspecified
Hardware: PC
Operating System: Mac OS
Importance: P5 normal
Assigned to: Tzvetan Popov
Depends on:
See also:

Tzvetan Popov - 2014-09-22 13:24:16 +0200

Diskussed to merge all FAQ instances dealing with cfg.renderer in one. During the Birmingham WS Robert spotted cases relating to ft_sourceplot and ft_singleplotTFR dealing with the odd colorbar display. Those should be merged into one FAQ.

Tzvetan Popov - 2014-09-22 14:48:43 +0200

So far I identified the following instances: Those two are unrelated to the renderer but still related to the bug: MRI beeing upside down:

Robert Oostenveld - 2014-09-24 14:55:16 +0200

the following is not according to the documentation guidelines I wonder whether it should be a tutorial on itself, or whether a tutorial should be built around it

Robert Oostenveld - 2014-09-24 14:57:10 +0200

I suggest to start reading and make a (paper?) overview of the documentation. Like a mind map or so...

Tzvetan Popov - 2014-09-24 14:59:06 +0200

(In reply to Robert Oostenveld from comment #2) Hm, good question. I'm currently working on the tutorial for ft_networkanalysis. Therein a important step is to get multiple virtual channels, basically the single trials on source level. Maybe we should include this issue there?

Tzvetan Popov - 2014-09-24 15:01:38 +0200

(In reply to Robert Oostenveld from comment #3) Say something like a "Manual: how to use the fieltrip documentation"?

Robert Oostenveld - 2014-09-24 15:21:07 +0200

(In reply to Tzvetan Popov from comment #5) we do have this:, which is "how to write documentation". Perhaps we should extend that for us. I think for normal users there should only be these two getting started on the wiki -> getting started with the code -> Perhaps it is not sufficiently clear that they serve this purpose.

Robert Oostenveld - 2014-09-30 20:54:06 +0200

for the MATLAB plotting and rendering issues there should be one faq and this should be added as well: