A question about installing addons (the file structure)

[cerberus]

A question about installing addons.

In the instructions (Phoenix cart user guide) it says :

"The contents of the unzipped addon will have a folder/directory structure that matches the structure of your store folders/directories.

Ensure the folders/directories and/or files are uploaded from your computer to the matching locations in your shop on the server"

So far I have installed addons that fit that description (following the file structure), but I have seen/downloaded addons that don't follow the file structure completely, for instance the file structure points to a folder that does not exist in my cart file structure.

I don't know if I am supposed to create that folder or the addon is for a different version of Phoenix cart or for a different skin (I am using override).

I know it maybe a silly question, but I would rather check before I break something again

(up to this point I have not bothered with addons that do not match the file structure completely in case of breaking things)

Thank you,
Steve

[Kofod95]

Add-ons can generally be uploaded with all their content (except "readme"-files or similar). You don't have to create the new folders, if you upload the entire add-on. I can't think of a good reason to upload each file one by one - maybe to "learn" the add-on? But I would do that before uploading anything. Add-ons will often have dependencies on multiple of its own files, so uploading one file and not the rest will likely give errors.

In the add-on area each add-on is flagged for which versions of Phoenix it can be safely installed to. If it's flagged for your version, installing should be safe.

And just to give a few words to new folders: Phoenix is made to be extended through add-ons and customisations. Thus it checks for folders and files that are not in core, so add-ons can use these points to extend the core.

//Daniel

[Mort_Lemur]

Hi Steve,

Creating new folders will not be a problem - in fact if it is a new folder just transfer that folder and its contents to your site.

Some of my addons create new folders or sub folders. These are often unique to the addon and will not affect core or be overwritten by future core updates.

[bonbec]

To complement @Kofod95's and @Mort_Lemur's excellent answer, I recommend three things:
1) Always read the `readme`, `instructions.txt`, or `install.txt` file—depending on how the addon authors explain its function—as these usually contain installation and uninstallation instructions.
2) If your site supports multiple languages ​​(though I don't think it does, based on the messages I've read), you should create the translation folders and files right from the start; this will help avoid potential errors.
3) Either test the addon on a clean site or back up your site (including the database) before installing it; this makes it easier to revert changes if necessary. Personally, I prefer testing locally on a clean site.

[burt]

Here is an example of the latest Addon I updated yesterday, it's a part of the README.

Installation
============

Before Installation, review comments below about New File and Overridden Files.
If you are using the /override/ template, you can simply;


1. Upload all
- except this README.

The installation is complete.


New/Overridden File
===================

This .zip contains a few files.
A FEW CORE FILES ARE OVERRIDDEN USING THE TEMPLATE STRUCTURE!

New File
--------

/ext/scripts/cart_update.php
- this is the script that powers the changes

Overridden files
----------------

/templates/{whatever_template_you_use}/includes/modules/content/shopping_cart/tpl_cm_sc_product_listing.php
/templates/{whatever_template_you_use}/includes/modules/content/shopping_cart/tpl_cm_sc_order_total.php
/templates/{whatever_template_you_use}/includes/modules/content/shopping_cart/tpl_cm_sc_stock_notice.php
and
/templates/{whatever_template_you_use}/includes/languages/english/modules/content/shopping_cart/cm_sc_stock_notice.php


Most users use /override/ template so that is where the file is located in this .zip.
If you are using a different template, change the folder name appropriately.

And this is what I would say is quite a complicated set of instructions. Read it - tell me what you think it says and what you would actually do next.

[burt]

So far I have installed addons that fit that description (following the file structure), but I have seen/downloaded addons that don't follow the file structure completely, for instance the file structure points to a folder that does not exist in my cart file structure.

If you can link to such an addon that confused you a bit, I can download it and see what's going on. And then I will report back.

[cerberus]

Hi all, thank you everyone for your replies.

First, burt, in your first reply you say :

"Add-ons can generally be uploaded with all their content (except "readme"-files or similar). You don't have to create the new folders, if you upload the entire add-on. I can't think of a good reason to upload each file one by one - maybe to "learn" the add-on? But I would do that before uploading anything. Add-ons will often have dependencies on multiple of its own files, so uploading one file and not the rest will likely give errors"


