Documentation guidelines

When you add documentation, please consider the following documentation guidelines to keep it consistent with other documentation and to facilitate cross-linking.

  • FieldTrip should be written with capital “F” and capital “T”
  • All FieldTrip functions should be written in the text made bold, without .m, and with a link to reference documentation: i.e. ft_preprocessing
  • When you add a new page, please give it relevant tags.
  • If you see something that needs to be fixed in the documentation, add a FIXME comment (write fixme in capital letters), and also add the tag 'fixme' at the top of the page.
  • Please structure new tutorials in the following way.
  • Please give clear names for example data.
  • If you refer to file formats using the extension, please do it like *.txt, *.dat or *.ext in general.

Where to add documentation on the website?

There are several places where you are especially encouraged to add your own input to the FieldTrip wiki. On the frequently asked questions page you can add answers to a variety of FieldTrip-related questions. On the example scripts page you can put parts of your own scripts of specific analysis done in FieldTrip or in conjunction with FieldTrip. If these scripts get very elaborate and use example data, you can alternatively add a tutorial on the tutorials page and contact us to send the example data so it can be put on the ftp-server (ftp://ftp.fcdonders.nl/pub/fieldtrip/tutorial).

How to add a page to the wiki?

Go to the frequently asked questions, example scripts, or tutorials page, and hit the 'Edit this page' button. Add the title of your contribution to the list and hit 'save'.

You add e.g.: * [[example:This is the name of your example script]]

You now see the title of your contribution as a red link. If you click on this link you can create the page and add your content. See syntax for further Wiki syntax. You can also practice on the playground.

How to add tags

By adding tags your contribution will be easier to find. Add as a first line (for example):

{{tag>example eeg source statistics}}

if you add an example script that describes performing source statistics in eeg. The tags 'example','eeg', 'source', and 'statistics' will be given to your page. Here you can find a list of possible tags. Please always add 'faq', 'example' or 'tutorial', depending on your type of contribution.

How to structure a tutorial

For consistency tutorials should preferably be structured in the following way:

  • Introduction: introduction to the tutorial and dataset
  • Background: some background on the methods used
  • Procedure: summarize which analysis steps are performed in the tutorial. Include picture of analysis protocol.
  • All steps in the procedure are subsequent headings.

For an example of a well-structured tutorial see the tutorial on event related fields.

How to name example data

When using example data in tutorials, please use consistent naming. That is:

  • add a prefix to the data-name that shows what kind of data it is. Prefixes are: data (for raw/preprocessed data), timelock, freq, stat and source. Example: if you have timelocked data (ERP/ERF) of condition FIC, you can call it timelockFIC. So do not use 'data' for everything.
  • save the data as a mat-file with the same name (e.g. save freqFIC freqFIC)
documentation_guidelines.txt · Last modified: 2010/04/01 16:10 by timeng
Back to top
chimeric.de = chi`s home Creative Commons License Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0