TSG Doc - User contributions [en]

System Image/Changelog

2026-04-16T14:02:04Z

E.vandenberge:

{{Outdated}}

==Windows 10 Version 2.35==

''Released 2025-03-07''

'''Software Updates'''
* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.34==

''Released 2025-02-07''

'''Software Updates'''
* Psychopy2024.2.4 is now the default version
* Python 3.10 is now the default version
* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.33==

''Released 2024-10-04''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.32==

''Released 2024-09-06''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.31==

''Released 2024-08-09''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.30==

''Released 2024-07-05''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

* Psychopy2024.1.0 is the default version
* Piplist
* alabaster==0.7.12
* appdirs==1.4.4
* arabic-reshaper==2.1.3
* arrow==1.2.2
* astroid==2.11.6
* astunparse==1.6.3
* asyncio==3.4.3
* atomicwrites==1.4.0
* attrs==21.4.0
* autopep8==1.6.0
* Babel==2.10.3
* backcall==0.2.0
* bcrypt==3.2.2
* beautifulsoup4==4.11.1
* binaryornot==0.4.4
* black==22.6.0
* bleach==5.0.1
* bleak==0.14.3
* bleak-winrt==1.1.1
* blosc2==2.2.7
* cachetools==5.2.0
* certifi==2022.6.15
* cffi==1.15.0
* chardet==4.0.0
* charset-normalizer==2.0.12
* click==8.1.3
* cloudpickle==2.1.0
* colorama==0.4.5
* cookiecutter==2.1.1
* cryptography==37.0.2
* cycler==0.11.0
* DateTime==4.4
* debugpy==1.6.0
* decorator==4.4.2
* defusedxml==0.7.1
* diff-match-patch==20200713
* dill==0.3.5.1
* distlib==0.3.4
* docutils==0.18.1
* dukpy==0.2.3
* egi-pynetstation==0.0.0rc1
* elementpath==4.4.0
* entrypoints==0.4
* esprima==4.0.1
* et-xmlfile==1.1.0
* fastjsonschema==2.15.3
* ffpyplayer==4.3.5
* filelock==3.7.1
* flake8==4.0.1
* fonttools==4.33.3
* freetype-py==2.3.0
* future==0.18.2
* gevent==21.12.0
* gitdb==4.0.9
* GitPython==3.1.27
* glfw==2.5.3
* google-api-core==2.8.2
* google-auth==2.8.0
* google-cloud==0.34.0
* google-cloud-speech==2.14.1
* googleapis-common-protos==1.56.3
* greenlet==1.1.2
* grpcio==1.47.0
* grpcio-status==1.47.0
* hexbytes==1.2.0
* hidapi==0.14.0
* html2text==2024.2.26
* idna==3.3
* imageio==2.19.3
* imageio-ffmpeg==0.4.7
* imagesize==1.3.0
* importlib-metadata==4.12.0
* importlib-resources==5.8.0
* inflection==0.5.1
* intervaltree==3.1.0
* ipykernel==6.15.0
* ipython==7.34.0
* ipython-genutils==0.2.0
* isort==5.10.1
* javascripthon==0.12
* jedi==0.18.1
* jellyfish==0.9.0
* Jinja2==3.1.2
* jinja2-time==0.2.0
* joblib==1.2.0
* joycon-python==0.2.4
* json-tricks==3.15.5
* jsonschema==4.6.0
* jupyter-client==7.3.4
* jupyter-core==4.10.0
* jupyterlab-pygments==0.2.2
* keyring==23.6.0
* kiwisolver==1.4.3
* lazy-object-proxy==1.7.1
* macropy3==1.1.0b2
* markdown-it-py==2.1.0
* MarkupSafe==2.1.1
* matplotlib==3.5.2
* matplotlib-inline==0.1.3
* mccabe==0.6.1
* mdurl==0.1.1
* mistune==0.8.4
* mne==1.2.1
* mnelab==0.8.5
* moviepy==1.0.3
* msgpack==1.0.4
* msgpack-numpy==0.4.8
* mypy-extensions==0.4.3
* nbclient==0.6.4
* nbconvert==6.5.0
* nbformat==5.4.0
* ndindex==1.8
* nest-asyncio==1.5.5
* nidaqmx==0.6.3
* ntplib==0.4.0
* numexpr==2.8.3
* numpy==1.23.0
* numpydoc==1.4.0
* opencv-python==4.6.0.66
* openpyxl==3.0.10
* orjson==3.10.0
* packaging==21.3
* pandas==2.0.3
* * pandocfilters==1.5.0
* paramiko==2.11.0
* parso==0.8.3
* pathspec==0.9.0
* patsy==0.5.2
* pep8==1.7.1
* pexpect==4.8.0
* pickleshare==0.7.5
* pillow==10.3.0
* platformdirs==2.5.2
* pluggy==1.0.0
* pooch==1.6.0
* proglog==0.1.10
* prompt-toolkit==3.0.30
* proto-plus==1.20.6
* protobuf==3.20.1
* psutil==5.9.1
* psychopy==2024.1.0
* psychtoolbox==3.0.18.2
* ptyprocess==0.7.0
* py-cpuinfo==9.0.0
* pyasn1==0.4.8
* pyasn1-modules==0.2.8
* pybv==0.7.5
* pycodestyle==2.8.0
* pycparser==2.21
* PyDAQmx==1.4.6
* pydocstyle==6.1.1
* pyEDFlib==0.1.30
* pyflakes==2.4.0
* pygame==2.1.2
* pyglet==1.4.11
* PyGLM==2.7.1
* Pygments==2.12.0
* pylint==2.14.3
* pyls-spyder==0.4.0
* pylsl==1.16.0
* PyNaCl==1.5.0
* pyo==1.0.4
* pyparallel==0.2.2
* pyparsing==3.0.9
* pypi-search==2.0
* pypiwin32==223
* pyqmix==2021.1.2
* PyQt5==5.15.7
* PyQt5-Qt5==5.15.2
* PyQt5-sip==12.11.0
* PyQt6==6.6.1
* PyQt6-Qt6==6.6.3
* PyQt6-sip==13.6.0
* pyqtgraph==0.12.4
* PyQtWebEngine==5.15.6
* PyQtWebEngine-Qt5==5.15.2
* pyrsistent==0.18.1
* pyscab==1.0.1
* pyserial==3.5
* PySide6==6.4.0.1
* PySide6-Addons==6.4.0.1
* PySide6-Essentials==6.4.0.1
* python-bidi==0.4.2
* python-dateutil==2.8.2
* python-gitlab==3.6.0
* python-lsp-black==1.2.1
* python-lsp-jsonrpc==1.0.0
* python-lsp-server==1.4.1
* python-picard==0.7
* python-slugify==6.1.2
* python-vlc==3.0.11115
* pytoolconfig==1.1.2
* pytz==2022.1
* pywin32==304
* pywin32-ctypes==0.2.0
* pyWinhook==1.6.2
* pyxdf==1.16.3
* PyYAML==6.0
* pyzmq==23.2.0
* QDarkStyle==3.0.3
* qstylizer==0.2.1
* QtAwesome==1.1.1
* qtconsole==5.3.1
* qtm==2.1.1
* qtm-rt==3.0.1
* QtPy==2.1.0
* questplus==2023.1
* requests==2.28.0
* requests-toolbelt==0.9.1
* rope==1.2.0
* rsa==4.8
* Rtree==1.0.0
* ruamel.yaml==0.16.3
* RuSocSci==0.9.0
* scikit-learn==1.1.3
* scipy==1.8.1
* seaborn==0.11.2
* setuptools==56.0.0
* shiboken6==6.4.0.1
* six==1.16.0
* smmap==5.0.0
* snowballstemmer==2.2.0
* sortedcontainers==2.4.0
* SoundFile==0.10.3.post1
* soupsieve==2.3.2.post1
* SpeechRecognition==3.8.1
* Sphinx==5.0.2
* sphinxcontrib-applehelp==1.0.2
* sphinxcontrib-devhelp==1.0.2
* sphinxcontrib-htmlhelp==2.0.0
* sphinxcontrib-jsmath==1.0.1
* sphinxcontrib-qthelp==1.0.3
* sphinxcontrib-serializinghtml==1.1.5
* spyder==5.3.1
* spyder-kernels==2.3.1
* statsmodels==0.13.2
* tables==3.7.0
* text-unidecode==1.3
* textdistance==4.2.2
* threadpoolctl==3.1.0
* three-merge==0.1.1
* tinycss2==1.1.1
* TittaPy==1.0.0
* tobii-research==1.10.1
* toml==0.10.2
* tomli==2.0.1
* tomlkit==0.11.0
* tornado==6.1
* tqdm==4.64.0
* traitlets==5.3.0
* typing_extensions==4.2.0
* tzdata==2024.1
* ujson==5.3.0
* urllib3==1.26.9
* virtualenv==20.15.0
* virtualenvwrapper-win==1.2.7
* watchdog==2.1.9
* wcwidth==0.2.5
* webencodings==0.5.1
* websocket-client==1.3.3
* websockets==12.0
* wheel==0.37.1
* WMI==1.5.1
* wrapt==1.14.1
* wxPython==4.1.1
* xarray==2022.3.0
* * xlrd==2.0.1
* xmlschema==3.2.1
* yapf==0.32.0
* zipp==3.8.0
* zope.event==4.5.0
* zope.interface==5.4.0
* sr_research_pylink-2.1.1.0-cp38-cp38-win_amd64.whl

* Psychopy 2024.1.4 is now a Virtual Environment
* Psychopy 2024.2.3 is now a Virtual Environment

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.29==

''Released 2024-06-06''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

* Matlab 2024A

'''Minor Changes'''

==Windows 10 Version 2.28==

''Released 2024-05-03''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

* Virtualenv Psychopy2024.1.0.Python3.8(64bits)

'''Minor Changes'''

==Windows 10 Version 2.27==

''Released 2024-04-05''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.26==

''Released 2024-03-01''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.25==

''Released 2024-02-01''

'''Software Updates'''

* F-Secure is updated
* Windows is updated
* Default Python is versie 3.8.10
* Psychopy is updated from Psychopy2022.2.4 to Psychopy2023.2.3
* VirtualEnvs zijn toegevoegd

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.24==

''Released 2024-01-05''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.23==

''Released 2023-12-01''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.22==

''Released 2023-11-02''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.21==

''Released 2023-10-06''

'''Software Updates'''

* F-Secure is updated
* Windows is updated
* GStreamer 1.0 1.20.1 GStreamer 1.0 1.20.4
* Microsoft Silverlight 5.1.30514.0 Microsoft Silverlight 5.1.50907.0
* Logitech G HUB 2021.3.5164 Logitech G HUB 2021.3.9205
* National Instruments is updated
* Presentation 22.1 01.21.21 Presentation 24.0 07.19.23
* Python virtual env. is updated
* PySide6 6.4.0.1 PySide6 6.5.2
* PySide6-Addons 6.4.0.1 PySide6-Addons 6.5.2
* PySide6-Essentials 6.4.0.1 PySide6-Essentials 6.5.2
* matplotlib 3.5.2 matplotlib 3.7.3
* mnelab 0.8.5 mnelab 0.8.6
* pip 23.1.2 pip 23.2.1
* shiboken6 6.4.0.1 shiboken6 6.5.2

'''Removed Software'''

'''Added Software'''

* Psychopy2023.1.3 and Psychopy2023.2.2 virtual envs
* contourpy 1.1.0
* dpath 2.1.6
* hexbytes 0.3.1
* orjson 3.9.7
* pyscab 1.0.1
* python-lightblue 1.0.3
* qtm-rt 3.0.1
* websockets 11.0.3

'''Minor Changes'''

==Windows 10 Version 2.20==

''Released 2023-09-01''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.19==

''Released 2023-08-04''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.18==

''Released 2023-07-07''

'''Software Updates'''

* F-Secure is updated
* Windows is updated to 22H2
* OBS Studio 25.04 OBS Studio 29.1.2

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.17==

''Released 2023-06-02''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.16==

''Released 2023-04-26''

'''Software Updates'''

* National Instruments is updated
* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.15==

''Released 2023-03-30''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.14==

''Released 2023-03-03''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.13==

''Released 2023-02-03''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.12==

''Released 2023-01-06''

'''Software Updates'''

* F-Secure is updated
* Windows is updated
* Psychopy 2022.1.4 Psychopy 2022.2.4

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.11==

''Released 2022-12-02''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.10==

''Released 2022-11-04''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''
*mnelab[full] package in Python 38

'''Minor Changes'''

==Windows 10 Version 2.9==

''Released 2022-10-07''

'''Software Updates'''

* F-Secure is updated to 15.20
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.8==

''Released 2022-09-02''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.7==

''Released 2022-08-05''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.6==

''Released 2022-07-01''

'''Software Updates'''

* F-Secure is updated
* Windows is updated
* Python 37 Python 38
* Psychopy 2020.1.0 Psychopy 2022.1.4

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.5==

''Released 2022-06-03''

'''Software Updates'''

* F-Secure is updated
* Windows is updated
* Presentation 22.1 01.21.21 Presentation 23.0.10.27.21

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.4==

''Released 2022-05-06''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.3==

''Released 2022-04-04''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

'''Removed Software'''

* LiteManager Pro - Kijker 4.9

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.2==

''Released 2022-02-28''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.1==

''Released 2022-04-02''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 2.0==

''Released 2022-07-01''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 1.7==

''Released 2021-12-02''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 1.6==

''Released 2021-11-04''

'''Software Updates'''

* F-Secure is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 1.5==

''Released 2021-10-01''

'''Software Updates'''

* F-Secure is updated
* Google Chrome is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 1.4==

''Released 2021-09-03''

'''Software Updates'''

* F-Secure is updated
* Google Chrome is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 1.3==

''Released 2021-08-06''

'''Software Updates'''
* ExperimentBuilder is updated to Version 2.3.38
* F-Secure is updated
* Google Chrome is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 1.2==

''Released 2021-05-07''

'''Software Updates'''

* F-Secure is updated
* Google Chrome is updated
* Windows is updated

'''Removed Software'''

'''Added Software'''

'''Minor Changes'''

==Windows 10 Version 1.1==

''Released 2021-04-09''

'''Software Updates'''

* F-Secure is updated
* Google Chrome is updated
* Intel(R) Management Engine Components are updated
* Microsoft Visual C++ is updated
* Presentation 20.3 02.25.19 Presentation 22.1 01.21.21
* Windows is updated

'''Removed Software'''

* Java 2.8.251.8

'''Added Software'''

* LiteManager Pro - Viewer 4.9
* Microsoft Office 2016 English version added

'''Minor Changes'''

==Windows 10 Version 1==

''Released 2021-01-11''

'''Software Updates'''

* Adobe Acrobat Reader DC 20.009.20067 Adobe 2019.008.20071
* Audacity 2.1.2 Audacity 2.3.3
* Bonjour Print Services 2.0.2.0 Bonjour Print Services 2.0.4.0
* Brainvision 2.1.1 Brainvision 2.2.0
* Cyberduck 4.7.3 4.7.3 Cyberduck 7.3.0.32621
* Eyelink Dataviewer 2.4.1 Eyelink Dataviewer 3.1.97
* MATLAB R2015b MATLAB R2020b 9.9
* Microsoft Office 2010 Microsoft Office 2016
* Microsoft Visual C++ is updated
* Microsoft .NET Framework 4.7.1 Microsoft .NET Framework 4.8
* NI is updated
* Notepad++ 7.1 Notepad++ (64-bit x64) 7.8.5
* F-Secure is updated
* Google Chrome is updated
* Git 2.6.3 Git 2.26.0
* Java 2.8.211.12 Java 2.8.251.8
* OBS Studio 23.2.1 OBS Studio 25.04
* Python 2.7.14 Python 3.7.6
* 7-Zip 16.04 7-Zip 19.00

'''Package Python37'''

* alabaster 0.7.12
* appdirs 1.4.4
* arabic-reshaper 2.1.1
* astroid 2.4.2
* astunparse 1.6.3
* async-generator 1.10
* atomicwrites 1.4.0
* attrs 20.3.0
* autopep8 1.5.4
* Babel 2.9.0
* backcall 0.2.0
* bcrypt 3.2.0
* black 20.8b1
* bleach 3.2.1
* certifi 2020.12.5
* cffi 1.14.4
* chardet 4.0.0
* click 7.1.2
* cloudpickle 1.6.0
* colorama 0.4.4
* cryptography 3.3.1
* cycler 0.10.0
* decorator 4.4.2
* defusedxml 0.6.0
* diff-match-patch 20200713
* distlib 0.3.1
* docutils 0.16
* dukpy 0.2.3
* entrypoints 0.3
* esprima 4.0.1
* et-xmlfile 1.0.1
* filelock 3.0.12
* flake8 3.8.4
* freetype-py 2.2.0
* future 0.18.2
* gevent 20.9.0
* gitdb 4.0.5
* GitPython 3.1.11
* glfw 2.0.0
* greenlet 0.4.17
* helpdev 0.7.1
* idna 2.10
* imageio 2.9.0
* imageio-ffmpeg 0.4.2
* imagesize 1.2.0
* importlib-metadata 2.0.0
* intervaltree 3.1.0
* ipykernel 5.4.2
* ipython 7.19.0
* ipython-genutils 0.2.0
* isort 5.6.4
* javascripthon 0.11
* jdcal 1.4.1
* jedi 0.17.2
* Jinja2 2.11.2
* json-tricks 3.15.5
* jsonschema 3.2.0
* jupyter-client 6.1.7
* jupyter-core 4.7.0
* jupyterlab-pygments 0.1.2
* keyring 21.5.0
* kiwisolver 1.3.1
* lazy-object-proxy 1.4.3
* macropy3 1.1.0b2
* MarkupSafe 1.1.1
* matplotlib 3.3.3
* mccabe 0.6.1
* mistune 0.8.4
* moviepy 1.0.3
* msgpack 1.0.2
* msgpack-numpy 0.4.7.1
* mypy-extensions 0.4.3
* nbclient 0.5.1
* nbconvert 6.0.7
* nbformat 5.0.8
* nest-asyncio 1.4.3
* numexpr 2.7.1
* numpy 1.19.4+mkl
* numpydoc 1.1.0
* opencv-python 4.4.0.46
* openpyxl 3.0.5
* packaging 20.8
* pandas 1.1.5
* pandocfilters 1.4.3
* paramiko 2.7.2
* parso 0.7.0
* pathspec 0.8.1
* patsy 0.5.1
* pexpect 4.8.0
* pickleshare 0.7.5
* Pillow 8.0.1
* pip 21.0.1
* pluggy 0.13.1
* proglog 0.1.9
* prompt-toolkit 3.0.8
* psutil 5.8.0
* PsychoPy 2020.2.10
* psychtoolbox 3.0.16
* ptyprocess 0.6.0
* pycodestyle 2.6.0
* pycparser 2.20
* pydocstyle 5.1.1
* pyflakes 2.2.0
* pygame 2.0.0
* pyglet 1.3.2
* Pygments 2.7.3
* pylint 2.6.0
* pyls-black 0.4.6
* pyls-spyder 0.3.0
* PyNaCl 1.4.0
* PyOpenGL 3.1.5
* pyOpenSSL 20.0.1
* pyosf 1.0.5
* pyparsing 2.4.7
* pypiwin32 223
* pyqmix 2019.1
* PyQt5 5.12.3
* PyQt5-sip 12.8.1
* PyQtWebEngine 5.12.1
* pyrsistent 0.17.3
* pyserial 3.5
* python-bidi 0.4.2
* python-dateutil 2.8.1
* python-gitlab 2.5.0
* python-jsonrpc-server 0.4.0
* python-language-server 0.36.2
* python-vlc 3.0.11115
* pytz 2020.4
* pywin32 228
* pywin32-ctypes 0.2.0
* pyWinhook 1.6.2
* PyYAML 5.3.1
* pyzmq 20.0.0
* QDarkStyle 2.8.1
* QtAwesome 1.0.2
* qtconsole 5.0.1
* QtPy 1.9.0
* questplus 2019.4
* regex 2020.11.13
* requests 2.25.1
* rope 0.18.0
* ruamel.yaml 0.16.12
* ruamel.yaml.clib 0.2.2
* RuSocSci 0.8.7
* scipy 1.5.4
* seaborn 0.11.1
* setuptools 41.2.0
* six 1.15.0
* smmap 3.0.4
* snowballstemmer 2.0.0
* sortedcontainers 2.3.0
* sounddevice 0.4.1
* SoundFile 0.10.3.post1
* Sphinx 3.4.0
* sphinxcontrib-applehelp 1.0.2
* sphinxcontrib-devhelp 1.0.2
* sphinxcontrib-htmlhelp 1.0.3
* sphinxcontrib-jsmath 1.0.1
* sphinxcontrib-qthelp 1.0.3
* sphinxcontrib-serializinghtml 1.1.4
* spyder 4.2.1
* spyder-kernels 1.10.1
* statsmodels 0.12.1
* tables 3.6.1
* testpath 0.4.4
* textdistance 4.2.0
* three-merge 0.1.1
* toml 0.10.2
* tornado 6.1
* tqdm 4.54.1
* traitlets 5.0.5
* typed-ast 1.4.1
* typing-extensions 3.7.4.3
* ujson 4.0.1
* urllib3 1.26.2
* virtualenv 20.0.34
* virtualenvwrapper-win 1.2.6
* watchdog 1.0.2
* wcwidth 0.2.5
* webencodings 0.5.1
* websocket-client 0.57.0
* wheel 0.36.2
* wrapt 1.12.1
* wxPython 4.1.1
* xarray 0.16.2
* xlrd 2.0.1
* yapf 0.30.0
* zipp 3.3.0
* zope.event 4.5.0
* zope.interface 5.2.0

'''Package Python36'''

* alabaster 0.7.12
* appdirs 1.4.3
* arabic-reshaper 2.0.15
* astroid 2.3.3
* astunparse 1.6.3
* atomicwrites 1.3.0
* attrs 19.3.0
* autopep8 1.5
* Babel 2.8.0
* backcall 0.1.0
* bcrypt 3.1.7
* bleach 3.1.3
* certifi 2019.11.28
* cffi 1.14.0
* chardet 3.0.4
* cloudpickle 1.3.0
* colorama 0.4.3
* cryptography 2.8
* cycler 0.10.0
* decorator 4.4.2
* defusedxml 0.6.0
* diff-match-patch 20181111
* docutils 0.16
* dukpy 0.2.2
* entrypoints 0.3
* esprima 4.0.1
* et-xmlfile 1.0.1
* flake8 3.7.9
* freetype-py 2.1.0.post1
* future 0.18.2
* gevent 1.4.0
* gitdb 4.0.2
* GitPython 3.1.0
* glfw 1.11.0
* greenlet 0.4.15
* helpdev 0.6.10
* idna 2.9
* imageio 2.8.0
* imageio-ffmpeg 0.4.1
* imagesize 1.2.0
* importlib-metadata 1.5.0
* intervaltree 3.0.2
* ipykernel 5.1.4
* ipython 7.13.0
* ipython-genutils 0.2.0
* isort 4.3.21
* javascripthon 0.10
* jdcal 1.4.1
* jedi 0.15.2
* Jinja2 2.11.1
* json-tricks 3.14.0
* jsonschema 3.2.0
* jupyter-client 6.0.0
* jupyter-core 4.6.3
* keyring 21.2.0
* kiwisolver 1.1.0
* lazy-object-proxy 1.4.3
* macropy3 1.1.0b2
* MarkupSafe 1.1.1
* matplotlib 3.2.0
* mccabe 0.6.1
* mistune 0.8.4
* moviepy 1.0.1
* msgpack 1.0.0
* msgpack-numpy 0.4.4.3
* nbconvert 5.6.1
* nbformat 5.0.4
* numexpr 2.7.1
* numpy 1.18.2
* numpydoc 0.9.2
* opencv-python 4.2.0.32
* openpyxl 3.0.3
* packaging 20.3
* pandas 1.0.2
* pandocfilters 1.4.2
* paramiko 2.7.1
* parso 0.5.2
* pathtools 0.1.2
* patsy 0.5.1
* pexpect 4.8.0
* pickleshare 0.7.5
* Pillow 7.0.0
* pip 21.0.1
* pluggy 0.13.1
* proglog 0.1.9
* prompt-toolkit 3.0.4
* psutil 5.7.0
* PsychoPy 2020.1.2
* psychtoolbox 3.0.16
* ptyprocess 0.6.0
* pycodestyle 2.5.0
* pycparser 2.20
* pydocstyle 5.0.2
* pyflakes 2.1.1
* pygame 1.9.6
* pyglet 1.3.2
* Pygments 2.6.1
* pylint 2.4.4
* PyNaCl 1.3.0
* PyOpenGL 3.1.5
* pyOpenSSL 19.1.0
* pyosf 1.0.5
* pyparsing 2.4.6
* pypiwin32 223
* pyqmix 2019.1
* PyQt5 5.12.3
* PyQt5-sip 12.7.1
* PyQtWebEngine 5.12.1
* pyrsistent 0.15.7
* pyserial 3.4
* python-bidi 0.4.2
* python-dateutil 2.8.1
* python-gitlab 2.1.2
* python-jsonrpc-server 0.3.4
* python-language-server 0.31.9
* python-pygaze 0.7.1
* pytz 2019.3
* pywin32 227
* pywin32-ctypes 0.2.0
* pyWinhook 1.6.1
* PyYAML 5.3
* pyzmq 19.0.0
* QDarkStyle 2.8
* QtAwesome 0.7.0
* qtconsole 4.7.1
* QtPy 1.9.0
* questplus 2019.4
* requests 2.23.0
* rope 0.16.0
* ruamel.yaml 0.16.10
* ruamel.yaml.clib 0.2.0
* RuSocSci 0.8.7
* scipy 1.4.1
* seaborn 0.10.0
* setuptools 46.0.0
* six 1.14.0
* smmap 3.0.1
* snowballstemmer 2.0.0
* sortedcontainers 2.1.0
* sounddevice 0.3.15
* SoundFile 0.10.3.post1
* Sphinx 2.4.4
* sphinxcontrib-applehelp 1.0.2
* sphinxcontrib-devhelp 1.0.2
* sphinxcontrib-htmlhelp 1.0.3
* sphinxcontrib-jsmath 1.0.1
* sphinxcontrib-qthelp 1.0.3
* sphinxcontrib-serializinghtml 1.1.4
* spyder 4.1.3
* spyder-kernels 1.9.1
* statsmodels 0.11.1
* tables 3.6.1
* testpath 0.4.4
* tobii-research 1.7.0
* tornado 6.0.4
* tqdm 4.43.0
* traitlets 4.3.3
* typed-ast 1.4.1
* urllib3 1.25.8
* watchdog 0.10.2
* wcwidth 0.1.8
* webencodings 0.5.1
* wheel 0.34.2
* wrapt 1.11.2
* wxPython 4.0.7.post2
* xarray 0.15.0
* xlrd 1.2.0
* yapf 0.29.0
* zipp 3.1.0

'''Software Changes'''

* OS Windows 7 OS Windows 10

'''Removed Software'''

* VPN-Client 2.2.2.0
* E-Prime 1.2 (1.2.1.841)
* ELAN 4.6.2 4.6.2.0
* GStreamer 1.0 1.10.0.1
* Movie Maker 16.4.3528.0331
* Photo Common 16.4.3528.0331
* Photo Gallery 16.4.3528.0331

'''Added Software'''

* MPC-HC 1.7.13 (64-bit) 1.7.13
* Tobii Eyetracking Presentation Workspace

'''Minor Changes'''

==Version 5.6==

''Released 2020-07-03''

'''Software Updates'''

* F-Secure is updated
* Google Chrome 77.0.3865.75 Google Chrome 83.0.4103.116
* Java 2.8.211.12 Java 2.8.251.8

