Quick start guide
This quick start guide will help you get familiar with basic concepts and procedures.
For additional support, you can read on the documentation or contact us. Please remember that support is provided only to active subscribers.
Last updated: 22 Jul 2016
Sprint Version: 3.2.0
Sprint 3.2+ is compatible with Joomla 3.x and VirtueMart 3.x can be installed like any other Joomla extension.
It needs VirtueMart, of course; otherwise you won't have any product to create a catalog with.
Currently the TCPDF library is included in the component but it will be removed from future releases (since it's included in VirtueMart anyway).
After installation, you should start by taking a look at configuration options: go into the backend of your site, click on Component -> Sprint, and then on the Options button.
Here is the explanation of the few options you are able to set.
- VirtueMart language: VirtueMart 2 adds a language suffix to some of its tables. If for some reason this language is not the same as your site default language, here you can insert the correct suffix.
- Include unpublished categories: quite obvious, should Sprint include also unpublished VirtueMart categories?
- VirtueMart categories sort criteria: both in configuration form and in the catalog, you can choose to sort categories alphabetically or according to the list order set in VirtueMart.
- Use manufacturers: you can decide to group your products by manufacturer instead of by category. Careful: this applies to all your catalogs.
- Show prices: if enabled, product base prices will be shown into the catalog
- Default color: this color will be used for all categories which have no specific color set
- Add language icon: if enabled, there will be a little language icon before name and descriptions. Useful for multilanguage catalogs.
Tab "PDF Creation"
- Initial pagebreak: if enabled, a page break will be inserted after the header image, so that it may be used as a cover page
- Index position: you may decide to print the catalog index at the beginning or at the end of the catalog
- Index start page: even more, you can decide at which page your index will be placed (only if it's set at the beginning)
- Image resize mode: should we resize images to exactly fit the box or keep proportions? You should probably never change this.
Ok: we're done with basic configuration.
Here is the main page of the whole component: the form to create catalogs.
You can create as many catalogs as you want, with different categories and different options.
Let's see how each catalog is defined.
- Start with giving the catalog a name which will be shown in the list.
- Set if the catalog is published or not (this only applies to frontend)
- Select an optional header and footer color.
- Set an optional catalog header image which will be shown at the beginning of the catalog, just after the title.
- You can then optionally choose an intro article: a Joomla article that will also be displayed at the beginning of the catalog.
- Set an optionl back cover image.
- If there are different available languages, choose which one to include. Note: there are some differences between language management from VirtueMart 1 and VirtueMart 2, we will talk about that later.
Now proceed to the categories selection.
The categories list includes VirtueMart categories according to your configuration (see "Basic Configuration" section above).
For each category you will be able to select:
- enable: if the category should be included in the catalog
- use header image: if the category should have an image at the beginning, before the products list
- header image path: the path to the header image (only relevant if use header image is enabled), with a link to browse / upload images
- use background image: if the category should have a background image
- background image path: the path to the background image (only relevant if use background image is enabled), with a link to browse / upload images
- layout: an optional alternative layout (see "Category layouts" in the "Advanced usage" documentation article)
- color: a color in hexadecimal format (e.g. #ff6600) that will be used as background for the category title
As you can see, you have many options to customize appearance for each category.
Would you like to save the catalog?
This is important: at this point you can proceed to create an HTML / PDF catalog, but it will not be saved!
If you would like to keep it and use it again, you will have to save it before proceeding to creation.
After that, you may click on Create HTML Catalog or Create PDF Catalog to see the result.
If something is not right. you may have to check again your component configuration (see "Basic Configuration" section above) or your catalog configuration.
If you need any help, see "Support" below.
And much more...
Basically, this all you need to know to start using Sprint.
But there are some advanced features which could be useful, so if you have still a little time left, go on reading the documentation and you'll find some other interesting stuff.
Apart from this documentation, users with an active subscription will get support on our ticket system.
Please be sure you check the faqs first.
You can buy a subscription anytime you want from the GiBi Sprint product page.