diff options
Diffstat (limited to 'doc/developers')
-rw-r--r-- | doc/developers/TODO.rst (renamed from doc/developers/TODO) | 0 | ||||
-rw-r--r-- | doc/developers/api.rst (renamed from doc/developers/api) | 0 | ||||
-rw-r--r-- | doc/developers/debugging | 20 | ||||
-rw-r--r-- | doc/developers/debugging.rst | 24 | ||||
-rw-r--r-- | doc/developers/doc-TODO.rst (renamed from doc/developers/doc-TODO) | 0 | ||||
-rw-r--r-- | doc/developers/release-new-version.rst (renamed from doc/developers/release-new-version) | 0 | ||||
-rw-r--r-- | doc/developers/rules.rst (renamed from doc/developers/rules) | 0 | ||||
-rw-r--r-- | doc/developers/running-unit-tests | 21 | ||||
-rw-r--r-- | doc/developers/running-unit-tests.rst | 26 | ||||
-rw-r--r-- | doc/developers/translation | 40 | ||||
-rw-r--r-- | doc/developers/translation.rst | 47 |
11 files changed, 97 insertions, 81 deletions
diff --git a/doc/developers/TODO b/doc/developers/TODO.rst index 59dd655..59dd655 100644 --- a/doc/developers/TODO +++ b/doc/developers/TODO.rst diff --git a/doc/developers/api b/doc/developers/api.rst index efa05fe..efa05fe 100644 --- a/doc/developers/api +++ b/doc/developers/api.rst diff --git a/doc/developers/debugging b/doc/developers/debugging deleted file mode 100644 index 7f84da6..0000000 --- a/doc/developers/debugging +++ /dev/null @@ -1,20 +0,0 @@ -How to debug SemanticScuttle -============================ - - -Database queries ----------------- -In config.php, enable debugMode. -Further, add the following there: -------- -register_shutdown_function( - create_function('', <<<FNC -\$GLOBALS['db'] = SemanticScuttle_Service_Factory::getDb(); -\$GLOBALS['db']->sql_report('display'); -FNC - ) -); ------- -To see database queries in SemanticScuttle, add -> ?explain=1 -to your URL. diff --git a/doc/developers/debugging.rst b/doc/developers/debugging.rst new file mode 100644 index 0000000..6bee309 --- /dev/null +++ b/doc/developers/debugging.rst @@ -0,0 +1,24 @@ +How to debug SemanticScuttle +============================ + + +Database queries +---------------- + +In ``data/config.php``, enable ``debugMode``. +Further, add the following afterwards: :: + + register_shutdown_function( + create_function('', <<<FNC + \$GLOBALS['db'] = SemanticScuttle_Service_Factory::getDb(); + \$GLOBALS['db']->sql_report('display'); + FNC + ) + ); + + +To see database queries in SemanticScuttle, add :: + + ?explain=1 + +to your URL. diff --git a/doc/developers/doc-TODO b/doc/developers/doc-TODO.rst index 4fac4ab..4fac4ab 100644 --- a/doc/developers/doc-TODO +++ b/doc/developers/doc-TODO.rst diff --git a/doc/developers/release-new-version b/doc/developers/release-new-version.rst index 4b2540a..4b2540a 100644 --- a/doc/developers/release-new-version +++ b/doc/developers/release-new-version.rst diff --git a/doc/developers/rules b/doc/developers/rules.rst index 701a215..701a215 100644 --- a/doc/developers/rules +++ b/doc/developers/rules.rst diff --git a/doc/developers/running-unit-tests b/doc/developers/running-unit-tests deleted file mode 100644 index 556055f..0000000 --- a/doc/developers/running-unit-tests +++ /dev/null @@ -1,21 +0,0 @@ -Running unit tests -================== - -Go to the SemanticScuttle main directory and run - $ php tests/AllTests.php -or - $ phpunit tests/AllTests.php -also remember the --verbose parameter to PHPUnit. - -If you want to run a specific test class only: - $ phpunit tests/BookmarksTest.php - -If you need to test one method only: - $ phpunit --filter BookmarkTest::testUnificationOfBookmarks tests/BookmarkTest.php - - -Caveats -------- -Having debugging enabled and database driver "mysql4" activated -will lead to failing tests because of FOUND_ROWS() usage, which -does not work nicely with database debugging. diff --git a/doc/developers/running-unit-tests.rst b/doc/developers/running-unit-tests.rst new file mode 100644 index 0000000..8b0fa0d --- /dev/null +++ b/doc/developers/running-unit-tests.rst @@ -0,0 +1,26 @@ +Running unit tests +================== + +Go to the SemanticScuttle ``tests`` directory and run ``phpunit``:: + + $ cd tests + $ phpunit . + +also remember the ``--verbose`` parameter to PHPUnit. + +If you want to run a specific test class only: :: + + $ cd tests + $ phpunit BookmarksTest.php + +If you need to test one method only: :: + + $ cd tests + $ phpunit --filter BookmarkTest::testUnificationOfBookmarks tests/BookmarkTest.php + + +Caveats +------- +Having debugging enabled and database driver "``mysql4``" activated +will lead to failing tests because of ``FOUND_ROWS()`` usage, which +does not work nicely with database debugging. diff --git a/doc/developers/translation b/doc/developers/translation deleted file mode 100644 index 776b5d7..0000000 --- a/doc/developers/translation +++ /dev/null @@ -1,40 +0,0 @@ -Translating SemanticScuttle -=========================== - -SemanticScuttle uses gnu gettext for translation. It does not -rely on the php extension but ships with a pure php implementation, -php-gettext[1]. - -Using gettext from within the code is really easy: -Enclose the string you want to translate in a "T_" function call. - -For example, to translate -> echo "Vote for"; -just write -> echo T_("Vote for"); - - -Translation basics ------------------- - -We keep one base translation file, data/locales/messages.po. -This file is auto-generated via xgettext from all our php source files. -In case you added a new string to the code that needs translation, -update the base translation file by running -> php scripts/update-translation-base.php - -After that has been done, the changes to the base messages.po file -need to be merged into the single language translation files, -for example data/locales/de_DE/LC_MESSAGES/messages.po. - -Updating them from the master file is as easy as running -> php scripts/update-translation.php de_DE - -When the translation is ready, the .po file needs to be compiled -in a machine-readable .mo file. Use -> php scripts/compile-translation.php de_DE -to achieve that. - - - -[1] https://launchpad.net/php-gettext/
\ No newline at end of file diff --git a/doc/developers/translation.rst b/doc/developers/translation.rst new file mode 100644 index 0000000..008f66e --- /dev/null +++ b/doc/developers/translation.rst @@ -0,0 +1,47 @@ +=========================== +Translating SemanticScuttle +=========================== + +SemanticScuttle uses gnu gettext for translation. It does not +rely on the php extension but ships with a pure php implementation, +php-gettext_. + +Using gettext from within the code is really easy: +Enclose the string you want to translate in a "``T_``" function call. + +For example, to translate:: + + echo "Vote for"; + +just write :: + + echo T_("Vote for"); + +.. _php-gettext: https://launchpad.net/php-gettext/ + +Translation basics +================== + +We keep one base translation file, ``data/locales/messages.po``. +This file is auto-generated via ``xgettext`` from all our php source files. +In case you added a new string to the code that needs translation, +update the base translation file by running :: + + $ php scripts/update-translation-base.php + +After that has been done, the changes to the base ``messages.po`` file +need to be merged into the single language translation files, +for example ``data/locales/de_DE/LC_MESSAGES/messages.po``. + +Updating them from the master file is as easy as running:: + + $ php scripts/update-translation.php de_DE + +When the translation is ready, the ``.po`` file needs to be compiled +in a machine-readable ``.mo`` file. Use :: + + $ php scripts/compile-translation.php de_DE + +to achieve that. + + |