Back to the main page.
Bug 2697 - make documentation and FAQ more consistent
| Status | ASSIGNED |
| 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 |
| URL: | |
| Tags: | |
| Depends on: | |
| Blocks: | |
| See also: | http://bugzilla.fcdonders.nl/show_bug.cgi?id=2714 |
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: http://fieldtrip.fcdonders.nl/faq/i_am_getting_strange_artifacts_in_figures_that_use_opacity http://fieldtrip.fcdonders.nl/faq/i_am_having_problems_printing_figures_that_use_opacity Those two are unrelated to the renderer but still related to the bug: http://fieldtrip.fcdonders.nl/faq/why_are_so_many_of_the_interesting_functions_in_the_private_directories http://fieldtrip.fcdonders.nl/faq/matlab_does_not_see_the_functions_in_the_private_directory MRI beeing upside down: http://fieldtrip.fcdonders.nl/faq/matlab_does_not_see_the_functions_in_the_private_directory http://fieldtrip.fcdonders.nl/faq/why_does_my_anatomical_mri_show_upside-down_when_plotting_it_with_ft_sourceplot
Robert Oostenveld - 2014-09-24 14:55:16 +0200
the following is not according to the documentation guidelines http://fieldtrip.fcdonders.nl/tutorial/shared/virtual_sensors 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: http://fieldtrip.fcdonders.nl/development/guidelines/documentation, 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 -> http://fieldtrip.fcdonders.nl/getting_started getting started with the code -> http://fieldtrip.fcdonders.nl/reading_data Perhaps it is not sufficiently clear that they serve this purpose.