This is documentation of the extension Proof of Identity and answers of some frequently asked questions. You will learn more about how to install and configure the component.

Additional Information

You will find additional documentation on the following pages:

Download and install

I guess, you have already installed Joomla! and now you have to download Proof of Identity package.

Go to "Extension Manager" and install the package.

Joomla! extension manager

If you are installing the extension for the first time, you will see a list of installed libraries, plug-ins and modules. The system will display list of minimum requirements. If the system displays red indicators for unfulfilled requirements, you should find a way to fix them.

Requirements

You must install Prism Library because the extension needs it to work properly.

Technical Requirements

The minimum requirements to run the extension properly are:

Options

It is time to configure Proof of Identity. Go to "Dashboard" and click on the button "Options". Review the settings and save them.

Basic

Those options will be used in the process of uploading files by users.

Path to Files - path to the folder where will be stored the encrypted files.

Legal Extensions - the extensions of the files that will be allowed for uploading by the users.

Legal MIME Types - the types of the files allowed for uploading.

Max Size (in MB) - maximum allowed size of the file that will be uploaded by users.

Advanced

The system uses those options for some specific functionalities.

Display Status Information - display information about user status "Is he verified or not?"

Display Additional Information - if you would like to say something to the users about the process of uploading files, you can enable this option.

Additional Information - the information that will be displayed on the page where users will use to upload files.

Display HTTPS Warning - display a warning message if the users has not use secure protocol (SSL) in his browser.

Redirect to HTTPS - redirect to secure (SSL) version of the page automatically. To work the site properly, you have to install SSL certificate on your server.

Administrator - select a user which will send messages to users and will receive emails that are intended for the administrator.

Email Templates

There are cases when the system has to send confirmation mails or notifications to your customers. To do that, you should create predefined e-mails templates and select them in some plug-ins. You should use some placeholders in the templates that will be replaced with dynamically generated data.

You have to use the extension Email Templates to do that.

When you are done with the e-mails, you have to select one of them in some extensions.

You should select email in following extensions.

NOTE: You can download the placeholders and email templates. You can import them in the extension. You should use the email templates for example and you can edit them for your needs.

Email templates placeholders

This is a list with placeholders that you can use in your email templates.

{ADMINISTRATOR_EMAIL} - E-mail address of a person from whom will be sent the email.

{ADMINISTRATOR_NAME} - Name of a person that sends the email.

{FILENAME} - The name of a file.

{ITEM_TITLE} - Name of an item (article, campaign, product, project, etc.)

{ITEM_URL} - URL to an item.

{NOTE} - Notification from administrator to user about his file.

{SITE_NAME} - The name of your website.

{SITE_URL} - The URL of your website. Example: http://itprism.com/

{USER_EMAIL} - E-mail address of a person that has been uploaded the file.

{USER_NAME} - Name of a person that upload the file.

NOTE: You will find information about placeholders that you can use in the documentation of every extension that needs email templates.

The next step is to create menu items.

1 .Select a menu and click on the button "New"

2. Select a "Menu Item Type"

3. Enter "Menu Title", alias and some advanced options, if you need.

4. Select access for registered users.

5. Click on the button "Save"

Components

The components are the main functional units of the CMS. They can be seen as mini-applications. Most components have two main parts - back-end ( administration ) and front-end.

Modules

The modules are Joomla! extensions which display blocks with content. They can be placed on predefined position included in the template. They are assigned per menu items.

You are able to manage them via the Module Manager.

Plug-ins

The plug-ins provide functions which are associated with trigger events. When a particular event occurs, all plugin functions of the type associated with the event are executed in sequence.

Proof of Identity comes with several plugins and you can find them on the "Plug-in Manager". Enable those that you would like to use.

How to send mails to user and administrator?

There are two plugins that send confirmation mails to users and notification to the administrator.

  • Content - Proof of Identity Admin Mail - That plug-in sends a mail to the administrator when someone uploads a file.
  • Content - Proof of Identity User Mail- That plug-in sends a mail to a user when the administrator verifies his profile.

The features that sends confirmation mails after payment are part of the payment plugins. You have to enable this functionality by their options.

How to translate Proof of Identity?

You can translate this extension in your language using Transifex. Go to the system and sign in. Find Proof of Identity translation project and start translating. If you need more information, read the article "How to translate ITPrism extensions in your language?"

You can also use ITP Transifex to create language packages. There are projects metadata that you can import to ITP Transifex.

You are able to download Proof of Identity language packages from the platform that generates them.

You have to install the packages via Joomla! Extension Manager.

How to edit translated text or element labels?

All translations are located in a folder "language" in every extension.

For example, you will find the language files of Proof of Identity in the following folders:

administrator/components/com_identityproof/language

components/com_identityproof/language

To change the text you have to use Joomla! Language Manager to override the constant that contains the text as a value.

Here you are more information about how to override translations.

How to debug the extension and catch an error?

If there is a problem with the extension and the system does not display error messages, you should debug it. That will give you more information about the problem.

  1. Go to "System" -> "Global Configuration" -> "System" -> "Debug Settings".
  2. Set to "Yes" the option "Debug System".
  3. Now go to tab "Server" and set option "Error Reporting" to maximum.

Now, the system should display information about the error.

You can also check log files in folder "/logs" or the log file "error_log" in your main folder.

It is strong recommended to select a user group allowed to see debugged data.

  1. Go to Plugins Manager.
  2. Open plug-in "System - Debug".
  3. Select a user group and save.

User Group System Plugin Debug

What template should I use?

You should use a template based on Twitter Bootstrap 3.x. You can try templates of JoomlArt or YouJoomla. You can download free ones and test them with Proof of Identity.

Here you are a list companies that provide Bootstrap 3 templates for Joomla.

How to upgrade the extension?

The better way to upgrade the extensions is:

  1. Make a backup of your site ( database and files ) ( optional but highly recommended ).
  2. Disable all modules and plugins of the Proof of Identity that you are going to upgrade ( optional but highly recommended ).
  3. Install the new version over the old one ( all previous data will be saved ).
  4. Check for a new version of Prism Library. If there is a new version, install it.
  5. You should also upgrade all other modules and plug-ins that work with Proof of Identity.
  6. Check the extension settings and menu items for changes;
  7. Check the options of your plug-ins and modules. Save them to be sure all settings are stored properly.

It is a good practice to have a copy of your website on a subdomain. It can be something like test.mywebsite.com. You should upgrade the extension on that test site first. That will be useful for you because you will be able to explore the newest features and configuration options. When all is OK, you will know how to upgrade the extension on your production website fast.

How to get support?

You can post issues on Proof of Identity Git repository.  If you have any questions, you can send me a mail from the contact form. If you need premium support you are able to subscribe for my premium services on ITPrism members site.

It would be great if you send me information about your problem. You can send me information about your Joomla! version, extension version, screenshots or links to your pages.

How to get FREE support?

You can report issues on Proof of Identity Git repository.

If you have any questions, you can send them to me, using the contact form. Please, send me a message with only one question. When I answer you, you will be able to send me your next one.


Free Subscription

You can get the latest publication via RSS, Twitter or Facebook. And I can also deliver last news to you for free via Email:

RSS subscription Find us on Facebook Google+ page Follow me