DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

Developer Corner

Generated markup

Syntax Highligther

1
2
3
<pre class="php">
   CODE GOES HERE
</pre>

Prism

1
2
3
4
5
<pre class="language-php">
   <code>
      CODE GOES HERE
   </code>
</pre>

FAQ

Howto install JS vendors

  1. Download amd install node.js from http://nodejs.org/download/

  2. Install bower

    npm install bower
    
  3. Install vendors from CLI

    bower install
    

Howto add BOM to all reStructuredText files

While editing the files in Eclipse, the BOM possibly gets removed, this script will help you to re-add the UTF8 BOM again.

Simply put that into the extension root directory, add executable rights (chmod u+x …). If you are still experiencing issues, just comment out the last line and execute the script multiple times until no output is displayed. Then uncomment the last line.

#!/bin/bash
for F in $(ls -R Documentation/*.rst Documentation/*/*.rst Documentation/*.txt)
do
  if [[ -f $F && `head -c 3 $F` == $'\xef\xbb\xbf' ]]; then
      # file exists and has UTF-8 BOM
      mv $F $F.bak
      tail -c +4 $F.bak > $F
      rm -f $F.bak
      echo "removed BOM from $F"
  fi
done
for file in $(ls -R Documentation/*.rst Documentation/*/*.rst Documentation/*.txt); do sed -i '1s/^/\xef\xbb\xbf/' "$file"; done

Run unit tests

cd typoconf/ext/beautyofcode

composer install

./vendor/bin/runtests

One could add a a php env node into the phpunit.xml.dist xml file:

<phpunit>
    <php>
        <env name="TYPO3_PATH_WEB" value="/var/www/path-to-typo3"/>
    </php>
</phpunit>