I have been uploading the files one by one following the file structure in the addon, I never new I could just upload the whole module and the file structure would sort its self out ? I thought it would either just upload the files to the wrong place or delete everything in the folder with the same name in my cart with the files in the folder I am uploading from the addon if I was to do it that way, that is why I upload the files one by one.

Also I think if I remember correctly when I unzip a addon sometimes there are files that need to be added to the admin section, in the addon the folder will be marked "Admin", but in my shop the admin folder is called "adminxxx", so I presume I have to upload the files individually because of that ?

And a lot of the addons are marked for version 1.1.0.6 or earlier of Phoenix cart, so I presumed the file structure may of been different in those versions.


Hi Mort_Lemur,

I see so I just create the new folder (or if I upload the who module as burt suggests above it will automatically create the folder ?, but I don't think I can do that as explained above about the admin folder, so I have to upload one file at a time ?)


Hi bonbec

Yes, I do always reads the readmes in the addon, they normally say the same as the instructions on the Phoenix cart instructions, "upload following the folder structure", that is also why I get a bit confused, because it says that there will be a folder in the addon instructions I don't have (so I cannot follow the folder structure in that case because the folder does not exist to follow). And yes, I only have English language set up. Maybe I need to setup another shop on the other free webspace I have to do a few tests first.


Hello burt (again)
In your last reply,

Yes I am using the override template. So I can just upload the whole module to the shop and the file structure will sort its self out ? can I just upload the zip file or extract it first ? (I have been extracting then following the file structure and uploading the files one by one, also as I said above my admin folder is called "adminxxx" and that may not align with the addon admin folder as the name is different)


New/Overridden File
===================
It will over write a few files if needed ?


I was going to try out the "Recently_Viewed_v6.1" addon, most of the files follow the file structure expect one at the moment that caused me to stop, shown below (I dont have the folder called "pages" as shown in the instructions or the addons file structure)

templates/override/pages/recently_viewed.php

So I presume I just create that folder


Thank you all

[burt]

Note that you have attributed something to me which I think was from Daniel.

I was going to try out the "Recently_Viewed_v6.1" addon, most of the files follow the file structure expect one at the moment that caused me to stop, shown below (I dont have the folder called "pages" as shown in the instructions or the addons file structure)

In your case, you know;

You use the Override theme/template which is located at /templates/override/

What you therefore need to do is;

1. create a FTP account at your host to allow you to upload and download files easily
- if you do not know how to do this, ask your host

2. get a good FTP client (software)
- search google or ask your host for recommendations, there are many free ones.

Then

3. follow the instructions at Recently_Viewed_v6.1/installation.txt
- it's incredibly wordy, but basically a/ upload and b/ turn on, so;

3a. Upload using FTP, everything in the /Upload/ folder

3b. Continue the Installation.txt
- to turn on required modules
- etc

Let us say you were NOT using Override template and instead you were using a template called Ignis.

You would on your desktop or whereever you have the addon unzipped and saved;

i. change the folder name /override/ to /ignis/
ii. go back to 3a and continue

--

Put simple, if you are uploading addons file-by-file using eg your hosting control panel, you are wasting your time.
Get a FTP client.

--

For this particular addon, the Support Area is at app.php/addons/free_addon/recently_view ... ts/support but, as always, Free Addons usually do not get prioritised support so you might wait a while.

[cerberus]

Thank you burt.

I am using filezilla.

So I still upload the files individually following the file structure ? not in one go (as suggested in your first post) ? as my admin folder is called adminxxx not just admin as used in most of the addons I have seen that also have files for the admin section.

[bonbec]

...
Also I think if I remember correctly when I unzip a addon sometimes there are files that need to be added to the admin section, in the addon the folder will be marked "Admin", but in my shop the admin folder is called "adminXXX", so I presume I have to upload the files individually because of that ?

Don't write on a public area the real name of your admin folder.
When you unzip the addon on your computer, simply rename the folder admin with your admin's name before transferring it. You simply need to transfer the add-on's directory structure.