Don't use h1 tag in article
← Older revision
Revision as of 23:55, 17 November 2013
Line 3:
Line 3:
# '''Set up your site accordingly'''
# '''Set up your site accordingly'''
−
=Fill out two new fields on JED=
+
=
=Fill out two new fields on JED
=
=
[[File:Install_from_Web_JED_Listing.png]]
[[File:Install_from_Web_JED_Listing.png]]
Line 24:
Line 24:
Here's some more detail on the download type.
Here's some more detail on the download type.
−
== None ==
+
=
== None
=
==
This the most common case today, and it basically means that you can't or don't want to provide a direct install URL for your extension. Only JED mandatory fields are filled, and "Install from Web" fields remain empty.
This the most common case today, and it basically means that you can't or don't want to provide a direct install URL for your extension. Only JED mandatory fields are filled, and "Install from Web" fields remain empty.
When a user goes into his/her backend and click on the "Install from Web" tab, your extension can be found, the "Download" button is shown but there's no "Install" button.
When a user goes into his/her backend and click on the "Install from Web" tab, your extension can be found, the "Download" button is shown but there's no "Install" button.
−
== Free Direct Download Link ==
+
=
== Free Direct Download Link
=
==
This is the option to choose if your extension is freely available, without registration or purchase. On the "Download/registration/purchase URL" you should put the URL of the update XML or directly the URL of the zip file.
This is the option to choose if your extension is freely available, without registration or purchase. On the "Download/registration/purchase URL" you should put the URL of the update XML or directly the URL of the zip file.
When a user goes into his/her backend and click on the "Install from Web" tab, your extension can be found and the "Install" button appears, so the user can just click to install your extension.
When a user goes into his/her backend and click on the "Install from Web" tab, your extension can be found and the "Install" button appears, so the user can just click to install your extension.
−
== Free but Registration Required at Link ==
+
=
== Free but Registration Required at Link
=
==
This is the option to choose if your extension requires registration to be downloaded. On the "Download/registration/purchase URL" you should put the URL of your site '''Registration Page'''.
This is the option to choose if your extension requires registration to be downloaded. On the "Download/registration/purchase URL" you should put the URL of your site '''Registration Page'''.
Line 41:
Line 41:
When you setup your site correctly (see Step 2 below) after successful registration the user will be redirected back to his/her site to complete the web install.
When you setup your site correctly (see Step 2 below) after successful registration the user will be redirected back to his/her site to complete the web install.
−
== Commercial Purchase Required at Link ==
+
=
== Commercial Purchase Required at Link
=
==
This is the option to choose if your extension requires a purchase to be downloaded. On the "Download/registration/purchase URL" you should put the URL of your extension '''Purchase Page'''.
This is the option to choose if your extension requires a purchase to be downloaded. On the "Download/registration/purchase URL" you should put the URL of your extension '''Purchase Page'''.
Line 50:
Line 50:
[What about subscription? Is that more similar to "registration-based" or to "commercial-based"?]
[What about subscription? Is that more similar to "registration-based" or to "commercial-based"?]
−
= Setting up your site =
+
=
= Setting up your site
=
=
As stated before, if your extension is freely available without the need for registration or purchase, you don't need to do anything else so skip this step.
As stated before, if your extension is freely available without the need for registration or purchase, you don't need to do anything else so skip this step.
−
== Setting your site and extensions up for -Free but Registration Required at Link- Extension ==
+
=
== Setting your site and extensions up for -Free but Registration Required at Link- Extension
=
==
If you require a consumer to register then you have to set up your site to deal with the user registration.
If you require a consumer to register then you have to set up your site to deal with the user registration.
Line 60:
Line 60:
If not, the user fills the registration, and the last step of the web installation is NOT completed.
If not, the user fills the registration, and the last step of the web installation is NOT completed.
−
== How web installation works ==
+
=
== How web installation works
=
==
When user clicks on the 'Install' button, Joomla submits these parameters:
When user clicks on the 'Install' button, Joomla submits these parameters:
Line 73:
Line 73:
While the registration is filled and processed, Joomla is expecting to receive the zip URL or an update XML URL. When it's received, Joomla finally completes the installation.
While the registration is filled and processed, Joomla is expecting to receive the zip URL or an update XML URL. When it's received, Joomla finally completes the installation.
−
== Web installation with jefreg-plugin ==
+
=
== Web installation with jefreg-plugin
=
==
The '''jefreg-plugin''' is the reference implementation. A good starting point that was developed specifically for this purpose found [https://github.com/emavro/jefreg-plugin here].
The '''jefreg-plugin''' is the reference implementation. A good starting point that was developed specifically for this purpose found [https://github.com/emavro/jefreg-plugin here].
Line 94:
Line 94:
About Entry URL: this plugin is specifically designed for the Joomla User Component (Defaul value index.php?option=com_users&view=login) however it will also integrate nicely with any registration page. E.g. in Community Builder case simply by changing the entry point URL in the plugins parameters - generally it is recommended (but by no means compulsory) to point this to your login page. Note an empty value of this parameter will default to pointing to the Joomla User Component Login page.
About Entry URL: this plugin is specifically designed for the Joomla User Component (Defaul value index.php?option=com_users&view=login) however it will also integrate nicely with any registration page. E.g. in Community Builder case simply by changing the entry point URL in the plugins parameters - generally it is recommended (but by no means compulsory) to point this to your login page. Note an empty value of this parameter will default to pointing to the Joomla User Component Login page.
−
=== How to build jefreg-plugin ===
+
=
=== How to build jefreg-plugin
=
===
# Download the files from github
# Download the files from github
Line 100:
Line 100:
# Zip all files, and install it in the Extension Manager
# Zip all files, and install it in the Extension Manager
−
== Setting your site and extensions up for a Commercial Extension ==
+
=
== Setting your site and extensions up for a Commercial Extension
=
==
This will need more work than the previous step. It is advised that you download the same plugin - however you will have to integrate into the plugin an extra check to see if the user has purchased your extension. As different extensions implement this in many different ways it is left to extension developers to implement this functionality.
This will need more work than the previous step. It is advised that you download the same plugin - however you will have to integrate into the plugin an extra check to see if the user has purchased your extension. As different extensions implement this in many different ways it is left to extension developers to implement this functionality.
Line 106:
Line 106:
The plugin can be used to get '''installat''' and '''installapp''' parameters, but it must NOT return the zip URL or update XML URL onUserLogin. When the purchase is completed, the operation can return to fill the web installation.
The plugin can be used to get '''installat''' and '''installapp''' parameters, but it must NOT return the zip URL or update XML URL onUserLogin. When the purchase is completed, the operation can return to fill the web installation.
−
== Source code for the feature ==
+
=
== Source code for the feature
=
==
You can contribute bug fixes and new features to the following repositories:
You can contribute bug fixes and new features to the following repositories: