Wiki replaced by the documentation in the toolbox authored by Tobias Otto's avatar Tobias Otto
Every page now says that the wiki is no longer maintained and that the
documentation is part of the toolbox: docs/html/index.html, opened in a
web browser after downloading. Each page names where its content is
now (function pages under docs/html/functions, guides under
docs/html/guides). The former content stays in the history of this
wiki.
![Artboard_1_copy_5x](uploads/2874f8ffe8447cb0af8aed9e4fb88c6f/Artboard_1_copy_5x.png) # The documentation has moved into the toolbox
**This wiki is no longer maintained.** The documentation of the OTBR Toolbox is now part of the toolbox itself, and it is more up to date than this wiki.
## [Getting started](Getting started) After downloading the toolbox, open **`docs/html/index.html`** in a web browser. It works offline, also for Octave users. In MATLAB and Octave, `help <function name>` shows the description of a function.
#### [Installation and Setup](/Getting-started#installation-and-setup)
#### [Setup an Experiment](/Getting-started#setup-an-experiment)
#### [Coding procedures](/Getting-started#coding-procedures)
#### [Function Tree](/Getting-started#function-tree)
#### [Function descriptions](/Getting-started#function-descriptions)
## [How-tos](How-tos) Download the toolbox: https://gitlab.ruhr-uni-bochum.de/ikn/OTBR
#### [flip/ dontFlip](/How-tos#flip-dontflip)
#### [Using a Raspberry Pi as local](/How-tos#using-a-raspberry-pi-as-local-computer)
#### [Using a Raspberry Pi as local or remote computer](/How-tos#using-a-raspberry-pi-as-remote-computer)
#### [How to flash a SD card for the OTBR Toolbox](/How-tos#how-to-flash-a-sd-card-for-the-otbr-toolbox)
#### [Updating the OTBR Toolbox and the Psychophysics Toolbox](/How-tos#updating-the-otbr-toolbox-and-the-psychophysics-toolbox)
#### [Configure OTBR Toolbox and Raspberry for use in a OTBR Network setup](/How-tos#configure-otbr-toolbox-and-raspberry-for-use-in-a-otbr-network-setup)
#### [Coding an MRI experiment](/How-tos#coding-an-mri-experiment)
#### [Event-codes](/How-tos#event-codes)
#### [Tracking](/How-tos#tracking)
## [Initialization](Initialization) ## Where the content of this page is now
#### [myHardwareSetup](/Initialization#myhardwaresetup)
#### [myParadigmSetup](/Initialization#myparadigmsetup)
#### [initOTBR](/Initialization#initotbr)
#### [startExperiment](/Initialization#startexperiment)
#### [stopExperiment](/Initialization#stopexperiment)
## [Stimuli Display](Stimuli-Display) The start page `docs/html/index.html` lists all functions by category, with a search field, and links to the guides:
#### [initWindow](/Stimuli-Display#initwindow)
#### [closeWindow](/Stimuli-Display#closewindow)
## [Text Options](Text Options) - Guide *Getting started*: `docs/html/guides/gettingStarted.html`
#### [showText](/Text-options#showtext) - Guide *Screen output: what appears when (Flip and dontFlip)*: `docs/html/guides/screenOutput.html`
#### [changeTextSettings](/Text-options#changetextsettings) - Guide *Coding an MRI experiment*: `docs/html/guides/mriExperiment.html`
#### [showInstructions (human)](/Text-options#showinstructions-human) - Guide *Raspberry Pi: local and remote*: `docs/html/guides/raspberryPi.html`
#### [fixationCross](/Text-options#fixationcross) - Guide *Camera tracking*: `docs/html/guides/tracking.html`
#### [plotScale (human)](/Text-options#plotscale-human) - Guide *Client panel: watching an experiment from the office*: `docs/html/guides/clientPanel.html`
#### [startQuestionnaire (human)](/Text-options#startquestionnaire-human) - Guide *Triggers on the parallel port*: `docs/html/guides/parallelPortTriggers.html`
#### [inputTextBox (human)](/Text-options#inputtextbox-human)
#### [cleanConfigCache](/Text-options#cleanconfigcache)
## [Image Display](Image Display) Each function has its own page under `docs/html/functions/<function name>.html`.
#### [loadImage](/Image-display#loadimage)
#### [showStimuli](/Image-display#showstimuli)
#### [showManyStimuli](/Image-display#showmanystimuli)
## [Video Display](Video Display) The former content of this wiki is still in its history.
#### [loadVideo](/Video-display#loadvideo)
#### [startVideo](/Video-display#startvideo)
#### [showVideo](/Video-display#showvideo)
#### [stopVideo](/Video-display#stopvideo)
#### [closeVideo](/Video-display#closevideo)
## [Sound Options](Sound Options)
#### [listSound](/Sound-options#listsound)
#### [initSound](/Sound-options#initsound)
#### [loadSound](/Sound-options#loadsound)
#### [controlSound](/Sound-options#controlsound)
#### [closeSound](/Sound-options#closesound)
## [User or Animal response](User or Animal response)
#### [getKeyValue](/User-or-animal-response#getkeyvalue)
#### [keyBuffer (animal)](/User-or-animal-response#keybuffer-animal)
#### [getAnswer (human)](/User-or-animal-response#getanswer-human)
#### [createButton](/User-or-animal-response#createbutton)
#### [getButtonClick](/User-or-animal-response#getbuttonclick)
#### [getMousePos](/User-or-animal-response#getmousepos)
## [Device Interface](Device Interface)
#### [bIO](/Device-interface#bio)
#### [feeding (animal)](/Device-interface#feeding-animal)
#### [punishment (animal)](/Device-interface#punishment-animal)
#### [openNetworkIO](/Device-interface#opennetworkio)
#### [closeNetworkIO](/Device-interface#closenetworkio)
## [Save Options](Save Options)
#### [errorSave](/Save-Options#errorsave)
#### [getBasicInformation](/Save-Options#getbasicinformation)
#### [save2File](/Save-Options#save2file)
#### [save2ExcelFile](/Save-Options#save2excelfile)
#### [getCode](/Save-Options#getcode)
#### [saveCode](/Save-Options#savecode)
## [Randomization Tools](Randomization Tools)
#### [randomOrder](/Randomization-tools#randomorder)
#### [nBackBuffer](/Randomization-tools#nbackbuffer)
## [Network Control Computer](Network Control Computer)
#### [connect2Host](/Network-control-computer#connect2host)
#### [sendExperiment2Host](/Network-control-computer#sendexperiment2host)
#### [printCmd](/Network-control-computer#printcmd)
#### [sendCommand2Host](/Network-control-computer#sendcommand2host)
#### [getKeyBufferResult](/Network-control-computer#getkeybufferresult)
#### [stopRemoteKeyBuffer](/Network-control-computer#stopremotekeybuffer)
#### [wait4NetworkResponse](/Network-control-computer#wait4networkresponse)
#### [disconnectFromHost](/Network-control-computer#disconnectfromhost)
#### [rebootRaspberry](/Network-control-computer#rebootraspberry)
## [Network Remote Computer](Network Remote Computer)
#### [connect2ControlComputer](/Network-remote-computer#connect2controlcomputer)
## [MRI or Trigger](MRI or Trigger)
#### [initMRIChatPart1](/MRI-or-trigger#initmrichatpart1)
#### [initMRIChatPart2](/MRI-or-trigger#initmrichatpart2)
#### [sendTriggerMRI](/MRI-or-trigger#sendtriggermri)
#### [parChat](/MRI-or-trigger#parchat)
#### [parChatWord](/MRI-or-trigger#parchatword)
## [Manual Client Panel](Manual Client Panel)
#### [What is the panel?](/Manual-Client-Panel#what-is-the-panel)
#### [What does the panel look like?](/Manual-Client-Panel#what-does-the-panel-look-like)
#### [How to incorporate the panel feature into your paradigms?](/Manual-Client-Panel#how-to-incorporate-the-panel-feature-into-your-paradigms)
#### [What do you need to run on your computer?](/Manual-Client-Panel#what-do-you-need-to-run-on-your-computer)
\ No newline at end of file