View source for Debugging a translation/en

==== Debug Plugin ====
[[Image:debug-plugin-en.png|right]]This system plugin controls what is displayed when debugging is activated in '''Global Configuration'''. It is enabled by default. You can access the parameters for the plugin from '''Extensions → Plugin Manager'''. Locate the “System - Debug” plugin and click on it. There are three settings of interest to translators.

* '''Display loaded language files'''.  If set to “Yes” then the debug information will include a list of the language files that were requested as the current page was being generated.
* '''Display undefined language strings.'''  If set to “diagnostic mode” then a list of untranslated strings and the location of the file containing the call to '''JText''' is included in the debug information.  If set to “designer mode” then a list of untranslated strings in a format that can be copy-pasted directly into a language definition file is included in the debug information.  That is, it displays the list in KEY=String format.  If set to “All modes” then both the diagnostic mode and designer mode lists are included in the debug information.
* '''Strip Key Prefix'''.  Only used when '''Display undefined language strings''' is set to “Designer mode” or "All modes".  This allows you to strip a prefix from the string to form the key.  This is useful if the designer uses a common prefix for their extensions when using '''JText''' methods.  See example below.

Note that the display of untranslated strings will only display the value passed to the appropriate '''JText''' method. For example, with the following code: 

<source lang="php">
echo JText::_( 'Reports Import Configuration' );
</source>

If untranslated, Designer mode will display this as: 

 <nowiki># /administrator/components/com_reports/views/reports/tmpl/default.php</nowiki>
 REPORTS IMPORT CONFIGURATION=Reports Import Configuration

If the Strip Key Prefix is set to "Reports", then the display would change slightly to: 

 <nowiki># /administrator/components/com_reports/views/reports/tmpl/default.php</nowiki>
 REPORTS IMPORT CONFIGURATION=Import Configuration

Note that the path shown is only a best guess based on a call to the PHP ''debug_backtrace'' function. Sometimes it is accurate, sometimes it is not and there are also cases where no file could be determined. In those cases you have to use your best judgement.

<noinclude>
[[Category:Tutorials]]
[[Category:Language Development]]
[[Category:Needs review]]
</noinclude>