Jump to content

Recommended Posts

As not native english speaker I find documentation is somewhat hard to read in several places.

For expamle http://doc.prestashop.com/display/PS14/Creating+a+PrestaShop+module

 

A PrestaShop module consists of:

  • A root folder, named after the module, which will hold all of the module's files, and will reside in PrestaShop's /modules folder.
  • A main PHP file, named after the module, located in that root folder. This PHP file should have the same name as its root folder.
  • An icon file, named logo.gif, representing this module.
  • Optional: some .tpl files, containing the module's theme.
  • Optional: language files, if the module or its theme have text to display (and therefore, that should be translatable).
  • Optional: in a /themes/modules folder, a folder with the same name as the module, containing .tpl and language files if necessary. This last folder is essential during modifications of existing module, so that you can adapt it without having to touch its original files. Notably, it enables you to handle the module's display in various ways, according to the current theme.

 

 

 

Last paragraph is crappy and messy.

 

That is enough for a very basic module, but obviously more files and folders can complement it.

 

 

Misuse of rich literary abilities.

 

I'm convinced that documentation should be written in a simple and direct style.

No need to bloat it by blurry words.

Edited by real-comp-master (see edit history)
Link to comment
Share on other sites

×
×
  • Create New...