'''Software Changes'''

'''Removed Software'''

* Adobe Reader XI MUI 11.0.00

'''Added Software'''

* Zoom 5.1.1 (28546.0628)
* Adobe Acrobat Reader DC 20.009.20067

'''Minor Changes'''

==Version 5.5==

''Released 2020-01-10''

'''Software Updates'''

* Ubuntu-partition is updated
* F-Secure is updated
* Google Chrome 74.0.3729.157 Google Chrome 77.0.3865.75
* Update for Microsoft .NET Framework 4.7.1 (KB4511516)

'''Software Changes'''

'''Removed Software'''

'''Added Software'''

* Python 3.7.5 64-bits
* Psychopy 3.2.4 64 bits

'''Minor Changes'''

==Version 5.4==

''Released 2019-10-04''

'''Software Updates'''
* Microsoft Visual C++ 2017 Redistributable Microsoft Visual C++ 2019 Redistributable
* Microsoft Visual C++ 2017 x64 Additional Runtime Microsoft Visual C++ 2019 x64 Additional Runtime
* Microsoft Visual C++ 2017 Minimum Runtime Microsoft Visual C++ 2019 Minimum Runtime
* Google Chrome 73.0.3683.86 Google Chrome 77.0.3865.75
* F-Secure is updated
* Microsoft .NET Framework is updated to 4.7.1

'''Software Changes'''

'''Removed Software'''

'''Added Software'''
* OBS Studio 23.2.1

'''Minor Changes'''
* Adobe Reader last documents are invisible

==Version 5.3==

''Released 2019-06-07''

'''Software Updates'''
* Java 191 Java 211
* F-Secure is updated

'''Software Changes'''

'''Removed Software'''
* Presentation 20.2
* Presentation 19.0

'''Added Software'''
* Presentation 20.3

'''Minor Changes'''
* Auto-update Silverlight disabled
* Experiment user added to input & dialout groups (Ubuntu)

==Version 5.2==

''Released 2018-11-02''

'''Software Updates'''
* RuSocSci 0.8.5 RuSocSci 0.8.6
* Java 171 Java 191
* Pip 10.0.1 Pip 18.1
* F-Secure is updated

'''Software Changes'''

'''Removed Software'''
* Arduino 1.6.7

'''Added Software'''
* Presentation 20.2
* Arduino 1.8.7

'''Minor Changes'''
* the UsefulInfo is changed
* shortcuts of Git has been added to the Experiment user

==Version 5.1==

''Released 2018-10-05''

'''Software Updates'''
* F-Secure 12.00 F-Secure 12.33
* Google Chrome 67.0.3396.99 Google Chrome 69.0.3497.100
* Beer is updated

'''Software Changes'''
* Ubuntu-partition is updated
* Beer is updated

'''Removed Software'''

'''Added Software'''
* PyLink for SR Research 2.7

'''Minor Changes'''
* a new Microsoft Office 2010 license is implemented
* the startmenu programs has been pinned

==Version 5==

''Released 2018-07-06''

'''Software Updates'''
* Google Chrome 63.0.3239.84 Google Chrome 67.0.3396.99
* Google Update Helper 1.3.33.7 Google Update Helper 1.3.33.17
* Java Auto Updater 2.8.151.12 Java Auto Updater 2.8.171.11
* Microsoft .NETFramework4.7 Microsoft .NETFramework 4.7.1
* Java 8 Update 151 Java 8 Update 171
* RU_Connect 1.7 Ru-connect 2_0_4_0
* asn1crypto 0.23.0 asn1crypto 0.24.0
* cffi 1.11.2 cffi 1.11.5
* comtypes 1.1.3 comtypes 1.1.4
* cryptography 2.1.2 cryptography 2.2.2
* cython 0.27.2 cython 0.28.3
* gevent 1.2.2 gevent 1.3.4
* greenlet 0.4.12 greenlet 0.4.13
* imageio 2.1.2 imageio 2.3.0
* ipaddress 1.0.18 ipaddress 1.0.22
* jdcal 1.3 jdcal 1.4
* json-tricks 3.8.0 json-tricks 3.12.1
* moviepy 0.2.3.2 moviepy 0.2.3.5
* msgpack-python 0.4.8 msgpack-python 0.5.6
* ndg-httpsclient 0.4.3 ndg-httpsclient 0.5.0
* nibabel 2.2.0 nibabel 2.3.0
* opencv-python 3.3.0.10 opencv-python 3.4.1.15
* openpyxl 2.4.9 openpyxl 2.5.4
* pillow 4.3.0 pillow 5.1.0
* pip 9.0.1 pip 10.0.1
* pipdeptree 0.10.1 pipdeptree 0.12.1
* psychopy 1.85.3 psychopy 1.90.2
* py 1.4.34 py 1.5.4
* pyasn1 0.3.7 pyasn1 0.4.3
* pydaqmx 1.3.2 pydaqmx 1.4.1
* pyopenssl 17.3.0 pyopenssl 18.0.0
* pypiwin32 219 pypiwin32 223
* pytest 3.2.3 pytest 3.6.2
* python-pygaze 0.6.0a21 python-pygaze 0.6.0a25
* pywin32 221 pywin32 223
* pyyaml 3.12 pyyaml 4.1
* rusocsci 0.7.9 rusocsci 0.8.5
* sounddevice 0.3.9 sounddevice 0.3.11
* spyder 3.2.4 spyder 3.2.8
* svgwrite 1.1.11 svgwrite 1.1.12
* tables 3.4.2 tables 3.4.4
* tqdm 4.11.2 tqdm 4.23.4
* wheel 0.30.0 wheel 0.31.1
* xlsxwriter 1.0.2 xlsxwriter 1.0.5

'''Software Changes'''
* Ubuntu-partition is updated
* psychopy 1.85.3 psychopy 1.90.2

'''Removed Software'''

'''Added Software'''
* atomicwrites 1.1.5
* attrs 18.1.0
* cloudpickle 0.5.3
* funcsigs 1.0.2
* more-itertools 4.2.0
* pluggy 0.6.0
* pypubsub 4.0.0
* python-vlc 3.0.102
* soundfile 0.10.2
* wxpython 4.0.3
* zmq 0.0.0

'''Minor Changes'''
* a shortcut to the workgroupdrive is removed from the desktop
* a shortcut to VLCplayer is changed

==Version 4==
''Released 2017-12-08''

'''Software Updates'''
* Microsoft .NET Framework 4.6.1 Microsoft .NET Framework 4.7
* alabaster 0.7.9 alabaster 0.7.10
* babel 2.3.4 babel 2.5.1
* certifi 2016.9.26 certifi 2017.7.27.1
* cffi 1.9.1 cffi 1.11.2
* colorama 0.3.7 colorama 0.3.9
* docutils 0.12 docutils 0.14
* expyriment 0.8.0 expyriment 0.9.0
* gevent 1.1.2 gevent 1.2.2
* greenlet 0.4.10 greenlet 0.4.12
* imageio 1.6 imageio 2.1.2
* jinja2 2.8 jinja2 2.9.6
* markupsafe 0.23 markupsafe 1.0
* matplotlib 1.5.3 matplotlib 2.1.0
* moviepy 0.2.2.11 moviepy 0.2.3.2
* numpy 1.11.3 numpy 1.13.1
* openpyxl 2.3.5 openpyxl 2.4.9
* pandas 0.19.1 pandas 0.21.0
* pillow 3.4.2 pillow 4.3.0
* psutil 4.4.2 psutil 5.4.0
* psychopy 1.84.2 psychopy 1.85.3
* py 1.4.31 py 1.4.34
* pycparser 2.17 pycparser 2.18
* pygments 2.1.3 pygments 2.2.0
* pyparallel 0.2.2 pyparallel
* pyparsing 2.1.10 pyparsing 2.2.0
* pyqtgraph 0.9.10 pyqtgraph 0.10.0
* pyserial 3.2.1 pyserial 3.4
* pytest 3.0.3 pytest 3.2.3
* python-dateutil2.6.0 python-dateutil 2.6.1
* pytz 2016.7 pytz 2017.2
* pywin32 220 pywin32 221
* requests 2.11.1 requests 2.18.4
* rusocsci 0.7.8 rusocsci 0.7.9
* scipy 0.16.1 scipy 0.19.1
* seaborn 0.7.1 seaborn 0.8.1
* setuptools 20.10.1 setuptools 28.8.0
* six 1.10.0 six 1.11.0
* sphinx 1.5a2 sphinx 1.6.5
* tornado 4.4.2 tornado 4.5.2
* tqdm 4.10.0 tqdm 4.11.2
* python 2712 python 2714
* numpy 1.11.3 numpy 1.13.1

'''Software Changes'''
* Ubuntu-partition is updated
* python 2.7.12 python 2.7.14
* psychopy 1.84.2 psychopy 1.85.3

