Tools

Tools & Setup for Editing reST

When editing reST files locally, you should use an editor or IDE with good support for syntax highlighting and marking errors in reST.

PhpStorm is commonly used by developers in the TYPO3 community. It does however cost money.

Good alternatives can be found in the "Free Editors" section of StackOverflow: reStructuredText tool support.

General Advice

EditorConfig

Setup your editor / IDE to use the .editorconfig file, which already exists in most documentation repositories. This will set up your editor / IDE to comply with our basic coding guidelines.

You may have to install an additional plugin, see EditorConfig.

PhpStorm

You should activate some plugins that will assist you when editing reST files. In order to activate a plugin, press ctrl + alt + s, then select Plugins, search for the plugin and enable it (mark checkbox).

../_images/phpstorm-rest-plugin.png

If the Plugin is not installed yet, you may have to Browse repositories, select the plugin and click the green Install button.

reStructuredText Plugin

Enable the reStructuredText plugin to get correct syntax highlighting. The plugin will also point out errors, for example wrong title underline length.

../_images/phpstorm-rest-warning.png

EditorConfig Plugin

Additionally, (download) and enable the EditorConfig plugin in order to get correct Coding Guideline settings like indent width already defined in .editorconfig file of documentation project.

Spellchecking

You can add some specific TYPO3 spellings to PhpStorms internal dictionary. Just place the cursor on the word, click alt-enter and then "Save to dictionary".

../_images/phpstorm-add-to-dictionary.png

For more information, see the Spellchecking PhpStorm page.