You are here

README.txt in Translation template extractor 7.3

ABOUT
================================================================================

The goal of the Translation Template Extractor project is to provide 
command line and web based Gettext translation template extractor 
functionality for Drupal. These translation templates are used by 
teams to translate Drupal to their language of choice. There are 
basically two ways to use the contents of this project:

 * Use Drush commands provided by the module to extract the translation strings.
     Command - drush potx
     Alias - NA
     Argument - mode : potx output mode e.g. single, multiple or core
     Options - potx accepts 4 options
       --modules : Comma delimited list of modules to extract translatable strings from.
       --files   : Comma delimited list of files to extract translatable strings from.
       --folder  : Folder to begin translation extraction in. When no other option is set this defaults to current directory.
       --api     : Drupal core version to use for extraction settings.

     Example -
     1.Extract translatable strings from applicable files in current directory and write to single output file.
       drush potx single
       drush potx (By default, mode = single)

     2.Extract translatable strings from applicable files of example module and write to module-specific output file.
       drush potx multiple --modules=example

     3.Extract translatable strings from example.module and write to single output file.
       drush potx --files=sites/all/modules/example/example.module

     4.Extract strings from folder 'projects/drupal/8' using API version 8.
       drush potx single --api=8 --folder=projects/drupal/8

 * Install the module on a Drupal site as you would with any other 
   module. Once potx module is turned on, you can go to the 
   "Extract" tab on the "Translate interface" administration interface, select 
   the module or modules or theme or themes you want to have a translation
   template for, and submit the form. You will get one single template file
   generated.

   Note: If you only get a white browser screen as response to the 
   extraction request, the memory limit for PHP on the server is probably 
   too low, try to set that higher.

The module also includes optional Coder (http://drupal.org/project/coder)
integration, allowing you to spot translatability errors in modules while
doing your regular code review.

CREDITS
================================================================================

Command line extractor functionality orignally by 
  Jacobo Tarrio <jtarrio [at] alfa21.com> (2003, 2004 Alfa21 Outsourcing)

Greatly optimized by 
  Brandon Bergren (2007)

Currently maintained by 
  Gabor Hojtsy <gabor [at] hojtsy.hu>

File

README.txt
View source
  1. ABOUT
  2. ================================================================================
  3. The goal of the Translation Template Extractor project is to provide
  4. command line and web based Gettext translation template extractor
  5. functionality for Drupal. These translation templates are used by
  6. teams to translate Drupal to their language of choice. There are
  7. basically two ways to use the contents of this project:
  8. * Use Drush commands provided by the module to extract the translation strings.
  9. Command - drush potx
  10. Alias - NA
  11. Argument - mode : potx output mode e.g. single, multiple or core
  12. Options - potx accepts 4 options
  13. --modules : Comma delimited list of modules to extract translatable strings from.
  14. --files : Comma delimited list of files to extract translatable strings from.
  15. --folder : Folder to begin translation extraction in. When no other option is set this defaults to current directory.
  16. --api : Drupal core version to use for extraction settings.
  17. Example -
  18. 1.Extract translatable strings from applicable files in current directory and write to single output file.
  19. drush potx single
  20. drush potx (By default, mode = single)
  21. 2.Extract translatable strings from applicable files of example module and write to module-specific output file.
  22. drush potx multiple --modules=example
  23. 3.Extract translatable strings from example.module and write to single output file.
  24. drush potx --files=sites/all/modules/example/example.module
  25. 4.Extract strings from folder 'projects/drupal/8' using API version 8.
  26. drush potx single --api=8 --folder=projects/drupal/8
  27. * Install the module on a Drupal site as you would with any other
  28. module. Once potx module is turned on, you can go to the
  29. "Extract" tab on the "Translate interface" administration interface, select
  30. the module or modules or theme or themes you want to have a translation
  31. template for, and submit the form. You will get one single template file
  32. generated.
  33. Note: If you only get a white browser screen as response to the
  34. extraction request, the memory limit for PHP on the server is probably
  35. too low, try to set that higher.
  36. The module also includes optional Coder (http://drupal.org/project/coder)
  37. integration, allowing you to spot translatability errors in modules while
  38. doing your regular code review.
  39. CREDITS
  40. ================================================================================
  41. Command line extractor functionality orignally by
  42. Jacobo Tarrio (2003, 2004 Alfa21 Outsourcing)
  43. Greatly optimized by
  44. Brandon Bergren (2007)
  45. Currently maintained by
  46. Gabor Hojtsy