Psychopy 1.84 has been replaced with 1.85.
The default audio back-end has changed as a result.
If you experience problems with sound after this update, try our troubleshooting guide: [[Psychopy#Version_Change_to_1.85]]

'''Removed Software'''
* ASIO4ALL 2.13
* OpenSesame 3.0.2-py2.7-win32-1
* ansi 0.1.3
* arrow 0.10.0
* builder 0.1.0
* coverage 4.2
* datastore 0.3.6
* django 1.10.5
* freetype-py 1.0.2
* futures 3.0.5
* image 1.5.5
* iolabs 3.2
* library 0.0.0
* networkx 1.11
* output 1.0.1
* parallel 0.2.5
* pp 1.6.5
* pyaml 16.11.0
* pyo 0.8.3
* sphinx-rtd-theme 0.1.10a0

'''Added Software'''
* HASP SRM Run-time 2.50.1.3928
* asn1crypto 0.23.0
* astroid 1.5.3
* backports.functools-lru-cache 1.4
* backports.shutil-get-terminal-size 1.0.0
* bleach 2.1.1
* boto 2.48.0
* bz2file 0.98
* chardet 3.0.4
* comtypes 1.1.3
* configparser 3.5.0
* cryptography 2.1.2
* cython 0.27.2
* entrypoints 0.2.3
* enum34 1.1.6
* functools32 3.2.3.post2
* future 0.16.0
* gensim 3.1.0
* hid 0.1.1
* html5lib 1.0b10
* idna 2.6
* ipaddress 1.0.18
* ipykernel 4.6.1
* ipython 5.5.0
* ipython-genutils 0.2.0
* ipywidgets 7.0.4
* isort 4.2.15
* jedi 0.11.0
* json-tricks 3.8.0
* jsonschema 2.6.0
* jupyter 1.0.0
* jupyter-client 5.1.0
* jupyter-console 5.2.0
* jupyter-core 4.3.0
* lazy-object-proxy 1.3.1
* mccabe 0.6.1
* mistune 0.8
* nbconvert 5.3.1
* nbformat 4.4.0
* ndg-httpsclient 0.4.3
* nibabel 2.2.0
* nltk 3.2.5
* nose 1.3.7
* notebook 5.2.1
* numexpr 2.6.4
* numpydoc 0.7.0
* opencv-python 3.3.0.10
* pandocfilters 1.4.2
* parso 0.1.0
* pathlib2 2.3.0
* patsy 0.4.1
* pattern 2.6
* pickleshare 0.7.4
* pipdeptree 0.10.1
* prompt-toolkit 1.0.15
* pyasn1 0.3.7
* pycodestyle 2.3.1
* pyfilesec 0.2.14
* pyflakes 1.6.0
* pyhook 1.5.1
* pylint 1.7.4
* pyopenssl 17.3.0
* pyosf 1.0.5
* pyzmq 16.0.3
* qtawesome 0.4.4
* qtconsole 4.3.1
* qtpy 1.3.1
* rope 0.10.7
* scandir 1.5
* scikit-learn 0.19.1
* simplegeneric 0.8.1
* smart-open 1.5.3
* sounddevice 0.3.9
* sphinxcontrib-websupport 1.0.1
* spyder 3.2.4
* statsmodels 0.8.0
* svgwrite 1.1.11
* tables 3.4.2
* testpath 0.3.1
* traitlets 4.3.2
* typing 3.6.2
* urllib3 1.22
* wcwidth 0.1.7
* webencodings 0.5.1
* wheel 0.30.0
* widgetsnbextension 3.0.7
* win-unicode-console 0.5
* wrapt 1.10.11
* wxPython 2.8.12.1
* xlrd 1.1.0
* xlsxwriter 1.0.2
* xlwt 1.3.0

'''Minor Changes'''
* a shortcut to the workgroupdrive is placed on the desktop
* shortcuts to spyder an psychopy are placed on the desktop
* UsefulInfo is updated

==Version 3.3==
''Released 2017-09-20''

'''Software Updates'''
* Microsoft .NET Framework 4.6.1 (KB4040973)
* Google Chrome 60.0.3112.113

'''Software Changes'''
* Anaconda is removed

'''Minor Changes'''
* a shortcut to drive E: (DATA) is placed on the desktop

==Version 3.1.1==
''Released 2017-05-19''

'''Software Updates'''
* Arduino updated to version 1.6.7
* E-Prime 2.0 Standard SP2 (2.0.10.356)updated to version 2.0.10356
* F-Secure Client Security - DeepGuard updated to version 5.0.58
* F-Secure Client Security - Virus & Spy Protection updated to version 9.51.223
* F-Secure Client Security - Web traffic scanning updated to version 3.00.453
* F-Secure Client Security - Browsing protection updated to version 2.00.1360
* F-Secure Client Security - E-Mail Scanning updated to version 6.00.543
* F-Secure Client Security updated to version 12.00
* GStreamer updated to version1.10.0.1
* Inquisit 4 updated to version4.0.8
* Java Auto Updater updated to version 2.8.121.13
* Java 8 updated to version 121 8.0.1210.13
* Microsoft Visual C++ 2005 Redistributable (x64)updated to version 8.0.61000
* NVIDIA Stereoscopic 3D Driver updated to version 7.17.13.7500
* Realtek High Definition Audio Driver updated to version 6.0.1.6068
* Renesas Electronics USB 3.0 Host Controller Driver updated to version 3.0.23.0
* SMI Experiment Suite 360°updated to version 3.6.149
* SMI iView SDK updated to version 4.2.63
* VLC media player updated to version 2.2.3
{{Listbreak}}
* actiCAP Control updated to version 1.02.0004
* Adobe Reader XI updated to version MUI 11.10
* Audacity updated to version 2.1.2 2..0
* BrainVision Recorder updated to version 1.20.0801
* BrainVision Analyzer updated to version 2.1.1
* Adobe Flash Player 23 ActiveX updated to version 23.0.0.185
* Bonjour updated to version 2.0.4.0
* Bonjour Print Services updated to version 2.0.2.0
* Cyberduck updated to version 4.7.3
* E-Prime 1.2 updated to version 1.2.17
* ffdshow updated to version v1.3.4533
* pyo version updated to version 0.8.2
* wxPython updated to version 3.0.2.0 for Python 2.7
* Presentation updated to version 19.0 11.14.16
* Python 2.7 pygame updated to version 1.9.2
* Python updated to version 2.7.12
* PyQt GPL updated to version v4.11.4 for Python v2.7 (x32)
* .NET Framework updated to version 4.6.1
{{Listbreak}}
* Experiment Builder updated to version 1.10.1630
* Microsoft Office 2010 version 14.0.7015.1000
* Microsoft Silverlight version 5.1.50901.0
* Notepad++ version 7.1
* OpenSesame version 3.0.2-py2.7-win32-1
* Slik Subversion version 1.9.2 (x64)
{{Listbreak}}
* EyeLink Developer's Kit 1.11.5.0 added
* Eyelink Dataviewer 2.4.1 added
* Google Chrome 56.0.2924.87 added
* NI complet package (64 bit) version 15.0.30 added
* Tobii Eyetracking SDK version 2.4.12 added
* Tobii Eyetracking Tools version 0.0.0 added
* VPN-Client version 2.2.2.0

'''Minor Changes'''
* Changing networkmode is updated
* Profile Experiment-user is on E: (Data)

System Image

2026-04-16T14:01:37Z

E.vandenberge:

{{Outdated}}
{{Infobox software
| name = System Image
| logo = cd.png
| screenshot =
| caption =
| developer = Technical Support Group
| installed version = Latest
| installed version date = See [[System Image/Changelog | Changelog]]
| operating system = Windows 11
| resources = 
}}

Our [[Lab Computer]]s are installed with a [https://en.wikipedia.org/wiki/System_image System Image]. This helps us standardize, manage and maintain all software and drivers across all computers in the BSI and DCC research labs. A standardized image allows researchers to easily transfer their experiments from one lab to the other (e.g. in case of booking constraints) or conduct research in multiple labs simultaneously with identical settings.

The TSG will periodically update this image to improve performance and security. 
⚠️ During the update, the Windows (C:\) will be wiped, as may the Data (D:\) drive. Therefore, please back up your data from the Data drive to your network drive regularly (e.g. at the end of every day).

==Pre-Installed Software==
Below is a list of the most frequently used applications that are installed as part of the system image. 
⚠️This list is incomplete and outdated. Please contact our [[Administrator]] if you want to know if a certain program or additional version is installed, or check the [[System_Image/Changelog | changelog]].

==== Research Applications ====
{| class="wikitable"
|-
! scope="col" | Product Name
! scope="col" | Publisher
! scope="col" | Installed Version
! scope="col" | License Type
! scope="col" | Dongle Req.
|-
| [[Biopac]] || BioPac Student Lab || 3.7.7 || Commercial || {{Some|No}} <ref group="fn">Requires Biopac device to be attached</ref>
|-
| Brainvision || Media Recorder || 1.23.0001 || Non-Commercial || {{Yes}}
|-
| Brainvision || Analyzer || 2.2.0 || Non-Commercial || {{Yes}}
|-
| E-Prime || PST-Software || 2.0.10356 || Research Only || {{Yes}}
|-
| Inquisit 6 || Millisecond Software || 6.6.3.6612 || Academic || {{No}}
|-
| [[Matlab]] || MathWorks || 2024a || Academic || {{No}}
|-
| [[Presentation]] || Neurobehavioral Systems || 25.0 || Academic || {{Some|Yes}} <ref group="fn">Limited network licenses are also available</ref>
|-
| [[Psychopy]] || Nottingham University || 2024.1.0 || GNU GPL || {{No}}
|-
| [[Python]] || Python || 3.10.11 || Open Source || {{No}}
|-
|}

==== Standard Applications ====

{| class="wikitable"
|-
! scope="col" | Product Name
! scope="col" | Publisher
! scope="col" | Installed Version
! scope="col" | License Type
|-
| 7zip || 7zip ||  || GNU GPL/LGPL
|-
| Adobe Acrobat Reader || Adobe || 26.001.21431 || Commercial
|-
| Arduino IDE || Arduino ||  || GNU GPL/LGPL
|-
| Audacity || AudacityTeam ||  || GNU GPL
|-
| Cyberduck || Cyberduck ||  || Libre
|-
| [[Gitlab Social Sciences | Git]] || Git ||  || Open Source
|-
| [[OBS Studio]] || OBS Project || 32.1 || GPL 2.0
|-
| Office || Microsoft || 2016 Plus || Academic
|-
| VLC Media Player || VideoLan ||  || GNU GPL
|-
| WithSecure™ Client Security Premium || F-Secure || <ref group="fn">As of image update date (see [[System_Image/Changelog|Changelog]])</ref> || Academic
|-
|}

<references group='fn'/>

==Changelog==
{{see also|System Image/Changelog}}

Meta:Guidelines

2026-04-16T14:00:56Z

E.vandenberge: /* Banners */

This is a sample page for the tsgdoc Wiki and can be used as reference for creating new pages. Note that this introduction is conventionally placed above the Table Of Contents (TOC), so visitors can immediately see what this page is about, instead of having to scroll passed the TOC.

For more general wiki conventions and formatting help , visit the [http://www.mediawiki.org/wiki/Help:Formatting MediaWiki Formatting Guide].

==Page Names==
Page names should be descriptive and unique. Use singular nouns instead of plurals when possible (e.g. "Keyboard" instead of "Keyboards"). This makes linking from singular words easier, as you can just use: 
<code><nowiki>One [[Keyboard]], Two [[Keyboard]]s.</nowiki></code> 
One [[Keyboard]], Two [[Keyboard]]s. 
instead of 
<code><nowiki>One [[Keyboards|Keyboard]], Two [[Keyboards]].</nowiki></code>

==Categories==

Always try to group and categorize your information in a logical and user-friendly way. Prevent redundancies: only create subcategories if there are more of them at the same level (levels are indicated by number of = signs before and after the header), otherwise just collapse to the parent.

You can add many levels of subheaders as you like, but after level 3 they become quite hard to distinguish and will clutter the TOC. If a subject requires many sub-subcategories, consider giving the subcategory its own page. Alternatively, if the sub-subcategories are only small in content, you could make non-TOC headers with simple '''bold text'''.

==Download/External Links==
Links should be '''descriptive'''. Don't waste space by pasting the entire url or writing something like "Click [[Meta:Guidelines|here]] to download the documentation". Examples:
*[[:File:Obs_tut_videoSet.png|Uploaded file with version control]]
*[[Media:BITSI_tempalte2015_duemilanove.zip|Directly downloadable file]] (zip)

==Images==
[[File:placeholder.png|thumb|320px|Right-floating image thumbnail with description.]]

To optimize screen space, images should be placed in a floating window, aligned to the right side of the screen. Larger images can be automatically resized to thumbnails, by specifying the thumbnail width. 300px is the preferred thumbnail size. Adding a description underneath the image is appreciated.
For more image formatting guidelines, visit the [http://www.mediawiki.org/wiki/Help:Images MediaWiki Images Guide].

'''Inline Images'''

Images that are used, for instance, as part of a step-by-step tutorial can be placed inline, with larger size to make them more readable. The exact size is up to you, but the width should not exceed 720px.<ref>Thumbnails 720px wide still fit comfortably within a browser window on half a 1920px desktop monitor.</ref>
[[File:placeholder.png|thumb|none|480px|Caption]]

You can prevent text that is placed after the image from flowing next to the image by placing an HTML break behind it.

==Tables==

For tables, use the Wikitable markup. It is more readable and easy on the eye than the default one. There are multiple ways to create rows and columns, some used in the example below, but for more information, consult the [http://www.mediawiki.org/wiki/Help:Tables MediaWiki Table Formatting Guide].

By default, table columns will scale to fit the contents of the cell, but this usually results in a messy-looking table. Set fixed column-widths to keep the table nice and tight.

For binary entries (e.g. Yes/No), a background color can be used to make it easier to recognize.

{| class="wikitable"
! width="150px" |
! width="200px" | Item 1
! width="200px" | Item 2
! width="200px" | Item 3
|-
| Regular Info || Info 1 || Info 2 || Info 3
|-
! Comparison
! colspan="3" |
|-
| Template || <center><code><nowiki>{{Yes}}</nowiki></code></center> || <center><code><nowiki>{{No}}</nowiki></code></center> || <center><code><nowiki>{{Some}}</nowiki></code></center>
|-
| Result || {{Yes}} || {{No}} || {{Some}}
|-
! colspan="4" |
|-
| Custom name || <center><code><nowiki>{{Yes|Yeah!}}</nowiki></code></center> || <center><code><nowiki>{{No|Nuh-uh}}</nowiki></code></center> || <center><code><nowiki>{{Some|Maybe?}}</nowiki></code></center>
|-
| Result || {{Yes|Yeah!}} || {{No|Nuh-uh}} || {{Some|Maybe?}}
|-
! colspan="4" |
|-
| Manual colors
| style="background-color:#9F9;" | #9F9
| style="background-color:#F99;" | #F99
| style="background-color:#FFD;" | #FFD
|-
|}

==Code==

If you want to add code, the syntax might interfere with the Mediawiki syntax. To prevent this from happening, place your code in one of the following preferred ways:

<code>Fixed format text for short, single-line code.</code>

<syntaxhighlight lang="text">
Long code, spans entire width of the page.
Supports syntax highlighting of certain languages, like Python and HTML.
Change the lang="" attribute to the correct language, e.g. lang="python" or lang="html5"
Use lang="text" for non-supported languages.
</syntaxhighlight>

 

<syntaxhighlight lang="text" line style="height:15em; overflow:auto;">
You can also add line numbering.

If your code is longer than, say, 50 lines, you can add a style attribute to introduce a scrollbar, as sampled here. For a 50-line cutoff, use style="height:50em; overflow:auto;".
Note that this method will cause the print version of the page to cut off the code at the line limit mark and not print the rest of the code.
I might fix that, but if it's really crucial to have an entire page full of code, you should probably give it a separate page.


Prow scuttle parrel provost Sail ho shrouds spirits boom mizzenmast yardarm. Pinnace holystone mizzenmast quarter crow's nest nipperkin grog yardarm hempen halter furl. Swab barque interloper chantey doubloon starboard grog black jack gangway rutters.
Deadlights jack lad schooner scallywag dance the hempen jig carouser broadside cable strike colors. Bring a spring upon her cable holystone blow the man down spanker Shiver me timbers to go on account lookout wherry doubloon chase. Belay yo-ho-ho keelhaul squiffy black spot yardarm spyglass sheet transom heave to.
Sail ho Corsair red ensign hulk smartly boom jib rum gangway. Case shot Shiver me timbers gangplank crack Jennys tea cup ballast Blimey lee snow crow's nest rutters. Fluke jib scourge of the seven seas boatswain schooner gaff booty Jack Tar transom spirits.

</syntaxhighlight>

For command-line code, you can also style it like this for clarity:
<code style="background-color:#000; color:#fff; padding:1px 3px;">ping 127.0.0.1 -n 50 -l 1024</code>

You could also use the <nowiki><tt> <pre> and nowiki </nowiki> tags if better suited for your needs, whatever works best to present the code as clear and readable as possible.

==Emoji==
It is encouraged to use [https://unicode.org/emoji/charts/full-emoji-list.html unicode emojis] (which you can just copy-paste as text) in places where they can draw extra attention, help illustrate your point, or break up the monotony of a long text.

Be aware that emojis may be rendered differently in different browsers or operating systems, so try to pick ones that are common and unambiguous, and also recognizable at the scale they get reduced to when placed in-line on our Wiki. Also, Windows doesn't natively support flag emojis like 🇳🇱, for some reason.

Lastly, don't overdo the emojis, as that could make it seem like our wiki was written by AI.

====Examples====
ℹ️ This is a piece of (extra) information.

⚠️ This is a warning!

❌ This is a no-go!

✅ This is good.

✨ This is something new!

🚧 This is under construction.

🐽 Oink.

These are just examples; feel free to come up with your own conventions so we can later compare and discuss what works best.

==Shields and Badges==
Github-style shields or badges are useful for providing software details like programming language and licensing at a glance. There's a case to be made for our Wiki and Gitlab READMEs to use similar layouts and features for more uniformity in our documentation, and so badges could help with that too. Unfortunately, it is currently a bit of a faff to implement badges on our wiki, as hotlinking or injecting dynamic content from external sources is disabled for security reasons.

The workaround:
# Generate a badge at https://shields.io
# Create a new CSS rule in [[MediaWiki:Common.css]] (see examples at bottom)
# On the page you want to edit, add a custom span with class="shield" and the id as named in the CSS, e.g.: <code><nowiki></nowiki></code>
# Add to the list of shields below.

===Available Shields===
: <code><nowiki></nowiki></code>

==Banners==
If a page is, or needs to be, significantly changed, you can put a banner on top to warn/inform visitors.
<pre>{{Notice|Did you know you could add banners?}}</pre>
{{Notice|Did you know you could add banners?}}
<pre>{{Warn|'''Look Out!'''}}</pre>
{{Warn|'''Look Out!'''}}
<pre>{{Outdated}}</pre>
{{Outdated}}

==References==
<references />

Meta:Guidelines

2026-04-16T13:59:35Z

E.vandenberge: /* Tables */

This is a sample page for the tsgdoc Wiki and can be used as reference for creating new pages. Note that this introduction is conventionally placed above the Table Of Contents (TOC), so visitors can immediately see what this page is about, instead of having to scroll passed the TOC.

For more general wiki conventions and formatting help , visit the [http://www.mediawiki.org/wiki/Help:Formatting MediaWiki Formatting Guide].

==Page Names==
Page names should be descriptive and unique. Use singular nouns instead of plurals when possible (e.g. "Keyboard" instead of "Keyboards"). This makes linking from singular words easier, as you can just use: 
<code><nowiki>One [[Keyboard]], Two [[Keyboard]]s.</nowiki></code> 
One [[Keyboard]], Two [[Keyboard]]s. 
instead of 
<code><nowiki>One [[Keyboards|Keyboard]], Two [[Keyboards]].</nowiki></code>

==Categories==

Always try to group and categorize your information in a logical and user-friendly way. Prevent redundancies: only create subcategories if there are more of them at the same level (levels are indicated by number of = signs before and after the header), otherwise just collapse to the parent.

You can add many levels of subheaders as you like, but after level 3 they become quite hard to distinguish and will clutter the TOC. If a subject requires many sub-subcategories, consider giving the subcategory its own page. Alternatively, if the sub-subcategories are only small in content, you could make non-TOC headers with simple '''bold text'''.

==Download/External Links==
Links should be '''descriptive'''. Don't waste space by pasting the entire url or writing something like "Click [[Meta:Guidelines|here]] to download the documentation". Examples:
*[[:File:Obs_tut_videoSet.png|Uploaded file with version control]]
*[[Media:BITSI_tempalte2015_duemilanove.zip|Directly downloadable file]] (zip)

==Images==
[[File:placeholder.png|thumb|320px|Right-floating image thumbnail with description.]]

To optimize screen space, images should be placed in a floating window, aligned to the right side of the screen. Larger images can be automatically resized to thumbnails, by specifying the thumbnail width. 300px is the preferred thumbnail size. Adding a description underneath the image is appreciated.
For more image formatting guidelines, visit the [http://www.mediawiki.org/wiki/Help:Images MediaWiki Images Guide].

'''Inline Images'''

Images that are used, for instance, as part of a step-by-step tutorial can be placed inline, with larger size to make them more readable. The exact size is up to you, but the width should not exceed 720px.<ref>Thumbnails 720px wide still fit comfortably within a browser window on half a 1920px desktop monitor.</ref>
[[File:placeholder.png|thumb|none|480px|Caption]]

You can prevent text that is placed after the image from flowing next to the image by placing an HTML break behind it.

==Tables==

For tables, use the Wikitable markup. It is more readable and easy on the eye than the default one. There are multiple ways to create rows and columns, some used in the example below, but for more information, consult the [http://www.mediawiki.org/wiki/Help:Tables MediaWiki Table Formatting Guide].

By default, table columns will scale to fit the contents of the cell, but this usually results in a messy-looking table. Set fixed column-widths to keep the table nice and tight.

For binary entries (e.g. Yes/No), a background color can be used to make it easier to recognize.

{| class="wikitable"
! width="150px" |
! width="200px" | Item 1
! width="200px" | Item 2
! width="200px" | Item 3
|-
| Regular Info || Info 1 || Info 2 || Info 3
|-
! Comparison
! colspan="3" |
|-
| Template || <center><code><nowiki>{{Yes}}</nowiki></code></center> || <center><code><nowiki>{{No}}</nowiki></code></center> || <center><code><nowiki>{{Some}}</nowiki></code></center>
|-
| Result || {{Yes}} || {{No}} || {{Some}}
|-
! colspan="4" |
|-
| Custom name || <center><code><nowiki>{{Yes|Yeah!}}</nowiki></code></center> || <center><code><nowiki>{{No|Nuh-uh}}</nowiki></code></center> || <center><code><nowiki>{{Some|Maybe?}}</nowiki></code></center>
|-
| Result || {{Yes|Yeah!}} || {{No|Nuh-uh}} || {{Some|Maybe?}}
|-
! colspan="4" |
|-
| Manual colors
| style="background-color:#9F9;" | #9F9
| style="background-color:#F99;" | #F99
| style="background-color:#FFD;" | #FFD
|-
|}

==Code==

If you want to add code, the syntax might interfere with the Mediawiki syntax. To prevent this from happening, place your code in one of the following preferred ways:

<code>Fixed format text for short, single-line code.</code>

<syntaxhighlight lang="text">
Long code, spans entire width of the page.
Supports syntax highlighting of certain languages, like Python and HTML.
Change the lang="" attribute to the correct language, e.g. lang="python" or lang="html5"
Use lang="text" for non-supported languages.
</syntaxhighlight>

 

<syntaxhighlight lang="text" line style="height:15em; overflow:auto;">
You can also add line numbering.

If your code is longer than, say, 50 lines, you can add a style attribute to introduce a scrollbar, as sampled here. For a 50-line cutoff, use style="height:50em; overflow:auto;".
Note that this method will cause the print version of the page to cut off the code at the line limit mark and not print the rest of the code.
I might fix that, but if it's really crucial to have an entire page full of code, you should probably give it a separate page.


Prow scuttle parrel provost Sail ho shrouds spirits boom mizzenmast yardarm. Pinnace holystone mizzenmast quarter crow's nest nipperkin grog yardarm hempen halter furl. Swab barque interloper chantey doubloon starboard grog black jack gangway rutters.
Deadlights jack lad schooner scallywag dance the hempen jig carouser broadside cable strike colors. Bring a spring upon her cable holystone blow the man down spanker Shiver me timbers to go on account lookout wherry doubloon chase. Belay yo-ho-ho keelhaul squiffy black spot yardarm spyglass sheet transom heave to.
Sail ho Corsair red ensign hulk smartly boom jib rum gangway. Case shot Shiver me timbers gangplank crack Jennys tea cup ballast Blimey lee snow crow's nest rutters. Fluke jib scourge of the seven seas boatswain schooner gaff booty Jack Tar transom spirits.

</syntaxhighlight>

For command-line code, you can also style it like this for clarity:
<code style="background-color:#000; color:#fff; padding:1px 3px;">ping 127.0.0.1 -n 50 -l 1024</code>

You could also use the <nowiki><tt> <pre> and nowiki </nowiki> tags if better suited for your needs, whatever works best to present the code as clear and readable as possible.

==Emoji==
It is encouraged to use [https://unicode.org/emoji/charts/full-emoji-list.html unicode emojis] (which you can just copy-paste as text) in places where they can draw extra attention, help illustrate your point, or break up the monotony of a long text.

Be aware that emojis may be rendered differently in different browsers or operating systems, so try to pick ones that are common and unambiguous, and also recognizable at the scale they get reduced to when placed in-line on our Wiki. Also, Windows doesn't natively support flag emojis like 🇳🇱, for some reason.

Lastly, don't overdo the emojis, as that could make it seem like our wiki was written by AI.

====Examples====
ℹ️ This is a piece of (extra) information.

⚠️ This is a warning!

❌ This is a no-go!

✅ This is good.

✨ This is something new!

🚧 This is under construction.

🐽 Oink.

These are just examples; feel free to come up with your own conventions so we can later compare and discuss what works best.

==Shields and Badges==
Github-style shields or badges are useful for providing software details like programming language and licensing at a glance. There's a case to be made for our Wiki and Gitlab READMEs to use similar layouts and features for more uniformity in our documentation, and so badges could help with that too. Unfortunately, it is currently a bit of a faff to implement badges on our wiki, as hotlinking or injecting dynamic content from external sources is disabled for security reasons.

The workaround:
# Generate a badge at https://shields.io
# Create a new CSS rule in [[MediaWiki:Common.css]] (see examples at bottom)
# On the page you want to edit, add a custom span with class="shield" and the id as named in the CSS, e.g.: <code><nowiki></nowiki></code>
# Add to the list of shields below.

===Available Shields===
: <code><nowiki></nowiki></code>

==Banners==
If a page is, or needs to be, significantly changed, you can put a banner on top to warn/inform visitors.
<pre>{{Notice|Did you know you could add banners?}}</pre>
{{Notice|Did you know you could add banners?}}
<pre>{{Outdated}}</pre>
{{Outdated}}

==References==
<references />

DataHub

2026-04-16T12:40:03Z

E.vandenberge:

{{Infobox software
| name = Lab Streaming Layer
| developer = Christian Kothe; Chadwick Boulay.
| status = -in development-
| programming language = C, C++, Python, Java, C#, MATLAB
| operating system = Windows, Linux, MacOS, Android, iOS
| genre = Data collection
| license = Open source
| website = [https://labstreaminglayer.readthedocs.io/info/intro.html LSL webpage]
}}

=== Resources ===
{{Infobox tsg
| downloads = {{bulleted list
| [https://surfdrive.surf.nl/files/index.php/s/zSpGD53mDQGuPKW Viewer & Streamer]
}}
| manuals = {{bulleted list
| [https://labstreaminglayer.readthedocs.io/ Documentation]
| [https://sccn.ucsd.edu/~mgrivich/LSL_Validation.html LSL Validation]
| [https://labstreaminglayer.readthedocs.io/info/supported_devices.html Supported Devices and Tools]
}}
| templates = {{bulleted list
| [https://surfdrive.surf.nl/files/index.php/s/qggfMMKsnUIDO0k Example Scripts (zip)]
}}
}}

The DataHub Makes use of the lab streaming layer. The lab streaming layer (LSL) is a system for the unified collection of measurement time series in research experiments that handles both the networking, time-synchronization, (near-) real-time access as well as optionally the centralized collection, viewing and disk recording of the data.



==Installation==
Our support for LSL is mainly done in python. Download python here: [https://www.python.org/downloads/release/python-376/ Please choose a 64 bit version.]. Run the installer and make sure to add Python to the file path (it's an option in the installer).
Open a command prompt, start with upgrading the pip installer by typing: 
<code style="background-color:#000; color:#fff; padding:1px 3px;">c:>python -m pip install --upgrade pip</code> 
Then: 
<code style="background-color:#000; color:#fff; padding:1px 3px;">c:>pip install pylsl</code>

more info: [https://github.com/labstreaminglayer/liblsl-Python cross platform pylsl]

===Versions===
Pylsl version 1.16.2 is installed on our [[Lab Computer]]s. Open a command and type the following to find the version used:

<code style="background-color:#000; color:#fff; padding:1px 3px;">c:>python</code> 
<code style="background-color:#000; color:#fff; padding:1px 3px;">>>> import pylsl</code> 
<code style="background-color:#000; color:#fff; padding:1px 3px;">>>> print(pylsl.__version__)</code> 

==Usage==
=== Python ===
Example demonstrating how to send LSL stream and marker data:
<syntaxhighlight lang="python" line>
#!/usr/bin/env python3.10
# -*- coding: utf-8 -*-

import time
import random
import keyboard
from pylsl import StreamInfo, StreamOutlet

from pylsl import local_clock

# --- Setup Marker Stream ---
print("Setting up marker stream...")
marker_info = StreamInfo(
name="MarkerStream",
type="Markers",
channel_count=1,
nominal_srate=0, # Irregular sampling
channel_format="string",
source_id="MarkerSource"
)
marker_outlet = StreamOutlet(marker_info, chunk_size=1)

# --- Setup Data Stream ---
print("Setting up data stream...")
data_info = StreamInfo(
name="TestStream",
type="TestData",
channel_count=4,
nominal_srate=100,
channel_format="float32",
source_id="TestStream_Source"
)

channels = data_info.desc().append_child("channels")
for name in ["A", "B", "C", "D"]:
chan = channels.append_child("channel")
chan.append_child_value("name", name)
chan.append_child_value("unit", "unitless")
chan.append_child_value("type", "TestData")

data_outlet = StreamOutlet(data_info, chunk_size=1)

# --- Start Streaming ---
print("Start streaming... Press 'q' to stop.")
marker_outlet.push_sample(["Start"])

while not keyboard.is_pressed('q'):
random_numbers = [random.randint(1, 2) for _ in range(4)]
data_outlet.push_sample(random_numbers)
time.sleep(0.01)

marker_outlet.push_sample(["Stop"])
print("Streaming stopped.")
</syntaxhighlight>

=== Matlab ===
Please, read the instructions on the GitHub labstreaminglayer website (https://github.com/labstreaminglayer/liblsl-Matlab) on how to prepare Matlab to work with LSL. You can either use the latest release for your Matlab version, or if that doesn't workout well, build it from the source files. Make sure to add the liblsl-Matlab folder to your path recursively to make it available to your own scripts.

A short example for sending lsl streaming data:
<syntaxhighlight lang="matlab" line>
%% instantiate the library
disp('Loading library...');
lib = lsl_loadlib();

% make a new stream outlet
disp('Creating a new streaminfo...');
info = lsl_streaminfo(lib,'BioSemi','EEG',8,100,'cf_float32','sdfwerr32432');

disp('Opening an outlet...');
outlet = lsl_outlet(info);

% send data into the outlet, sample by sample
disp('Now transmitting data...');
while true
outlet.push_sample(randn(8,1));
pause(0.01);
end
</syntaxhighlight>

A short example for receiving lsl streaming data:
<syntaxhighlight lang="matlab" line>
%% instantiate the library
disp('Loading the library...');
lib = lsl_loadlib();

% resolve a stream...
disp('Resolving an EEG stream...');
result = {};
while isempty(result)
result = lsl_resolve_byprop(lib,'type','EEG'); end

% create a new inlet
disp('Opening an inlet...');
inlet = lsl_inlet(result{1});

disp('Now receiving data...');
while true
% get data from the inlet
[vec,ts] = inlet.pull_sample();
% and display it
fprintf('%.2f\t',vec);
fprintf('%.5f\n',ts);
end</syntaxhighlight>

DataHub

2026-04-16T12:39:08Z

E.vandenberge: /* Versions */

{{Infobox software
| name = DataHub
| developer = Christian Kothe; Chadwick Boulay.
| status = -in development-
| programming language = C, C++, Python, Java, C#, MATLAB
| operating system = Windows, Linux, MacOS, Android, iOS
| genre = Data collection
| license = Open source
| website = [https://labstreaminglayer.readthedocs.io/info/intro.html LSL webpage]
}}

=== Resources ===
{{Infobox tsg
| downloads = {{bulleted list
| [https://surfdrive.surf.nl/files/index.php/s/zSpGD53mDQGuPKW viewer & streamer]
}}
| manuals = {{bulleted list
| [https://labstreaminglayer.readthedocs.io/ Documentation]
| [https://sccn.ucsd.edu/~mgrivich/LSL_Validation.html LSL Validation]
| [https://labstreaminglayer.readthedocs.io/info/supported_devices.html Supported Devices and Tools]
}}
| templates = {{bulleted list
| [https://surfdrive.surf.nl/files/index.php/s/qggfMMKsnUIDO0k example scripts (zip)]
}}
}}

The DataHub Makes use of the lab streaming layer. The lab streaming layer (LSL) is a system for the unified collection of measurement time series in research experiments that handles both the networking, time-synchronization, (near-) real-time access as well as optionally the centralized collection, viewing and disk recording of the data.



==Installation==
Our support for LSL is mainly done in python. Download python here: [https://www.python.org/downloads/release/python-376/ Please choose a 64 bit version.]. Run the installer and make sure to add Python to the file path (it's an option in the installer).
Open a command prompt, start with upgrading the pip installer by typing: 
<code style="background-color:#000; color:#fff; padding:1px 3px;">c:>python -m pip install --upgrade pip</code> 
Then: 
<code style="background-color:#000; color:#fff; padding:1px 3px;">c:>pip install pylsl</code>

more info: [https://github.com/labstreaminglayer/liblsl-Python cross platform pylsl]

===Versions===
Pylsl version 1.16.2 is installed on our [[Lab Computer]]s. Open a command and type the following to find the version used:

<code style="background-color:#000; color:#fff; padding:1px 3px;">c:>python</code> 
<code style="background-color:#000; color:#fff; padding:1px 3px;">>>> import pylsl</code> 
<code style="background-color:#000; color:#fff; padding:1px 3px;">>>> print(pylsl.__version__)</code> 

==Usage==
=== Python ===
Example demonstrating how to send LSL stream and marker data:
<syntaxhighlight lang="python" line>
#!/usr/bin/env python3.10
# -*- coding: utf-8 -*-

import time
import random
import keyboard
from pylsl import StreamInfo, StreamOutlet

from pylsl import local_clock

# --- Setup Marker Stream ---
print("Setting up marker stream...")
marker_info = StreamInfo(
name="MarkerStream",
type="Markers",
channel_count=1,
nominal_srate=0, # Irregular sampling
channel_format="string",
source_id="MarkerSource"
)
marker_outlet = StreamOutlet(marker_info, chunk_size=1)

# --- Setup Data Stream ---
print("Setting up data stream...")
data_info = StreamInfo(
name="TestStream",
type="TestData",
channel_count=4,
nominal_srate=100,
channel_format="float32",
source_id="TestStream_Source"
)

channels = data_info.desc().append_child("channels")
for name in ["A", "B", "C", "D"]:
chan = channels.append_child("channel")
chan.append_child_value("name", name)
chan.append_child_value("unit", "unitless")
chan.append_child_value("type", "TestData")

data_outlet = StreamOutlet(data_info, chunk_size=1)

# --- Start Streaming ---
print("Start streaming... Press 'q' to stop.")
marker_outlet.push_sample(["Start"])

while not keyboard.is_pressed('q'):
random_numbers = [random.randint(1, 2) for _ in range(4)]
data_outlet.push_sample(random_numbers)
time.sleep(0.01)

marker_outlet.push_sample(["Stop"])
print("Streaming stopped.")
</syntaxhighlight>

=== Matlab ===
Please, read the instructions on the GitHub labstreaminglayer website (https://github.com/labstreaminglayer/liblsl-Matlab) on how to prepare Matlab to work with LSL. You can either use the latest release for your Matlab version, or if that doesn't workout well, build it from the source files. Make sure to add the liblsl-Matlab folder to your path recursively to make it available to your own scripts.

A short example for sending lsl streaming data:
<syntaxhighlight lang="matlab" line>
%% instantiate the library
disp('Loading library...');
lib = lsl_loadlib();

% make a new stream outlet
disp('Creating a new streaminfo...');
info = lsl_streaminfo(lib,'BioSemi','EEG',8,100,'cf_float32','sdfwerr32432');

disp('Opening an outlet...');
outlet = lsl_outlet(info);

% send data into the outlet, sample by sample
disp('Now transmitting data...');
while true
outlet.push_sample(randn(8,1));
pause(0.01);
end
</syntaxhighlight>

A short example for receiving lsl streaming data:
<syntaxhighlight lang="matlab" line>
%% instantiate the library
disp('Loading the library...');
lib = lsl_loadlib();

% resolve a stream...
disp('Resolving an EEG stream...');
result = {};
while isempty(result)
result = lsl_resolve_byprop(lib,'type','EEG'); end

% create a new inlet
disp('Opening an inlet...');
inlet = lsl_inlet(result{1});

disp('Now receiving data...');
while true
% get data from the inlet
[vec,ts] = inlet.pull_sample();
% and display it
fprintf('%.2f\t',vec);
fprintf('%.5f\n',ts);
end</syntaxhighlight>

Python

2026-04-16T12:38:02Z

E.vandenberge:

{{Infobox software
| name = Python
| logo = Python-logo-generic.svg
| logo size = 180px
| logo alt = Python(tm)
| caption =
| developer =
| released = 
| discontinued =
| latest release version =
| latest release date = 
| latest preview version =
| latest preview date = 
| installed version = 3.10.11 64-bits
| installed version date = 
| status = Active
| programming language = Python
| operating system =
| platform =
| website = [http://www.python.org python.org]
| resources = {{Infobox tsg
| child = yes
| header1 = Workshop
| data1 = {{bulleted list
| [[Workshop: Python for behavioural scientists|Python for behavioural scientists]]
}}
}}
}}

[[wikipedia:Python_(programming_language)|Python]] is a general-purpose, high-level programming language. It is also a [[wikipedia:Python_%28genus%29|type of snake]] and a [[wikipedia:Python_%28Efteling%29|rollercoaster]], but the language is probably more relevant to your research. 
On the lab computers, there is support for Spyder, PyCharm and [[Psychopy]].



==Psychopy==
{{see also|Psychopy}}

When your script fails to load in Psychopy, because you need packages that are not installed on our lab computers, please contact TSG.

== Usage ==

===Example: TestArgs.py===
Execute the following script within the commandline (CMD): <code style="background-color:#000; color:#fff; padding:1px 3px;">python testArgs.py a.</code> 
You should see the following result:

<syntaxhighlight lang="python" overflow:auto;">
number of argument: 2
argv[0]: ./testArgs.py
argv[1]: a
</syntaxhighlight>

==See Also==
*[[Psychopy]]
*[[Workshop: Python for social scientists]]


==External Links==
*{{Official website|http://www.python.org}}

Matlab

2026-04-16T11:56:36Z

E.vandenberge: /* Matlab Libraries */

{{Infobox software
| name = Mathworks Matlab
| logo = Matlab_Logo.png
| screenshot =
| caption =
| developer =
| released = 
| discontinued =
| latest release version =
| latest release date = 
| latest preview version =
| latest preview date = 
| installed version =
| installed version date = 
| status = Active
| programming language = C, C++, Java, MATLAB
| operating system = Microsoft Windows, Linux, MacOSX
| platform =
| size =
| language =
| genre =
| license = Proprietary commercial software
| website = [http://nl.mathworks.com/products/matlab/ www.mathworks.com/matlab]

}}

MATLAB (matrix laboratory) is a multi-paradigm numerical computing environment and fourth-generation programming language. A proprietary programming language developed by MathWorks, MATLAB allows matrix manipulations, plotting of functions and data, implementation of algorithms, creation of user interfaces, and interfacing with programs written in other languages, including C, C++, Java, Fortran and Python.

== Installed Toolboxes ==

{|class="wikitable"
| MATLAB || Simulink || Bioinformatics Toolbox || Control System Toolbox
|-
| Curve Fitting Toolbox || DSP System Toolbox || Data Acquisition Toolbox || Database Toolbox
|-
| DatapixxToolbox || Filter Design HDL Coder || Fixed-Point Designer || Image Acquisition Toolbox
|-
| Image Processing Toolbox || MATLAB Builder EX || MATLAB Builder JA || MATLAB Compiler
|-
| Mapping Toolbox || Neural Network Toolbox || Optimization Toolbox || Parallel Computing Toolbox
|-
| Partial Differential Equation Toolbox || Psychtoolbox || Signal Processing Toolbox || Simulink 3D Animation
|-
| Simulink Control Design || Spreadsheet Link EX || Statistics Toolbox || Symbolic Math Toolbox
|-
| System Identification Toolbox || Wavelet Toolbox || ||
|}

== Matlab Libraries ==

{| class="wikitable"
|-
! scope="col" | Matlab Library
! scope="col" | Description
! scope="col" | Installed
! scope="col" | Installer Type
! scope="col" | URL

|-
| Psychtoolbox || Psychophysics Toolbox is a free set of Matlab and GNU/Octave functions for vision research. || {{Yes}} || Python installer || https://www.psychtoolbox.org/PsychtoolboxDownload
|-
| Gstreamer || GStreamer is a library for constructing graphs of media-handling components. || {{Yes}} || Windows Installer || http://gstreamer.freedesktop.org/download/
|-
| BrainStream || BrainStream is a Matlab toolbox for designing and executing Brain-Computer-Interface (BCI) experiments. || {{No}} || toolbox || [[BrainStream]]
|-
|}

== Default Location Psychtoolbox ==

'''Windows'''
<syntaxhighlight lang="matlab" overflow:auto;">
C:\toolbox\psychtoolbox
</syntaxhighlight>

== License ==

For license and installation information click [http://wiki.science.ru.nl/cncz/Matlab '''here''']

Module:Protection banner

2026-04-16T11:42:21Z

E.vandenberge: Rollback

-- This module implements {{pp-meta}} and its daughter templates such as
-- {{pp-dispute}}, {{pp-vandalism}} and {{pp-sock}}.

-- Initialise necessary modules.
require('Module:No globals')
local makeFileLink = require('Module:File link')._main
local effectiveProtectionLevel = require('Module:Effective protection level')._main
local effectiveProtectionExpiry = require('Module:Effective protection expiry')._main
local yesno = require('Module:Yesno')

-- Lazily initialise modules and objects we don't always need.
local getArgs, makeMessageBox, lang

-- Set constants.
local CONFIG_MODULE = 'Module:Protection banner/config'

--------------------------------------------------------------------------------
-- Helper functions
--------------------------------------------------------------------------------

local function makeCategoryLink(cat, sort)
if cat then
return string.format(
'[[%s:%s|%s]]',
mw.site.namespaces[14].name,
cat,
sort
)
end
end

-- Validation function for the expiry and the protection date
local function validateDate(dateString, dateType)
if not lang then
lang = mw.language.getContentLanguage()
end
local success, result = pcall(lang.formatDate, lang, 'U', dateString)
if success then
result = tonumber(result)
if result then
return result
end
end
error(string.format(
'invalid %s: %s',
dateType,
tostring(dateString)
), 4)
end

local function makeFullUrl(page, query, display)
return string.format(
'[%s %s]',
tostring(mw.uri.fullUrl(page, query)),
display
)
end

-- Given a directed graph formatted as node -> table of direct successors,
-- get a table of all nodes reachable from a given node (though always
-- including the given node).
local function getReachableNodes(graph, start)
local toWalk, retval = {[start] = true}, {}
while true do
-- Can't use pairs() since we're adding and removing things as we're iterating
local k = next(toWalk) -- This always gets the "first" key
if k == nil then
return retval
end
toWalk[k] = nil
retval[k] = true
for _,v in ipairs(graph[k]) do
if not retval[v] then
toWalk[v] = true
end
end
end
end

--------------------------------------------------------------------------------
-- Protection class
--------------------------------------------------------------------------------

local Protection = {}
Protection.__index = Protection

Protection.supportedActions = {
edit = true,
move = true,
autoreview = true,
upload = true
}

Protection.bannerConfigFields = {
'text',
'explanation',
'tooltip',
'alt',
'link',
'image'
}

function Protection.new(args, cfg, title)
local obj = {}
obj._cfg = cfg
obj.title = title or mw.title.getCurrentTitle()

-- Set action
if not args.action then
obj.action = 'edit'
elseif Protection.supportedActions[args.action] then
obj.action = args.action
else
error(string.format(
'invalid action: %s',
tostring(args.action)
), 3)
end

-- Set level
obj.level = args.demolevel or effectiveProtectionLevel(obj.action, obj.title)
if not obj.level or (obj.action == 'move' and obj.level == 'autoconfirmed') then
-- Users need to be autoconfirmed to move pages anyway, so treat
-- semi-move-protected pages as unprotected.
obj.level = '*'
end

-- Set expiry
local effectiveExpiry = effectiveProtectionExpiry(obj.action, obj.title)
if effectiveExpiry == 'infinity' then
obj.expiry = 'indef'
elseif effectiveExpiry ~= 'unknown' then
obj.expiry = validateDate(effectiveExpiry, 'expiry date')
end

-- Set reason
if args[1] then
obj.reason = mw.ustring.lower(args[1])
if obj.reason:find('|') then
error('reasons cannot contain the pipe character ("|")', 3)
end
end

-- Set protection date
if args.date then
obj.protectionDate = validateDate(args.date, 'protection date')
end

-- Set banner config
do
obj.bannerConfig = {}
local configTables = {}
if cfg.banners[obj.action] then
configTables[#configTables + 1] = cfg.banners[obj.action][obj.reason]
end
if cfg.defaultBanners[obj.action] then
configTables[#configTables + 1] = cfg.defaultBanners[obj.action][obj.level]
configTables[#configTables + 1] = cfg.defaultBanners[obj.action].default
end
configTables[#configTables + 1] = cfg.masterBanner
for i, field in ipairs(Protection.bannerConfigFields) do
for j, t in ipairs(configTables) do
if t[field] then
obj.bannerConfig[field] = t[field]
break
end
end
end
end
return setmetatable(obj, Protection)
end

function Protection:isProtected()
return self.level ~= '*'
end

function Protection:isTemporary()
return type(self.expiry) == 'number'
end

function Protection:makeProtectionCategory()
local cfg = self._cfg
local title = self.title

-- Exit if the page is not protected.
if not self:isProtected() then
return ''
end

-- Get the expiry key fragment.
local expiryFragment
if self.expiry == 'indef' then
expiryFragment = self.expiry
elseif type(self.expiry) == 'number' then
expiryFragment = 'temp'
end

-- Get the namespace key fragment.
local namespaceFragment = cfg.categoryNamespaceKeys[title.namespace]
if not namespaceFragment and title.namespace % 2 == 1 then
namespaceFragment = 'talk'
end

-- Define the order that key fragments are tested in. This is done with an
-- array of tables containing the value to be tested, along with its
-- position in the cfg.protectionCategories table.
local order = {
{val = expiryFragment, keypos = 1},
{val = namespaceFragment, keypos = 2},
{val = self.reason, keypos = 3},
{val = self.level, keypos = 4},
{val = self.action, keypos = 5}
}

--[[
-- The old protection templates used an ad-hoc protection category system,
-- with some templates prioritising namespaces in their categories, and
-- others prioritising the protection reason. To emulate this in this module
-- we use the config table cfg.reasonsWithNamespacePriority to set the
-- reasons for which namespaces have priority over protection reason.
-- If we are dealing with one of those reasons, move the namespace table to
-- the end of the order table, i.e. give it highest priority. If not, the
-- reason should have highest priority, so move that to the end of the table
-- instead.
--]]
table.insert(order, table.remove(order, self.reason and cfg.reasonsWithNamespacePriority[self.reason] and 2 or 3))

--[[
-- Define the attempt order. Inactive subtables (subtables with nil "value"
-- fields) are moved to the end, where they will later be given the key
-- "all". This is to cut down on the number of table lookups in
-- cfg.protectionCategories, which grows exponentially with the number of
-- non-nil keys. We keep track of the number of active subtables with the
-- noActive parameter.
--]]
local noActive, attemptOrder
do
local active, inactive = {}, {}
for i, t in ipairs(order) do
if t.val then
active[#active + 1] = t
else
inactive[#inactive + 1] = t
end
end
noActive = #active
attemptOrder = active
for i, t in ipairs(inactive) do
attemptOrder[#attemptOrder + 1] = t
end
end

--[[
-- Check increasingly generic key combinations until we find a match. If a
-- specific category exists for the combination of key fragments we are
-- given, that match will be found first. If not, we keep trying different
-- key fragment combinations until we match using the key
-- "all-all-all-all-all".
--
-- To generate the keys, we index the key subtables using a binary matrix
-- with indexes i and j. j is only calculated up to the number of active
-- subtables. For example, if there were three active subtables, the matrix
-- would look like this, with 0 corresponding to the key fragment "all", and
-- 1 corresponding to other key fragments.
--
-- j 1 2 3
-- i
-- 1 1 1 1
-- 2 0 1 1
-- 3 1 0 1
-- 4 0 0 1
-- 5 1 1 0
-- 6 0 1 0
-- 7 1 0 0
-- 8 0 0 0
--
-- Values of j higher than the number of active subtables are set
-- to the string "all".
--
-- A key for cfg.protectionCategories is constructed for each value of i.
-- The position of the value in the key is determined by the keypos field in
-- each subtable.
--]]
local cats = cfg.protectionCategories
for i = 1, 2^noActive do
local key = {}
for j, t in ipairs(attemptOrder) do
if j > noActive then
key[t.keypos] = 'all'
else
local quotient = i / 2 ^ (j - 1)
quotient = math.ceil(quotient)
if quotient % 2 == 1 then
key[t.keypos] = t.val
else
key[t.keypos] = 'all'
end
end
end
key = table.concat(key, '|')
local attempt = cats[key]
if attempt then
return makeCategoryLink(attempt, title.text)
end
end
return ''
end

function Protection:isIncorrect()
local expiry = self.expiry
return not self:isProtected()
or type(expiry) == 'number' and expiry < os.time()
end

function Protection:isTemplateProtectedNonTemplate()
local action, namespace = self.action, self.title.namespace
return self.level == 'templateeditor'
and (
(action ~= 'edit' and action ~= 'move')
or (namespace ~= 10 and namespace ~= 828)
)
end

function Protection:makeCategoryLinks()
local msg = self._cfg.msg
local ret = { self:makeProtectionCategory() }
if self:isIncorrect() then
ret[#ret + 1] = makeCategoryLink(
msg['tracking-category-incorrect'],
self.title.text
)
end
if self:isTemplateProtectedNonTemplate() then
ret[#ret + 1] = makeCategoryLink(
msg['tracking-category-template'],
self.title.text
)
end
return table.concat(ret)
end

--------------------------------------------------------------------------------
-- Blurb class
--------------------------------------------------------------------------------

local Blurb = {}
Blurb.__index = Blurb

Blurb.bannerTextFields = {
text = true,
explanation = true,
tooltip = true,
alt = true,
link = true
}

function Blurb.new(protectionObj, args, cfg)
return setmetatable({
_cfg = cfg,
_protectionObj = protectionObj,
_args = args
}, Blurb)
end

-- Private methods --

function Blurb:_formatDate(num)
-- Formats a Unix timestamp into dd Month, YYYY format.
lang = lang or mw.language.getContentLanguage()
local success, date = pcall(
lang.formatDate,
lang,
self._cfg.msg['expiry-date-format'] or 'j F Y',
'@' .. tostring(num)
)
if success then
return date
end
end

function Blurb:_getExpandedMessage(msgKey)
return self:_substituteParameters(self._cfg.msg[msgKey])
end

function Blurb:_substituteParameters(msg)
if not self._params then
local parameterFuncs = {}

parameterFuncs.CURRENTVERSION = self._makeCurrentVersionParameter
parameterFuncs.EDITREQUEST = self._makeEditRequestParameter
parameterFuncs.EXPIRY = self._makeExpiryParameter
parameterFuncs.EXPLANATIONBLURB = self._makeExplanationBlurbParameter
parameterFuncs.IMAGELINK = self._makeImageLinkParameter
parameterFuncs.INTROBLURB = self._makeIntroBlurbParameter
parameterFuncs.INTROFRAGMENT = self._makeIntroFragmentParameter
parameterFuncs.PAGETYPE = self._makePagetypeParameter
parameterFuncs.PROTECTIONBLURB = self._makeProtectionBlurbParameter
parameterFuncs.PROTECTIONDATE = self._makeProtectionDateParameter
parameterFuncs.PROTECTIONLEVEL = self._makeProtectionLevelParameter
parameterFuncs.PROTECTIONLOG = self._makeProtectionLogParameter
parameterFuncs.TALKPAGE = self._makeTalkPageParameter
parameterFuncs.TOOLTIPBLURB = self._makeTooltipBlurbParameter
parameterFuncs.TOOLTIPFRAGMENT = self._makeTooltipFragmentParameter
parameterFuncs.VANDAL = self._makeVandalTemplateParameter

self._params = setmetatable({}, {
__index = function (t, k)
local param
if parameterFuncs[k] then
param = parameterFuncs[k](self)
end
param = param or ''
t[k] = param
return param
end
})
end

msg = msg:gsub('${(%u+)}', self._params)
return msg
end

function Blurb:_makeCurrentVersionParameter()
-- A link to the page history or the move log, depending on the kind of
-- protection.
local pagename = self._protectionObj.title.prefixedText
if self._protectionObj.action == 'move' then
-- We need the move log link.
return makeFullUrl(
'Special:Log',
{type = 'move', page = pagename},
self:_getExpandedMessage('current-version-move-display')
)
else
-- We need the history link.
return makeFullUrl(
pagename,
{action = 'history'},
self:_getExpandedMessage('current-version-edit-display')
)
end
end

function Blurb:_makeEditRequestParameter()
local mEditRequest = require('Module:Submit an edit request')
local action = self._protectionObj.action
local level = self._protectionObj.level

-- Get the edit request type.
local requestType
if action == 'edit' then
if level == 'autoconfirmed' then
requestType = 'semi'
elseif level == 'extendedconfirmed' then
requestType = 'extended'
elseif level == 'templateeditor' then
requestType = 'template'
end
end
requestType = requestType or 'full'

-- Get the display value.
local display = self:_getExpandedMessage('edit-request-display')

return mEditRequest._link{type = requestType, display = display}
end

function Blurb:_makeExpiryParameter()
local expiry = self._protectionObj.expiry
if type(expiry) == 'number' then
return self:_formatDate(expiry)
else
return expiry
end
end

function Blurb:_makeExplanationBlurbParameter()
-- Cover special cases first.
if self._protectionObj.title.namespace == 8 then
-- MediaWiki namespace
return self:_getExpandedMessage('explanation-blurb-nounprotect')
end

-- Get explanation blurb table keys
local action = self._protectionObj.action
local level = self._protectionObj.level
local talkKey = self._protectionObj.title.isTalkPage and 'talk' or 'subject'

-- Find the message in the explanation blurb table and substitute any
-- parameters.
local explanations = self._cfg.explanationBlurbs
local msg
if explanations[action][level] and explanations[action][level][talkKey] then
msg = explanations[action][level][talkKey]
elseif explanations[action][level] and explanations[action][level].default then
msg = explanations[action][level].default
elseif explanations[action].default and explanations[action].default[talkKey] then
msg = explanations[action].default[talkKey]
elseif explanations[action].default and explanations[action].default.default then
msg = explanations[action].default.default
else
error(string.format(
'could not find explanation blurb for action "%s", level "%s" and talk key "%s"',
action,
level,
talkKey
), 8)
end
return self:_substituteParameters(msg)
end

function Blurb:_makeImageLinkParameter()
local imageLinks = self._cfg.imageLinks
local action = self._protectionObj.action
local level = self._protectionObj.level
local msg
if imageLinks[action][level] then
msg = imageLinks[action][level]
elseif imageLinks[action].default then
msg = imageLinks[action].default
else
msg = imageLinks.edit.default
end
return self:_substituteParameters(msg)
end

function Blurb:_makeIntroBlurbParameter()
if self._protectionObj:isTemporary() then
return self:_getExpandedMessage('intro-blurb-expiry')
else
return self:_getExpandedMessage('intro-blurb-noexpiry')
end
end

function Blurb:_makeIntroFragmentParameter()
if self._protectionObj:isTemporary() then
return self:_getExpandedMessage('intro-fragment-expiry')
else
return self:_getExpandedMessage('intro-fragment-noexpiry')
end
end

function Blurb:_makePagetypeParameter()
local pagetypes = self._cfg.pagetypes
return pagetypes[self._protectionObj.title.namespace]
or pagetypes.default
or error('no default pagetype defined', 8)
end

function Blurb:_makeProtectionBlurbParameter()
local protectionBlurbs = self._cfg.protectionBlurbs
local action = self._protectionObj.action
local level = self._protectionObj.level
local msg
if protectionBlurbs[action][level] then
msg = protectionBlurbs[action][level]
elseif protectionBlurbs[action].default then
msg = protectionBlurbs[action].default
elseif protectionBlurbs.edit.default then
msg = protectionBlurbs.edit.default
else
error('no protection blurb defined for protectionBlurbs.edit.default', 8)
end
return self:_substituteParameters(msg)
end

function Blurb:_makeProtectionDateParameter()
local protectionDate = self._protectionObj.protectionDate
if type(protectionDate) == 'number' then
return self:_formatDate(protectionDate)
else
return protectionDate
end
end

function Blurb:_makeProtectionLevelParameter()
local protectionLevels = self._cfg.protectionLevels
local action = self._protectionObj.action
local level = self._protectionObj.level
local msg
if protectionLevels[action][level] then
msg = protectionLevels[action][level]
elseif protectionLevels[action].default then
msg = protectionLevels[action].default
elseif protectionLevels.edit.default then
msg = protectionLevels.edit.default
else
error('no protection level defined for protectionLevels.edit.default', 8)
end
return self:_substituteParameters(msg)
end

function Blurb:_makeProtectionLogParameter()
local pagename = self._protectionObj.title.prefixedText
if self._protectionObj.action == 'autoreview' then
-- We need the pending changes log.
return makeFullUrl(
'Special:Log',
{type = 'stable', page = pagename},
self:_getExpandedMessage('pc-log-display')
)
else
-- We need the protection log.
return makeFullUrl(
'Special:Log',
{type = 'protect', page = pagename},
self:_getExpandedMessage('protection-log-display')
)
end
end

function Blurb:_makeTalkPageParameter()
return string.format(
'[[%s:%s#%s|%s]]',
mw.site.namespaces[self._protectionObj.title.namespace].talk.name,
self._protectionObj.title.text,
self._args.section or 'top',
self:_getExpandedMessage('talk-page-link-display')
)
end

function Blurb:_makeTooltipBlurbParameter()
if self._protectionObj:isTemporary() then
return self:_getExpandedMessage('tooltip-blurb-expiry')
else
return self:_getExpandedMessage('tooltip-blurb-noexpiry')
end
end

function Blurb:_makeTooltipFragmentParameter()
if self._protectionObj:isTemporary() then
return self:_getExpandedMessage('tooltip-fragment-expiry')
else
return self:_getExpandedMessage('tooltip-fragment-noexpiry')
end
end

function Blurb:_makeVandalTemplateParameter()
return require('Module:Vandal-m')._main{
self._args.user or self._protectionObj.title.baseText
}
end

-- Public methods --

function Blurb:makeBannerText(key)
-- Validate input.
if not key or not Blurb.bannerTextFields[key] then
error(string.format(
'"%s" is not a valid banner config field',
tostring(key)
), 2)
end

-- Generate the text.
local msg = self._protectionObj.bannerConfig[key]
if type(msg) == 'string' then
return self:_substituteParameters(msg)
elseif type(msg) == 'function' then
msg = msg(self._protectionObj, self._args)
if type(msg) ~= 'string' then
error(string.format(
'bad output from banner config function with key "%s"'
.. ' (expected string, got %s)',
tostring(key),
type(msg)
), 4)
end
return self:_substituteParameters(msg)
end
end

--------------------------------------------------------------------------------
-- BannerTemplate class
--------------------------------------------------------------------------------

local BannerTemplate = {}
BannerTemplate.__index = BannerTemplate

function BannerTemplate.new(protectionObj, cfg)
local obj = {}
obj._cfg = cfg

-- Set the image filename.
local imageFilename = protectionObj.bannerConfig.image
if imageFilename then
obj._imageFilename = imageFilename
else
-- If an image filename isn't specified explicitly in the banner config,
-- generate it from the protection status and the namespace.
local action = protectionObj.action
local level = protectionObj.level
local namespace = protectionObj.title.namespace
local reason = protectionObj.reason

-- Deal with special cases first.
if (
namespace == 10
or namespace == 828
or reason and obj._cfg.indefImageReasons[reason]
)
and action == 'edit'
and level == 'sysop'
and not protectionObj:isTemporary()
then
-- Fully protected modules and templates get the special red "indef"
-- padlock.
obj._imageFilename = obj._cfg.msg['image-filename-indef']
else
-- Deal with regular protection types.
local images = obj._cfg.images
if images[action] then
if images[action][level] then
obj._imageFilename = images[action][level]
elseif images[action].default then
obj._imageFilename = images[action].default
end
end
end
end
return setmetatable(obj, BannerTemplate)
end

function BannerTemplate:renderImage()
local filename = self._imageFilename
or self._cfg.msg['image-filename-default']
or 'Transparent.gif'
return makeFileLink{
file = filename,
size = (self.imageWidth or 20) .. 'px',
alt = self._imageAlt,
link = self._imageLink,
caption = self.imageCaption
}
end

--------------------------------------------------------------------------------
-- Banner class
--------------------------------------------------------------------------------

local Banner = setmetatable({}, BannerTemplate)
Banner.__index = Banner

function Banner.new(protectionObj, blurbObj, cfg)
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
obj.imageWidth = 40
obj.imageCaption = blurbObj:makeBannerText('alt') -- Large banners use the alt text for the tooltip.
obj._reasonText = blurbObj:makeBannerText('text')
obj._explanationText = blurbObj:makeBannerText('explanation')
obj._page = protectionObj.title.prefixedText -- Only makes a difference in testing.
return setmetatable(obj, Banner)
end

function Banner:__tostring()
-- Renders the banner.
makeMessageBox = makeMessageBox or require('Module:Message box').main
local reasonText = self._reasonText or error('no reason text set', 2)
local explanationText = self._explanationText
local mbargs = {
page = self._page,
type = 'protection',
image = self:renderImage(),
text = string.format(
"'''%s'''%s",
reasonText,
explanationText and ' ' .. explanationText or ''
)
}
return makeMessageBox('mbox', mbargs)
end

--------------------------------------------------------------------------------
-- Padlock class
--------------------------------------------------------------------------------

local Padlock = setmetatable({}, BannerTemplate)
Padlock.__index = Padlock

function Padlock.new(protectionObj, blurbObj, cfg)
local obj = BannerTemplate.new(protectionObj, cfg) -- This doesn't need the blurb.
obj.imageWidth = 20
obj.imageCaption = blurbObj:makeBannerText('tooltip')
obj._imageAlt = blurbObj:makeBannerText('alt')
obj._imageLink = blurbObj:makeBannerText('link')
obj._indicatorName = cfg.padlockIndicatorNames[protectionObj.action]
or cfg.padlockIndicatorNames.default
or 'pp-default'
return setmetatable(obj, Padlock)
end

function Padlock:__tostring()
local frame = mw.getCurrentFrame()
-- The nowiki tag helps prevent whitespace at the top of articles.
return frame:extensionTag{name = 'nowiki'} .. frame:extensionTag{
name = 'indicator',
args = {name = self._indicatorName},
content = self:renderImage()
}
end

--------------------------------------------------------------------------------
-- Exports
--------------------------------------------------------------------------------

local p = {}

function p._exportClasses()
-- This is used for testing purposes.
return {
Protection = Protection,
Blurb = Blurb,
BannerTemplate = BannerTemplate,
Banner = Banner,
Padlock = Padlock,
}
end

function p._main(args, cfg, title)
args = args or {}
cfg = cfg or require(CONFIG_MODULE)

local protectionObj = Protection.new(args, cfg, title)

local ret = {}

-- If a page's edit protection is equally or more restrictive than its
-- protection from some other action, then don't bother displaying anything
-- for the other action (except categories).
if protectionObj.action == 'edit' or
args.demolevel or
not getReachableNodes(
cfg.hierarchy,
protectionObj.level
)[effectiveProtectionLevel('edit', protectionObj.title)]
then
-- Initialise the blurb object
local blurbObj = Blurb.new(protectionObj, args, cfg)

-- Render the banner
if protectionObj:isProtected() then
ret[#ret + 1] = tostring(
(yesno(args.small) and Padlock or Banner)
.new(protectionObj, blurbObj, cfg)
)
end
end

-- Render the categories
if yesno(args.category) ~= false then
ret[#ret + 1] = protectionObj:makeCategoryLinks()
end

return table.concat(ret)
end

function p.main(frame, cfg)
cfg = cfg or require(CONFIG_MODULE)

-- Find default args, if any.
local parent = frame.getParent and frame:getParent()
local defaultArgs = parent and cfg.wrappers[parent:getTitle():gsub('/sandbox$', '')]

-- Find user args, and use the parent frame if we are being called from a
-- wrapper template.
getArgs = getArgs or require('Module:Arguments').getArgs
local userArgs = getArgs(frame, {
parentOnly = defaultArgs,
frameOnly = not defaultArgs
})

-- Build the args table. User-specified args overwrite default args.
local args = {}
for k, v in pairs(defaultArgs or {}) do
args[k] = v
end
for k, v in pairs(userArgs) do
args[k] = v
end
return p._main(args, cfg)
end

return p

Module:Documentation

2026-04-16T10:59:48Z

E.vandenberge:

-- This module implements {{documentation}}.

-- Get required modules.
local getArgs = require('Module:Arguments').getArgs
local messageBox = require('Module:Message box')

-- Get the config table.
local cfg = mw.loadData('Module:Documentation/config')

local p = {}

-- Often-used functions.
local ugsub = mw.ustring.gsub

----------------------------------------------------------------------------
-- Helper functions
--
-- These are defined as local functions, but are made available in the p
-- table for testing purposes.
----------------------------------------------------------------------------

local function message(cfgKey, valArray, expectType)
--[[
-- Gets a message from the cfg table and formats it if appropriate.
-- The function raises an error if the value from the cfg table is not
-- of the type expectType. The default type for expectType is 'string'.
-- If the table valArray is present, strings such as $1, $2 etc. in the
-- message are substituted with values from the table keys [1], [2] etc.
-- For example, if the message "foo-message" had the value 'Foo $2 bar $1.',
-- message('foo-message', {'baz', 'qux'}) would return "Foo qux bar baz."
--]]
local msg = cfg[cfgKey]
expectType = expectType or 'string'
if type(msg) ~= expectType then
error('message: type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2)
end
if not valArray then
return msg
end

local function getMessageVal(match)
match = tonumber(match)
return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4)
end

local ret = ugsub(msg, '$([1-9][0-9]*)', getMessageVal)
return ret
end

p.message = message

local function makeWikilink(page, display)
if display then
return mw.ustring.format('[[%s|%s]]', page, display)
else
return mw.ustring.format('[[%s]]', page)
end
end

p.makeWikilink = makeWikilink

local function makeCategoryLink(cat, sort)
local catns = mw.site.namespaces[14].name
return makeWikilink(catns .. ':' .. cat, sort)
end

p.makeCategoryLink = makeCategoryLink

local function makeUrlLink(url, display)
return mw.ustring.format('[%s %s]', url, display)
end

p.makeUrlLink = makeUrlLink

local function makeToolbar(...)
local ret = {}
local lim = select('#', ...)
if lim < 1 then
return nil
end
for i = 1, lim do
ret[#ret + 1] = select(i, ...)
end
return '(' .. table.concat(ret, ' | ') .. ')'
end

p.makeToolbar = makeToolbar

----------------------------------------------------------------------------
-- Argument processing
----------------------------------------------------------------------------

local function makeInvokeFunc(funcName)
return function (frame)
local args = getArgs(frame, {
valueFunc = function (key, value)
if type(value) == 'string' then
value = value:match('^%s*(.-)%s*$') -- Remove whitespace.
if key == 'heading' or value ~= '' then
return value
else
return nil
end
else
return value
end
end
})
return p[funcName](args)
end
end

----------------------------------------------------------------------------
-- Main function
----------------------------------------------------------------------------

p.main = makeInvokeFunc('_main')

function p._main(args)
--[[
-- This function defines logic flow for the module.
-- @args - table of arguments passed by the user
--
-- Messages:
-- 'main-div-id' --> 'template-documentation'
-- 'main-div-classes' --> 'template-documentation iezoomfix'
--]]
local env = p.getEnvironment(args)
local root = mw.html.create()
root
:wikitext(p.protectionTemplate(env))
:wikitext(p.sandboxNotice(args, env))
-- This div tag is from {{documentation/start box}}, but moving it here
-- so that we don't have to worry about unclosed tags.
:tag('div')
:attr('id', message('main-div-id'))
:addClass(message('main-div-classes'))
:newline()
:wikitext(p._startBox(args, env))
:wikitext(p._content(args, env))
:tag('div')
:css('clear', 'both') -- So right or left floating items don't stick out of the doc box.
:newline()
:done()
:done()
:wikitext(p._endBox(args, env))
:wikitext(p.addTrackingCategories(env))
return tostring(root)
end

----------------------------------------------------------------------------
-- Environment settings
----------------------------------------------------------------------------

function p.getEnvironment(args)
--[[
-- Returns a table with information about the environment, including title objects and other namespace- or
-- path-related data.
-- @args - table of arguments passed by the user
--
-- Title objects include:
-- env.title - the page we are making documentation for (usually the current title)
-- env.templateTitle - the template (or module, file, etc.)
-- env.docTitle - the /doc subpage.
-- env.sandboxTitle - the /sandbox subpage.
-- env.testcasesTitle - the /testcases subpage.
-- env.printTitle - the print version of the template, located at the /Print subpage.
--
-- Data includes:
-- env.protectionLevels - the protection levels table of the title object.
-- env.subjectSpace - the number of the title's subject namespace.
-- env.docSpace - the number of the namespace the title puts its documentation in.
-- env.docpageBase - the text of the base page of the /doc, /sandbox and /testcases pages, with namespace.
-- env.compareUrl - URL of the Special:ComparePages page comparing the sandbox with the template.
--
-- All table lookups are passed through pcall so that errors are caught. If an error occurs, the value
-- returned will be nil.
--]]

local env, envFuncs = {}, {}

-- Set up the metatable. If triggered we call the corresponding function in the envFuncs table. The value
-- returned by that function is memoized in the env table so that we don't call any of the functions
-- more than once. (Nils won't be memoized.)
setmetatable(env, {
__index = function (t, key)
local envFunc = envFuncs[key]
if envFunc then
local success, val = pcall(envFunc)
if success then
env[key] = val -- Memoise the value.
return val
end
end
return nil
end
})

function envFuncs.title()
-- The title object for the current page, or a test page passed with args.page.
local title
local titleArg = args.page
if titleArg then
title = mw.title.new(titleArg)
else
title = mw.title.getCurrentTitle()
end
return title
end

function envFuncs.templateTitle()
--[[
-- The template (or module, etc.) title object.
-- Messages:
-- 'sandbox-subpage' --> 'sandbox'
-- 'testcases-subpage' --> 'testcases'
--]]
local subjectSpace = env.subjectSpace
local title = env.title
local subpage = title.subpageText
if subpage == message('sandbox-subpage') or subpage == message('testcases-subpage') then
return mw.title.makeTitle(subjectSpace, title.baseText)
else
return mw.title.makeTitle(subjectSpace, title.text)
end
end

function envFuncs.docTitle()
--[[
-- Title object of the /doc subpage.
-- Messages:
-- 'doc-subpage' --> 'doc'
--]]
local title = env.title
local docname = args[1] -- User-specified doc page.
local docpage
if docname then
docpage = docname
else
docpage = env.docpageBase .. '/' .. message('doc-subpage')
end
return mw.title.new(docpage)
end

function envFuncs.sandboxTitle()
--[[
-- Title object for the /sandbox subpage.
-- Messages:
-- 'sandbox-subpage' --> 'sandbox'
--]]
return mw.title.new(env.docpageBase .. '/' .. message('sandbox-subpage'))
end

function envFuncs.testcasesTitle()
--[[
-- Title object for the /testcases subpage.
-- Messages:
-- 'testcases-subpage' --> 'testcases'
--]]
return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage'))
end

function envFuncs.printTitle()
--[[
-- Title object for the /Print subpage.
-- Messages:
-- 'print-subpage' --> 'Print'
--]]
return env.templateTitle:subPageTitle(message('print-subpage'))
end

function envFuncs.protectionLevels()
-- The protection levels table of the title object.
return env.title.protectionLevels
end

function envFuncs.subjectSpace()
-- The subject namespace number.
return mw.site.namespaces[env.title.namespace].subject.id
end

function envFuncs.docSpace()
-- The documentation namespace number. For most namespaces this is the same as the
-- subject namespace. However, pages in the Article, File, MediaWiki or Category
-- namespaces must have their /doc, /sandbox and /testcases pages in talk space.
local subjectSpace = env.subjectSpace
if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then
return subjectSpace + 1
else
return subjectSpace
end
end

function envFuncs.docpageBase()
-- The base page of the /doc, /sandbox, and /testcases subpages.
-- For some namespaces this is the talk page, rather than the template page.
local templateTitle = env.templateTitle
local docSpace = env.docSpace
local docSpaceText = mw.site.namespaces[docSpace].name
-- Assemble the link. docSpace is never the main namespace, so we can hardcode the colon.
return docSpaceText .. ':' .. templateTitle.text
end

function envFuncs.compareUrl()
-- Diff link between the sandbox and the main template using [[Special:ComparePages]].
local templateTitle = env.templateTitle
local sandboxTitle = env.sandboxTitle
if templateTitle.exists and sandboxTitle.exists then
local compareUrl = mw.uri.fullUrl(
'Special:ComparePages',
{page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText}
)
return tostring(compareUrl)
else
return nil
end
end

return env
end

----------------------------------------------------------------------------
-- Auxiliary templates
----------------------------------------------------------------------------

function p.sandboxNotice(args, env)
--[=[
-- Generates a sandbox notice for display above sandbox pages.
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- Messages:
-- 'sandbox-notice-image' --> '[[Image:Sandbox.svg|50px|alt=|link=]]'
-- 'sandbox-notice-blurb' --> 'This is the $1 for $2.'
-- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).'
-- 'sandbox-notice-pagetype-template' --> '[[Wikipedia:Template test cases|template sandbox]] page'
-- 'sandbox-notice-pagetype-module' --> '[[Wikipedia:Template test cases|module sandbox]] page'
-- 'sandbox-notice-pagetype-other' --> 'sandbox page'
-- 'sandbox-notice-compare-link-display' --> 'diff'
-- 'sandbox-notice-testcases-blurb' --> 'See also the companion subpage for $1.'
-- 'sandbox-notice-testcases-link-display' --> 'test cases'
-- 'sandbox-category' --> 'Template sandboxes'
--]=]
local title = env.title
local sandboxTitle = env.sandboxTitle
local templateTitle = env.templateTitle
local subjectSpace = env.subjectSpace
if not (subjectSpace and title and sandboxTitle and templateTitle and mw.title.equals(title, sandboxTitle)) then
return nil
end
-- Build the table of arguments to pass to {{ombox}}. We need just two fields, "image" and "text".
local omargs = {}
omargs.image = message('sandbox-notice-image')
-- Get the text. We start with the opening blurb, which is something like
-- "This is the template sandbox for [[Template:Foo]] (diff)."
local text = ''
local pagetype
if subjectSpace == 10 then
pagetype = message('sandbox-notice-pagetype-template')
elseif subjectSpace == 828 then
pagetype = message('sandbox-notice-pagetype-module')
else
pagetype = message('sandbox-notice-pagetype-other')
end
local templateLink = makeWikilink(templateTitle.prefixedText)
local compareUrl = env.compareUrl
if compareUrl then
local compareDisplay = message('sandbox-notice-compare-link-display')
local compareLink = makeUrlLink(compareUrl, compareDisplay)
text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink})
else
text = text .. message('sandbox-notice-blurb', {pagetype, templateLink})
end
-- Get the test cases page blurb if the page exists. This is something like
-- "See also the companion subpage for [[Template:Foo/testcases|test cases]]."
local testcasesTitle = env.testcasesTitle
if testcasesTitle and testcasesTitle.exists then
if testcasesTitle.contentModel == "Scribunto" then
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display')
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)
text = text .. ' ' .. message('sandbox-notice-testcases-run-blurb', {testcasesLink, testcasesRunLink})
else
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)
text = text .. ' ' .. message('sandbox-notice-testcases-blurb', {testcasesLink})
end
end
-- Add the sandbox to the sandbox category.
text = text .. makeCategoryLink(message('sandbox-category'))
omargs.text = text
local ret = '<div style="clear: both;"></div>'
ret = ret .. messageBox.main('ombox', omargs)
return ret
end

function p.protectionTemplate(env)
-- Generates the padlock icon in the top right.
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
-- Messages:
-- 'protection-template' --> 'pp-template'
-- 'protection-template-args' --> {docusage = 'yes'}
local protectionLevels, mProtectionBanner
local title = env.title
protectionLevels = env.protectionLevels
if not protectionLevels then
return nil
end
local editProt = protectionLevels.edit and protectionLevels.edit[1]
local moveProt = protectionLevels.move and protectionLevels.move[1]
if editProt then
-- The page is edit-protected.
mProtectionBanner = require('Module:Protection banner')
local reason = message('protection-reason-edit')
return mProtectionBanner._main{reason, small = true}
elseif moveProt and moveProt ~= 'autoconfirmed' then
-- The page is move-protected but not edit-protected. Exclude move
-- protection with the level "autoconfirmed", as this is equivalent to
-- no move protection at all.
mProtectionBanner = require('Module:Protection banner')
return mProtectionBanner._main{action = 'move', small = true}
else
return nil
end
end

----------------------------------------------------------------------------
-- Start box
----------------------------------------------------------------------------

p.startBox = makeInvokeFunc('_startBox')

function p._startBox(args, env)
--[[
-- This function generates the start box.
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- The actual work is done by p.makeStartBoxLinksData and p.renderStartBoxLinks which make
-- the [view] [edit] [history] [purge] links, and by p.makeStartBoxData and p.renderStartBox
-- which generate the box HTML.
--]]
env = env or p.getEnvironment(args)
local links
local content = args.content
if not content or args[1] then
-- No need to include the links if the documentation is on the template page itself.
local linksData = p.makeStartBoxLinksData(args, env)
if linksData then
links = p.renderStartBoxLinks(linksData)
end
end
-- Generate the start box html.
local data = p.makeStartBoxData(args, env, links)
if data then
return p.renderStartBox(data)
else
-- User specified no heading.
return nil
end
end

function p.makeStartBoxLinksData(args, env)
--[[
-- Does initial processing of data to make the [view] [edit] [history] [purge] links.
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- Messages:
-- 'view-link-display' --> 'view'
-- 'edit-link-display' --> 'edit'
-- 'history-link-display' --> 'history'
-- 'purge-link-display' --> 'purge'
-- 'file-docpage-preload' --> 'Template:Documentation/preload-filespace'
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
-- 'docpage-preload' --> 'Template:Documentation/preload'
-- 'create-link-display' --> 'create'
--]]
local subjectSpace = env.subjectSpace
local title = env.title
local docTitle = env.docTitle
if not title or not docTitle then
return nil
end
if docTitle.isRedirect then
docTitle = docTitle.redirectTarget
end

local data = {}
data.title = title
data.docTitle = docTitle
-- View, display, edit, and purge links if /doc exists.
data.viewLinkDisplay = message('view-link-display')
data.editLinkDisplay = message('edit-link-display')
data.historyLinkDisplay = message('history-link-display')
data.purgeLinkDisplay = message('purge-link-display')
-- Create link if /doc doesn't exist.
local preload = args.preload
if not preload then
if subjectSpace == 6 then -- File namespace
preload = message('file-docpage-preload')
elseif subjectSpace == 828 then -- Module namespace
preload = message('module-preload')
else
preload = message('docpage-preload')
end
end
data.preload = preload
data.createLinkDisplay = message('create-link-display')
return data
end

function p.renderStartBoxLinks(data)
--[[
-- Generates the [view][edit][history][purge] or [create] links from the data table.
-- @data - a table of data generated by p.makeStartBoxLinksData
--]]

local function escapeBrackets(s)
-- Escapes square brackets with HTML entities.
s = s:gsub('%[', '[') -- Replace square brackets with HTML entities.
s = s:gsub('%]', ']')
return s
end

local ret
local docTitle = data.docTitle
local title = data.title
if docTitle.exists then
local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay)
local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, data.editLinkDisplay)
local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, data.historyLinkDisplay)
local purgeLink = makeUrlLink(title:fullUrl{action = 'purge'}, data.purgeLinkDisplay)
ret = '[%s] [%s] [%s] [%s]'
ret = escapeBrackets(ret)
ret = mw.ustring.format(ret, viewLink, editLink, historyLink, purgeLink)
else
local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay)
ret = '[%s]'
ret = escapeBrackets(ret)
ret = mw.ustring.format(ret, createLink)
end
return ret
end

function p.makeStartBoxData(args, env, links)
--[=[
-- Does initial processing of data to pass to the start-box render function, p.renderStartBox.
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
-- @links - a string containing the [view][edit][history][purge] links - could be nil if there's an error.
--
-- Messages:
-- 'documentation-icon-wikitext' --> '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'
-- 'template-namespace-heading' --> 'Template documentation'
-- 'module-namespace-heading' --> 'Module documentation'
-- 'file-namespace-heading' --> 'Summary'
-- 'other-namespaces-heading' --> 'Documentation'
-- 'start-box-linkclasses' --> 'mw-editsection-like plainlinks'
-- 'start-box-link-id' --> 'doc_editlinks'
-- 'testcases-create-link-display' --> 'create'
--]=]
local subjectSpace = env.subjectSpace
if not subjectSpace then
-- Default to an "other namespaces" namespace, so that we get at least some output
-- if an error occurs.
subjectSpace = 2
end
local data = {}

-- Heading
local heading = args.heading -- Blank values are not removed.
if heading == '' then
-- Don't display the start box if the heading arg is defined but blank.
return nil
end
if heading then
data.heading = heading
elseif subjectSpace == 10 then -- Template namespace
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('template-namespace-heading')
elseif subjectSpace == 828 then -- Module namespace
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('module-namespace-heading')
elseif subjectSpace == 6 then -- File namespace
data.heading = message('file-namespace-heading')
else
data.heading = message('other-namespaces-heading')
end

-- Heading CSS
local headingStyle = args['heading-style']
if headingStyle then
data.headingStyleText = headingStyle
elseif subjectSpace == 10 then
-- We are in the template or template talk namespaces.
data.headingFontWeight = 'bold'
data.headingFontSize = '125%'
else
data.headingFontSize = '150%'
end

-- Data for the [view][edit][history][purge] or [create] links.
if links then
data.linksClass = message('start-box-linkclasses')
data.linksId = message('start-box-link-id')
data.links = links
end

return data
end

function p.renderStartBox(data)
-- Renders the start box html.
-- @data - a table of data generated by p.makeStartBoxData.
local sbox = mw.html.create('div')
sbox
:css('padding-bottom', '3px')
:css('border-bottom', '1px solid #aaa')
:css('margin-bottom', '1ex')
:newline()
:tag('span')
:cssText(data.headingStyleText)
:css('font-weight', data.headingFontWeight)
:css('font-size', data.headingFontSize)
:wikitext(data.heading)
local links = data.links
if links then
sbox:tag('span')
:addClass(data.linksClass)
:attr('id', data.linksId)
:wikitext(links)
end
return tostring(sbox)
end

----------------------------------------------------------------------------
-- Documentation content
----------------------------------------------------------------------------

p.content = makeInvokeFunc('_content')

function p._content(args, env)
-- Displays the documentation contents
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
env = env or p.getEnvironment(args)
local docTitle = env.docTitle
local content = args.content
if not content and docTitle and docTitle.exists then
content = args._content or mw.getCurrentFrame():expandTemplate{title = docTitle.prefixedText}
end
-- The line breaks below are necessary so that "=== Headings ===" at the start and end
-- of docs are interpreted correctly.
return '\n' .. (content or '') .. '\n'
end

p.contentTitle = makeInvokeFunc('_contentTitle')

function p._contentTitle(args, env)
env = env or p.getEnvironment(args)
local docTitle = env.docTitle
if not args.content and docTitle and docTitle.exists then
return docTitle.prefixedText
else
return ''
end
end

----------------------------------------------------------------------------
-- End box
----------------------------------------------------------------------------

p.endBox = makeInvokeFunc('_endBox')

function p._endBox(args, env)
--[=[
-- This function generates the end box (also known as the link box).
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- Messages:
-- 'fmbox-id' --> 'documentation-meta-data'
-- 'fmbox-style' --> 'background-color: #ecfcf4'
-- 'fmbox-textstyle' --> 'font-style: italic'
--
-- The HTML is generated by the {{fmbox}} template, courtesy of [[Module:Message box]].
--]=]

-- Get environment data.
env = env or p.getEnvironment(args)
local subjectSpace = env.subjectSpace
local docTitle = env.docTitle
if not subjectSpace or not docTitle then
return nil
end

-- Check whether we should output the end box at all. Add the end
-- box by default if the documentation exists or if we are in the
-- user, module or template namespaces.
local linkBox = args['link box']
if linkBox == 'off'
or not (
docTitle.exists
or subjectSpace == 2
or subjectSpace == 828
or subjectSpace == 10
)
then
return nil
end

-- Assemble the arguments for {{fmbox}}.
local fmargs = {}
fmargs.id = message('fmbox-id') -- Sets 'documentation-meta-data'
fmargs.image = 'none'
fmargs.style = message('fmbox-style') -- Sets 'background-color: #ecfcf4'
fmargs.textstyle = message('fmbox-textstyle') -- 'font-style: italic;'

-- Assemble the fmbox text field.
local text = ''
if linkBox then
text = text .. linkBox
else
text = text .. (p.makeDocPageBlurb(args, env) or '') -- "This documentation is transcluded from [[Foo]]."
if subjectSpace == 2 or subjectSpace == 10 or subjectSpace == 828 then
-- We are in the user, template or module namespaces.
-- Add sandbox and testcases links.
-- "Editors can experiment in this template's sandbox and testcases pages."
text = text .. (p.makeExperimentBlurb(args, env) or '')
text = text .. ' '
if not args.content and not args[1] then
-- "Please add categories to the /doc subpage."
-- Don't show this message with inline docs or with an explicitly specified doc page,
-- as then it is unclear where to add the categories.
text = text .. (p.makeCategoriesBlurb(args, env) or '')
end
text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template"
local printBlurb = p.makePrintBlurb(args, env) -- Two-line blurb about print versions of templates.
if printBlurb then
text = text .. ' ' .. printBlurb
end
end
end
fmargs.text = text

return messageBox.main('fmbox', fmargs)
end

function p.makeDocPageBlurb(args, env)
--[=[
-- Makes the blurb "This documentation is transcluded from [[Template:Foo]] (edit, history)".
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- Messages:
-- 'edit-link-display' --> 'edit'
-- 'history-link-display' --> 'history'
-- 'transcluded-from-blurb' -->
-- 'The above [[Wikipedia:Template documentation|documentation]]
-- is [[Wikipedia:Transclusion|transcluded]] from $1.'
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
-- 'create-link-display' --> 'create'
-- 'create-module-doc-blurb' -->
-- 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'
--]=]
local docTitle = env.docTitle
if not docTitle then
return nil
end
local ret
if docTitle.exists then
-- /doc exists; link to it.
local docLink = makeWikilink(docTitle.prefixedText)
local editUrl = docTitle:fullUrl{action = 'edit'}
local editDisplay = message('edit-link-display')
local editLink = makeUrlLink(editUrl, editDisplay)
local historyUrl = docTitle:fullUrl{action = 'history'}
local historyDisplay = message('history-link-display')
local historyLink = makeUrlLink(historyUrl, historyDisplay)
ret = message('transcluded-from-blurb', {docLink})
.. ' '
.. makeToolbar(editLink, historyLink)
.. ' '
elseif env.subjectSpace == 828 then
-- /doc does not exist; ask to create it.
local createUrl = docTitle:fullUrl{action = 'edit', preload = message('module-preload')}
local createDisplay = message('create-link-display')
local createLink = makeUrlLink(createUrl, createDisplay)
ret = message('create-module-doc-blurb', {createLink})
.. ' '
end
return ret
end

function p.makeExperimentBlurb(args, env)
--[[
-- Renders the text "Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages."
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- Messages:
-- 'sandbox-link-display' --> 'sandbox'
-- 'sandbox-edit-link-display' --> 'edit'
-- 'compare-link-display' --> 'diff'
-- 'module-sandbox-preload' --> 'Template:Documentation/preload-module-sandbox'
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'
-- 'sandbox-create-link-display' --> 'create'
-- 'mirror-edit-summary' --> 'Create sandbox version of $1'
-- 'mirror-link-display' --> 'mirror'
-- 'mirror-link-preload' --> 'Template:Documentation/mirror'
-- 'sandbox-link-display' --> 'sandbox'
-- 'testcases-link-display' --> 'testcases'
-- 'testcases-edit-link-display'--> 'edit'
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'
-- 'testcases-create-link-display' --> 'create'
-- 'testcases-link-display' --> 'testcases'
-- 'testcases-edit-link-display' --> 'edit'
-- 'module-testcases-preload' --> 'Template:Documentation/preload-module-testcases'
-- 'template-testcases-preload' --> 'Template:Documentation/preload-testcases'
-- 'experiment-blurb-module' --> 'Editors can experiment in this module's $1 and $2 pages.'
-- 'experiment-blurb-template' --> 'Editors can experiment in this template's $1 and $2 pages.'
--]]
local subjectSpace = env.subjectSpace
local templateTitle = env.templateTitle
local sandboxTitle = env.sandboxTitle
local testcasesTitle = env.testcasesTitle
local templatePage = templateTitle.prefixedText
if not subjectSpace or not templateTitle or not sandboxTitle or not testcasesTitle then
return nil
end
-- Make links.
local sandboxLinks, testcasesLinks
if sandboxTitle.exists then
local sandboxPage = sandboxTitle.prefixedText
local sandboxDisplay = message('sandbox-link-display')
local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay)
local sandboxEditUrl = sandboxTitle:fullUrl{action = 'edit'}
local sandboxEditDisplay = message('sandbox-edit-link-display')
local sandboxEditLink = makeUrlLink(sandboxEditUrl, sandboxEditDisplay)
local compareUrl = env.compareUrl
local compareLink
if compareUrl then
local compareDisplay = message('compare-link-display')
compareLink = makeUrlLink(compareUrl, compareDisplay)
end
sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink)
else
local sandboxPreload
if subjectSpace == 828 then
sandboxPreload = message('module-sandbox-preload')
else
sandboxPreload = message('template-sandbox-preload')
end
local sandboxCreateUrl = sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload}
local sandboxCreateDisplay = message('sandbox-create-link-display')
local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)
local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)})
local mirrorPreload = message('mirror-link-preload')
local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary}
if subjectSpace == 828 then
mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = templateTitle.prefixedText, summary = mirrorSummary}
end
local mirrorDisplay = message('mirror-link-display')
local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)
sandboxLinks = message('sandbox-link-display') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink)
end
if testcasesTitle.exists then
local testcasesPage = testcasesTitle.prefixedText
local testcasesDisplay = message('testcases-link-display')
local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay)
local testcasesEditUrl = testcasesTitle:fullUrl{action = 'edit'}
local testcasesEditDisplay = message('testcases-edit-link-display')
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)
-- for Modules, add testcases run link if exists
if testcasesTitle.contentModel == "Scribunto" and testcasesTitle.talkPageTitle and testcasesTitle.talkPageTitle.exists then
local testcasesRunLinkDisplay = message('testcases-run-link-display')
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink, testcasesRunLink)
else
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)
end
else
local testcasesPreload
if subjectSpace == 828 then
testcasesPreload = message('module-testcases-preload')
else
testcasesPreload = message('template-testcases-preload')
end
local testcasesCreateUrl = testcasesTitle:fullUrl{action = 'edit', preload = testcasesPreload}
local testcasesCreateDisplay = message('testcases-create-link-display')
local testcasesCreateLink = makeUrlLink(testcasesCreateUrl, testcasesCreateDisplay)
testcasesLinks = message('testcases-link-display') .. ' ' .. makeToolbar(testcasesCreateLink)
end
local messageName
if subjectSpace == 828 then
messageName = 'experiment-blurb-module'
else
messageName = 'experiment-blurb-template'
end
return message(messageName, {sandboxLinks, testcasesLinks})
end

function p.makeCategoriesBlurb(args, env)
--[[
-- Generates the text "Please add categories to the /doc subpage."
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
-- Messages:
-- 'doc-link-display' --> '/doc'
-- 'add-categories-blurb' --> 'Please add categories to the $1 subpage.'
--]]
local docTitle = env.docTitle
if not docTitle then
return nil
end
local docPathLink = makeWikilink(docTitle.prefixedText, message('doc-link-display'))
return message('add-categories-blurb', {docPathLink})
end

function p.makeSubpagesBlurb(args, env)
--[[
-- Generates the "Subpages of this template" link.
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment

-- Messages:
-- 'template-pagetype' --> 'template'
-- 'module-pagetype' --> 'module'
-- 'default-pagetype' --> 'page'
-- 'subpages-link-display' --> 'Subpages of this $1'
--]]
local subjectSpace = env.subjectSpace
local templateTitle = env.templateTitle
if not subjectSpace or not templateTitle then
return nil
end
local pagetype
if subjectSpace == 10 then
pagetype = message('template-pagetype')
elseif subjectSpace == 828 then
pagetype = message('module-pagetype')
else
pagetype = message('default-pagetype')
end
local subpagesLink = makeWikilink(
'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/',
message('subpages-link-display', {pagetype})
)
return message('subpages-blurb', {subpagesLink})
end

function p.makePrintBlurb(args, env)
--[=[
-- Generates the blurb displayed when there is a print version of the template available.
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- Messages:
-- 'print-link-display' --> '/Print'
-- 'print-blurb' --> 'A [[Help:Books/for experts#Improving the book layout|print version]]'
-- .. ' of this template exists at $1.'
-- .. ' If you make a change to this template, please update the print version as well.'
-- 'display-print-category' --> true
-- 'print-category' --> 'Templates with print versions'
--]=]
local printTitle = env.printTitle
if not printTitle then
return nil
end
local ret
if printTitle.exists then
local printLink = makeWikilink(printTitle.prefixedText, message('print-link-display'))
ret = message('print-blurb', {printLink})
local displayPrintCategory = message('display-print-category', nil, 'boolean')
if displayPrintCategory then
ret = ret .. makeCategoryLink(message('print-category'))
end
end
return ret
end

----------------------------------------------------------------------------
-- Tracking categories
----------------------------------------------------------------------------

function p.addTrackingCategories(env)
--[[
-- Check if {{documentation}} is transcluded on a /doc or /testcases page.
-- @env - environment table containing title objects, etc., generated with p.getEnvironment

-- Messages:
-- 'display-strange-usage-category' --> true
-- 'doc-subpage' --> 'doc'
-- 'testcases-subpage' --> 'testcases'
-- 'strange-usage-category' --> 'Wikipedia pages with strange ((documentation)) usage'
--
-- /testcases pages in the module namespace are not categorised, as they may have
-- {{documentation}} transcluded automatically.
--]]
local title = env.title
local subjectSpace = env.subjectSpace
if not title or not subjectSpace then
return nil
end
local subpage = title.subpageText
local ret = ''
if message('display-strange-usage-category', nil, 'boolean')
and (
subpage == message('doc-subpage')
or subjectSpace ~= 828 and subpage == message('testcases-subpage')
)
then
ret = ret .. makeCategoryLink(message('strange-usage-category'))
end
return ret
end

return p

Module:Documentation/config

2026-04-16T10:58:21Z

E.vandenberge: Rollback

----------------------------------------------------------------------------------------------------
--
-- Configuration for Module:Documentation
--
-- Here you can set the values of the parameters and messages used in Module:Documentation to
-- localise it to your wiki and your language. Unless specified otherwise, values given here
-- should be string values.
----------------------------------------------------------------------------------------------------

local cfg = {} -- Do not edit this line.

----------------------------------------------------------------------------------------------------
-- Protection template configuration
----------------------------------------------------------------------------------------------------

-- cfg['protection-reason-edit']
-- The protection reason for edit-protected templates to pass to
-- [[Module:Protection banner]].
cfg['protection-reason-edit'] = 'template'

--[[
----------------------------------------------------------------------------------------------------
-- Sandbox notice configuration
--
-- On sandbox pages the module can display a template notifying users that the current page is a
-- sandbox, and the location of test cases pages, etc. The module decides whether the page is a
-- sandbox or not based on the value of cfg['sandbox-subpage']. The following settings configure the
-- messages that the notices contains.
----------------------------------------------------------------------------------------------------
--]]

-- cfg['sandbox-notice-image']
-- The image displayed in the sandbox notice.
cfg['sandbox-notice-image'] = '[[Image:Sandbox.svg|50px|alt=|link=]]'

--[[
-- cfg['sandbox-notice-pagetype-template']
-- cfg['sandbox-notice-pagetype-module']
-- cfg['sandbox-notice-pagetype-other']
-- The page type of the sandbox page. The message that is displayed depends on the current subject
-- namespace. This message is used in either cfg['sandbox-notice-blurb'] or
-- cfg['sandbox-notice-diff-blurb'].
--]]
cfg['sandbox-notice-pagetype-template'] = '[[Wikipedia:Template test cases|template sandbox]] page'
cfg['sandbox-notice-pagetype-module'] = '[[Wikipedia:Template test cases|module sandbox]] page'
cfg['sandbox-notice-pagetype-other'] = 'sandbox page'

--[[
-- cfg['sandbox-notice-blurb']
-- cfg['sandbox-notice-diff-blurb']
-- cfg['sandbox-notice-diff-display']
-- Either cfg['sandbox-notice-blurb'] or cfg['sandbox-notice-diff-blurb'] is the opening sentence
-- of the sandbox notice. The latter has a diff link, but the former does not. $1 is the page
-- type, which is either cfg['sandbox-notice-pagetype-template'],
-- cfg['sandbox-notice-pagetype-module'] or cfg['sandbox-notice-pagetype-other'] depending what
-- namespace we are in. $2 is a link to the main template page, and $3 is a diff link between
-- the sandbox and the main template. The display value of the diff link is set by
-- cfg['sandbox-notice-compare-link-display'].
--]]
cfg['sandbox-notice-blurb'] = 'This is the $1 for $2.'
cfg['sandbox-notice-diff-blurb'] = 'This is the $1 for $2 ($3).'
cfg['sandbox-notice-compare-link-display'] = 'diff'

--[[
-- cfg['sandbox-notice-testcases-blurb']
-- cfg['sandbox-notice-testcases-link-display']
-- cfg['sandbox-notice-testcases-run-blurb']
-- cfg['sandbox-notice-testcases-run-link-display']
-- cfg['sandbox-notice-testcases-blurb'] is a sentence notifying the user that there is a test cases page
-- corresponding to this sandbox that they can edit. $1 is a link to the test cases page.
-- cfg['sandbox-notice-testcases-link-display'] is the display value for that link.
-- cfg['sandbox-notice-testcases-run-blurb'] is a sentence notifying the user that there is a test cases page
-- corresponding to this sandbox that they can edit, along with a link to run it. $1 is a link to the test
-- cases page, and $2 is a link to the page to run it.
-- cfg['sandbox-notice-testcases-run-link-display'] is the display value for the link to run the test
-- cases.
--]]
cfg['sandbox-notice-testcases-blurb'] = 'See also the companion subpage for $1.'
cfg['sandbox-notice-testcases-link-display'] = 'test cases'
cfg['sandbox-notice-testcases-run-blurb'] = 'See also the companion subpage for $1 ($2).'
cfg['sandbox-notice-testcases-run-link-display'] = 'run'

-- cfg['sandbox-category']
-- A category to add to all template sandboxes.
cfg['sandbox-category'] = 'Template sandboxes'

----------------------------------------------------------------------------------------------------
-- Start box configuration
----------------------------------------------------------------------------------------------------

-- cfg['documentation-icon-wikitext']
-- The wikitext for the icon shown at the top of the template.
cfg['documentation-icon-wikitext'] = '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'

-- cfg['template-namespace-heading']
-- The heading shown in the template namespace.
cfg['template-namespace-heading'] = 'Template documentation'

-- cfg['module-namespace-heading']
-- The heading shown in the module namespace.
cfg['module-namespace-heading'] = 'Module documentation'

-- cfg['file-namespace-heading']
-- The heading shown in the file namespace.
cfg['file-namespace-heading'] = 'Summary'

-- cfg['other-namespaces-heading']
-- The heading shown in other namespaces.
cfg['other-namespaces-heading'] = 'Documentation'

-- cfg['view-link-display']
-- The text to display for "view" links.
cfg['view-link-display'] = 'view'

-- cfg['edit-link-display']
-- The text to display for "edit" links.
cfg['edit-link-display'] = 'edit'

-- cfg['history-link-display']
-- The text to display for "history" links.
cfg['history-link-display'] = 'history'

-- cfg['purge-link-display']
-- The text to display for "purge" links.
cfg['purge-link-display'] = 'purge'

-- cfg['create-link-display']
-- The text to display for "create" links.
cfg['create-link-display'] = 'create'

----------------------------------------------------------------------------------------------------
-- Link box (end box) configuration
----------------------------------------------------------------------------------------------------

-- cfg['transcluded-from-blurb']
-- Notice displayed when the docs are transcluded from another page. $1 is a wikilink to that page.
cfg['transcluded-from-blurb'] = 'The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from $1.'

--[[
-- cfg['create-module-doc-blurb']
-- Notice displayed in the module namespace when the documentation subpage does not exist.
-- $1 is a link to create the documentation page with the preload cfg['module-preload'] and the
-- display cfg['create-link-display'].
--]]
cfg['create-module-doc-blurb'] = 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'

----------------------------------------------------------------------------------------------------
-- Experiment blurb configuration
----------------------------------------------------------------------------------------------------

--[[
-- cfg['experiment-blurb-template']
-- cfg['experiment-blurb-module']
-- The experiment blurb is the text inviting editors to experiment in sandbox and test cases pages.
-- It is only shown in the template and module namespaces. With the default English settings, it
-- might look like this:
--
-- Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages.
--
-- In this example, "sandbox", "edit", "diff", "testcases", and "edit" would all be links.
--
-- There are two versions, cfg['experiment-blurb-template'] and cfg['experiment-blurb-module'], depending
-- on what namespace we are in.
--
-- Parameters:
--
-- $1 is a link to the sandbox page. If the sandbox exists, it is in the following format:
--
-- cfg['sandbox-link-display'] (cfg['sandbox-edit-link-display'] | cfg['compare-link-display'])
--
-- If the sandbox doesn't exist, it is in the format:
--
-- cfg['sandbox-link-display'] (cfg['sandbox-create-link-display'] | cfg['mirror-link-display'])
--
-- The link for cfg['sandbox-create-link-display'] link preloads the page with cfg['template-sandbox-preload']
-- or cfg['module-sandbox-preload'], depending on the current namespace. The link for cfg['mirror-link-display']
-- loads a default edit summary of cfg['mirror-edit-summary'].
--
-- $2 is a link to the test cases page. If the test cases page exists, it is in the following format:
--
-- cfg['testcases-link-display'] (cfg['testcases-edit-link-display'] | cfg['testcases-run-link-display'])
--
-- If the test cases page doesn't exist, it is in the format:
--
-- cfg['testcases-link-display'] (cfg['testcases-create-link-display'])
--
-- If the test cases page doesn't exist, the link for cfg['testcases-create-link-display'] preloads the
-- page with cfg['template-testcases-preload'] or cfg['module-testcases-preload'], depending on the current
-- namespace.
--]]
cfg['experiment-blurb-template'] = "Editors can experiment in this template's $1 and $2 pages."
cfg['experiment-blurb-module'] = "Editors can experiment in this module's $1 and $2 pages."

----------------------------------------------------------------------------------------------------
-- Sandbox link configuration
----------------------------------------------------------------------------------------------------

-- cfg['sandbox-subpage']
-- The name of the template subpage typically used for sandboxes.
cfg['sandbox-subpage'] = 'sandbox'

-- cfg['template-sandbox-preload']
-- Preload file for template sandbox pages.
cfg['template-sandbox-preload'] = 'Template:Documentation/preload-sandbox'

-- cfg['module-sandbox-preload']
-- Preload file for Lua module sandbox pages.
cfg['module-sandbox-preload'] = 'Template:Documentation/preload-module-sandbox'

-- cfg['sandbox-link-display']
-- The text to display for "sandbox" links.
cfg['sandbox-link-display'] = 'sandbox'

-- cfg['sandbox-edit-link-display']
-- The text to display for sandbox "edit" links.
cfg['sandbox-edit-link-display'] = 'edit'

-- cfg['sandbox-create-link-display']
-- The text to display for sandbox "create" links.
cfg['sandbox-create-link-display'] = 'create'

-- cfg['compare-link-display']
-- The text to display for "compare" links.
cfg['compare-link-display'] = 'diff'

-- cfg['mirror-edit-summary']
-- The default edit summary to use when a user clicks the "mirror" link. $1 is a wikilink to the
-- template page.
cfg['mirror-edit-summary'] = 'Create sandbox version of $1'

-- cfg['mirror-link-display']
-- The text to display for "mirror" links.
cfg['mirror-link-display'] = 'mirror'

-- cfg['mirror-link-preload']
-- The page to preload when a user clicks the "mirror" link.
cfg['mirror-link-preload'] = 'Template:Documentation/mirror'

----------------------------------------------------------------------------------------------------
-- Test cases link configuration
----------------------------------------------------------------------------------------------------

-- cfg['testcases-subpage']
-- The name of the template subpage typically used for test cases.
cfg['testcases-subpage'] = 'testcases'

-- cfg['template-testcases-preload']
-- Preload file for template test cases pages.
cfg['template-testcases-preload'] = 'Template:Documentation/preload-testcases'

-- cfg['module-testcases-preload']
-- Preload file for Lua module test cases pages.
cfg['module-testcases-preload'] = 'Template:Documentation/preload-module-testcases'

-- cfg['testcases-link-display']
-- The text to display for "testcases" links.
cfg['testcases-link-display'] = 'testcases'

-- cfg['testcases-edit-link-display']
-- The text to display for test cases "edit" links.
cfg['testcases-edit-link-display'] = 'edit'

-- cfg['testcases-run-link-display']
-- The text to display for test cases "run" links.
cfg['testcases-run-link-display'] = 'run'

-- cfg['testcases-create-link-display']
-- The text to display for test cases "create" links.
cfg['testcases-create-link-display'] = 'create'

----------------------------------------------------------------------------------------------------
-- Add categories blurb configuration
----------------------------------------------------------------------------------------------------

--[[
-- cfg['add-categories-blurb']
-- Text to direct users to add categories to the /doc subpage. Not used if the "content" or
-- "docname fed" arguments are set, as then it is not clear where to add the categories. $1 is a
-- link to the /doc subpage with a display value of cfg['doc-link-display'].
--]]
cfg['add-categories-blurb'] = 'Please add categories to the $1 subpage.'

-- cfg['doc-link-display']
-- The text to display when linking to the /doc subpage.
cfg['doc-link-display'] = '/doc'

----------------------------------------------------------------------------------------------------
-- Subpages link configuration
----------------------------------------------------------------------------------------------------

--[[
-- cfg['subpages-blurb']
-- The "Subpages of this template" blurb. $1 is a link to the main template's subpages with a
-- display value of cfg['subpages-link-display']. In the English version this blurb is simply
-- the link followed by a period, and the link display provides the actual text.
--]]
cfg['subpages-blurb'] = '$1.'

--[[
-- cfg['subpages-link-display']
-- The text to display for the "subpages of this page" link. $1 is cfg['template-pagetype'],
-- cfg['module-pagetype'] or cfg['default-pagetype'], depending on whether the current page is in
-- the template namespace, the module namespace, or another namespace.
--]]
cfg['subpages-link-display'] = 'Subpages of this $1'

-- cfg['template-pagetype']
-- The pagetype to display for template pages.
cfg['template-pagetype'] = 'template'

-- cfg['module-pagetype']
-- The pagetype to display for Lua module pages.
cfg['module-pagetype'] = 'module'

-- cfg['default-pagetype']
-- The pagetype to display for pages other than templates or Lua modules.
cfg['default-pagetype'] = 'page'

----------------------------------------------------------------------------------------------------
-- Doc link configuration
----------------------------------------------------------------------------------------------------

-- cfg['doc-subpage']
-- The name of the subpage typically used for documentation pages.
cfg['doc-subpage'] = 'doc'

-- cfg['file-docpage-preload']
-- Preload file for documentation page in the file namespace.
cfg['file-docpage-preload'] = 'Template:Documentation/preload-filespace'

-- cfg['docpage-preload']
-- Preload file for template documentation pages in all namespaces.
cfg['docpage-preload'] = 'Template:Documentation/preload'

-- cfg['module-preload']
-- Preload file for Lua module documentation pages.
cfg['module-preload'] = 'Template:Documentation/preload-module-doc'

----------------------------------------------------------------------------------------------------
-- Print version configuration
----------------------------------------------------------------------------------------------------

-- cfg['print-subpage']
-- The name of the template subpage used for print versions.
cfg['print-subpage'] = 'Print'

-- cfg['print-link-display']
-- The text to display when linking to the /Print subpage.
cfg['print-link-display'] = '/Print'

-- cfg['print-blurb']
-- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg['print-link-display'].
cfg['print-blurb'] = 'A [[Help:Books/for experts#Improving the book layout|print version]] of this template exists at $1.'
.. ' If you make a change to this template, please update the print version as well.'

-- cfg['display-print-category']
-- Set to true to enable output of cfg['print-category'] if a /Print subpage exists.
-- This should be a boolean value (either true or false).
cfg['display-print-category'] = true

-- cfg['print-category']
-- Category to output if cfg['display-print-category'] is set to true, and a /Print subpage exists.
cfg['print-category'] = 'Templates with print versions'

----------------------------------------------------------------------------------------------------
-- HTML and CSS configuration
----------------------------------------------------------------------------------------------------

-- cfg['main-div-id']
-- The "id" attribute of the main HTML "div" tag.
cfg['main-div-id'] = 'template-documentation'

-- cfg['main-div-classes']
-- The CSS classes added to the main HTML "div" tag.
cfg['main-div-classes'] = 'template-documentation iezoomfix'

-- cfg['start-box-linkclasses']
-- The CSS classes used for the [view][edit][history] or [create] links in the start box.
cfg['start-box-linkclasses'] = 'mw-editsection-like plainlinks'

-- cfg['start-box-link-id']
-- The HTML "id" attribute for the links in the start box.
cfg['start-box-link-id'] = 'doc_editlinks'

----------------------------------------------------------------------------------------------------
-- {{fmbox}} template configuration
----------------------------------------------------------------------------------------------------

-- cfg['fmbox-id']
-- The id sent to the "id" parameter of the {{fmbox}} template.
cfg['fmbox-id'] = 'documentation-meta-data'

-- cfg['fmbox-style']
-- The value sent to the style parameter of {{fmbox}}.
cfg['fmbox-style'] = 'background-color: #ecfcf4'

-- cfg['fmbox-textstyle']
-- The value sent to the "textstyle parameter of {{fmbox}}.
cfg['fmbox-textstyle'] = 'font-style: italic'

----------------------------------------------------------------------------------------------------
-- Tracking category configuration
----------------------------------------------------------------------------------------------------

-- cfg['display-strange-usage-category']
-- Set to true to enable output of cfg['strange-usage-category'] if the module is used on a /doc subpage
-- or a /testcases subpage. This should be a boolean value (either true or false).
cfg['display-strange-usage-category'] = true

-- cfg['strange-usage-category']
-- Category to output if cfg['display-strange-usage-category'] is set to true and the module is used on a
-- /doc subpage or a /testcases subpage.
cfg['strange-usage-category'] = 'Wikipedia pages with strange ((documentation)) usage'

--[[
----------------------------------------------------------------------------------------------------
-- End configuration
--
-- Don't edit anything below this line.
----------------------------------------------------------------------------------------------------
--]]

return cfg

Module:Documentation

2026-04-16T10:49:51Z

E.vandenberge: Undo revision 6465 by E.vandenberge (talk)

-- This module implements {{documentation}}.

-- Get required modules.
local getArgs = require('Module:Arguments').getArgs

-- Get the config table.
local cfg = mw.loadData('Module:Documentation/config')

local p = {}

-- Often-used functions.
local ugsub = mw.ustring.gsub
local format = mw.ustring.format

----------------------------------------------------------------------------
-- Helper functions
--
-- These are defined as local functions, but are made available in the p
-- table for testing purposes.
----------------------------------------------------------------------------

local function message(cfgKey, valArray, expectType)
--[[
-- Gets a message from the cfg table and formats it if appropriate.
-- The function raises an error if the value from the cfg table is not
-- of the type expectType. The default type for expectType is 'string'.
-- If the table valArray is present, strings such as $1, $2 etc. in the
-- message are substituted with values from the table keys [1], [2] etc.
-- For example, if the message "foo-message" had the value 'Foo $2 bar $1.',
-- message('foo-message', {'baz', 'qux'}) would return "Foo qux bar baz."
--]]
local msg = cfg[cfgKey]
expectType = expectType or 'string'
if type(msg) ~= expectType then
error('message: type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2)
end
if not valArray then
return msg
end

local function getMessageVal(match)
match = tonumber(match)
return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4)
end

return ugsub(msg, '$([1-9][0-9]*)', getMessageVal)
end

p.message = message

local function makeWikilink(page, display)
if display then
return format('[[%s|%s]]', page, display)
else
return format('[[%s]]', page)
end
end

p.makeWikilink = makeWikilink

local function makeCategoryLink(cat, sort)
local catns = mw.site.namespaces[14].name
return makeWikilink(catns .. ':' .. cat, sort)
end

p.makeCategoryLink = makeCategoryLink

local function makeUrlLink(url, display)
return format('[%s %s]', url, display)
end

p.makeUrlLink = makeUrlLink

local function makeToolbar(...)
local ret = {}
local lim = select('#', ...)
if lim < 1 then
return nil
end
for i = 1, lim do
ret[#ret + 1] = select(i, ...)
end
-- 'documentation-toolbar'
return format(
'(%s)',
message('toolbar-class'),
table.concat(ret, ' | ')
)
end

p.makeToolbar = makeToolbar

----------------------------------------------------------------------------
-- Argument processing
----------------------------------------------------------------------------

local function makeInvokeFunc(funcName)
return function (frame)
local args = getArgs(frame, {
valueFunc = function (key, value)
if type(value) == 'string' then
value = value:match('^%s*(.-)%s*$') -- Remove whitespace.
if key == 'heading' or value ~= '' then
return value
else
return nil
end
else
return value
end
end
})
return p[funcName](args)
end
end

----------------------------------------------------------------------------
-- Entry points
----------------------------------------------------------------------------

function p.nonexistent(frame)
if mw.title.getCurrentTitle().subpageText == 'testcases' then
return frame:expandTemplate{title = 'module test cases notice'}
else
return p.main(frame)
end
end

p.main = makeInvokeFunc('_main')

function p._main(args)
--[[
-- This function defines logic flow for the module.
-- @args - table of arguments passed by the user
--]]
local env = p.getEnvironment(args)
local root = mw.html.create()
root
:wikitext(p._getModuleWikitext(args, env))
:wikitext(p.protectionTemplate(env))
:wikitext(p.sandboxNotice(args, env))
:tag('div')
-- 'documentation-container'
:addClass(message('container'))
:attr('role', 'complementary')
:attr('aria-labelledby', args.heading ~= '' and 'documentation-heading' or nil)
:attr('aria-label', args.heading == '' and 'Documentation' or nil)
:newline()
:tag('div')
-- 'documentation'
:addClass(message('main-div-classes'))
:newline()
:wikitext(p._startBox(args, env))
:wikitext(p._content(args, env))
:tag('div')
-- 'documentation-clear'
:addClass(message('clear'))
:done()
:newline()
:done()
:wikitext(p._endBox(args, env))
:done()
:wikitext(p.addTrackingCategories(env))
-- 'Module:Documentation/styles.css'
return mw.getCurrentFrame():extensionTag (
'templatestyles', '', {src=cfg['templatestyles']
}) .. tostring(root)
end

----------------------------------------------------------------------------
-- Environment settings
----------------------------------------------------------------------------

function p.getEnvironment(args)
--[[
-- Returns a table with information about the environment, including title
-- objects and other namespace- or path-related data.
-- @args - table of arguments passed by the user
--
-- Title objects include:
-- env.title - the page we are making documentation for (usually the current title)
-- env.templateTitle - the template (or module, file, etc.)
-- env.docTitle - the /doc subpage.
-- env.sandboxTitle - the /sandbox subpage.
-- env.testcasesTitle - the /testcases subpage.
--
-- Data includes:
-- env.protectionLevels - the protection levels table of the title object.
-- env.subjectSpace - the number of the title's subject namespace.
-- env.docSpace - the number of the namespace the title puts its documentation in.
-- env.docpageBase - the text of the base page of the /doc, /sandbox and /testcases pages, with namespace.
-- env.compareUrl - URL of the Special:ComparePages page comparing the sandbox with the template.
--
-- All table lookups are passed through pcall so that errors are caught. If an error occurs, the value
-- returned will be nil.
--]]

local env, envFuncs = {}, {}

-- Set up the metatable. If triggered we call the corresponding function in the envFuncs table. The value
-- returned by that function is memoized in the env table so that we don't call any of the functions
-- more than once. (Nils won't be memoized.)
setmetatable(env, {
__index = function (t, key)
local envFunc = envFuncs[key]
if envFunc then
local success, val = pcall(envFunc)
if success then
env[key] = val -- Memoise the value.
return val
end
end
return nil
end
})

function envFuncs.title()
-- The title object for the current page, or a test page passed with args.page.
local title
local titleArg = args.page
if titleArg then
title = mw.title.new(titleArg)
else
title = mw.title.getCurrentTitle()
end
return title
end

function envFuncs.templateTitle()
--[[
-- The template (or module, etc.) title object.
-- Messages:
-- 'sandbox-subpage' --> 'sandbox'
-- 'testcases-subpage' --> 'testcases'
--]]
local subjectSpace = env.subjectSpace
local title = env.title
local subpage = title.subpageText
if subpage == message('sandbox-subpage') or subpage == message('testcases-subpage') or (subpage == message('doc-subpage') and mw.title.getCurrentTitle().namespace == env.docSpace) then
return mw.title.makeTitle(subjectSpace, title.baseText)
else
return mw.title.makeTitle(subjectSpace, title.text)
end
end

function envFuncs.docTitle()
--[[
-- Title object of the /doc subpage.
-- Messages:
-- 'doc-subpage' --> 'doc'
--]]
local title = env.title
local docname = args[1] -- User-specified doc page.
local docpage
if docname then
docpage = docname
else
docpage = env.docpageBase .. '/' .. message('doc-subpage')
end
return mw.title.new(docpage)
end

function envFuncs.sandboxTitle()
--[[
-- Title object for the /sandbox subpage.
-- Messages:
-- 'sandbox-subpage' --> 'sandbox'
--]]
return mw.title.new(env.docpageBase .. '/' .. message('sandbox-subpage'))
end

function envFuncs.testcasesTitle()
--[[
-- Title object for the /testcases subpage.
-- Messages:
-- 'testcases-subpage' --> 'testcases'
--]]
return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage'))
end

function envFuncs.protectionLevels()
-- The protection levels table of the title object.
return env.title.protectionLevels
end

function envFuncs.subjectSpace()
-- The subject namespace number.
return mw.site.namespaces[env.title.namespace].subject.id
end

function envFuncs.docSpace()
-- The documentation namespace number. For most namespaces this is the
-- same as the subject namespace. However, pages in the Article, File,
-- MediaWiki or Category namespaces must have their /doc, /sandbox and
-- /testcases pages in talk space.
local subjectSpace = env.subjectSpace
if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then
return subjectSpace + 1
else
return subjectSpace
end
end

function envFuncs.docpageBase()
-- The base page of the /doc, /sandbox, and /testcases subpages.
-- For some namespaces this is the talk page, rather than the template page.
local templateTitle = env.templateTitle
local docSpace = env.docSpace
local docSpaceText = mw.site.namespaces[docSpace].name
-- Assemble the link. docSpace is never the main namespace, so we can hardcode the colon.
return docSpaceText .. ':' .. templateTitle.text
end

function envFuncs.compareUrl()
-- Diff link between the sandbox and the main template using [[Special:ComparePages]].
local templateTitle = env.templateTitle
local sandboxTitle = env.sandboxTitle
if templateTitle.exists and sandboxTitle.exists then
local compareUrl = mw.uri.canonicalUrl(
'Special:ComparePages',
{ page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText}
)
return tostring(compareUrl)
else
return nil
end
end

return env
end

----------------------------------------------------------------------------
-- Auxiliary templates
----------------------------------------------------------------------------

p.getModuleWikitext = makeInvokeFunc('_getModuleWikitext')

function p._getModuleWikitext(args, env)
local currentTitle = mw.title.getCurrentTitle()
if currentTitle.contentModel ~= 'Scribunto' then return end
pcall(require, currentTitle.prefixedText) -- if it fails, we don't care
local moduleWikitext = package.loaded["Module:Module wikitext"]
if moduleWikitext then
return moduleWikitext.main()
end
end

function p.sandboxNotice(args, env)
--[=[
-- Generates a sandbox notice for display above sandbox pages.
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- Messages:
-- 'sandbox-notice-image' --> '[[File:Sandbox.svg|50px|alt=|link=]]'
-- 'sandbox-notice-blurb' --> 'This is the $1 for $2.'
-- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).'
-- 'sandbox-notice-pagetype-template' --> '[[Wikipedia:Template test cases|template sandbox]] page'
-- 'sandbox-notice-pagetype-module' --> '[[Wikipedia:Template test cases|module sandbox]] page'
-- 'sandbox-notice-pagetype-other' --> 'sandbox page'
-- 'sandbox-notice-compare-link-display' --> 'diff'
-- 'sandbox-notice-testcases-blurb' --> 'See also the companion subpage for $1.'
-- 'sandbox-notice-testcases-link-display' --> 'test cases'
-- 'sandbox-category' --> 'Template sandboxes'
-- 'module-sandbox-category' --> 'Module sandboxes'
-- 'other-sandbox-category' --> 'Sandboxes outside of template or module namespace'
--]=]
local title = env.title
local sandboxTitle = env.sandboxTitle
local templateTitle = env.templateTitle
local subjectSpace = env.subjectSpace
if not (subjectSpace and title and sandboxTitle and templateTitle
and mw.title.equals(title, sandboxTitle)) then
return nil
end
-- Build the table of arguments to pass to {{ombox}}. We need just two fields, "image" and "text".
local omargs = {}
omargs.image = message('sandbox-notice-image')
-- Get the text. We start with the opening blurb, which is something like
-- "This is the template sandbox for [[Template:Foo]] (diff)."
local text = '__EXPECTUNUSEDTEMPLATE__'
local pagetype, sandboxCat
if subjectSpace == 10 then
pagetype = message('sandbox-notice-pagetype-template')
sandboxCat = message('sandbox-category')
elseif subjectSpace == 828 then
pagetype = message('sandbox-notice-pagetype-module')
sandboxCat = message('module-sandbox-category')
else
pagetype = message('sandbox-notice-pagetype-other')
sandboxCat = message('other-sandbox-category')
end
local templateLink = makeWikilink(templateTitle.prefixedText)
local compareUrl = env.compareUrl
if compareUrl then
local compareDisplay = message('sandbox-notice-compare-link-display')
local compareLink = makeUrlLink(compareUrl, compareDisplay)
text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink})
else
text = text .. message('sandbox-notice-blurb', {pagetype, templateLink})
end
-- Get the test cases page blurb if the page exists. This is something like
-- "See also the companion subpage for [[Template:Foo/testcases|test cases]]."
local testcasesTitle = env.testcasesTitle
if testcasesTitle and testcasesTitle.exists then
if testcasesTitle.contentModel == "Scribunto" then
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display')
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)
text = text .. ' ' .. message('sandbox-notice-testcases-run-blurb', {testcasesLink, testcasesRunLink})
else
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)
text = text .. ' ' .. message('sandbox-notice-testcases-blurb', {testcasesLink})
end
end

-- Add the sandbox to the sandbox category.
omargs.text = text .. makeCategoryLink(sandboxCat)

-- 'documentation-clear'
return '<div class="' .. message('clear') .. '"></div>'
.. require('Module:Message box').main('ombox', omargs)
end

function p.protectionTemplate(env)
-- Generates the padlock icon in the top right.
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
-- Messages:
-- 'protection-template' --> 'pp-template'
-- 'protection-template-args' --> {docusage = 'yes'}
local protectionLevels = env.protectionLevels
if not protectionLevels then
return nil
end
local editProt = protectionLevels.edit and protectionLevels.edit[1]
local moveProt = protectionLevels.move and protectionLevels.move[1]
if editProt then
-- The page is edit-protected.
return require('Module:Protection banner')._main{
message('protection-reason-edit'), small = true
}
elseif moveProt and moveProt ~= 'autoconfirmed' then
-- The page is move-protected but not edit-protected. Exclude move
-- protection with the level "autoconfirmed", as this is equivalent to
-- no move protection at all.
return require('Module:Protection banner')._main{
action = 'move', small = true
}
else
return nil
end
end

----------------------------------------------------------------------------
-- Start box
----------------------------------------------------------------------------

p.startBox = makeInvokeFunc('_startBox')

function p._startBox(args, env)
--[[
-- This function generates the start box.
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- The actual work is done by p.makeStartBoxLinksData and p.renderStartBoxLinks which make
-- the [view] [edit] [history] [purge] links, and by p.makeStartBoxData and p.renderStartBox
-- which generate the box HTML.
--]]
env = env or p.getEnvironment(args)
local links
local content = args.content
if not content or args[1] then
-- No need to include the links if the documentation is on the template page itself.
local linksData = p.makeStartBoxLinksData(args, env)
if linksData then
links = p.renderStartBoxLinks(linksData)
end
end
-- Generate the start box html.
local data = p.makeStartBoxData(args, env, links)
if data then
return p.renderStartBox(data)
else
-- User specified no heading.
return nil
end
end

function p.makeStartBoxLinksData(args, env)
--[[
-- Does initial processing of data to make the [view] [edit] [history] [purge] links.
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- Messages:
-- 'view-link-display' --> 'view'
-- 'edit-link-display' --> 'edit'
-- 'history-link-display' --> 'history'
-- 'purge-link-display' --> 'purge'
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
-- 'docpage-preload' --> 'Template:Documentation/preload'
-- 'create-link-display' --> 'create'
--]]
local subjectSpace = env.subjectSpace
local title = env.title
local docTitle = env.docTitle
if not title or not docTitle then
return nil
end
if docTitle.isRedirect then
docTitle = docTitle.redirectTarget
end

-- Create link if /doc doesn't exist.
local preload = args.preload
if not preload then
if subjectSpace == 828 then -- Module namespace
preload = message('module-preload')
else
preload = message('docpage-preload')
end
end

return {
title = title,
docTitle = docTitle,
-- View, display, edit, and purge links if /doc exists.
viewLinkDisplay = message('view-link-display'),
editLinkDisplay = message('edit-link-display'),
historyLinkDisplay = message('history-link-display'),
purgeLinkDisplay = message('purge-link-display'),
preload = preload,
createLinkDisplay = message('create-link-display')
}
end

function p.renderStartBoxLinks(data)
--[[
-- Generates the [view][edit][history][purge] or [create][purge] links from the data table.
-- @data - a table of data generated by p.makeStartBoxLinksData
--]]
local docTitle = data.docTitle
-- yes, we do intend to purge the template page on which the documentation appears
local purgeLink = makeWikilink("Special:Purge/" .. data.title.prefixedText, data.purgeLinkDisplay)

if docTitle.exists then
local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay)
local editLink = makeWikilink("Special:EditPage/" .. docTitle.prefixedText, data.editLinkDisplay)
local historyLink = makeWikilink("Special:PageHistory/" .. docTitle.prefixedText, data.historyLinkDisplay)
return "[" .. viewLink .. "] [" .. editLink .. "] [" .. historyLink .. "] [" .. purgeLink .. "]"
else
local createLink = makeUrlLink(docTitle:canonicalUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay)
return "[" .. createLink .. "] [" .. purgeLink .. "]"
end
return ret
end

function p.makeStartBoxData(args, env, links)
--[=[
-- Does initial processing of data to pass to the start-box render function, p.renderStartBox.
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
-- @links - a string containing the [view][edit][history][purge] links - could be nil if there's an error.
--
-- Messages:
-- 'documentation-icon-wikitext' --> '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'
-- 'template-namespace-heading' --> 'Template documentation'
-- 'module-namespace-heading' --> 'Module documentation'
-- 'file-namespace-heading' --> 'Summary'
-- 'other-namespaces-heading' --> 'Documentation'
-- 'testcases-create-link-display' --> 'create'
--]=]
local subjectSpace = env.subjectSpace
if not subjectSpace then
-- Default to an "other namespaces" namespace, so that we get at least some output
-- if an error occurs.
subjectSpace = 2
end
local data = {}

-- Heading
local heading = args.heading -- Blank values are not removed.
if heading == '' then
-- Don't display the start box if the heading arg is defined but blank.
return nil
end
if heading then
data.heading = heading
elseif subjectSpace == 10 then -- Template namespace
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('template-namespace-heading')
elseif subjectSpace == 828 then -- Module namespace
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('module-namespace-heading')
elseif subjectSpace == 6 then -- File namespace
data.heading = message('file-namespace-heading')
else
data.heading = message('other-namespaces-heading')
end

-- Heading CSS
local headingStyle = args['heading-style']
if headingStyle then
data.headingStyleText = headingStyle
else
-- 'documentation-heading'
data.headingClass = message('main-div-heading-class')
end

-- Data for the [view][edit][history][purge] or [create] links.
if links then
-- 'mw-editsection-like plainlinks'
data.linksClass = message('start-box-link-classes')
data.links = links
end

return data
end

function p.renderStartBox(data)
-- Renders the start box html.
-- @data - a table of data generated by p.makeStartBoxData.
local sbox = mw.html.create('div')
sbox
-- 'documentation-startbox'
:addClass(message('start-box-class'))
:newline()
:tag('span')
:addClass(data.headingClass)
:attr('id', 'documentation-heading')
:cssText(data.headingStyleText)
:wikitext(data.heading)
local links = data.links
if links then
sbox:tag('span')
:addClass(data.linksClass)
:attr('id', data.linksId)
:wikitext(links)
end
return tostring(sbox)
end

----------------------------------------------------------------------------
-- Documentation content
----------------------------------------------------------------------------

p.content = makeInvokeFunc('_content')

function p._content(args, env)
-- Displays the documentation contents
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
env = env or p.getEnvironment(args)
local docTitle = env.docTitle
local content = args.content
if not content and docTitle and docTitle.exists then
content = args._content or mw.getCurrentFrame():expandTemplate{title = docTitle.prefixedText}
end
-- The line breaks below are necessary so that "=== Headings ===" at the start and end
-- of docs are interpreted correctly.
return '\n' .. (content or '') .. '\n'
end

p.contentTitle = makeInvokeFunc('_contentTitle')

function p._contentTitle(args, env)
env = env or p.getEnvironment(args)
local docTitle = env.docTitle
if not args.content and docTitle and docTitle.exists then
return docTitle.prefixedText
else
return ''
end
end

----------------------------------------------------------------------------
-- End box
----------------------------------------------------------------------------

p.endBox = makeInvokeFunc('_endBox')

function p._endBox(args, env)
--[=[
-- This function generates the end box (also known as the link box).
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
--]=]

-- Get environment data.
env = env or p.getEnvironment(args)
local subjectSpace = env.subjectSpace
local docTitle = env.docTitle
if not subjectSpace or not docTitle then
return nil
end

-- Check whether we should output the end box at all. Add the end
-- box by default if the documentation exists or if we are in the
-- user, module or template namespaces.
local linkBox = args['link box']
if linkBox == 'off'
or not (
docTitle.exists
or subjectSpace == 2
or subjectSpace == 828
or subjectSpace == 10
)
then
return nil
end

-- Assemble the link box.
local text = ''
if linkBox then
text = text .. linkBox
else
text = text .. (p.makeDocPageBlurb(args, env) or '') -- "This documentation is transcluded from [[Foo]]."
if subjectSpace == 2 or subjectSpace == 10 or subjectSpace == 828 then
-- We are in the user, template or module namespaces.
-- Add sandbox and testcases links.
-- "Editors can experiment in this template's sandbox and testcases pages."
text = text .. (p.makeExperimentBlurb(args, env) or '') .. ' '
if not args.content and not args[1] then
-- "Please add categories to the /doc subpage."
-- Don't show this message with inline docs or with an explicitly specified doc page,
-- as then it is unclear where to add the categories.
text = text .. (p.makeCategoriesBlurb(args, env) or '')
end
text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template"
end
end

local box = mw.html.create('div')
-- 'documentation-metadata'
box:attr('role', 'note')
:addClass(message('end-box-class'))
-- 'plainlinks'
:addClass(message('end-box-plainlinks'))
:wikitext(text)
:done()

return '\n' .. tostring(box)
end

function p.makeDocPageBlurb(args, env)
--[=[
-- Makes the blurb "This documentation is transcluded from [[Template:Foo]] (edit, history)".
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- Messages:
-- 'edit-link-display' --> 'edit'
-- 'history-link-display' --> 'history'
-- 'transcluded-from-blurb' -->
-- 'The above [[Wikipedia:Template documentation|documentation]]
-- is [[Help:Transclusion|transcluded]] from $1.'
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
-- 'create-link-display' --> 'create'
-- 'create-module-doc-blurb' -->
-- 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'
--]=]
local docTitle = env.docTitle
if not docTitle then
return nil
end
if docTitle.exists then
-- /doc exists; link to it.
local docLink = makeWikilink(docTitle.prefixedText)
local editDisplay = message('edit-link-display')
local editLink = makeWikilink("Special:EditPage/" .. docTitle.prefixedText, editDisplay)
local historyDisplay = message('history-link-display')
local historyLink = makeWikilink("Special:PageHistory/" .. docTitle.prefixedText, historyDisplay)
return message('transcluded-from-blurb', {docLink})
.. ' '
.. makeToolbar(editLink, historyLink)
.. ' '
elseif env.subjectSpace == 828 then
-- /doc does not exist; ask to create it.
local createUrl = docTitle:canonicalUrl{action = 'edit', preload = message('module-preload')}
local createDisplay = message('create-link-display')
local createLink = makeUrlLink(createUrl, createDisplay)
return message('create-module-doc-blurb', {createLink})
.. ' '
end
end

function p.makeExperimentBlurb(args, env)
--[[
-- Renders the text "Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages."
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- Messages:
-- 'sandbox-link-display' --> 'sandbox'
-- 'sandbox-edit-link-display' --> 'edit'
-- 'compare-link-display' --> 'diff'
-- 'module-sandbox-preload' --> 'Template:Documentation/preload-module-sandbox'
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'
-- 'sandbox-create-link-display' --> 'create'
-- 'mirror-edit-summary' --> 'Create sandbox version of $1'
-- 'mirror-link-display' --> 'mirror'
-- 'mirror-link-preload' --> 'Template:Documentation/mirror'
-- 'sandbox-link-display' --> 'sandbox'
-- 'testcases-link-display' --> 'testcases'
-- 'testcases-edit-link-display'--> 'edit'
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'
-- 'testcases-create-link-display' --> 'create'
-- 'testcases-link-display' --> 'testcases'
-- 'testcases-edit-link-display' --> 'edit'
-- 'module-testcases-preload' --> 'Template:Documentation/preload-module-testcases'
-- 'template-testcases-preload' --> 'Template:Documentation/preload-testcases'
-- 'experiment-blurb-module' --> 'Editors can experiment in this module's $1 and $2 pages.'
-- 'experiment-blurb-template' --> 'Editors can experiment in this template's $1 and $2 pages.'
--]]
local subjectSpace = env.subjectSpace
local templateTitle = env.templateTitle
local sandboxTitle = env.sandboxTitle
local testcasesTitle = env.testcasesTitle
local templatePage = templateTitle.prefixedText
if not subjectSpace or not templateTitle or not sandboxTitle or not testcasesTitle then
return nil
end
-- Make links.
local sandboxLinks, testcasesLinks
if sandboxTitle.exists then
local sandboxPage = sandboxTitle.prefixedText
local sandboxDisplay = message('sandbox-link-display')
local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay)
local sandboxEditDisplay = message('sandbox-edit-link-display')
local sandboxEditLink = makeWikilink("Special:EditPage/" .. sandboxPage, sandboxEditDisplay)
local compareUrl = env.compareUrl
local compareLink
if compareUrl then
local compareDisplay = message('compare-link-display')
compareLink = makeUrlLink(compareUrl, compareDisplay)
end
sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink)
else
local sandboxPreload
if subjectSpace == 828 then
sandboxPreload = message('module-sandbox-preload')
else
sandboxPreload = message('template-sandbox-preload')
end
local sandboxCreateUrl = sandboxTitle:canonicalUrl{action = 'edit', preload = sandboxPreload}
local sandboxCreateDisplay = message('sandbox-create-link-display')
local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)
local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)})
local mirrorPreload = message('mirror-link-preload')
local mirrorUrl = sandboxTitle:canonicalUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary}
if subjectSpace == 828 then
mirrorUrl = sandboxTitle:canonicalUrl{action = 'edit', preload = templateTitle.prefixedText, summary = mirrorSummary}
end
local mirrorDisplay = message('mirror-link-display')
local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)
sandboxLinks = message('sandbox-link-display') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink)
end
if testcasesTitle.exists then
local testcasesPage = testcasesTitle.prefixedText
local testcasesDisplay = message('testcases-link-display')
local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay)
local testcasesEditUrl = testcasesTitle:canonicalUrl{action = 'edit'}
local testcasesEditDisplay = message('testcases-edit-link-display')
local testcasesEditLink = makeWikilink("Special:EditPage/" .. testcasesPage, testcasesEditDisplay)
-- for Modules, add testcases run link if exists
if testcasesTitle.contentModel == "Scribunto" and testcasesTitle.talkPageTitle and testcasesTitle.talkPageTitle.exists then
local testcasesRunLinkDisplay = message('testcases-run-link-display')
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink, testcasesRunLink)
else
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)
end
else
local testcasesPreload
if subjectSpace == 828 then
testcasesPreload = message('module-testcases-preload')
else
testcasesPreload = message('template-testcases-preload')
end
local testcasesCreateUrl = testcasesTitle:canonicalUrl{action = 'edit', preload = testcasesPreload}
local testcasesCreateDisplay = message('testcases-create-link-display')
local testcasesCreateLink = makeUrlLink(testcasesCreateUrl, testcasesCreateDisplay)
testcasesLinks = message('testcases-link-display') .. ' ' .. makeToolbar(testcasesCreateLink)
end
local messageName
if subjectSpace == 828 then
messageName = 'experiment-blurb-module'
else
messageName = 'experiment-blurb-template'
end
return message(messageName, {sandboxLinks, testcasesLinks})
end

function p.makeCategoriesBlurb(args, env)
--[[
-- Generates the text "Please add categories to the /doc subpage."
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
-- Messages:
-- 'doc-link-display' --> '/doc'
-- 'add-categories-blurb' --> 'Please add categories to the $1 subpage.'
--]]
local docTitle = env.docTitle
if not docTitle then
return nil
end
local docPathLink = makeWikilink(docTitle.prefixedText, message('doc-link-display'))
return message('add-categories-blurb', {docPathLink})
end

function p.makeSubpagesBlurb(args, env)
--[[
-- Generates the "Subpages of this template" link.
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment

-- Messages:
-- 'template-pagetype' --> 'template'
-- 'module-pagetype' --> 'module'
-- 'default-pagetype' --> 'page'
-- 'subpages-link-display' --> 'Subpages of this $1'
--]]
local subjectSpace = env.subjectSpace
local templateTitle = env.templateTitle
if not subjectSpace or not templateTitle then
return nil
end
local pagetype
if subjectSpace == 10 then
pagetype = message('template-pagetype')
elseif subjectSpace == 828 then
pagetype = message('module-pagetype')
else
pagetype = message('default-pagetype')
end
local subpagesLink = makeWikilink(
'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/',
message('subpages-link-display', {pagetype})
)
return message('subpages-blurb', {subpagesLink})
end

----------------------------------------------------------------------------
-- Tracking categories
----------------------------------------------------------------------------

function p.addTrackingCategories(env)
--[[
-- Check if {{documentation}} is transcluded on a /doc or /testcases page.
-- @env - environment table containing title objects, etc., generated with p.getEnvironment

-- Messages:
-- 'display-strange-usage-category' --> true
-- 'doc-subpage' --> 'doc'
-- 'testcases-subpage' --> 'testcases'
-- 'strange-usage-category' --> 'Wikipedia pages with strange ((documentation)) usage'
--
-- /testcases pages in the module namespace are not categorised, as they may have
-- {{documentation}} transcluded automatically.
--]]
local title = env.title
local subjectSpace = env.subjectSpace
if not title or not subjectSpace then
return nil
end
local subpage = title.subpageText
if message('display-strange-usage-category', nil, 'boolean')
and (
subpage == message('doc-subpage')
or subjectSpace ~= 828 and subpage == message('testcases-subpage')
)
then
return makeCategoryLink(message('strange-usage-category'))
end
return ''
end

return p

Module:Documentation

2026-04-16T10:49:14Z

E.vandenberge: Rollback

Module:Documentation

2026-04-16T10:41:16Z

E.vandenberge: Reverted edits by E.vandenberge (talk) to last revision by en>Paine Ellsworth

Module:Documentation

2026-04-16T10:40:23Z

E.vandenberge: Rollback

Main Page

2026-04-16T10:25:09Z

E.vandenberge:

{{Notice|The wiki has been updated with information on our '''new lab computer and peripherals'''!}}
 
Welcome to the TSG Wiki.

On this wiki you will find documentation for the Hardware, Software and Research Equipment used in the lab environments of the research facilities of the Radboud University's Faculty of Social Sciences, as well as other useful information. 
To learn more about the Technical Support Group, visit [http://www.ru.nl/socialsciences/technicalsupportgroup/ our website] or the [[TSG info|about]] section.


<div style="width:100%;">
{{Main Page/Frame
| color = be311a
| title = 📄Hardware Documentation
| content = {{Bulleted list
| [[Audio Interface]]s
| [[Balance Board]]
| [[Biopac]]
| [[Brainvision]]
| [[ButtonBox]]es
| [[Camera]]s
| [[Lab Computer|Computers]]
| [[Eyetracker]]s
| [[Head Mounted Display]]s
| [[Headphones]]
| [[Ipod]] (Video & Audio Recording)
| [[JoyStick]]s
| [[Kinect]]
| [[Laptop]]s
| [[Microphone]]s
| [[Monitor]]s
| [[Optotrak]]
| [[Plux biosignals]]
| [[Qualisys]]
| [[Structure sensor]]
| [[TemperatureHumidity]]
| [[TMSi]]
| [[Vertical Sync sensor]]
}}
}}

{{Main Page/Frame
| color = be311a
| title = 📃Software Documentation
| content = {{Bulleted list
| [[FFmpeg]] (Video Conversion)
| [[LSL]]
| [[Matlab]]
| [[OBS Studio]] (Screen/Webcam Recording)
| [[Presentation]]
| [[Psychopy]]
| [[Python]]
| [[System Image]]
| [[Unity]]
}} 
;Online Experiments
{{Bulleted list
| [[Online Experiments|Overview of Online Systems]]
| [[jsPsych]]
| [[LimeSurvey]]
| [[Qualtrics]]
| [[Online Experiments/Toolbox|Toolbox for online experiments]]
| [[Web development]]
}} 
;Data Acquisition
{{Bulleted list
| [[Data Files|Data Formatting]]
| [[Radcloud]]
}} 
;Stimuli
{{Bulleted list
| [[Audio]]
| [[Video Codecs]]
| [[Video Playback]]
}} 
;Miscellaneous
{{Bulleted list

| [[Gitlab Social Sciences]]
| [[IP Distribution Lab Computer]]
| [[Mattermost Social Sciences]]
| [[Virtualization Server]]
}}
}}

{{Main Page/Frame
| color = be311a
| title = 📄Lab Documentation
| content = {{Bulleted list
| [[BalanceBoard Lab]]

| [[Cubicle]]s (Standard Labs)
| [[EEG Lab]]
| [[Eye Tracker Lab]]
| [[RIVER Lab]] (Virtual Reality)
| [[SensoriMotorLab]]
| [[Social Interaction Lab]]
| [[Sound Recording Lab]]

| [[TMS Lab]]
}} 
;Lab Use Policy and Guidelines
{{Bulleted list
| [[Booking labs]]
| [[Media:EEG_lab_user_guide.pdf|EEG lab user guide]]
| [[Media:Cleaningprocedure_EEG.pdf|EEG cleaning protocol]]
| [[Using labs]]
| [[Informed consent]]
}}
}}

</div>

Module:Message box

2026-04-16T10:24:12Z

E.vandenberge: Rollback

-- This is a meta-module for producing message box templates, including
-- {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.

-- Load necessary modules.
require('Module:No globals')
local getArgs
local yesno = require('Module:Yesno')

-- Get a language object for formatDate and ucfirst.
local lang = mw.language.getContentLanguage()

-- Define constants
local CONFIG_MODULE = 'Module:Message box/configuration'
local DEMOSPACES = {talk = 'tmbox', image = 'imbox', file = 'imbox', category = 'cmbox', article = 'ambox', main = 'ambox'}

--------------------------------------------------------------------------------
-- Helper functions
--------------------------------------------------------------------------------

local function getTitleObject(...)
-- Get the title object, passing the function through pcall
-- in case we are over the expensive function count limit.
local success, title = pcall(mw.title.new, ...)
if success then
return title
end
end

local function union(t1, t2)
-- Returns the union of two arrays.
local vals = {}
for i, v in ipairs(t1) do
vals[v] = true
end
for i, v in ipairs(t2) do
vals[v] = true
end
local ret = {}
for k in pairs(vals) do
table.insert(ret, k)
end
table.sort(ret)
return ret
end

local function getArgNums(args, prefix)
local nums = {}
for k, v in pairs(args) do
local num = mw.ustring.match(tostring(k), '^' .. prefix .. '([1-9]%d*)$')
if num then
table.insert(nums, tonumber(num))
end
end
table.sort(nums)
return nums
end

--------------------------------------------------------------------------------
-- Box class definition
--------------------------------------------------------------------------------

local MessageBox = {}
MessageBox.__index = MessageBox

function MessageBox.new(boxType, args, cfg)
args = args or {}
local obj = {}

-- Set the title object and the namespace.
obj.title = getTitleObject(args.page) or mw.title.getCurrentTitle()

-- Set the config for our box type.
obj.cfg = cfg[boxType]
if not obj.cfg then
local ns = obj.title.namespace
-- boxType is "mbox" or invalid input
if args.demospace and args.demospace ~= '' then
-- implement demospace parameter of mbox
local demospace = string.lower(args.demospace)
if DEMOSPACES[demospace] then
-- use template from DEMOSPACES
obj.cfg = cfg[DEMOSPACES[demospace]]
elseif string.find( demospace, 'talk' ) then
-- demo as a talk page
obj.cfg = cfg.tmbox
else
-- default to ombox
obj.cfg = cfg.ombox
end
elseif ns == 0 then
obj.cfg = cfg.ambox -- main namespace
elseif ns == 6 then
obj.cfg = cfg.imbox -- file namespace
elseif ns == 14 then
obj.cfg = cfg.cmbox -- category namespace
else
local nsTable = mw.site.namespaces[ns]
if nsTable and nsTable.isTalk then
obj.cfg = cfg.tmbox -- any talk namespace
else
obj.cfg = cfg.ombox -- other namespaces or invalid input
end
end
end

-- Set the arguments, and remove all blank arguments except for the ones
-- listed in cfg.allowBlankParams.
do
local newArgs = {}
for k, v in pairs(args) do
if v ~= '' then
newArgs[k] = v
end
end
for i, param in ipairs(obj.cfg.allowBlankParams or {}) do
newArgs[param] = args[param]
end
obj.args = newArgs
end

-- Define internal data structure.
obj.categories = {}
obj.classes = {}
-- For lazy loading of [[Module:Category handler]].
obj.hasCategories = false

return setmetatable(obj, MessageBox)
end

function MessageBox:addCat(ns, cat, sort)
if not cat then
return nil
end
if sort then
cat = string.format('[[Category:%s|%s]]', cat, sort)
else
cat = string.format('[[Category:%s]]', cat)
end
self.hasCategories = true
self.categories[ns] = self.categories[ns] or {}
table.insert(self.categories[ns], cat)
end

function MessageBox:addClass(class)
if not class then
return nil
end
table.insert(self.classes, class)
end

function MessageBox:setParameters()
local args = self.args
local cfg = self.cfg

-- Get type data.
self.type = args.type
local typeData = cfg.types[self.type]
self.invalidTypeError = cfg.showInvalidTypeError
and self.type
and not typeData
typeData = typeData or cfg.types[cfg.default]
self.typeClass = typeData.class
self.typeImage = typeData.image

-- Find if the box has been wrongly substituted.
self.isSubstituted = cfg.substCheck and args.subst == 'SUBST'

-- Find whether we are using a small message box.
self.isSmall = cfg.allowSmall and (
cfg.smallParam and args.small == cfg.smallParam
or not cfg.smallParam and yesno(args.small)
)

-- Add attributes, classes and styles.
self.id = args.id
self.name = args.name
if self.name then
self:addClass('box-' .. string.gsub(self.name,' ','_'))
end
if yesno(args.plainlinks) ~= false then
self:addClass('plainlinks')
end
for _, class in ipairs(cfg.classes or {}) do
self:addClass(class)
end
if self.isSmall then
self:addClass(cfg.smallClass or 'mbox-small')
end
self:addClass(self.typeClass)
self:addClass(args.class)
self.style = args.style
self.attrs = args.attrs

-- Set text style.
self.textstyle = args.textstyle

-- Find if we are on the template page or not. This functionality is only
-- used if useCollapsibleTextFields is set, or if both cfg.templateCategory
-- and cfg.templateCategoryRequireName are set.
self.useCollapsibleTextFields = cfg.useCollapsibleTextFields
if self.useCollapsibleTextFields
or cfg.templateCategory
and cfg.templateCategoryRequireName
then
if self.name then
local templateName = mw.ustring.match(
self.name,
'^[tT][eE][mM][pP][lL][aA][tT][eE][%s_]*:[%s_]*(.*)$'
) or self.name
templateName = 'Template:' .. templateName
self.templateTitle = getTitleObject(templateName)
end
self.isTemplatePage = self.templateTitle
and mw.title.equals(self.title, self.templateTitle)
end

-- Process data for collapsible text fields. At the moment these are only
-- used in {{ambox}}.
if self.useCollapsibleTextFields then
-- Get the self.issue value.
if self.isSmall and args.smalltext then
self.issue = args.smalltext
else
local sect
if args.sect == '' then
sect = 'This ' .. (cfg.sectionDefault or 'page')
elseif type(args.sect) == 'string' then
sect = 'This ' .. args.sect
end
local issue = args.issue
issue = type(issue) == 'string' and issue ~= '' and issue or nil
local text = args.text
text = type(text) == 'string' and text or nil
local issues = {}
table.insert(issues, sect)
table.insert(issues, issue)
table.insert(issues, text)
self.issue = table.concat(issues, ' ')
end

-- Get the self.talk value.
local talk = args.talk
-- Show talk links on the template page or template subpages if the talk
-- parameter is blank.
if talk == ''
and self.templateTitle
and (
mw.title.equals(self.templateTitle, self.title)
or self.title:isSubpageOf(self.templateTitle)
)
then
talk = '#'
elseif talk == '' then
talk = nil
end
if talk then
-- If the talk value is a talk page, make a link to that page. Else
-- assume that it's a section heading, and make a link to the talk
-- page of the current page with that section heading.
local talkTitle = getTitleObject(talk)
local talkArgIsTalkPage = true
if not talkTitle or not talkTitle.isTalkPage then
talkArgIsTalkPage = false
talkTitle = getTitleObject(
self.title.text,
mw.site.namespaces[self.title.namespace].talk.id
)
end
if talkTitle and talkTitle.exists then
local talkText = 'Relevant discussion may be found on'
if talkArgIsTalkPage then
talkText = string.format(
'%s [[%s|%s]].',
talkText,
talk,
talkTitle.prefixedText
)
else
talkText = string.format(
'%s the [[%s#%s|talk page]].',
talkText,
talkTitle.prefixedText,
talk
)
end
self.talk = talkText
end
end

-- Get other values.
self.fix = args.fix ~= '' and args.fix or nil
local date
if args.date and args.date ~= '' then
date = args.date
elseif args.date == '' and self.isTemplatePage then
date = lang:formatDate('F Y')
end
if date then
self.date = string.format(" ''(%s)''", date)
end
self.info = args.info
if yesno(args.removalnotice) then
self.removalNotice = cfg.removalNotice
end
end

-- Set the non-collapsible text field. At the moment this is used by all box
-- types other than ambox, and also by ambox when small=yes.
if self.isSmall then
self.text = args.smalltext or args.text
else
self.text = args.text
end

-- Set the below row.
self.below = cfg.below and args.below

-- General image settings.
self.imageCellDiv = not self.isSmall and cfg.imageCellDiv
self.imageEmptyCell = cfg.imageEmptyCell
if cfg.imageEmptyCellStyle then
self.imageEmptyCellStyle = 'border:none;padding:0px;width:1px'
end

-- Left image settings.
local imageLeft = self.isSmall and args.smallimage or args.image
if cfg.imageCheckBlank and imageLeft ~= 'blank' and imageLeft ~= 'none'
or not cfg.imageCheckBlank and imageLeft ~= 'none'
then
self.imageLeft = imageLeft
if not imageLeft then
local imageSize = self.isSmall
and (cfg.imageSmallSize or '30x30px')
or '40x40px'
self.imageLeft = string.format('[[File:%s|%s|link=|alt=]]', self.typeImage
or 'Imbox notice.png', imageSize)
end
end

-- Right image settings.
local imageRight = self.isSmall and args.smallimageright or args.imageright
if not (cfg.imageRightNone and imageRight == 'none') then
self.imageRight = imageRight
end
end

function MessageBox:setMainspaceCategories()
local args = self.args
local cfg = self.cfg

if not cfg.allowMainspaceCategories then
return nil
end

local nums = {}
for _, prefix in ipairs{'cat', 'category', 'all'} do
args[prefix .. '1'] = args[prefix]
nums = union(nums, getArgNums(args, prefix))
end

-- The following is roughly equivalent to the old {{Ambox/category}}.
local date = args.date
date = type(date) == 'string' and date
local preposition = 'from'
for _, num in ipairs(nums) do
local mainCat = args['cat' .. tostring(num)]
or args['category' .. tostring(num)]
local allCat = args['all' .. tostring(num)]
mainCat = type(mainCat) == 'string' and mainCat
allCat = type(allCat) == 'string' and allCat
if mainCat and date and date ~= '' then
local catTitle = string.format('%s %s %s', mainCat, preposition, date)
self:addCat(0, catTitle)
catTitle = getTitleObject('Category:' .. catTitle)
if not catTitle or not catTitle.exists then
self:addCat(0, 'Articles with invalid date parameter in template')
end
elseif mainCat and (not date or date == '') then
self:addCat(0, mainCat)
end
if allCat then
self:addCat(0, allCat)
end
end
end

function MessageBox:setTemplateCategories()
local args = self.args
local cfg = self.cfg

-- Add template categories.
if cfg.templateCategory then
if cfg.templateCategoryRequireName then
if self.isTemplatePage then
self:addCat(10, cfg.templateCategory)
end
elseif not self.title.isSubpage then
self:addCat(10, cfg.templateCategory)
end
end

-- Add template error categories.
if cfg.templateErrorCategory then
local templateErrorCategory = cfg.templateErrorCategory
local templateCat, templateSort
if not self.name and not self.title.isSubpage then
templateCat = templateErrorCategory
elseif self.isTemplatePage then
local paramsToCheck = cfg.templateErrorParamsToCheck or {}
local count = 0
for i, param in ipairs(paramsToCheck) do
if not args[param] then
count = count + 1
end
end
if count > 0 then
templateCat = templateErrorCategory
templateSort = tostring(count)
end
if self.categoryNums and #self.categoryNums > 0 then
templateCat = templateErrorCategory
templateSort = 'C'
end
end
self:addCat(10, templateCat, templateSort)
end
end

function MessageBox:setAllNamespaceCategories()
-- Set categories for all namespaces.
if self.invalidTypeError then
local allSort = (self.title.namespace == 0 and 'Main:' or '') .. self.title.prefixedText
self:addCat('all', 'Wikipedia message box parameter needs fixing', allSort)
end
if self.isSubstituted then
self:addCat('all', 'Pages with incorrectly substituted templates')
end
end

function MessageBox:setCategories()
if self.title.namespace == 0 then
self:setMainspaceCategories()
elseif self.title.namespace == 10 then
self:setTemplateCategories()
end
self:setAllNamespaceCategories()
end

function MessageBox:renderCategories()
if not self.hasCategories then
-- No categories added, no need to pass them to Category handler so,
-- if it was invoked, it would return the empty string.
-- So we shortcut and return the empty string.
return ""
end
-- Convert category tables to strings and pass them through
-- [[Module:Category handler]].
return require('Module:Category handler')._main{
main = table.concat(self.categories[0] or {}),
template = table.concat(self.categories[10] or {}),
all = table.concat(self.categories.all or {}),
nocat = self.args.nocat,
page = self.args.page
}
end

function MessageBox:export()
local root = mw.html.create()

-- Add the subst check error.
if self.isSubstituted and self.name then
root:tag('b')
:addClass('error')
:wikitext(string.format(
'Template <code>%s[[Template:%s|%s]]%s</code> has been incorrectly substituted.',
mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}')
))
end

-- Create the box table.
local boxTable = root:tag('table')
boxTable:attr('id', self.id or nil)
for i, class in ipairs(self.classes or {}) do
boxTable:addClass(class or nil)
end
boxTable
:cssText(self.style or nil)
:attr('role', 'presentation')

if self.attrs then
boxTable:attr(self.attrs)
end

-- Add the left-hand image.
local row = boxTable:tag('tr')
if self.imageLeft then
local imageLeftCell = row:tag('td'):addClass('mbox-image')
if self.imageCellDiv then
-- If we are using a div, redefine imageLeftCell so that the image
-- is inside it. Divs use style="width: 52px;", which limits the
-- image width to 52px. If any images in a div are wider than that,
-- they may overlap with the text or cause other display problems.
imageLeftCell = imageLeftCell:tag('div'):css('width', '52px')
end
imageLeftCell:wikitext(self.imageLeft or nil)
elseif self.imageEmptyCell then
-- Some message boxes define an empty cell if no image is specified, and
-- some don't. The old template code in templates where empty cells are
-- specified gives the following hint: "No image. Cell with some width
-- or padding necessary for text cell to have 100% width."
row:tag('td')
:addClass('mbox-empty-cell')
:cssText(self.imageEmptyCellStyle or nil)
end

-- Add the text.
local textCell = row:tag('td'):addClass('mbox-text')
if self.useCollapsibleTextFields then
-- The message box uses advanced text parameters that allow things to be
-- collapsible. At the moment, only ambox uses this.
textCell:cssText(self.textstyle or nil)
local textCellDiv = textCell:tag('div')
textCellDiv
:addClass('mbox-text-span')
:wikitext(self.issue or nil)
if (self.talk or self.fix) and not self.isSmall then
textCellDiv:tag('span')
:addClass('hide-when-compact')
:wikitext(self.talk and (' ' .. self.talk) or nil)
:wikitext(self.fix and (' ' .. self.fix) or nil)
end
textCellDiv:wikitext(self.date and (' ' .. self.date) or nil)
if self.info and not self.isSmall then
textCellDiv
:tag('span')
:addClass('hide-when-compact')
:wikitext(self.info and (' ' .. self.info) or nil)
end
if self.removalNotice then
textCellDiv:tag('small')
:addClass('hide-when-compact')
:tag('i')
:wikitext(string.format(" (%s)", self.removalNotice))
end
else
-- Default text formatting - anything goes.
textCell
:cssText(self.textstyle or nil)
:wikitext(self.text or nil)
end

-- Add the right-hand image.
if self.imageRight then
local imageRightCell = row:tag('td'):addClass('mbox-imageright')
if self.imageCellDiv then
-- If we are using a div, redefine imageRightCell so that the image
-- is inside it.
imageRightCell = imageRightCell:tag('div'):css('width', '52px')
end
imageRightCell
:wikitext(self.imageRight or nil)
end

-- Add the below row.
if self.below then
boxTable:tag('tr')
:tag('td')
:attr('colspan', self.imageRight and '3' or '2')
:addClass('mbox-text')
:cssText(self.textstyle or nil)
:wikitext(self.below or nil)
end

-- Add error message for invalid type parameters.
if self.invalidTypeError then
root:tag('div')
:css('text-align', 'center')
:wikitext(string.format(
'This message box is using an invalid "type=%s" parameter and needs fixing.',
self.type or ''
))
end

-- Add categories.
root:wikitext(self:renderCategories() or nil)

return tostring(root)
end

--------------------------------------------------------------------------------
-- Exports
--------------------------------------------------------------------------------

local p, mt = {}, {}

function p._exportClasses()
-- For testing.
return {
MessageBox = MessageBox
}
end

function p.main(boxType, args, cfgTables)
local box = MessageBox.new(boxType, args, cfgTables or mw.loadData(CONFIG_MODULE))
box:setParameters()
box:setCategories()
return box:export()
end

function mt.__index(t, k)
return function (frame)
if not getArgs then
getArgs = require('Module:Arguments').getArgs
end
return t.main(k, getArgs(frame, {trim = false, removeBlanks = false}))
end
end

return setmetatable(p, mt)

Main Page

2026-04-16T10:16:26Z

E.vandenberge:

Welcome to the TSG Wiki.

On this wiki you will find documentation for the Hardware, Software and Research Equipment used in the lab environments of the research facilities of the Radboud University's Faculty of Social Sciences, as well as other useful information. 
To learn more about the Technical Support Group, visit [http://www.ru.nl/socialsciences/technicalsupportgroup/ our website] or the [[TSG info|about]] section.


<div style="width:100%;">
{{Main Page/Frame
| color = be311a
| title = 📄Hardware Documentation
| content = {{Bulleted list
| [[Audio Interface]]s
| [[Balance Board]]
| [[Biopac]]
| [[Brainvision]]
| [[ButtonBox]]es
| [[Camera]]s
| [[Lab Computer|Computers]]
| [[Eyetracker]]s
| [[Head Mounted Display]]s
| [[Headphones]]
| [[Ipod]] (Video & Audio Recording)
| [[JoyStick]]s
| [[Kinect]]
| [[Laptop]]s
| [[Microphone]]s
| [[Monitor]]s
| [[Optotrak]]
| [[Plux biosignals]]
| [[Qualisys]]
| [[Structure sensor]]
| [[TemperatureHumidity]]
| [[TMSi]]
| [[Vertical Sync sensor]]
}}
}}

{{Main Page/Frame
| color = be311a
| title = 📃Software Documentation
| content = {{Bulleted list
| [[FFmpeg]] (Video Conversion)
| [[LSL]]
| [[Matlab]]
| [[OBS Studio]] (Screen/Webcam Recording)
| [[Presentation]]
| [[Psychopy]]
| [[Python]]
| [[System Image]]
| [[Unity]]
}} 
;Online Experiments
{{Bulleted list
| [[Online Experiments|Overview of Online Systems]]
| [[jsPsych]]
| [[LimeSurvey]]
| [[Qualtrics]]
| [[Online Experiments/Toolbox|Toolbox for online experiments]]
| [[Web development]]
}} 
;Data Acquisition
{{Bulleted list
| [[Data Files|Data Formatting]]
| [[Radcloud]]
}} 
;Stimuli
{{Bulleted list
| [[Audio]]
| [[Video Codecs]]
| [[Video Playback]]
}} 
;Miscellaneous
{{Bulleted list

| [[Gitlab Social Sciences]]
| [[IP Distribution Lab Computer]]
| [[Mattermost Social Sciences]]
| [[Virtualization Server]]
}}
}}

{{Main Page/Frame
| color = be311a
| title = 📄Lab Documentation
| content = {{Bulleted list
| [[BalanceBoard Lab]]

| [[Cubicle]]s (Standard Labs)
| [[EEG Lab]]
| [[Eye Tracker Lab]]
| [[RIVER Lab]] (Virtual Reality)
| [[SensoriMotorLab]]
| [[Social Interaction Lab]]
| [[Sound Recording Lab]]

| [[TMS Lab]]
}} 
;Lab Use Policy and Guidelines
{{Bulleted list
| [[Booking labs]]
| [[Media:EEG_lab_user_guide.pdf|EEG lab user guide]]
| [[Media:Cleaningprocedure_EEG.pdf|EEG cleaning protocol]]
| [[Using labs]]
| [[Informed consent]]
}}
}}

</div>

Help:LimeSurvey/Demo time

2026-04-16T10:15:36Z

E.vandenberge: /* Limesurvey Demo time, Disappearing questions */

[https://survey.socsci.ru.nl/index.php/615263?lang=en Try this demo survey]
== Limesurvey Demo time, Disappearing questions ==
A similar trick as we used with the [[Help:LimeSurvey/Demo video|h.264 video]] is also possible to let text disappear after a while. Type some text, click the ''source'' button. Let's assume it looks like this:

Following text disappears after five seconds: 
Roses are red, violets are blue, I am gone, and so...

now change it into the following:

Following text disappears after five seconds: 
<div id="question17">
Roses are red, violets are blue, I am gone, and so...
</div>
<script type="text/javascript">
setTimeout("document.getElementById('question17').style.visibility='hidden'", 3000);
</script>

Make sure the id (''question17'') is unique on the question page. It must appear precisely twice (as shown above). The 3000 is the time before the text disappears in ms. Try it in [https://survey.socsci.ru.nl/index.php/615263?lang=en demo time].

RIVER Lab/Legacy

2026-04-16T10:13:31Z

E.vandenberge:

{{Infobox tsg
| image = Riverlab2_01.png
| image alt = RIVER Lab 2
| caption = RIVER Lab 2 in 2015
| label1 = Location
| data1 = B.00.12a (RIVER Lab 1), B.00.10 (RIVER Lab 2)
| manuals = {{bulleted list
| <del>RIVER Lab 2 Oculus Quick Start Guide</del>
| <del>RIVER Lab 2 Vive Quick Start Guide</del>
}}
}}

The Radboud Immersive Virtual Environment Research (RIVER) Labs 1 and 2 were two Behavioral Science Institute research labs dedicated to experiments in Virtual Reality (VR) in the Spinoza building.

==Physical Properties==
{| class="wikitable"
|-
! scope="col" style="width:200px;"|
! scope="col" style="width:200px;"| [[File:Riverlab1_01.png|200px|Image: 200 pixels]]
! scope="col" style="width:200px;"| [[File:Riverlab2_01.png|200px|Image: 200 pixels]]
|-
! scope="col"|
! scope="col"| RIVER Lab 1
! scope="col"| RIVER Lab 2
|-
! Room Properties
! scope="row" colspan="2"|
|-
| Room Number || B.00.12a || B.00.10
|-
| Room Size<ref>Effective tracking area</ref> (m) || 4.0 * 8.0 || 5.0 * 7.2
|}

==Equipment==

Both RIVER labs come with special equipment for creating a digital immersive virtual environment. The following specifications apply to the current lab setup, operational since January 2014. For older specifications, please contact the [[RIVER_Lab/manager|lab manager]].

{| class="wikitable"
|-
! scope="col" style="width:200px;"|
! scope="col" style="width:200px;"| RIVER Lab 1
! scope="col" style="width:200px;"| RIVER Lab 2
|-
! Tracking
! scope="row" colspan="2"|
|-
| Tracking System || Intersense IS-900 || AR-Tracking ARTTRACK3
|-
| Type || Inertial-Ultrasound Hybrid || Optical, 16 Cameras
|-
| Accuracy (mm) || 0.75 - 3.0 || <1.0
|-
| Update Rate (Hz) || 180 || 60
|-
| Tracking Software || Intersense Server || AR-Tracking DTrack 2.0
|-
| Tracker Type || Inertial-Ultrasound Hybrid Sensor || Passive retro-reflective markers
|-
! Virtual Reality
! scope="row" colspan="2" |
|-
| Wireless VR || style="background-color:#F99;" | No || style="background-color:#FFB;" | No<ref>Possible with Oculus Rift DK1 only.</ref>
|-
| Stimulus PC || [[Computers|Dell Precision T3610]]<ref name="stimpc">Different graphics card installed (GTX1060 or GTX1080). For exact up-to-date specifications, please contact the [[RIVER_Lab/manager|lab manager]] </ref> || [[Computers|Dell Precision T3610]]<ref name="stimpc"/>
|-
| Stimulus Software || colspan="2" style="text-align:center"| [http://www.worldviz.com/products/vizard Worldviz Vizard 4.0], [https://unity3d.com/ Unity]
|}

=== Head Mounted Displays ===

{| class="wikitable"
! scope="col"|
! scope="col"| Nvis Nvisor SX60
! scope="col"| Oculus Rift Dev. Kit 1
! scope="col"| HTC Vive
|-
| In service || style="text-align:center;" | 2006 - October 2013 || style="text-align:center;" | November 2013 - 2017 || style="text-align:center;" | November 2016 -
|}

In RIVER Lab 2, five retro-reflective markers are attached to the [[Head Mounted Displays | Head Mounted Display]] (except HTC Vive) via a custom 3D-printed frame for tracking the participant's position and orientation; any internal tracking in the HMD is disabled.

==== Vive ====
As of November 2016, standard HTC Vive setups are available in both RIVER Labs. These setups use the Vive's own "Lighthouse" tracking system instead of the lab's, and a standard [[Computers#Lab_Computer | Lab Computer]] (with upgraded graphics card). No wireless solution is available for the Vive (yet), so the tracking area is limited by the length of the cable and the range of the Lighthouse tracking system.
As of September 2017, the Vive in RIVER Lab 2 has been equipped with the Deluxe Audio Strap, which has built-in headphones.



==See Also==
*[[Head Mounted Displays]]

==References==
<references />

Sequence of URLs

2026-04-16T10:05:56Z

E.vandenberge:

[https://www.socsci.ru.nl/tsg/sequence Sequence of URLs] allows you to send the same data as URL parameters to a numbers of URLs that together make up your experiment. Typically You will start from SONA or Prolific, then go to an informed consent form, then to an online experiment or survey and then back to Prolific for completion of the experiment.
= Simple example =
If you want to visit two URLs and let both know that your name is John, you can visit these pages like this:
* https://www.ru.nl?name=John
* https://www.nos.nl?name=John

But you may want to prevent having to type the same information twice. That is where [https://www.socsci.ru.nl/tsg/sequence Sequence of URLs] can help. Put your two URLs in a Sequence:
[[File:Overview .png|frame|center|A sequence of two URLs]]

now you can visit the following two URLs:
* https://www.socsci.ru.nl/tsg/sequence/123456/0?name=John
* https://www.socsci.ru.nl/tsg/sequence/123456/1

which will be automatically forwarded to the two URLs mentioned above. Note that the name is automatically send to both pages, while it was entered only for the first.

= Prolific =
Imagine you want to conduct an online experiment with Prolific and you want to your participants to visit the following three places:
* Informed consent
* Online Experiment
* Prolific completion

If the informed consent form is of the type that is most common in the Donders Center for Cognition, the experiment is on our exp server this will give you three URL's for these places like this:
* https://questions.socsci.ru.nl/index.php/654321
* https://exp.socsci.ru.nl/coolExperiment
* https://app.prolific.co/submissions/complete?cc=FJ2UID24

The last of the three comes from Prolific:

[[File:Prolific completion.png|frame|center|Form on the Prolific study page showing the completion URL.]]

Since you programmed ''coolExperiment'' yourself you can make sure that the last page contains a link to the completion URL, but to let the informed consent survey know where the experiment is, you have to add it in the first URL like this:
* https://questions.socsci.ru.nl/index.php/654321?url=https://exp.socsci.ru.nl/coolExperiment
* https://exp.socsci.ru.nl/coolExperiment
* https://app.prolific.co/submissions/complete?cc=FJ2UID24

You may have never done this before by hand, since it is done for you by [[URL Composer]]. This works but typically we want to make it even more complicated. The experiment wants to keep track of the ''prolific pid'' to identify unique participants. In the past we could use [[URL Composer]] for an even more complicated URL, but that no longer works (2023-06-16) therefore we need [https://www.socsci.ru.nl/tsg/sequence Sequence of URLs], a small tool that makes aliases for the three URLs in your experiment and keeps track of the ''prolific pid'' for you. Just enter the three URLs there:

* https://questions.socsci.ru.nl/index.php/654321?url=https://www.socsci.ru.nl/tsg/sequence/123456/1
* https://exp.socsci.ru.nl/coolExperiment
* https://app.prolific.co/submissions/complete?cc=FJ2UID24
like this.

[[File:Sequence of URLs.png|frame|center|Three URLs that make up an experiment]]

Instead of linking to the informed consent form directly, you link prolific to the first URL in the sequence:
[[File:Prolific URL.png|frame|center|form on the prolific study page showing the experiment url.]]

Now all three URLs will receive the prolific PID, study id, etc.

= SONA and Prolific =
Imagine you want to conduct an online experiment with two panel systems that recruit participants to the same experiment, SONA and Prolific, and you want to your participants to visit the following places:
* Online Experiment in Limesurvey
* SONA or Prolific completion, depending on where they were recruited

As the three URLs in ''Sequence'' you input (mutatis mutandis):
<ol>
<li value="0"><code><nowiki>https://questions.socsci.ru.nl/index.php/654321</nowiki></code> (change the 6 digit number to your limesurvey number)</li>
<li value="1"><code><nowiki>https://radboud.sona-systems.com/services/SonaAPI.svc/WebstudyCredit?experiment_id=12345&credit_token=123456789abcdef</nowiki></code> (take your SONA completion url)</li>
<li value="2"><code><nowiki>https://app.prolific.co/submissions/complete?cc=ABC123</nowiki></code> (take your the Prolific completion url)</li>
</ol>

:ℹ️ We leave out the last part of the completion URL that the SONA experiment page gives (&survey_code=XXXXXX) since that is taken care of by ''Sequence''

As the SONA study url you should use without ''Sequence'':
<pre>https://questions.socsci.ru.nl/index.php/654321?survey_code=%SURVEY_CODE%</pre>
but because you use ''Sequence'' you replace the first part:
<pre>https://www.socsci.ru.nl/tsg/sequence/123456/0?survey_code=%SURVEY_CODE%</pre>

As the Prolific study url you should use without ''Sequence'':
<pre>https://questions.socsci.ru.nl/index.php/654321?PROLIFIC_PID={{%PROLIFIC_PID%}}&STUDY_ID={{%STUDY_ID%}}&SESSION_ID={{%SESSION_ID%}}</pre>
but with ''Sequence'' you replace the first part:
<pre>https://www.socsci.ru.nl/tsg/sequence/123456/0?PROLIFIC_PID={{%PROLIFIC_PID%}}&STUDY_ID={{%STUDY_ID%}}&SESSION_ID={{%SESSION_ID%}}</pre>
:ℹ️ You only enter the part up to but not including the question mark in Prolific and Polific will add the rest.

All that we now have to do is set a Limesurvey ''end url'' that points either to SONA or to Prolific:
<pre>https://www.socsci.ru.nl/tsg/misc/redirect.php?url={if(is_empty('{PASSTHRU:PROLIFIC_PID}'), 'https://www.socsci.ru.nl/tsg/sequence/123456/1', 'https://www.socsci.ru.nl/tsg/sequence/123456/2')}</pre>
which in normal English means something like: if there is ''no'' PROLIFIC PID, go to ''Sequence'' page 1, otherwise go to ''Sequence'' page 2.

= Privacy =
This method looks a bit like the way the worlds largest privacy breakers work. These web pages receive the name of the person visiting them without the participant sending it explicitly also.

This is precisely the intention of ''Sequence'', but it is also very different. Rather than saving a persistent cookie and storing the participants information for later use, we save
only the precise information entered by the participant, store it only on the participants computer and store it only during the session. Therefore no cookie notice is required.
You only need to inform the participant that the information of the separate parts of the experiment is combined, like you would do anyway in your informed consent form.

Sequence of URLs

2026-04-16T10:04:57Z

E.vandenberge: /* SONA and Prolific */

[https://www.socsci.ru.nl/tsg/sequence Sequence of URLs] allows you to send the same data as URL parameters to a numbers of URLs that together make up your experiment. Typically You will start from SONA or Prolific, then go to an informed consent form, then to an online experiment or survey and then back to Prolific for completion of the experiment.
= Simple example =
If you want to visit two URLs and let both know that your name is John, you can visit these pages like this:
* https://www.ru.nl?name=John
* https://www.nos.nl?name=John

But you may want to prevent having to type the same information twice. That is where [https://www.socsci.ru.nl/tsg/sequence Sequence of URLs] can help. Put your two URLs in a Sequence:
[[File:Overview .png|frame|center|A sequence of two URLs]]

now you can visit the following two URLs:
* https://www.socsci.ru.nl/tsg/sequence/123456/0?name=John
* https://www.socsci.ru.nl/tsg/sequence/123456/1

which will be automatically forwarded to the two URLs mentioned above. Note that the name is automatically send to both pages, while it was entered only for the first.

= Prolific =
Imagine you want to conduct an online experiment with Prolific and you want to your participants to visit the following three places:
* Informed consent
* Online Experiment
* Prolific completion

If the informed consent form is of the type that is most common in the Donders Center for Cognition, the experiment is on our exp server this will give you three URL's for these places like this:
* https://questions.socsci.ru.nl/index.php/654321
* https://exp.socsci.ru.nl/coolExperiment
* https://app.prolific.co/submissions/complete?cc=FJ2UID24

The last of the three comes from Prolific:

[[File:Prolific completion.png|frame|center|Form on the Prolific study page showing the completion URL.]]

Since you programmed ''coolExperiment'' yourself you can make sure that the last page contains a link to the completion URL, but to let the informed consent survey know where the experiment is, you have to add it in the first URL like this:
* https://questions.socsci.ru.nl/index.php/654321?url=https://exp.socsci.ru.nl/coolExperiment
* https://exp.socsci.ru.nl/coolExperiment
* https://app.prolific.co/submissions/complete?cc=FJ2UID24

You may have never done this before by hand, since it is done for you by [[URL Composer]]. This works but typically we want to make it even more complicated. The experiment wants to keep track of the ''prolific pid'' to identify unique participants. In the past we could use [[URL Composer]] for an even more complicated URL, but that no longer works (2023-06-16) therefore we need [https://www.socsci.ru.nl/tsg/sequence Sequence of URLs], a small tool that makes aliases for the three URLs in your experiment and keeps track of the ''prolific pid'' for you. Just enter the three URLs there:

* https://questions.socsci.ru.nl/index.php/654321?url=https://www.socsci.ru.nl/tsg/sequence/123456/1
* https://exp.socsci.ru.nl/coolExperiment
* https://app.prolific.co/submissions/complete?cc=FJ2UID24
like this.

[[File:Sequence of URLs.png|frame|center|Three URLs that make up an experiment]]

Instead of linking to the informed consent form directly, you link prolific to the first URL in the sequence:
[[File:Prolific URL.png|frame|center|form on the prolific study page showing the experiment url.]]

Now all three URLs will receive the prolific PID, study id, etc.

= SONA and Prolific =
Imagine you want to conduct an online experiment with two panel systems that recruit participants to the same experiment, SONA and Prolific, and you want to your participants to visit the following places:
* Online Experiment in Limesurvey
* SONA or Prolific completion, depending on where they were recruited

As the three URLs in ''Sequence'' you input (mutatis mutandis):
<ol>
<li value="0"><code><nowiki>https://questions.socsci.ru.nl/index.php/654321</nowiki></code> (change the 6 digit number to your limesurvey number)</li>
<li value="1"><code><nowiki>https://radboud.sona-systems.com/services/SonaAPI.svc/WebstudyCredit?experiment_id=12345&credit_token=123456789abcdef</nowiki></code> (take your SONA completion url)</li>
<li value="2"><code><nowiki>https://app.prolific.co/submissions/complete?cc=ABC123</nowiki></code> (take your the Prolific completion url)</li>
</ol>

ℹ️ We leave out the last part of the completion URL that the SONA experiment page gives (&survey_code=XXXXXX) since that is taken care of by ''Sequence''

As the SONA study url you should use without ''Sequence'':
<pre>https://questions.socsci.ru.nl/index.php/654321?survey_code=%SURVEY_CODE%</pre>
but because you use ''Sequence'' you replace the first part:
<pre>https://www.socsci.ru.nl/tsg/sequence/123456/0?survey_code=%SURVEY_CODE%</pre>

As the Prolific study url you should use without ''Sequence'':
<pre>https://questions.socsci.ru.nl/index.php/654321?PROLIFIC_PID={{%PROLIFIC_PID%}}&STUDY_ID={{%STUDY_ID%}}&SESSION_ID={{%SESSION_ID%}}</pre>
but with ''Sequence'' you replace the first part:
<pre>https://www.socsci.ru.nl/tsg/sequence/123456/0?PROLIFIC_PID={{%PROLIFIC_PID%}}&STUDY_ID={{%STUDY_ID%}}&SESSION_ID={{%SESSION_ID%}}</pre>
Note that you only enter the part up to but not including the question mark in Prolific and Polific will add the rest.

All that we now have to do is set a Limesurvey ''end url'' that points either to SONA or to Prolific:
<pre>https://www.socsci.ru.nl/tsg/misc/redirect.php?url={if(is_empty('{PASSTHRU:PROLIFIC_PID}'), 'https://www.socsci.ru.nl/tsg/sequence/123456/1', 'https://www.socsci.ru.nl/tsg/sequence/123456/2')}</pre>
which in normal English means something like: if there is ''no'' PROLIFIC PID, go to ''Sequence'' page 1, otherwise go to ''Sequence'' page 2.

= Privacy =
This method looks a bit like the way the worlds largest privacy breakers work. These web pages receive the name of the person visiting them without the participant sending it explicitly also.

This is precisely the intention of ''Sequence'', but it is also very different. Rather than saving a persistent cookie and storing the participants information for later use, we save
only the precise information entered by the participant, store it only on the participants computer and store it only during the session. Therefore no cookie notice is required.
You only need to inform the participant that the information of the separate parts of the experiment is combined, like you would do anyway in your informed consent form.

Module:Documentation/config

2026-04-16T09:41:47Z