Module for the Magento online shop. Advanced Invoice Layout. Installation notes. Version 1.1

Transcription

1 Module for the Magento online shop Advanced Invoice Layout Installation notes Version 1.1

2 The Advanced Invoice Layout module for the Magento online shop offers a customizable layout for invoices, creditmemos and shipments. More details about the functionality of this module can be found on the product page at /advancedinvoicelayout. Take also a look to our online demo shop to see the module in action at /magento. Following you will find some installation notes for the module. These are related to a standard Magento installation via file transfer protocol (FTP) under Microsoft Windows. There s no claim to be complete. The screenshots are taken from the Magento version More information, for example additional documentation for the Magento online shop are available on our download site (/downloads.php). If you have any questions, problems or comments to our software please feel free to contact us via +49 (0) 89 / and. Furthermore we want to point to the fact that there can be no warranty that the information in this package and the related documents are complete, correct and current in either case. A consultancy of a legal expert is required in either case. Your feedback about this module will be received under /kontakt.php. This is necessary for a continuous improvement of this kind of software. Kind regards, Vianetz_AdvancedInvoiceLayout_InstallationNotes, Version 2.01,

3 1. Technical Prerequisites The following prerequisites are necessary on the web server for the installation of the module AdvancedInvoiceLayout: It is recommended to back up your Magento installation before installing the module. If you update the module from a prior version please note chapter 6. Deinstallation. 2. Unpacking of the Module Package & Upload to the Web Server The AdvancedInvoiceLayout module will be provided as a ZIP file. Depending on your Magento version different setup packages are necessary: - Magento online shop version >= PHP version >= Language Pack (e.g. for German it s the Magento-Connect-Package magentocommunity/locale_mage_community_de_de) Magento version Filename up to (incl.) Vianetz_AdvancedInvoiceLayout-1.1_Mage zip (incl.) Vianetz_AdvancedInvoiceLayout-1.1_Mage zip from Vianetz_AdvancedInvoiceLayout-1.1.zip In the following chapters it is assumed that you use the current version. Unpack the file Vianetz_AdvancedInvoiceLayout-1.1.zip, e.g. with the Freeware program WinRAR, into a directory of your choice. Afterwards the unpacked files must be uploaded to the web server, e.g. with the program FileZilla. Pay attention to keep the folder structure as in the ZIP package. Notice: The files of the original Magento installation will not be overwritten. Vianetz_AdvancedInvoiceLayout_InstallationNotes, Version 2.01,

4 3. Changes in the design files You have to make the following modifications to your design files: - Create the folder pdf/ in directory app/design/frontend/default/default/template/payment/info - Copy the folder content from app/design/frontend/default/default/template/payment/info into the new created folder pdf/ The path must be adapted to your theme and interface folder. Vianetz_AdvancedInvoiceLayout_InstallationNotes, Version 2.01,

5 4. Configuration in Magento admin panel The configuration of the Magento module AdvancedInvoiceLayout in the admin panel is divided into two steps. The basic configuration options can be adjusted in system/configuration/sales. In the tab Rechnungs- und Lieferscheingestaltung the logo and the online shop address can be configured: In system/configuration/pdf Print Outs the following options are available: Vianetz_AdvancedInvoiceLayout_InstallationNotes, Version 2.01,

6 Vianetz_AdvancedInvoiceLayout_InstallationNotes, Version 2.01,

7 5. Clear the Magento cache To see the changes in the backend it may be necessary to clear/deactivate the Magento cache. Vianetz_AdvancedInvoiceLayout_InstallationNotes, Version 2.01,

8 6. Miscellaneous notices a. Display of addresses The standard display of address data in Magento can optionally be customized via the file app/code/core/mage/customer/etc/config.xml. This is done with respect to the display in invoices, shipments and creditmemos. To do that you have to look for the XML path config/global/customer/address/formats and change the following code to your needs: <pdf translate="title" module="customer"> <title>pdf</title> <defaultformat><![cdata[ {{depend prefix}}{{var prefix}} {{/depend}}{{var firstname}} {{depend middlename}}{{var middlename}} {{/depend}}{{var lastname}}{{depend suffix}} {{var suffix}}{{/depend}} {{depend company}}{{var company}} {{/depend}} {{var street1}} {{depend street2}}{{var street2}} {{/depend}} {{depend street3}}{{var street3}} {{/depend}} {{depend street4}}{{var street4}} {{/depend}} {{depend city}}{{var city}}, {{/depend}}{{depend region}}{{var region}}, {{/depend}}{{var postcode}} {{var country}} {{depend telephone}}t: {{var telephone}}{{/depend}} {{depend fax}}<br/>f: {{var fax}}{{/depend}} ]]></defaultformat> b. Translations Customization in the translation strings can be taken in the following files: - app/locales/xx_xx/mage_sales.csv - app/locales/xx_xx/vianetz_advancedinvoicelayout.csv If you are in the need of further customization please contact us. 7. Deinstallation For deinstallation of the module the following steps must be manually executed: - Delete the folder app/code/community/vianetz/advancedinvoicelayout - Delete the file app/locales/xx_xx/vianetz_advancedinvoicelayout.csv - Delete the file app/etc/modules/vianetz_advancedinvoicelayout.xml Vianetz_AdvancedInvoiceLayout_InstallationNotes, Version 2.01,